dac14  2.1.0.0
dac14.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef DAC14_H
29 #define DAC14_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_spi_master.h"
39 #include "spi_specifics.h"
40 
61 #define DAC14_REG_NOP 0x00
62 #define DAC14_REG_DAC1_MARGIN_HIGH 0x01
63 #define DAC14_REG_DAC1_MARGIN_LOW 0x02
64 #define DAC14_REG_DAC1_VOUT_CMP_CONFIG 0x03
65 #define DAC14_REG_DAC1_IOUT_MISC_CONFIG 0x04
66 #define DAC14_REG_DAC1_CMP_MODE_CONFIG 0x05
67 #define DAC14_REG_DAC1_FUNC_CONFIG 0x06
68 #define DAC14_REG_DAC0_MARGIN_HIGH 0x13
69 #define DAC14_REG_DAC0_MARGIN_LOW 0x14
70 #define DAC14_REG_DAC0_VOUT_CMP_CONFIG 0x15
71 #define DAC14_REG_DAC0_IOUT_MISC_CONFIG 0x16
72 #define DAC14_REG_DAC0_CMP_MODE_CONFIG 0x17
73 #define DAC14_REG_DAC0_FUNC_CONFIG 0x18
74 #define DAC14_REG_DAC1_DATA 0x19
75 #define DAC14_REG_DAC0_DATA 0x1C
76 #define DAC14_REG_COMMON_CONFIG 0x1F
77 #define DAC14_REG_COMMON_TRIGGER 0x20
78 #define DAC14_REG_COMMON_DAC_TRIG 0x21
79 #define DAC14_REG_GENERAL_STATUS 0x22
80 #define DAC14_REG_CMP_STATUS 0x23
81 #define DAC14_REG_GPIO_CONFIG 0x24
82 #define DAC14_REG_DEVICE_MODE_CONFIG 0x25
83 #define DAC14_REG_INTERFACE_CONFIG 0x26
84 #define DAC14_REG_SRAM_CONFIG 0x2B
85 #define DAC14_REG_SRAM_DATA 0x2C
86 #define DAC14_REG_BRDCAST_DATA 0x50
87  // dac14_reg
89 
104 #define DAC14_CC_WIN_LATCH_EN 0x8000
105 #define DAC14_CC_DEV_LOCK 0x4000
106 #define DAC14_CC_EE_READ_ADDR 0x2000
107 #define DAC14_CC_EN_INT_REF 0x1000
108 #define DAC14_CC_VOUT_PDN_0_POWER_UP 0x0000
109 #define DAC14_CC_VOUT_PDN_0_POWER_DOWN_10K 0x0400
110 #define DAC14_CC_VOUT_PDN_0_POWER_DOWN_100K 0x0800
111 #define DAC14_CC_VOUT_PDN_0_POWER_DOWN_Z 0x0C00
112 #define DAC14_CC_VOUT_PDN_0_MASK 0x0C00
113 #define DAC14_CC_IOUT_PDN_0_POWER_UP 0x0000
114 #define DAC14_CC_IOUT_PDN_0_POWER_DOWN 0x0200
115 #define DAC14_CC_IOUT_PDN_0_MASK 0x0200
116 #define DAC14_CC_RESERVED 0x0088
117 #define DAC14_CC_VOUT_PDN_1_POWER_UP 0x0000
118 #define DAC14_CC_VOUT_PDN_1_POWER_DOWN_10K 0x0002
119 #define DAC14_CC_VOUT_PDN_1_POWER_DOWN_100K 0x0004
120 #define DAC14_CC_VOUT_PDN_1_POWER_DOWN_Z 0x0006
121 #define DAC14_CC_VOUT_PDN_1_MASK 0x0006
122 #define DAC14_CC_IOUT_PDN_1_POWER_UP 0x0000
123 #define DAC14_CC_IOUT_PDN_1_POWER_DOWN 0x0001
124 #define DAC14_CC_IOUT_PDN_1_MASK 0x0001
125 
130 #define DAC14_CDT_RESET_CMP_FLAG_1 0x8000
131 #define DAC14_CDT_TRIG_MAR_LO_1 0x4000
132 #define DAC14_CDT_TRIG_MAR_HI_1 0x2000
133 #define DAC14_CDT_STOP_FUNC_1 0x0000
134 #define DAC14_CDT_START_FUNC_1 0x1000
135 #define DAC14_CDT_RESET_CMP_FLAG_0 0x0008
136 #define DAC14_CDT_TRIG_MAR_LO_0 0x0004
137 #define DAC14_CDT_TRIG_MAR_HI_0 0x0002
138 #define DAC14_CDT_START_FUNC_0 0x0001
139 #define DAC14_CDT_STOP_FUNC_0 0x0000
140 
145 #define DAC14_DXFC_CLR_SEL_X 0x8000
146 #define DAC14_DXFC_SYNC_CONFIG_X 0x4000
147 #define DAC14_DXFC_BRD_CONFIG_X 0x2000
148 #define DAC14_DXFC_PHASE_SEL_X_0_DEG 0x0000
149 #define DAC14_DXFC_PHASE_SEL_X_120_DEG 0x0800
150 #define DAC14_DXFC_PHASE_SEL_X_240_DEG 0x1000
151 #define DAC14_DXFC_PHASE_SEL_X_90_DEG 0x1800
152 #define DAC14_DXFC_PHASE_SEL_X_MASK 0x1800
153 #define DAC14_DXFC_FUNC_CONFIG_X_TRIANGULAR 0x0000
154 #define DAC14_DXFC_FUNC_CONFIG_X_SAWTH 0x0100
155 #define DAC14_DXFC_FUNC_CONFIG_X_INV_SAWTH 0x0200
156 #define DAC14_DXFC_FUNC_CONFIG_X_SINE 0x0400
157 #define DAC14_DXFC_FUNC_CONFIG_X_DIS_FC 0x0700
158 #define DAC14_DXFC_FUNC_CONFIG_X_MASK 0x0700
159 #define DAC14_DXFC_LOG_SLEW_EN_X 0x0080
160 #define DAC14_DXFC_CODE_STEP_X_1 0x0000
161 #define DAC14_DXFC_CODE_STEP_X_2 0x0010
162 #define DAC14_DXFC_CODE_STEP_X_3 0x0020
163 #define DAC14_DXFC_CODE_STEP_X_4 0x0030
164 #define DAC14_DXFC_CODE_STEP_X_6 0x0040
165 #define DAC14_DXFC_CODE_STEP_X_8 0x0050
166 #define DAC14_DXFC_CODE_STEP_X_16 0x0060
167 #define DAC14_DXFC_CODE_STEP_X_32 0x0070
168 #define DAC14_DXFC_CODE_STEP_X_MASK 0x0070
169 #define DAC14_DXFC_SLEW_RATE_X_NO_SR 0x0000
170 #define DAC14_DXFC_SLEW_RATE_X_4_US 0x0001
171 #define DAC14_DXFC_SLEW_RATE_X_8_US 0x0002
172 #define DAC14_DXFC_SLEW_RATE_X_12_US 0x0003
173 #define DAC14_DXFC_SLEW_RATE_X_18_US 0x0004
174 #define DAC14_DXFC_SLEW_RATE_X_27_04_US 0x0005
175 #define DAC14_DXFC_SLEW_RATE_X_40_48_US 0x0006
176 #define DAC14_DXFC_SLEW_RATE_X_60_72_US 0x0007
177 #define DAC14_DXFC_SLEW_RATE_X_91_12_US 0x0008
178 #define DAC14_DXFC_SLEW_RATE_X_136_72_US 0x0009
179 #define DAC14_DXFC_SLEW_RATE_X_239_2_US 0x000A
180 #define DAC14_DXFC_SLEW_RATE_X_418_64_US 0x000B
181 #define DAC14_DXFC_SLEW_RATE_X_732_56_US 0x000C
182 #define DAC14_DXFC_SLEW_RATE_X_1282_US 0x000D
183 #define DAC14_DXFC_SLEW_RATE_X_2563_96_US 0x000E
184 #define DAC14_DXFC_SLEW_RATE_X_5127_92_US 0x000F
185 #define DAC14_DXFC_SLEW_RATE_X_MASK 0x000F
186 
191 #define DAC14_VCC_VOUT_GAIN_X_EXT_VREF 0x0000
192 #define DAC14_VCC_VOUT_GAIN_X_VDD 0x0400
193 #define DAC14_VCC_VOUT_GAIN_X_INT_1_5X 0x0800
194 #define DAC14_VCC_VOUT_GAIN_X_INT_2X 0x0C00
195 #define DAC14_VCC_VOUT_GAIN_X_INT_3X 0x1000
196 #define DAC14_VCC_VOUT_GAIN_X_INT_4X 0x1400
197 #define DAC14_VCC_VOUT_GAIN_X_MASK 0x1C00
198 #define DAC14_VCC_CMP_X_OD_EN 0x0010
199 #define DAC14_VCC_CMP_X_OUT_EN 0x0008
200 #define DAC14_VCC_CMP_X_HIZ_IN_EN 0x0004
201 #define DAC14_VCC_CMP_X_INV_EN 0x0002
202 #define DAC14_VCC_CMP_X_EN 0x0001
203 
208 #define DAC14_IC_TIMEOUT_EN 0x1000
209 #define DAC14_IC_EN_PMBUS 0x0100
210 #define DAC14_IC_FSDO_EN 0x0004
211 #define DAC14_IC_SDO_EN 0x0001
212 #define DAC14_IC_SDO_DIS 0x0000
213 
218 #define DAC14_DAC_DATA_MAX 1023
219 #define DAC14_DAC_DATA_MIN 0
220 
225 #define DAC14_DEVICE_ID_MASK 0xFC
226 #define DAC14_DEVICE_ID 0x1C
227 
232 #define DAC14_SEL_DAC_0 0
233 #define DAC14_SEL_DAC_1 1
234 
239 #define DAC14_EN_VOUT_POWER_UP 0
240 #define DAC14_EN_VOUT_POWER_DOWN_10K_AGND 1
241 #define DAC14_EN_VOUT_POWER_DOWN_100K_AGND 2
242 #define DAC14_EN_VOUT_POWER_DOWN_HI_Z_AGND 3
243 
248 #define DAC14_WAVEFORM_TRIANGULAR 0
249 #define DAC14_WAVEFORM_SAWTOOTH 1
250 #define DAC14_WAVEFORM_INV_SAWTOOTH 2
251 #define DAC14_WAVEFORM_SINE 4
252 #define DAC14_WAVEFORM_DISABLE 7
253 
258 #define DAC14_CODE_STEP_1_LSB 0
259 #define DAC14_CODE_STEP_2_LSB 1
260 #define DAC14_CODE_STEP_3_LSB 2
261 #define DAC14_CODE_STEP_4_LSB 3
262 #define DAC14_CODE_STEP_6_LSB 4
263 #define DAC14_CODE_STEP_8_LSB 5
264 #define DAC14_CODE_STEP_16_LSB 6
265 #define DAC14_CODE_STEP_32_LSB 7
266 
271 #define DAC14_SLEW_RATE_NO_SLEW 0
272 #define DAC14_SLEW_RATE_4_US 1
273 #define DAC14_SLEW_RATE_8_US 2
274 #define DAC14_SLEW_RATE_12_US 3
275 #define DAC14_SLEW_RATE_18_US 4
276 #define DAC14_SLEW_RATE_27_04_US 5
277 #define DAC14_SLEW_RATE_40_48_US 6
278 #define DAC14_SLEW_RATE_60_72_US 7
279 #define DAC14_SLEW_RATE_91_12_US 8
280 #define DAC14_SLEW_RATE_136_72_US 9
281 #define DAC14_SLEW_RATE_239_2_US 10
282 #define DAC14_SLEW_RATE_418_64_US 11
283 #define DAC14_SLEW_RATE_732_56_US 12
284 #define DAC14_SLEW_RATE_1282_US 13
285 #define DAC14_SLEW_RATE_2563_96_US 14
286 #define DAC14_SLEW_RATE_5127_92_US 15
287 
292 #define DAC14_VREF_EXT 0
293 #define DAC14_VREF_VDD 1
294 #define DAC14_VREF_INT_1_5X 2
295 #define DAC14_VREF_INT_2X 3
296 #define DAC14_VREF_INT_3X 4
297 #define DAC14_VREF_INT_4X 5
298 
303 #define DAC14_VDD_3V3 3.3f
304 #define DAC14_VDD_5V 5.0f
305 
311 #define DAC14_DEVICE_ADDRESS_GND 0x48
312 #define DAC14_DEVICE_ADDRESS_VCC 0x49
313 #define DAC14_DEVICE_ADDRESS_SDA 0x4A
314 #define DAC14_DEVICE_ADDRESS_SCL 0x4B
315 
324 #define DAC14_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
325 #define DAC14_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
326  // dac14_set
328 
343 #define DAC14_MAP_MIKROBUS( cfg, mikrobus ) \
344  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
345  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
346  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
347  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
348  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
349  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
350  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
351  // dac14_map // dac14
354 
359 typedef enum
360 {
365 
370 typedef err_t ( *dac14_master_io_t )( struct dac14_s*, uint8_t, uint16_t* );
376 typedef struct dac14_s
377 {
378  digital_in_t int_pin;
380  i2c_master_t i2c;
381  spi_master_t spi;
383  uint8_t slave_address;
384  pin_name_t chip_select;
391 
396 typedef struct
397 {
398  pin_name_t scl;
399  pin_name_t sda;
400  pin_name_t miso;
401  pin_name_t mosi;
402  pin_name_t sck;
403  pin_name_t cs;
404  pin_name_t int_pin;
406  uint32_t i2c_speed;
407  uint8_t i2c_address;
409  uint32_t spi_speed;
410  spi_master_mode_t spi_mode;
411  spi_master_chip_select_polarity_t cs_polarity;
415 } dac14_cfg_t;
416 
421 typedef enum
422 {
423  DAC14_OK = 0,
424  DAC14_ERROR = -1
425 
427 
444 
460 
474 err_t dac14_init ( dac14_t *ctx, dac14_cfg_t *cfg );
475 
488 err_t dac14_default_cfg ( dac14_t *ctx );
489 
502 err_t dac14_write_register ( dac14_t *ctx, uint8_t reg, uint16_t data_in );
503 
516 err_t dac14_read_register ( dac14_t *ctx, uint8_t reg, uint16_t *data_out );
517 
526 uint8_t dac14_get_int_pin ( dac14_t *ctx );
527 
539 
556 err_t dac14_set_dac_vout_enable ( dac14_t *ctx, uint8_t dac, uint8_t vout_pdn );
557 
576 err_t dac14_set_dac_vref ( dac14_t *ctx, uint8_t dac, uint8_t vref );
577 
592 err_t dac14_set_dac_margins ( dac14_t *ctx, uint8_t dac, uint16_t margin_l, uint16_t margin_h );
593 
607 err_t dac14_set_dac_data ( dac14_t *ctx, uint8_t dac, uint16_t dac_data );
608 
621 err_t dac14_start_function_gen ( dac14_t *ctx, uint8_t dac );
622 
635 err_t dac14_stop_function_gen ( dac14_t *ctx, uint8_t dac );
636 
661 err_t dac14_config_function_gen ( dac14_t *ctx, uint8_t dac, uint8_t waveform,
662  uint8_t code_step, uint8_t slew_rate );
663 
664 #ifdef __cplusplus
665 }
666 #endif
667 #endif // DAC14_H
668  // dac14
670 
671 // ------------------------------------------------------------------------ END
dac14_cfg_t::i2c_address
uint8_t i2c_address
Definition: dac14.h:407
dac14_set_dac_vref
err_t dac14_set_dac_vref(dac14_t *ctx, uint8_t dac, uint8_t vref)
DAC 14 set dac vref function.
dac14_stop_function_gen
err_t dac14_stop_function_gen(dac14_t *ctx, uint8_t dac)
DAC 14 stop function gen function.
dac14_s
DAC 14 Click context object.
Definition: dac14.h:377
dac14_cfg_t
DAC 14 Click configuration object.
Definition: dac14.h:397
dac14_cfg_t::drv_sel
dac14_drv_t drv_sel
Definition: dac14.h:413
DAC14_DRV_SEL_I2C
@ DAC14_DRV_SEL_I2C
Definition: dac14.h:362
DAC14_ERROR
@ DAC14_ERROR
Definition: dac14.h:424
dac14_init
err_t dac14_init(dac14_t *ctx, dac14_cfg_t *cfg)
DAC 14 initialization function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
dac14_master_io_t
err_t(* dac14_master_io_t)(struct dac14_s *, uint8_t, uint16_t *)
DAC 14 Click driver interface.
Definition: dac14.h:370
DAC14_DRV_SEL_SPI
@ DAC14_DRV_SEL_SPI
Definition: dac14.h:361
dac14_read_register
err_t dac14_read_register(dac14_t *ctx, uint8_t reg, uint16_t *data_out)
DAC 14 read register function.
dac14_cfg_t::sck
pin_name_t sck
Definition: dac14.h:402
dac14_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: dac14.h:411
dac14_s::read_f
dac14_master_io_t read_f
Definition: dac14.h:388
dac14_s::spi
spi_master_t spi
Definition: dac14.h:381
dac14_drv_interface_selection
void dac14_drv_interface_selection(dac14_cfg_t *cfg, dac14_drv_t drv_sel)
DAC 14 driver interface setup function.
dac14_cfg_t::sda
pin_name_t sda
Definition: dac14.h:399
dac14_cfg_t::scl
pin_name_t scl
Definition: dac14.h:398
dac14_cfg_t::mosi
pin_name_t mosi
Definition: dac14.h:401
dac14_set_dac_margins
err_t dac14_set_dac_margins(dac14_t *ctx, uint8_t dac, uint16_t margin_l, uint16_t margin_h)
DAC 14 set dac margins function.
dac14_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: dac14.h:410
dac14_cfg_setup
void dac14_cfg_setup(dac14_cfg_t *cfg)
DAC 14 configuration object setup function.
dac14_s::chip_select
pin_name_t chip_select
Definition: dac14.h:384
dac14_s::int_pin
digital_in_t int_pin
Definition: dac14.h:378
dac14_check_communication
err_t dac14_check_communication(dac14_t *ctx)
DAC 14 check communication function.
dac14_cfg_t::spi_speed
uint32_t spi_speed
Definition: dac14.h:409
dac14_return_value_t
dac14_return_value_t
DAC 14 Click return value data.
Definition: dac14.h:422
dac14_cfg_t::int_pin
pin_name_t int_pin
Definition: dac14.h:404
dac14_s::i2c
i2c_master_t i2c
Definition: dac14.h:380
DAC14_OK
@ DAC14_OK
Definition: dac14.h:423
dac14_default_cfg
err_t dac14_default_cfg(dac14_t *ctx)
DAC 14 default configuration function.
dac14_start_function_gen
err_t dac14_start_function_gen(dac14_t *ctx, uint8_t dac)
DAC 14 start function gen function.
dac14_write_register
err_t dac14_write_register(dac14_t *ctx, uint8_t reg, uint16_t data_in)
DAC 14 write register function.
dac14_s::slave_address
uint8_t slave_address
Definition: dac14.h:383
dac14_drv_t
dac14_drv_t
DAC 14 Click driver selector.
Definition: dac14.h:360
dac14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dac14.h:406
dac14_set_dac_data
err_t dac14_set_dac_data(dac14_t *ctx, uint8_t dac, uint16_t dac_data)
DAC 14 set dac data function.
dac14_set_dac_vout_enable
err_t dac14_set_dac_vout_enable(dac14_t *ctx, uint8_t dac, uint8_t vout_pdn)
DAC 14 set dac vout enable function.
dac14_s::drv_sel
dac14_drv_t drv_sel
Definition: dac14.h:385
dac14_cfg_t::cs
pin_name_t cs
Definition: dac14.h:403
dac14_t
struct dac14_s dac14_t
DAC 14 Click context object.
dac14_config_function_gen
err_t dac14_config_function_gen(dac14_t *ctx, uint8_t dac, uint8_t waveform, uint8_t code_step, uint8_t slew_rate)
DAC 14 config function gen function.
dac14_cfg_t::miso
pin_name_t miso
Definition: dac14.h:400
dac14_get_int_pin
uint8_t dac14_get_int_pin(dac14_t *ctx)
DAC 14 get int pin function.
dac14_s::write_f
dac14_master_io_t write_f
Definition: dac14.h:387