adc18  2.0.0.0
adc18.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 ADC18_H
29 #define ADC18_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_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define ADC18_REG_GEN_PROD 0x00
61 #define ADC18_REG_GEN_REV 0x01
62 #define ADC18_REG_GEN_CNFG 0x02
63 #define ADC18_REG_GEN_CHNL_CTRL 0x03
64 #define ADC18_REG_GEN_GPIO_CTRL 0x04
65 #define ADC18_REG_GEN_GPI_INT 0x05
66 #define ADC18_REG_GEN_GPI_DATA 0x06
67 #define ADC18_REG_GEN_INT 0x07
68 #define ADC18_REG_GEN_INTEN 0x08
69 #define ADC18_REG_GEN_PWR_CTRL 0x09
70 #define ADC18_REG_DCHNL_CMD 0x20
71 #define ADC18_REG_DCHNL_STA 0x21
72 #define ADC18_REG_DCHNL_CTRL1 0x22
73 #define ADC18_REG_DCHNL_CTRL2 0x23
74 #define ADC18_REG_DCHNL_DATA 0x24
75 #define ADC18_REG_DCHNL_N_SEL 0x25
76 #define ADC18_REG_DCHNL_N_SOC 0x26
77 #define ADC18_REG_DCHNL_N_SGC 0x27
78  // adc18_reg
80 
95 #define ADC18_PRODUCT_ID 0x18
96 
101 #define ADC18_GEN_CNFG_CRC_EN 0x800000ul
102 
107 #define ADC18_DATA_RESOLUTION 0x7FFFFFul
108 #define ADC18_FULL_SCALE_VOLTAGE 12.5
109 
114 #define ADC18_START_CONVERSION 0x30
115 #define ADC18_STOP_CONVERSION 0x10
116 #define ADC18_DATA_RATE_5_SPS 0x00
117 #define ADC18_DATA_RATE_10_SPS 0x01
118 #define ADC18_DATA_RATE_15_SPS 0x02
119 #define ADC18_DATA_RATE_30_SPS 0x03
120 #define ADC18_DATA_RATE_50_SPS 0x04
121 #define ADC18_DATA_RATE_60_SPS 0x05
122 #define ADC18_DATA_RATE_225_SPS 0x06
123 #define ADC18_DATA_RATE_450_SPS 0x07
124 #define ADC18_DATA_RATE_900_SPS 0x08
125 #define ADC18_DATA_RATE_1800_SPS 0x09
126 #define ADC18_DATA_RATE_3600_SPS 0x0A
127 #define ADC18_DATA_RATE_7200_SPS 0x0B
128 #define ADC18_DATA_RATE_14400_SPS 0x0C
129 #define ADC18_DATA_RATE_28800_SPS 0x0D
130 #define ADC18_DATA_RATE_57600_SPS 0x0E
131 #define ADC18_DATA_RATE_115200_SPS 0x0F
132 
137 #define ADC18_PD_STATE_STANDBY 0x00
138 #define ADC18_PD_STATE_RESET 0x10
139 #define ADC18_CONV_MODE_CONTINUOUS 0x00
140 #define ADC18_CONV_MODE_SINGLE_CYCLE 0x02
141 #define ADC18_CONV_MODE_CONT_SINGLE_CYCLE 0x03
142 
147 #define ADC18_CH_AI1_SINGLE_ENDED 0x00
148 #define ADC18_CH_AI2_SINGLE_ENDED 0x01
149 #define ADC18_CH_AI3_SINGLE_ENDED 0x02
150 #define ADC18_CH_AI4_SINGLE_ENDED 0x03
151 #define ADC18_CH_AI5_SINGLE_ENDED 0x04
152 #define ADC18_CH_AI6_SINGLE_ENDED 0x05
153 #define ADC18_CH_AI7_SINGLE_ENDED 0x06
154 #define ADC18_CH_AI8_SINGLE_ENDED 0x07
155 #define ADC18_CH_AI9_SINGLE_ENDED 0x08
156 #define ADC18_CH_AI10_SINGLE_ENDED 0x09
157 #define ADC18_CH_AI11_SINGLE_ENDED 0x0A
158 #define ADC18_CH_AI12_SINGLE_ENDED 0x0B
159 #define ADC18_CH_AI1_AI2_DIFFERENTIAL 0x0C
160 #define ADC18_CH_AI3_AI4_DIFFERENTIAL 0x0D
161 #define ADC18_CH_AI5_AI6_DIFFERENTIAL 0x0E
162 #define ADC18_CH_AI7_AI8_DIFFERENTIAL 0x0F
163 #define ADC18_CH_AI9_AI10_DIFFERENTIAL 0x10
164 #define ADC18_CH_AI11_AI12_DIFFERENTIAL 0x11
165 #define ADC18_CH_AI1_COM_AI2_MULTI_DIFF 0x12
166 #define ADC18_CH_AI1_COM_AI3_MULTI_DIFF 0x13
167 #define ADC18_CH_AI4_COM_AI5_MULTI_DIFF 0x14
168 #define ADC18_CH_AI4_COM_AI6_MULTI_DIFF 0x15
169 #define ADC18_CH_AI7_COM_AI8_MULTI_DIFF 0x16
170 #define ADC18_CH_AI7_COM_AI9_MULTI_DIFF 0x17
171 #define ADC18_CH_AI10_COM_AI11_MULTI_DIFF 0x18
172 #define ADC18_CH_AI10_COM_AI12_MULTI_DIFF 0x19
173 #define ADC18_AIP_TEST_DISABLED 0x00
174 #define ADC18_AIP_TEST_2MOHM_TO_AGND 0x40
175 #define ADC18_AIP_TEST_2MOHM_TO_HVDD 0x80
176 #define ADC18_AIP_TEST_2MOHM_TO_HVDD_AGND 0xC0
177 #define ADC18_AIN_TEST_DISABLED 0x00
178 #define ADC18_AIN_TEST_2MOHM_TO_AGND 0x10
179 #define ADC18_AIN_TEST_2MOHM_TO_HVDD 0x20
180 #define ADC18_AIN_TEST_2MOHM_TO_HVDD_AGND 0x30
181 
190 #define ADC18_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
191 #define ADC18_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
192  // adc18_set
194 
209 #define ADC18_MAP_MIKROBUS( cfg, mikrobus ) \
210  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
211  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
212  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
213  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
214  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_AN ); \
215  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
216  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
217  // adc18_map // adc18
220 
225 typedef struct
226 {
227  // Output pins
228  digital_out_t rst;
230  // Input pins
231  digital_in_t rdy;
232  digital_in_t int_pin;
234  // Modules
235  spi_master_t spi;
237  pin_name_t chip_select;
241 } adc18_t;
242 
247 typedef struct
248 {
249  // Communication gpio pins
250  pin_name_t miso;
251  pin_name_t mosi;
252  pin_name_t sck;
253  pin_name_t cs;
255  // Additional gpio pins
256  pin_name_t rst;
257  pin_name_t rdy;
258  pin_name_t int_pin;
260  // static variable
261  uint32_t spi_speed;
262  spi_master_mode_t spi_mode;
263  spi_master_chip_select_polarity_t cs_polarity;
265 } adc18_cfg_t;
266 
271 typedef enum
272 {
273  ADC18_OK = 0,
274  ADC18_ERROR = -1
275 
277 
294 
308 err_t adc18_init ( adc18_t *ctx, adc18_cfg_t *cfg );
309 
322 err_t adc18_default_cfg ( adc18_t *ctx );
323 
337 err_t adc18_write_register ( adc18_t *ctx, uint8_t reg, uint32_t data_in );
338 
352 err_t adc18_read_register ( adc18_t *ctx, uint8_t reg, uint32_t *data_out );
353 
364 
375 
386 
396 
405 uint8_t adc18_get_rdy_pin ( adc18_t *ctx );
406 
415 uint8_t adc18_get_int_pin ( adc18_t *ctx );
416 
427 err_t adc18_start_conversion ( adc18_t *ctx, uint8_t data_rate );
428 
439 
453 err_t adc18_set_conversion_mode ( adc18_t *ctx, uint8_t mode );
454 
465 err_t adc18_set_active_channel ( adc18_t *ctx, uint8_t channel );
466 
477 err_t adc18_read_raw_adc ( adc18_t *ctx, int32_t *raw_adc );
478 
489 err_t adc18_read_voltage ( adc18_t *ctx, float *voltage );
490 
491 #ifdef __cplusplus
492 }
493 #endif
494 #endif // ADC18_H
495  // adc18
497 
498 // ------------------------------------------------------------------------ END
adc18_get_int_pin
uint8_t adc18_get_int_pin(adc18_t *ctx)
ADC 18 get int pin function.
adc18_return_value_t
adc18_return_value_t
ADC 18 Click return value data.
Definition: adc18.h:272
adc18_t::rst
digital_out_t rst
Definition: adc18.h:228
adc18_write_register
err_t adc18_write_register(adc18_t *ctx, uint8_t reg, uint32_t data_in)
ADC 18 write register function.
adc18_cfg_t::mosi
pin_name_t mosi
Definition: adc18.h:251
spi_specifics.h
This file contains SPI specific macros, functions, etc.
adc18_read_register
err_t adc18_read_register(adc18_t *ctx, uint8_t reg, uint32_t *data_out)
ADC 18 read register function.
adc18_init
err_t adc18_init(adc18_t *ctx, adc18_cfg_t *cfg)
ADC 18 initialization function.
adc18_t::chip_select
pin_name_t chip_select
Definition: adc18.h:237
adc18_cfg_t::int_pin
pin_name_t int_pin
Definition: adc18.h:258
adc18_reset_device
void adc18_reset_device(adc18_t *ctx)
ADC 18 reset device function.
adc18_t::rdy
digital_in_t rdy
Definition: adc18.h:231
adc18_set_active_channel
err_t adc18_set_active_channel(adc18_t *ctx, uint8_t channel)
ADC 18 set active channel function.
adc18_cfg_t::sck
pin_name_t sck
Definition: adc18.h:252
adc18_cfg_setup
void adc18_cfg_setup(adc18_cfg_t *cfg)
ADC 18 configuration object setup function.
adc18_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: adc18.h:263
adc18_t::spi_crc_enable
bool spi_crc_enable
Definition: adc18.h:239
adc18_cfg_t
ADC 18 Click configuration object.
Definition: adc18.h:248
adc18_stop_conversion
err_t adc18_stop_conversion(adc18_t *ctx)
ADC 18 stop conversion function.
adc18_t::int_pin
digital_in_t int_pin
Definition: adc18.h:232
adc18_cfg_t::rdy
pin_name_t rdy
Definition: adc18.h:257
adc18_read_voltage
err_t adc18_read_voltage(adc18_t *ctx, float *voltage)
ADC 18 read voltage function.
adc18_cfg_t::rst
pin_name_t rst
Definition: adc18.h:256
adc18_cfg_t::cs
pin_name_t cs
Definition: adc18.h:253
adc18_disable_spi_crc
err_t adc18_disable_spi_crc(adc18_t *ctx)
ADC 18 disable spi crc function.
adc18_read_raw_adc
err_t adc18_read_raw_adc(adc18_t *ctx, int32_t *raw_adc)
ADC 18 read raw adc function.
adc18_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: adc18.h:262
adc18_check_communication
err_t adc18_check_communication(adc18_t *ctx)
ADC 18 check communication function.
adc18_t
ADC 18 Click context object.
Definition: adc18.h:226
adc18_start_conversion
err_t adc18_start_conversion(adc18_t *ctx, uint8_t data_rate)
ADC 18 start conversion function.
adc18_cfg_t::miso
pin_name_t miso
Definition: adc18.h:250
adc18_enable_spi_crc
err_t adc18_enable_spi_crc(adc18_t *ctx)
ADC 18 enable spi crc function.
ADC18_ERROR
@ ADC18_ERROR
Definition: adc18.h:274
adc18_set_conversion_mode
err_t adc18_set_conversion_mode(adc18_t *ctx, uint8_t mode)
ADC 18 set conversion mode function.
adc18_get_rdy_pin
uint8_t adc18_get_rdy_pin(adc18_t *ctx)
ADC 18 get rdy pin function.
adc18_t::spi
spi_master_t spi
Definition: adc18.h:235
adc18_cfg_t::spi_speed
uint32_t spi_speed
Definition: adc18.h:261
adc18_default_cfg
err_t adc18_default_cfg(adc18_t *ctx)
ADC 18 default configuration function.
ADC18_OK
@ ADC18_OK
Definition: adc18.h:273