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 "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 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define DAC4_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.lda = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
66  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
67 
73 #define DAC4_OK 0
74 #define DAC4_ERROR -1
75 
77 #define DAC4_DEVICE_ADDRESS 0x60
78 
83 #define DAC4_CHANNEL_A 0
84 #define DAC4_CHANNEL_B 1
85 #define DAC4_CHANNEL_C 2
86 #define DAC4_CHANNEL_D 3
87 
93 #define DAC4_UPDATE 0
94 #define DAC4_DONT_UPDATE 1
95 
101 #define DAC4_VREF_EXTERNAL 0
102 #define DAC4_VREF_INTERNAL 1
103 
109 #define DAC4_MODE_NORMAL 0
110 #define DAC4_MODE_1kOhm 1
111 #define DAC4_MODE_100kOhm 2
112 #define DAC4_MODE_500kOhm 3
113 
119 #define DAC4_GAIN_x1 0
120 #define DAC4_GAIN_x2 1
121  // End group macro
124 // --------------------------------------------------------------- PUBLIC TYPES
130 typedef struct
131 {
132  uint8_t rdy_bit;
133  uint8_t por_bit;
134  uint8_t channel_select;
135  uint8_t udac_bit;
137  uint8_t power_mode;
138  uint8_t gain_value;
139  uint16_t dac_input_data;
140 
142 
143 typedef struct
144 {
149 
151 
152 typedef struct
153 {
154  uint8_t channel_a;
155  uint8_t channel_b;
156  uint8_t channel_c;
157  uint8_t channel_d;
158 
160 
161 typedef struct
162 {
163  uint8_t channel_a;
164  uint8_t channel_b;
165  uint8_t channel_c;
166  uint8_t channel_d;
167 
169 
170 typedef struct
171 {
172  uint8_t channel_a;
173  uint8_t channel_b;
174  uint8_t channel_c;
175  uint8_t channel_d;
176 
178 
182 typedef struct
183 {
184  // Output pins
185 
186  digital_out_t lda;
187 
188  // Input pins
189 
190  digital_in_t rdy;
191 
192  // Modules
193 
194  i2c_master_t i2c;
195 
196  // ctx variable
197 
198  uint8_t slave_address;
199 
200 } dac4_t;
201 
205 typedef struct
206 {
207  // Communication gpio pins
208 
209  pin_name_t scl;
210  pin_name_t sda;
211 
212  // Additional gpio pins
213 
214  pin_name_t lda;
215  pin_name_t rdy;
216 
217  // static variable
218 
219  uint32_t i2c_speed;
220  uint8_t i2c_address;
221 
222 } dac4_cfg_t;
223  // End types group
225 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
226 
232 #ifdef __cplusplus
233 extern "C"{
234 #endif
235 
245 
254 err_t dac4_init ( dac4_t *ctx, dac4_cfg_t *cfg );
255 
265 void dac4_generic_write ( dac4_t *ctx, uint8_t *data_buf, uint8_t len );
266 
276 void dac4_generic_read ( dac4_t *ctx, uint8_t *data_buf, uint8_t len );
277 
288 uint8_t dac4_int_get ( dac4_t *ctx );
289 
298 void dac4_pwm_set ( dac4_t *ctx, uint8_t pin_state );
299 
309 void dac4_i2c_get ( dac4_t *ctx, uint8_t *get_buffer, uint16_t n_bytes );
310 
320 void dac4_i2c_set ( dac4_t *ctx, uint8_t *set_buffer, uint16_t n_bytes );
321 
333 
345 
357 
378 uint8_t dac4_fast_write ( dac4_t *ctx, dac4_channel_t *channels );
400 uint8_t dac4_multi_write ( dac4_t *ctx, dac4_channel_setting_t *channel_buffer, uint8_t n_channels );
401 
423 uint8_t dac4_sequential_write ( dac4_t *ctx, uint8_t starting_channel, dac4_channel_setting_t *channel_buffer );
424 
445 uint8_t dac4_single_write ( dac4_t *ctx, dac4_channel_setting_t *channel_x );
446 
462 
478 
493 uint8_t dac4_gain_set ( dac4_t *ctx, dac4_gain_channels_t *gain );
494 
513 uint8_t dac4_data_report ( dac4_t *ctx, dac4_channel_setting_t *channel_buffer );
514 
515 
516 #ifdef __cplusplus
517 }
518 #endif
519 #endif // _DAC4_H_
520  // End public_function group
523 
524 // ------------------------------------------------------------------------- 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:138
dac4_channel_t::channel_c
dac4_channel_setting_t channel_c
Definition: dac4.h:147
dac4_pm_channels_t::channel_c
uint8_t channel_c
Definition: dac4.h:165
dac4_channel_t
Definition: dac4.h:144
dac4_cfg_t
Click configuration structure definition.
Definition: dac4.h:206
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:166
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:174
dac4_channel_t::channel_a
dac4_channel_setting_t channel_a
Definition: dac4.h:145
dac4_pm_channels_t::channel_b
uint8_t channel_b
Definition: dac4.h:164
dac4_t
Click ctx object definition.
Definition: dac4.h:183
dac4_generic_read
void dac4_generic_read(dac4_t *ctx, uint8_t *data_buf, uint8_t len)
Generic read function.
dac4_t::lda
digital_out_t lda
Definition: dac4.h:186
dac4_pm_channels_t
Definition: dac4.h:162
dac4_general_call_reset
uint8_t dac4_general_call_reset(dac4_t *ctx)
Executing reset command.
dac4_generic_write
void dac4_generic_write(dac4_t *ctx, uint8_t *data_buf, uint8_t len)
Generic write function.
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:148
dac4_channel_setting_t::power_mode
uint8_t power_mode
Definition: dac4.h:137
dac4_gain_channels_t::channel_b
uint8_t channel_b
Definition: dac4.h:173
dac4_channel_t::channel_b
dac4_channel_setting_t channel_b
Definition: dac4.h:146
dac4_channel_setting_t::voltage_reference
uint8_t voltage_reference
Definition: dac4.h:136
dac4_channel_setting_t::rdy_bit
uint8_t rdy_bit
Definition: dac4.h:132
dac4_v_ref_channels_t::channel_b
uint8_t channel_b
Definition: dac4.h:155
dac4_t::i2c
i2c_master_t i2c
Definition: dac4.h:194
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:133
dac4_cfg_t::lda
pin_name_t lda
Definition: dac4.h:214
dac4_init
err_t dac4_init(dac4_t *ctx, dac4_cfg_t *cfg)
Initialization function.
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:220
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:209
dac4_v_ref_channels_t::channel_d
uint8_t channel_d
Definition: dac4.h:157
dac4_t::slave_address
uint8_t slave_address
Definition: dac4.h:198
dac4_channel_setting_t::dac_input_data
uint16_t dac_input_data
Definition: dac4.h:139
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:153
dac4_gain_channels_t::channel_d
uint8_t channel_d
Definition: dac4.h:175
dac4_t::rdy
digital_in_t rdy
Definition: dac4.h:190
dac4_cfg_setup
void dac4_cfg_setup(dac4_cfg_t *cfg)
Config Object Initialization function.
dac4_gain_channels_t
Definition: dac4.h:171
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:156
dac4_gain_channels_t::channel_a
uint8_t channel_a
Definition: dac4.h:172
dac4_cfg_t::sda
pin_name_t sda
Definition: dac4.h:210
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:134
dac4_channel_setting_t::udac_bit
uint8_t udac_bit
Definition: dac4.h:135
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_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dac4.h:219
dac4_v_ref_channels_t::channel_a
uint8_t channel_a
Definition: dac4.h:154
dac4_cfg_t::rdy
pin_name_t rdy
Definition: dac4.h:215
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:163
dac4_channel_setting_t
Definition: dac4.h:131