dac5  2.0.0.0
dac5.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 DAC5_H
36 #define DAC5_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define DAC5_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
55  cfg.lda = MIKROBUS( mikrobus, MIKROBUS_PWM )
56 
62 #define DAC5_RETVAL uint8_t
63 
64 #define DAC5_OK 0x00
65 #define DAC5_INIT_ERROR 0xFF
66 #define DAC5_ERROR 0
67 #define DAC5_SUCCESS 1
68 
74 #define DAC5_SLAVE_ADDRESS_BROADCAST 0x47
75 #define DAC5_SLAVE_ADDRESS_GND 0x48
76 #define DAC5_SLAVE_ADDRESS_VCC 0x49
77 #define DAC5_SLAVE_ADDRESS_SDA 0x4A
78 #define DAC5_SLAVE_ADDRESS_SCL 0x4B
79 
85 #define DAC5_VREF_3300MV 3300
86 #define DAC5_VREF_5000MV 5000
87 #define DAC5_VREF_2048MV 2048
88 #define DAC5_VREF_1024MV 1024
89 
95 #define DAC5_REG_CONFIG 0x01
96 #define DAC5_REG_STATUS_TRIGGER 0x02
97 #define DAC5_REG_BRDCAST 0x03
98 #define DAC5_REG_DAC_A_DATA 0x08
99 #define DAC5_REG_DAC_B_DATA 0x09
100 #define DAC5_REG_DAC_C_DATA 0x0A
101 #define DAC5_REG_DAC_D_DATA 0x0B
102 #define DAC5_REG_DAC_E_DATA 0x0C
103 #define DAC5_REG_DAC_F_DATA 0x0D
104 #define DAC5_REG_DAC_G_DATA 0x0E
105 #define DAC5_REG_DAC_H_DATA 0x0F
106 
112 #define DAC5_CONFIG_DEFAULT 0x00FF
113 #define DAC5_CONFIG_GLOBAL_ENABLED 0x0000
114 #define DAC5_CONFIG_GLOBAL_DISABLED 0x0100
115 #define DAC5_CONFIG_A_ENABLED 0x0000
116 #define DAC5_CONFIG_A_DISABLED 0x0001
117 #define DAC5_CONFIG_B_ENABLED 0x0000
118 #define DAC5_CONFIG_B_DISABLED 0x0002
119 #define DAC5_CONFIG_C_ENABLED 0x0000
120 #define DAC5_CONFIG_C_DISABLED 0x0004
121 #define DAC5_CONFIG_D_ENABLED 0x0000
122 #define DAC5_CONFIG_D_DISABLED 0x0008
123 #define DAC5_CONFIG_E_ENABLED 0x0000
124 #define DAC5_CONFIG_E_DISABLED 0x0010
125 #define DAC5_CONFIG_F_ENABLED 0x0000
126 #define DAC5_CONFIG_F_DISABLED 0x0020
127 #define DAC5_CONFIG_G_ENABLED 0x0000
128 #define DAC5_CONFIG_G_DISABLED 0x0040
129 #define DAC5_CONFIG_H_ENABLED 0x0000
130 #define DAC5_CONFIG_H_DISABLED 0x0080
131 
137 #define DAC5_DEVICE_ID 0x0300
138 #define DAC5_SOFTWARE_RESET 0x000A
139 
145 #define DAC5_MIN_DATA 0x0000
146 #define DAC5_MAX_DATA 0x0FFF
147 
153 #define DAC5_ERROR 0
154 #define DAC5_SUCCESS 1
155 
161 #define DAC5_SYNCHRONOUS 1
162 #define DAC5_ASYNCHRONOUS 0
163  // End group macro
166 // --------------------------------------------------------------- PUBLIC TYPES
175 typedef struct
176 {
177  // Output pins
178 
179  digital_out_t rst;
180  digital_out_t lda;
181 
182  // Modules
183 
184  i2c_master_t i2c;
185 
186  // ctx variable
187 
188  uint8_t slave_address;
189  uint16_t vref;
190 
191 } dac5_t;
192 
196 typedef struct
197 {
198  // Communication gpio pins
199 
200  pin_name_t scl;
201  pin_name_t sda;
202 
203  // Additional gpio pins
204 
205  pin_name_t rst;
206  pin_name_t lda;
207 
208  // static variable
209 
210  uint32_t i2c_speed;
211  uint8_t i2c_address;
212 
213 } dac5_cfg_t;
214  // End types group
216 
217 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
218 
224 #ifdef __cplusplus
225 extern "C"{
226 #endif
227 
236 void dac5_cfg_setup ( dac5_cfg_t *cfg );
237 
246 DAC5_RETVAL dac5_init ( dac5_t *ctx, dac5_cfg_t *cfg );
247 
257 void dac5_generic_write ( dac5_t *ctx, uint8_t reg, uint16_t data_buf );
258 
269 uint16_t dac5_generic_read ( dac5_t *ctx, uint8_t reg );
270 
279 void dac5_config ( dac5_t *ctx, uint16_t config_data );
280 
290 uint16_t dac5_get_device_id ( dac5_t *ctx );
291 
299 void dac5_software_reset ( dac5_t *ctx );
300 
308 void dac5_clear ( dac5_t *ctx );
309 
320 uint8_t dac5_set_ldac_pin ( dac5_t *ctx, uint8_t status );
321 
335 uint8_t dac5_send_data ( dac5_t *ctx, uint8_t data_reg, uint16_t data_buf );
336 
337 #ifdef __cplusplus
338 }
339 #endif
340 #endif // _DAC5_H_
341  // End public_function group
344 
345 // ------------------------------------------------------------------------- END
dac5_generic_read
uint16_t dac5_generic_read(dac5_t *ctx, uint8_t reg)
Generic read function.
dac5_cfg_t
Click configuration structure definition.
Definition: dac5.h:196
dac5_cfg_t::scl
pin_name_t scl
Definition: dac5.h:200
dac5_t
Click ctx object definition.
Definition: dac5.h:175
dac5_cfg_setup
void dac5_cfg_setup(dac5_cfg_t *cfg)
Config Object Initialization function.
dac5_t::slave_address
uint8_t slave_address
Definition: dac5.h:188
dac5_software_reset
void dac5_software_reset(dac5_t *ctx)
Function for software reset.
dac5_set_ldac_pin
uint8_t dac5_set_ldac_pin(dac5_t *ctx, uint8_t status)
Function for setting LDAC pin status.
dac5_cfg_t::lda
pin_name_t lda
Definition: dac5.h:206
dac5_send_data
uint8_t dac5_send_data(dac5_t *ctx, uint8_t data_reg, uint16_t data_buf)
Function for sending data to one output.
dac5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dac5.h:210
dac5_generic_write
void dac5_generic_write(dac5_t *ctx, uint8_t reg, uint16_t data_buf)
Generic write function.
dac5_t::rst
digital_out_t rst
Definition: dac5.h:179
dac5_init
DAC5_RETVAL dac5_init(dac5_t *ctx, dac5_cfg_t *cfg)
Initialization function.
dac5_cfg_t::i2c_address
uint8_t i2c_address
Definition: dac5.h:211
dac5_t::lda
digital_out_t lda
Definition: dac5.h:180
DAC5_RETVAL
#define DAC5_RETVAL
Definition: dac5.h:62
dac5_cfg_t::rst
pin_name_t rst
Definition: dac5.h:205
dac5_cfg_t::sda
pin_name_t sda
Definition: dac5.h:201
dac5_get_device_id
uint16_t dac5_get_device_id(dac5_t *ctx)
Function for reading device id.
dac5_t::i2c
i2c_master_t i2c
Definition: dac5.h:184
dac5_clear
void dac5_clear(dac5_t *ctx)
Function for clearing sent data.
dac5_config
void dac5_config(dac5_t *ctx, uint16_t config_data)
Function for configurating click.
dac5_t::vref
uint16_t vref
Definition: dac5.h:189