dac4  2.0.0.0
dac4.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 DAC4_H
36 #define DAC4_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define DAC4_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.lda = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
56  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define DAC4_RETVAL uint8_t
64 
65 #define DAC4_OK 0x00
66 #define DAC4_INIT_ERROR 0xFF
67 
69 #define DAC4_DEVICE_ADDRESS 0x60
70 
75 #define DAC4_CHANNEL_A 0
76 #define DAC4_CHANNEL_B 1
77 #define DAC4_CHANNEL_C 2
78 #define DAC4_CHANNEL_D 3
79 
85 #define DAC4_UPDATE 0
86 #define DAC4_DONT_UPDATE 1
87 
93 #define DAC4_VREF_EXTERNAL 0
94 #define DAC4_VREF_INTERNAL 1
95 
101 #define DAC4_MODE_NORMAL 0
102 #define DAC4_MODE_1kOhm 1
103 #define DAC4_MODE_100kOhm 2
104 #define DAC4_MODE_500kOhm 3
105 
111 #define DAC4_GAIN_x1 0
112 #define DAC4_GAIN_x2 1
113  // End group macro
116 // --------------------------------------------------------------- PUBLIC TYPES
122 typedef struct
123 {
124  uint8_t rdy_bit;
125  uint8_t por_bit;
126  uint8_t channel_select;
127  uint8_t udac_bit;
129  uint8_t power_mode;
130  uint8_t gain_value;
131  uint16_t dac_input_data;
132 
134 
135 typedef struct
136 {
141 
143 
144 typedef struct
145 {
146  uint8_t channel_a;
147  uint8_t channel_b;
148  uint8_t channel_c;
149  uint8_t channel_d;
150 
152 
153 typedef struct
154 {
155  uint8_t channel_a;
156  uint8_t channel_b;
157  uint8_t channel_c;
158  uint8_t channel_d;
159 
161 
162 typedef struct
163 {
164  uint8_t channel_a;
165  uint8_t channel_b;
166  uint8_t channel_c;
167  uint8_t channel_d;
168 
170 
174 typedef struct
175 {
176  // Output pins
177 
178  digital_out_t lda;
179 
180  // Input pins
181 
182  digital_in_t rdy;
183 
184  // Modules
185 
186  i2c_master_t i2c;
187 
188  // ctx variable
189 
190  uint8_t slave_address;
191 
192 } dac4_t;
193 
197 typedef struct
198 {
199  // Communication gpio pins
200 
201  pin_name_t scl;
202  pin_name_t sda;
203 
204  // Additional gpio pins
205 
206  pin_name_t lda;
207  pin_name_t rdy;
208 
209  // static variable
210 
211  uint32_t i2c_speed;
212  uint8_t i2c_address;
213 
214 } dac4_cfg_t;
215  // End types group
217 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
218 
224 #ifdef __cplusplus
225 extern "C"{
226 #endif
227 
237 
247 
255 void dac4_default_cfg ( dac4_t *ctx );
256 
267 void dac4_generic_write ( dac4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
268 
279 void dac4_generic_read ( dac4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
280 
291 uint8_t dac4_int_get ( dac4_t *ctx );
292 
301 void dac4_pwm_set ( dac4_t *ctx, uint8_t pin_state );
302 
312 void dac4_i2c_get ( dac4_t *ctx, uint8_t *get_buffer, uint16_t n_bytes );
313 
323 void dac4_i2c_set ( dac4_t *ctx, uint8_t *set_buffer, uint16_t n_bytes );
324 
336 
348 
360 
381 uint8_t dac4_fast_write ( dac4_t *ctx, dac4_channel_t *channels );
403 uint8_t dac4_multi_write ( dac4_t *ctx, dac4_channel_setting_t *channel_buffer, uint8_t n_channels );
404 
426 uint8_t dac4_sequential_write ( dac4_t *ctx, uint8_t starting_channel, dac4_channel_setting_t *channel_buffer );
427 
448 uint8_t dac4_single_write ( dac4_t *ctx, dac4_channel_setting_t *channel_x );
449 
465 
481 
496 uint8_t dac4_gain_set ( dac4_t *ctx, dac4_gain_channels_t *gain );
497 
516 uint8_t dac4_data_report ( dac4_t *ctx, dac4_channel_setting_t *channel_buffer );
517 
518 
519 #ifdef __cplusplus
520 }
521 #endif
522 #endif // _DAC4_H_
523  // End public_function group
526 
527 // ------------------------------------------------------------------------- END
dac4_int_get
uint8_t dac4_int_get(dac4_t *ctx)
Getting INT pin state.
dac4_channel_setting_t::gain_value
uint8_t gain_value
Definition: dac4.h:130
dac4_channel_t::channel_c
dac4_channel_setting_t channel_c
Definition: dac4.h:139
dac4_pm_channels_t::channel_c
uint8_t channel_c
Definition: dac4.h:157
dac4_generic_read
void dac4_generic_read(dac4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
dac4_channel_t
Definition: dac4.h:136
dac4_cfg_t
Click configuration structure definition.
Definition: dac4.h:198
dac4_default_cfg
void dac4_default_cfg(dac4_t *ctx)
Click Default Configuration function.
dac4_voltage_reference_set
uint8_t dac4_voltage_reference_set(dac4_t *ctx, dac4_v_ref_channels_t *vref)
Setting channel voltage reference values.
dac4_pm_channels_t::channel_d
uint8_t channel_d
Definition: dac4.h:158
dac4_general_call_wake_up
uint8_t dac4_general_call_wake_up(dac4_t *ctx)
Executing wake up command.
dac4_gain_channels_t::channel_c
uint8_t channel_c
Definition: dac4.h:166
dac4_channel_t::channel_a
dac4_channel_setting_t channel_a
Definition: dac4.h:137
dac4_pm_channels_t::channel_b
uint8_t channel_b
Definition: dac4.h:156
dac4_t
Click ctx object definition.
Definition: dac4.h:175
dac4_t::lda
digital_out_t lda
Definition: dac4.h:178
dac4_pm_channels_t
Definition: dac4.h:154
dac4_general_call_reset
uint8_t dac4_general_call_reset(dac4_t *ctx)
Executing reset command.
dac4_power_mode_set
uint8_t dac4_power_mode_set(dac4_t *ctx, dac4_pm_channels_t *pm)
Setting channel power modes.
dac4_channel_t::channel_d
dac4_channel_setting_t channel_d
Definition: dac4.h:140
dac4_channel_setting_t::power_mode
uint8_t power_mode
Definition: dac4.h:129
dac4_gain_channels_t::channel_b
uint8_t channel_b
Definition: dac4.h:165
dac4_generic_write
void dac4_generic_write(dac4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
dac4_channel_t::channel_b
dac4_channel_setting_t channel_b
Definition: dac4.h:138
dac4_channel_setting_t::voltage_reference
uint8_t voltage_reference
Definition: dac4.h:128
dac4_channel_setting_t::rdy_bit
uint8_t rdy_bit
Definition: dac4.h:124
dac4_v_ref_channels_t::channel_b
uint8_t channel_b
Definition: dac4.h:147
dac4_t::i2c
i2c_master_t i2c
Definition: dac4.h:186
dac4_multi_write
uint8_t dac4_multi_write(dac4_t *ctx, dac4_channel_setting_t *channel_buffer, uint8_t n_channels)
Executing multi-write command.
dac4_channel_setting_t::por_bit
uint8_t por_bit
Definition: dac4.h:125
dac4_cfg_t::lda
pin_name_t lda
Definition: dac4.h:206
dac4_fast_write
uint8_t dac4_fast_write(dac4_t *ctx, dac4_channel_t *channels)
Executing fast write command.
dac4_gain_set
uint8_t dac4_gain_set(dac4_t *ctx, dac4_gain_channels_t *gain)
Writing channel gain values.
dac4_i2c_set
void dac4_i2c_set(dac4_t *ctx, uint8_t *set_buffer, uint16_t n_bytes)
Setting data via I2C.
dac4_cfg_t::i2c_address
uint8_t i2c_address
Definition: dac4.h:212
DAC4_RETVAL
#define DAC4_RETVAL
Definition: dac4.h:63
dac4_general_call_software_update
uint8_t dac4_general_call_software_update(dac4_t *ctx)
Executing software update command.
dac4_cfg_t::scl
pin_name_t scl
Definition: dac4.h:201
dac4_v_ref_channels_t::channel_d
uint8_t channel_d
Definition: dac4.h:149
dac4_t::slave_address
uint8_t slave_address
Definition: dac4.h:190
dac4_channel_setting_t::dac_input_data
uint16_t dac_input_data
Definition: dac4.h:131
dac4_i2c_get
void dac4_i2c_get(dac4_t *ctx, uint8_t *get_buffer, uint16_t n_bytes)
Getting data via I2C.
dac4_v_ref_channels_t
Definition: dac4.h:145
dac4_gain_channels_t::channel_d
uint8_t channel_d
Definition: dac4.h:167
dac4_t::rdy
digital_in_t rdy
Definition: dac4.h:182
dac4_cfg_setup
void dac4_cfg_setup(dac4_cfg_t *cfg)
Config Object Initialization function.
dac4_gain_channels_t
Definition: dac4.h:163
dac4_pwm_set
void dac4_pwm_set(dac4_t *ctx, uint8_t pin_state)
Setting PWM pin state.
dac4_v_ref_channels_t::channel_c
uint8_t channel_c
Definition: dac4.h:148
dac4_gain_channels_t::channel_a
uint8_t channel_a
Definition: dac4.h:164
dac4_cfg_t::sda
pin_name_t sda
Definition: dac4.h:202
dac4_data_report
uint8_t dac4_data_report(dac4_t *ctx, dac4_channel_setting_t *channel_buffer)
dac4_channel_setting_t::channel_select
uint8_t channel_select
Definition: dac4.h:126
dac4_channel_setting_t::udac_bit
uint8_t udac_bit
Definition: dac4.h:127
dac4_sequential_write
uint8_t dac4_sequential_write(dac4_t *ctx, uint8_t starting_channel, dac4_channel_setting_t *channel_buffer)
Executing sequential write command.
dac4_init
DAC4_RETVAL dac4_init(dac4_t *ctx, dac4_cfg_t *cfg)
Initialization function.
dac4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dac4.h:211
dac4_v_ref_channels_t::channel_a
uint8_t channel_a
Definition: dac4.h:146
dac4_cfg_t::rdy
pin_name_t rdy
Definition: dac4.h:207
dac4_single_write
uint8_t dac4_single_write(dac4_t *ctx, dac4_channel_setting_t *channel_x)
Executing single write command.
dac4_pm_channels_t::channel_a
uint8_t channel_a
Definition: dac4.h:155
dac4_channel_setting_t
Definition: dac4.h:123