dac8  2.0.0.0
dac8.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef DAC8_H
36 #define DAC8_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 #include "drv_spi_master.h"
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define DAC8_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
66  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
72  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
73 
79 #define DAC8_MASTER_I2C 0
80 #define DAC8_MASTER_SPI 1
81 
87 #define DAC8_RETVAL uint8_t
88 
89 #define DAC8_OK 0x00
90 #define DAC8_INIT_ERROR 0xFF
91 
97 #define DAC8_I2C_SLAVE_ADDR 0x48
98 
104 #define DAC8_REG_NOOP 0x00
105 #define DAC8_REG_DEVID 0x01
106 #define DAC8_REG_SYNC 0x02
107 #define DAC8_REG_CONFIG 0x03
108 #define DAC8_REG_GAIN 0x04
109 #define DAC8_REG_TRIGGER 0x05
110 #define DAC8_REG_STATUS 0x07
111 #define DAC8_REG_DAC 0x08
112 
118 #define DAC8_SYNC_DISABLE 0x0000
119 #define DAC8_SYNC_ENABLE 0x0001
120 
126 #define DAC8_CONFIG_REF_PWDWN_ENABLE 0x0000
127 #define DAC8_CONFIG_REF_PWDWN_DISABLE 0x0001
128 #define DAC8_CONFIG_REF_PWDWN_BIT_MASK 0x0001
129 #define DAC8_CONFIG_DAC_PWDWN_DISABLE 0x0000
130 #define DAC8_CONFIG_DAC_PWDWN_ENABLE 0x0001
131 #define DAC8_CONFIG_DAC_PWDWN_BIT_MASK 0x0001
132 
138 #define DAC8_GAIN_REF_DIV_DISABLE 0x0000
139 #define DAC8_GAIN_REF_DIV_2 0x0001
140 #define DAC8_GAIN_REF_DIV_BIT_MASK 0x0001
141 #define DAC8_GAIN_BUFF_GAIN_1 0x0000
142 #define DAC8_GAIN_BUFF_GAIN_2 0x0001
143 #define DAC8_GAIN_BUFF_GAIN_BIT_MASK 0x0001
144 
150 #define DAC8_TRIGGER_LDAC 0x0010
151 #define DAC8_TRIGGER_SOFT_RESET 0x000A
152 
158 #define DAC8_STATUS_REF_ALARM_BIT_MASK 0x0001
159 
160 #define DAC8_ERROR 0x00
161 #define DAC8_SUCCESS 0x01
162 
168 #define DAC8_ADDR_DEFAULT 0x00
169 #define DAC8_ADDR_BIT_MASK 0x03
170 
171 #define DAC8_CTRL_UPD_AN_OUT_SINGLE_CH_STORE 0x00
172 #define DAC8_CTRL_UPD_AN_OUT_SINGLE_CH_UPDATE 0x01
173 #define DAC8_CTRL_UPD_AN_OUT_SIMULTANEOUS_UPDATE 0x02
174 #define DAC8_CTRL_UPD_AN_OUT_BROADCAST_UPDATE 0x03
175 #define DAC8_CTRL_UPD_AN_OUT_BIT_MASK 0x03
176 
177 #define DAC8_DAC_SEL_CH_A 0x00
178 #define DAC8_DAC_SEL_CH_B 0x01
179 #define DAC8_DAC_SEL_CH_C 0x02
180 #define DAC8_DAC_SEL_CH_D 0x03
181 #define DAC8_DAC_SEL_ALL_CH_BROADCAST 0x30
182 #define DAC8_DAC_SEL_CH_BIT_MASK 0x03
183 
184 #define DAC8_PWR_MODE_POWER_UP 0x00
185 #define DAC8_PWR_MODE_POWER_DOWN_OUT_HIGH_IMPEDANCE 0x09
186 #define DAC8_PWR_MODE_POWER_DOWN_OUT_TYP_1K_TO_GND 0x0B
187 #define DAC8_PWR_MODE_POWER_DOWN_OUT_TYP_100K_TO_GND 0x0D
188 #define DAC8_PWR_MODE_POWER_DOWN_OUT_HIGH_IMPEDANCES 0x0F
189 #define DAC8_PWR_UP_MODE_BIT_MASK 0x01
190 #define DAC8_PWR_DOWN_MODE_BIT_MASK 0x0E
191 
192 #define DAC8_24_BIT_BIT_MASK 0x00FFFFFF
193 
194 #define DAC8_DAC_OUT_DATA_MIN 0x0000
195 #define DAC8_DAC_OUT_DATA_MAX 0x0FFF
196 
197 #define DAC8_LDAC_LOW 0x00
198 #define DAC8_LDAC_HIGH 0x01
199 
200 #define DAC8_DAC8554_ENABLE 0x00
201 #define DAC8_DAC8554_DISABLE 0x01
202  // End group macro
204 // --------------------------------------------------------------- PUBLIC TYPES
213 typedef uint8_t dac8_select_t;
214 
218 typedef void ( *dac8_master_io_t )( struct dac8_s*, uint8_t, uint8_t*, uint8_t );
219 
223 typedef struct dac8_s
224 {
225  // Modules
226 
227  i2c_master_t i2c;
228  spi_master_t spi;
229 
230  // Output pins
231 
232  digital_out_t cs;
233  digital_out_t pwm;
234  digital_out_t rst;
235 
236  // ctx variable
237 
238  uint8_t slave_address;
239  pin_name_t chip_select;
243 
245 
249 typedef struct
250 {
251  // Communication gpio pins
252 
253  pin_name_t scl;
254  pin_name_t sda;
255  pin_name_t miso;
256  pin_name_t mosi;
257  pin_name_t sck;
258  pin_name_t cs;
259 
260  // Additional gpio pins
261 
262  pin_name_t pwm;
263  pin_name_t rst;
264 
265  // static variable
266 
267  uint32_t i2c_speed;
268  uint8_t i2c_address;
269 
270  uint32_t spi_speed;
271  spi_master_mode_t spi_mode;
272  spi_master_chip_select_polarity_t cs_polarity;
273 
275 
276 } dac8_cfg_t;
277 
278 typedef struct
279 {
280  uint8_t addr;
282  uint8_t dac_sel;
283  uint8_t pwr_mode;
284  uint16_t dac_val;
285 }
287  // End types group
289 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
295 #ifdef __cplusplus
296 extern "C"{
297 #endif
298 
309 
318 DAC8_RETVAL dac8_init ( dac8_t *ctx, dac8_cfg_t *cfg, uint8_t master_mode );
319 
330 void dac8_generic_write ( dac8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
331 
342 void dac8_generic_read ( dac8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
343 
364 DAC8_RETVAL dac8_enable_sync ( dac8_t *ctx, uint8_t en_sync );
365 
391 DAC8_RETVAL dac8_set_config ( dac8_t *ctx, uint16_t en_ref_pwdwn, uint16_t en_dac_pwdwn );
392 
419 DAC8_RETVAL dac8_set_gain ( dac8_t *ctx, uint16_t en_ref_div, uint16_t en_buff_gain );
420 
431 
441 void dac8_soft_reset ( dac8_t *ctx );
442 
459 uint8_t dac8_get_ref_alarm ( dac8_t *ctx );
460 
478 DAC8_RETVAL dac8_set_vref ( dac8_t *ctx, uint16_t vref_mv );
479 
495 void dac8_device_enable ( dac8_t *ctx, uint8_t en_sel );
496 
511 void dac8_set_ldac ( dac8_t *ctx, uint8_t ldac_sel );
512 
523 void dac8_load_dac ( dac8_t *ctx );
524 
536 void dac8_generic_spi_write ( dac8_t *ctx, uint32_t tx_data );
537 
548 void dac8_device_config ( dac8_t *ctx, dac8_cfg_data_t cfg_data );
549 
550 #ifdef __cplusplus
551 }
552 #endif
553 #endif // _DAC8_H_
554  // End public_function group
557 
558 // ------------------------------------------------------------------------- END
dac8_cfg_data_t::ctrl_upd_an_out
uint8_t ctrl_upd_an_out
Definition: dac8.h:281
dac8_s::write_f
dac8_master_io_t write_f
Definition: dac8.h:240
dac8_cfg_data_t::dac_val
uint16_t dac_val
Definition: dac8.h:284
dac8_generic_write
void dac8_generic_write(dac8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
dac8_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dac8.h:267
dac8_device_enable
void dac8_device_enable(dac8_t *ctx, uint8_t en_sel)
Device enable function.
dac8_cfg_t
Click configuration structure definition.
Definition: dac8.h:250
dac8_set_ldac
void dac8_set_ldac(dac8_t *ctx, uint8_t ldac_sel)
Set LDAC function.
dac8_s::cs
digital_out_t cs
Definition: dac8.h:232
dac8_cfg_data_t::dac_sel
uint8_t dac_sel
Definition: dac8.h:282
dac8_cfg_t::sel
dac8_select_t sel
Definition: dac8.h:274
dac8_cfg_t::mosi
pin_name_t mosi
Definition: dac8.h:256
dac8_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: dac8.h:272
dac8_select_t
uint8_t dac8_select_t
Communication type.
Definition: dac8.h:213
dac8_set_gain
DAC8_RETVAL dac8_set_gain(dac8_t *ctx, uint16_t en_ref_div, uint16_t en_buff_gain)
Set gain function.
dac8_set_config
DAC8_RETVAL dac8_set_config(dac8_t *ctx, uint16_t en_ref_pwdwn, uint16_t en_dac_pwdwn)
Set config function.
dac8_t
struct dac8_s dac8_t
Click ctx object definition.
dac8_cfg_t::sck
pin_name_t sck
Definition: dac8.h:257
dac8_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: dac8.h:271
dac8_device_config
void dac8_device_config(dac8_t *ctx, dac8_cfg_data_t cfg_data)
Set device config function.
dac8_cfg_data_t::pwr_mode
uint8_t pwr_mode
Definition: dac8.h:283
dac8_cfg_t::i2c_address
uint8_t i2c_address
Definition: dac8.h:268
dac8_cfg_t::cs
pin_name_t cs
Definition: dac8.h:258
dac8_cfg_t::miso
pin_name_t miso
Definition: dac8.h:255
dac8_s::chip_select
pin_name_t chip_select
Definition: dac8.h:239
dac8_s::spi
spi_master_t spi
Definition: dac8.h:228
dac8_cfg_t::scl
pin_name_t scl
Definition: dac8.h:253
dac8_s
Click ctx object definition.
Definition: dac8.h:224
dac8_init
DAC8_RETVAL dac8_init(dac8_t *ctx, dac8_cfg_t *cfg, uint8_t master_mode)
Initialization function.
dac8_set_synchronously_load
void dac8_set_synchronously_load(dac8_t *ctx)
Set synchronously load function.
dac8_generic_read
void dac8_generic_read(dac8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
dac8_s::rst
digital_out_t rst
Definition: dac8.h:234
dac8_set_vref
DAC8_RETVAL dac8_set_vref(dac8_t *ctx, uint16_t vref_mv)
Set vref function.
dac8_s::pwm
digital_out_t pwm
Definition: dac8.h:233
dac8_s::read_f
dac8_master_io_t read_f
Definition: dac8.h:241
dac8_enable_sync
DAC8_RETVAL dac8_enable_sync(dac8_t *ctx, uint8_t en_sync)
Enable synchronous function.
dac8_cfg_t::sda
pin_name_t sda
Definition: dac8.h:254
dac8_cfg_t::spi_speed
uint32_t spi_speed
Definition: dac8.h:270
dac8_generic_spi_write
void dac8_generic_spi_write(dac8_t *ctx, uint32_t tx_data)
Generic SPI write function.
dac8_load_dac
void dac8_load_dac(dac8_t *ctx)
Load DAC function.
dac8_s::i2c
i2c_master_t i2c
Definition: dac8.h:227
dac8_get_ref_alarm
uint8_t dac8_get_ref_alarm(dac8_t *ctx)
Get ref alarm function.
dac8_cfg_t::pwm
pin_name_t pwm
Definition: dac8.h:262
DAC8_RETVAL
#define DAC8_RETVAL
Definition: dac8.h:87
dac8_cfg_data_t
Definition: dac8.h:279
dac8_cfg_data_t::addr
uint8_t addr
Definition: dac8.h:280
dac8_s::slave_address
uint8_t slave_address
Definition: dac8.h:238
dac8_soft_reset
void dac8_soft_reset(dac8_t *ctx)
Set reset function.
dac8_cfg_setup
void dac8_cfg_setup(dac8_cfg_t *cfg)
Config Object Initialization function.
dac8_s::master_sel
dac8_select_t master_sel
Definition: dac8.h:242
dac8_master_io_t
void(* dac8_master_io_t)(struct dac8_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: dac8.h:218
dac8_cfg_t::rst
pin_name_t rst
Definition: dac8.h:263