adswio  2.0.0.0
adswio.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 ADSWIO_H
36 #define ADSWIO_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_spi_master.h"
51 #include "spi_specifics.h"
52 
53 
54 // -------------------------------------------------------------- PUBLIC MACROS
65 #define ADSWIO_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
67  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
68  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
69  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
70  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.alt = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
72  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
73 
79 #define adswio_obj_t const uint8_t*
80 
86 #define adswio_err_t uint8_t
87 
93 #define ADSWIO_RETVAL uint8_t
94 
95 #define ADSWIO_OK 0x00
96 #define ADSWIO_INIT_ERROR 0xFF
97 
103 #define ADSWIO_FRAME_LENGTH 4
104 #define ADSWIO_MASK_RD_FRAME_RESERVED_BIT 0x80
105 #define ADSWIO_MASK_RD_FRAME_REG_ADDR 0x7F
106 #define ADSWIO_MASK_RD_FRAME_STATUS 0x7F
107 
113 #define ADSWIO_RD_RET_INFO 0x1
114 
120 #define ADSWIO_OFFSET_REG_CONV_RES 0x25
121 #define ADSWIO_OFFSET_REG_DIAG_RES 0x29
122 
128 #define DUMMY 0
129 #define ADSWIO_NULL 0
130 
136 #define ADSWIO_RD_AUTO_EN 0x2
137 #define ADSWIO_RD_AUTO_DIS 0x0
138 
149 #define ADSWIO_MASK_CONV_EN 0xF
150 #define ADSWIO_OFFSET_CONV_EN_CH 0
151 #define ADSWIO_OFFSET_CONV_EN_DIAG 4
152 
158 #define ADSWIO_MASK_DIAG_ASSIGN 0xF
159 #define ADSWIO_OFFSET_ASSIGN_DIAG0 0
160 #define ADSWIO_OFFSET_ASSIGN_DIAG1 4
161 #define ADSWIO_OFFSET_ASSIGN_DIAG2 8
162 #define ADSWIO_OFFSET_ASSIGN_DIAG3 12
163 
169 #define ADSWIO_MASK_CONV_MODE 0x300
170 #define ADSWIO_OFFSET_CONV_MODE 8
171 
177 #define ADSWIO_MASK_DAC_CODE 0x1FFF
178 
184 #define ADSWIO_MASK_ALERT 0x7FFF
185 
191 #define ADSWIO_MASK_DIN_THRESH_COMP 0x3E
192 
198 #define ADSWIO_MASK_STATUS_ALRT_CAL_MEM_ERR 0x4000
199 #define ADSWIO_MASK_STATUS_ALRT_SPI_CRC_ERR 0x2000
200 #define ADSWIO_MASK_STATUS_ALRT_RST 0x8000
201 #define ADSWIO_MASK_STATUS_ALRT_SPI_SCLK_CNT_ERR 0x1000
202 #define ADSWIO_MASK_STATUS_ALRT_ADC_SAT_ERR 0x800
203 #define ADSWIO_MASK_STATUS_ALRT_ADC_CONV_ERR 0x400
204 #define ADSWIO_MASK_STATUS_ALRT_ALDO1V8_ERR 0x200
205 #define ADSWIO_MASK_STATUS_ALRT_DVCC_ERR 0x100
206 #define ADSWIO_MASK_STATUS_ALRT_AVDD_ERR 0x80
207 #define ADSWIO_MASK_STATUS_ALRT_ALDO5V_ERR 0x40
208 #define ADSWIO_MASK_STATUS_ALRT_CHARGE_PUMP_ERR 0x20
209 #define ADSWIO_MASK_STATUS_ALRT_HI_TEMP_ERR 0x10
210 #define ADSWIO_MASK_STATUS_ALRT_VI_ERR_D 0x8
211 #define ADSWIO_MASK_STATUS_ALRT_VI_ERR_C 0x4
212 #define ADSWIO_MASK_STATUS_ALRT_VI_ERR_B 0x2
213 #define ADSWIO_MASK_STATUS_ALRT_VI_ERR_A 0x1
214 
220 #define ADSWIO_MASK_STATUS_LIVE_ADC_DRDY 0x4000
221 #define ADSWIO_MASK_STATUS_LIVE_ADC_BUSY 0x2000
222 #define ADSWIO_MASK_STATUS_LIVE_ADC_CURR_CH 0x1C00
223 #define ADSWIO_MASK_STATUS_LIVE_ALDO1V8 0x200
224 #define ADSWIO_MASK_STATUS_LIVE_DVCC 0x100
225 #define ADSWIO_MASK_STATUS_LIVE_AVDD 0x80
226 #define ADSWIO_MASK_STATUS_LIVE_ALDO5V 0x40
227 #define ADSWIO_MASK_STATUS_LIVE_CHARGE_PUMP 0x20
228 #define ADSWIO_MASK_STATUS_LIVE_HI_TEMP 0x10
229 #define ADSWIO_MASK_STATUS_LIVE_VI_ERR_CURR_D 0x8
230 #define ADSWIO_MASK_STATUS_LIVE_VI_ERR_CURR_C 0x4
231 #define ADSWIO_MASK_STATUS_LIVE_VI_ERR_CURR_B 0x2
232 #define ADSWIO_MASK_STATUS_LIVE_VI_ERR_CURR_A 0x1
233 
239 #define ADSWIO_MAX_NWORDS 4
240 #define ADSWIO_MIN_NWORDS 1
241  // End offset_mask group
244 
249 #define ADSWIO_REG_NOP 0x0
250 #define ADSWIO_REG_FUNC_SETUP_CHA 0x1
251 #define ADSWIO_REG_FUNC_SETUP_CHB 0x2
252 #define ADSWIO_REG_FUNC_SETUP_CHC 0x3
253 #define ADSWIO_REG_FUNC_SETUP_CHD 0x4
254 #define ADSWIO_REG_CFG_ADC_CHA 0x5
255 #define ADSWIO_REG_CFG_ADC_CHB 0x6
256 #define ADSWIO_REG_CFG_ADC_CHC 0x7
257 #define ADSWIO_REG_CFG_ADC_CHD 0x8
258 #define ADSWIO_REG_CFG_DIN_CHA 0x9
259 #define ADSWIO_REG_CFG_DIN_CHB 0xA
260 #define ADSWIO_REG_CFG_DIN_CHC 0xB
261 #define ADSWIO_REG_CFG_DIN_CHD 0xC
262 #define ADSWIO_REG_GPO_PARALLEL 0xD
263 #define ADSWIO_REG_CFG_GPO_CHA 0xE
264 #define ADSWIO_REG_CFG_GPO_CHB 0xF
265 #define ADSWIO_REG_CFG_GPO_CHC 0x10
266 #define ADSWIO_REG_CFG_GPO_CHD 0x11
267 #define ADSWIO_REG_CFG_OUTPUT_CHA 0x12
268 #define ADSWIO_REG_CFG_OUTPUT_CHB 0x13
269 #define ADSWIO_REG_CFG_OUTPUT_CHC 0x14
270 #define ADSWIO_REG_CFG_OUTPUT_CHD 0x15
271 #define ADSWIO_REG_DAC_CODE_CHA 0x16
272 #define ADSWIO_REG_DAC_CODE_CHB 0x17
273 #define ADSWIO_REG_DAC_CODE_CHC 0x18
274 #define ADSWIO_REG_DAC_CODE_CHD 0x19
275 #define ADSWIO_REG_DAC_CODE_CLR_CHA 0x1A
276 #define ADSWIO_REG_DAC_CODE_CLR_CHB 0x1B
277 #define ADSWIO_REG_DAC_CODE_CLR_CHC 0x1C
278 #define ADSWIO_REG_DAC_CODE_CLR_CHD 0x1D
279 #define ADSWIO_REG_DAC_CODE_ACT_CHA 0x1E
280 #define ADSWIO_REG_DAC_CODE_ACT_CHB 0x1F
281 #define ADSWIO_REG_DAC_CODE_ACT_CHC 0x20
282 #define ADSWIO_REG_DAC_CODE_ACT_CHD 0x21
283 #define ADSWIO_REG_DIN_THRESH 0x22
284 #define ADSWIO_REG_ADC_CONV_CTRL 0x23
285 #define ADSWIO_REG_DIAG_ASSIGN 0x24
286 #define ADSWIO_REG_DIN_COMP_OUT 0x25
287 #define ADSWIO_REG_RESULT_ADC_CHA 0x26
288 #define ADSWIO_REG_RESULT_ADC_CHB 0x27
289 #define ADSWIO_REG_RESULT_ADC_CHC 0x28
290 #define ADSWIO_REG_RESULT_ADC_CHD 0x29
291 #define ADSWIO_REG_RESULT_DIAG1 0x2A
292 #define ADSWIO_REG_RESULT_DIAG2 0x2B
293 #define ADSWIO_REG_RESULT_DIAG3 0x2C
294 #define ADSWIO_REG_RESULT_DIAG4 0x2D
295 #define ADSWIO_REG_STATUS_ALERT 0x2E
296 #define ADSWIO_REG_STATUS_LIVE 0x2F
297 #define ADSWIO_REG_MASK_ALERT 0x3C
298 #define ADSWIO_REG_DIN_COUNTER_CHA 0x3D
299 #define ADSWIO_REG_DIN_COUNTER_CHB 0x3E
300 #define ADSWIO_REG_DIN_COUNTER_CHC 0x3F
301 #define ADSWIO_REG_DIN_COUNTER_CHD 0x40
302 #define ADSWIO_REG_READ_SELECT 0x41
303 #define ADSWIO_REG_THERM_RST 0x43
304 #define ADSWIO_REG_CMD_KEY 0x44
305 #define ADSWIO_REG_SCRATCH 0x45
306 #define ADSWIO_REG_SILICON_REV 0x46
307 
318 #define ADSWIO_SETUP_CONV_EN_CHD 0x8
319 #define ADSWIO_SETUP_CONV_EN_CHC 0x4
320 #define ADSWIO_SETUP_CONV_EN_CHB 0x2
321 #define ADSWIO_SETUP_CONV_EN_CHA 0x1
322 
328 #define ADSWIO_SETUP_CH_FUNC_HZ 0x0
329 #define ADSWIO_SETUP_CH_FUNC_VOLT_OUTPUT 0x1
330 #define ADSWIO_SETUP_CH_FUNC_CURR_OUTPUT 0x2
331 #define ADSWIO_SETUP_CH_FUNC_VOLT_INPUT 0x3
332 #define ADSWIO_SETUP_CH_FUNC_CURR_INPUT_PWR_EXT 0x4
333 #define ADSWIO_SETUP_CH_FUNC_CURR_INPUT_PWR_LOOP 0x5
334 #define ADSWIO_SETUP_CH_FUNC_RES_MEAS 0x6
335 #define ADSWIO_SETUP_CH_FUNC_DIG_INPUT_LOGIC 0x7
336 #define ADSWIO_SETUP_CH_FUNC_DIG_INPUT_PWR_LOOP 0x8
337 #define ADSWIO_SETUP_CH_FUNC_CURR_INPUT_PWR_EXT_HART 0x9
338 #define ADSWIO_SETUP_CH_FUNC_CURR_INPUT_PWR_LOOP_HART 0xA
339 
345 #define ADSWIO_SETUP_CONV_EN_DIAG3 0x8
346 #define ADSWIO_SETUP_CONV_EN_DIAG2 0x4
347 #define ADSWIO_SETUP_CONV_EN_DIAG1 0x2
348 #define ADSWIO_SETUP_CONV_EN_DIAG0 0x1
349 
355 #define ADSWIO_SETUP_DIAG_ASSIGN_AGND 0x0
356 #define ADSWIO_SETUP_DIAG_ASSIGN_TEMP 0x1
357 #define ADSWIO_SETUP_DIAG_ASSIGN_AVDD 0x2
358 #define ADSWIO_SETUP_DIAG_ASSIGN_VAVSS 0x3
359 #define ADSWIO_SETUP_DIAG_ASSIGN_REFOUT 0x4
360 #define ADSWIO_SETUP_DIAG_ASSIGN_ALDO5V 0x5
361 #define ADSWIO_SETUP_DIAG_ASSIGN_ALDO1V8 0x6
362 #define ADSWIO_SETUP_DIAG_ASSIGN_DLDO1V8 0x7
363 #define ADSWIO_SETUP_DIAG_ASSIGN_DVCC 0x8
364 #define ADSWIO_SETUP_DIAG_ASSIGN_IOVDD 0x9
365 #define ADSWIO_SETUP_DIAG_ASSIGN_SENSELA 0xA
366 #define ADSWIO_SETUP_DIAG_ASSIGN_SENSELB 0xB
367 #define ADSWIO_SETUP_DIAG_ASSIGN_SENSELC 0xC
368 #define ADSWIO_SETUP_DIAG_ASSIGN_SENSELD 0xD
369 #define ADSWIO_SETUP_DIAG_ASSIGN_LVIN 0xE
370 
376 #define ADSWIO_SETUP_CONV_STOP_CONT_CONV_ADC_PWR_UP 0x0
377 #define ADSWIO_SETUP_CONV_START_SING_SEQ_CONV 0x1
378 #define ADSWIO_SETUP_CONV_START_CONT_CONV 0x2
379 #define ADSWIO_SETUP_CONV_STOP_CONT_CONV_ADC_PWR_DWN 0x3
380 
386 #define ADSWIO_SETUP_ADC_RANGE_0V_TO_10V 0x0
387 #define ADSWIO_SETUP_ADC_RANGE_2500MV_PWR_EXT 0x20
388 #define ADSWIO_SETUP_ADC_RANGE_2500MV_PWR_LOOP 0x40
389 #define ADSWIO_SETUP_ADC_RANGE_2500MV_NEG_TO_2500MV_POS 0x60
390 #define ADSWIO_SETUP_ADC_RANGE_104MV_NEG_TO_104MV_POS 0x80
391 #define ADSWIO_SETUP_ADC_SAMPLE_RATE_20SPS 0x0
392 #define ADSWIO_SETUP_ADC_SAMPLE_RATE_4800SPS 0x8
393 #define ADSWIO_SETUP_ADC_SAMPLE_RATE_10SPS 0x10
394 #define ADSWIO_SETUP_ADC_SAMPLE_RATE_1200SPS 0x18
395 #define ADSWIO_SETUP_ADC_CH_200K_TO_GND 0x4
396 #define ADSWIO_SETUP_ADC_INPUT_VOLTAGE_AGND_SENSE 0x0
397 #define ADSWIO_SETUP_ADC_INPUT_VOLTAGE_100_OHM_RES 0x1
398 
404 #define ADSWIO_SETUP_DIN_COUNT_EN 0x8000
405 #define ADSWIO_SETUP_DIN_COMP_IN_FILTERED 0x4000
406 #define ADSWIO_SETUP_DIN_COMP_OUT_INV 0x2000
407 #define ADSWIO_SETUP_DIN_COMP_EN 0x1000
408 #define ADSWIO_SETUP_DIN_RANGE_0 0x0
409 #define ADSWIO_SETUP_DIN_RANGE_1 0x800
410 #define ADSWIO_SETUP_DIN_DEBOUNCE_MODE_0 0x0
411 #define ADSWIO_SETUP_DIN_DEBOUNCE_MODE_1 0x20
412 
418 #define ADSWIO_SETUP_GPO_PARALL_DATA_D 0x8
419 #define ADSWIO_SETUP_GPO_PARALL_DATA_C 0x4
420 #define ADSWIO_SETUP_GPO_PARALL_DATA_B 0x2
421 #define ADSWIO_SETUP_GPO_PARALL_DATA_A 0x1
422 
428 #define ADSWIO_SETUP_GPO_LOGIC_LOW 0x0
429 #define ADSWIO_SETUP_GPO_LOGIC_HIGH 0x8
430 
436 #define ADSWIO_SETUP_OUT_SLEW_EN_LINEAR 0x40
437 #define ADSWIO_SETUP_OUT_SLEW_EN_HART 0x80
438 #define ADSWIO_SETUP_OUT_SLEW_LIN_STEP_64_DEC_CODES 0x0
439 #define ADSWIO_SETUP_OUT_SLEW_LIN_STEP_120_DEC_CODES 0x10
440 #define ADSWIO_SETUP_OUT_SLEW_LIN_STEP_500_DEC_CODES 0x20
441 #define ADSWIO_SETUP_OUT_SLEW_LIN_STEP_1820_DEC_CODES 0x30
442 #define ADSWIO_SETUP_OUT_SLEW_LIN_RATE_4KHZ 0x0
443 #define ADSWIO_SETUP_OUT_SLEW_LIN_RATE_64KHZ 0x4
444 #define ADSWIO_SETUP_OUT_SLEW_LIN_RATE_150KHZ 0x8
445 #define ADSWIO_SETUP_OUT_SLEW_LIN_RATE_240KHZ 0xC
446 #define ADSWIO_SETUP_OUT_CLR_EN 0x2
447 #define ADSWIO_SETUP_OUT_CURR_LIM_30MA 0x0
448 #define ADSWIO_SETUP_OUT_CURR_LIM_7_5MA 0x1
449 
455 #define ADSWIO_SETUP_DIN_THRESH_GND_AND_AVDD 0x0
456 #define ADSWIO_SETUP_DIN_THRESH_GND_AND_16V 0x1
457 
463 #define ADSWIO_SETUP_CONV_EN_50_60_HZ_REJ_DIAG 0x400
464 
465 #define ADSWIO_SETUP_CONV_EN_ALL_CH 0xF
466 #define ADSWIO_SETUP_CONV_EN_ALL_DIAG 0xF
467 #define ADSWIO_SETUP_CONV_DIS_ALL_CH 0x0
468 #define ADSWIO_SETUP_CONV_DIS_ALL_DIAG 0x0
469 
475 #define ADSWIO_SETUP_THERM_RST_EN 0x1
476 
482 #define ADSWIO_STATUS_LIVE_ADC_CURR_CHA 0x0
483 #define ADSWIO_STATUS_LIVE_ADC_CURR_CHB 0x400
484 #define ADSWIO_STATUS_LIVE_ADC_CURR_CHC 0x800
485 #define ADSWIO_STATUS_LIVE_ADC_CURR_CHD 0xC00
486 #define ADSWIO_STATUS_LIVE_ADC_CURR_DIAG0 0x1000
487 #define ADSWIO_STATUS_LIVE_ADC_CURR_DIAG1 0x1400
488 #define ADSWIO_STATUS_LIVE_ADC_CURR_DIAG2 0x1800
489 #define ADSWIO_STATUS_LIVE_ADC_CURR_DIAG3 0x1C00
490 
496 #define ADSWIO_CMD_NOP 0x0
497 #define ADSWIO_CMD_SW_RST_KEY1 0x15FA
498 #define ADSWIO_CMD_SW_RST_KEY2 0xAF51
499 #define ADSWIO_CMD_LDAC_KEY 0x953A
500 #define ADSWIO_CMD_DAC_CLR_KEY 0x73D1
501  // End reg_setup group
504 
509 #define ADSWIO_ERR_STATUS_OK 0
510 #define ADSWIO_ERR_INIT_DRV 1
511 #define ADSWIO_ERR_UNSUPPORTED_PIN 2
512 #define ADSWIO_ERR_RD_STATUS 3
513 #define ADSWIO_ERR_RD_MODE 4
514 #define ADSWIO_ERR_RD_NWORDS 5
515 #define ADSWIO_ERR_CMD_KEY 6
516 #define ADSWIO_ERR_EN_CH 7
517 #define ADSWIO_ERR_EN_DIAG 8
518 #define ADSWIO_ERR_CRC 9
519 #define ADSWIO_ERR_REG_ADDR 10
520 #define ADSWIO_ERR_CONV_MODE 11
521 #define ADSWIO_ERR_CH_FUNC 12
522 #define ADSWIO_ERR_DIAG_ASSIGN 13
523 
529 #define ADSWIO_ID_SILICON_REV 0x8
530 
540 #define ADSWIO_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
541 #define ADSWIO_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
542  // End group macro
544 // --------------------------------------------------------------- PUBLIC TYPES
553 typedef void ( * adswio_handler_t )( uint8_t * );
554 
555 
559 typedef struct
560 {
561  // Output pins
562 
563  digital_out_t cs;
564  digital_out_t rst;
565 
566  // Input pins
567 
568  digital_in_t alt;
569  digital_in_t rdy;
570 
571  // Modules
572 
573  spi_master_t spi;
574  pin_name_t chip_select;
575 
576  // static variable
577 
579 
580 } adswio_t;
581 
585 typedef struct
586 {
587  // static variable
588 
589  uint8_t reg_addr;
590  uint16_t *data_out;
591  uint8_t rd_mode;
592  uint8_t n_words;
593 
594 } adswio_read_t;
595 
599 typedef struct
600 {
601  // Communication gpio pins
602 
603  pin_name_t miso;
604  pin_name_t mosi;
605  pin_name_t sck;
606  pin_name_t cs;
607 
608  // Additional gpio pins
609 
610  pin_name_t rst;
611  pin_name_t alt;
612  pin_name_t rdy;
613 
614  // static variable
615 
616  uint32_t spi_speed;
617  spi_master_mode_t spi_mode;
618  spi_master_chip_select_polarity_t cs_polarity;
619 
620 } adswio_cfg_t;
621  // End types group
623 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
624 
629 #ifdef __cplusplus
630 extern "C"{
631 #endif
632 
642 
652 
661 
673 void adswio_generic_transfer ( adswio_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
674 
680 void adswio_reset( adswio_t *ctx );
681 
692 
703 
713 
722 
734 adswio_err_t adswio_generic_write ( adswio_t *ctx, uint8_t reg_addr, uint16_t data_in );
735 
755 adswio_err_t adswio_generic_read ( adswio_t *ctx, uint8_t reg_addr, uint16_t *data_out, uint8_t *rd_status );
756 
782 
793 adswio_err_t adswio_exe_command ( adswio_t *ctx, uint16_t cmd_key );
794 
803 void adswio_mask_alert_set ( adswio_t *ctx, uint16_t alert_mask );
804 
817 adswio_err_t adswio_status_live ( adswio_t *ctx, uint16_t *status, uint16_t status_mask );
818 
833 adswio_err_t adswio_status_data_ready ( adswio_t *ctx, uint8_t *drdy, uint16_t *conv_target );
834 
849 adswio_err_t adswio_status_alert ( adswio_t *ctx, uint16_t *status, uint16_t status_mask );
850 
868 
885 adswio_err_t adswio_enable_ch ( adswio_t *ctx, uint8_t channel );
886 
903 adswio_err_t adswio_enable_diag ( adswio_t *ctx, uint8_t diagnostic );
904 
916 adswio_err_t adswio_set_ch_func ( adswio_t *ctx, uint8_t channel, uint8_t ch_func );
917 
936 adswio_err_t adswio_assign_diag ( adswio_t *ctx, uint8_t diagnostic, uint8_t duty );
937 
955 adswio_err_t adswio_get_conv_results ( adswio_t *ctx, uint8_t channel, uint16_t *data_out );
956 
974 adswio_err_t adswio_get_diag_results ( adswio_t *ctx, uint8_t diagnostic, uint16_t *data_out );
975 
976 #ifdef __cplusplus
977 }
978 #endif
979 #endif // _ADSWIO_H_
980  // End public_function group
983 
984 // ------------------------------------------------------------------------- END
adswio_default_cfg
void adswio_default_cfg(adswio_t *ctx)
Click Default Configuration function.
adswio_set_handler
void adswio_set_handler(adswio_t *ctx, adswio_handler_t handler)
Error Handler Setup function.
adswio_cfg_t::sck
pin_name_t sck
Definition: adswio.h:605
adswio_assign_diag
adswio_err_t adswio_assign_diag(adswio_t *ctx, uint8_t diagnostic, uint8_t duty)
Diagnostic Assign function.
adswio_generic_transfer
void adswio_generic_transfer(adswio_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
adswio_status_alert
adswio_err_t adswio_status_alert(adswio_t *ctx, uint16_t *status, uint16_t status_mask)
Alert Status function.
adswio_err_t
#define adswio_err_t
Definition: adswio.h:86
adswio_t::rdy
digital_in_t rdy
Definition: adswio.h:569
adswio_status_pin_alert
uint8_t adswio_status_pin_alert(adswio_t *ctx)
Alert Pin Status Check function.
adswio_cfg_t
Click configuration structure definition.
Definition: adswio.h:600
adswio_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: adswio.h:617
spi_specifics.h
This file contains SPI specific macros, functions, etc.
adswio_cfg_t::rdy
pin_name_t rdy
Definition: adswio.h:612
adswio_generic_read
adswio_err_t adswio_generic_read(adswio_t *ctx, uint8_t reg_addr, uint16_t *data_out, uint8_t *rd_status)
Generic Read function.
adswio_init
ADSWIO_RETVAL adswio_init(adswio_t *ctx, adswio_cfg_t *cfg)
Initialization function.
adswio_read_t::rd_mode
uint8_t rd_mode
Definition: adswio.h:591
adswio_t::chip_select
pin_name_t chip_select
Definition: adswio.h:574
adswio_read_t::data_out
uint16_t * data_out
Definition: adswio.h:590
adswio_clear_handler
void adswio_clear_handler(adswio_t *ctx)
Error Handler Clear function.
adswio_t::err_handler
adswio_handler_t err_handler
Definition: adswio.h:578
adswio_t
Click ctx object definition.
Definition: adswio.h:560
adswio_cfg_t::spi_speed
uint32_t spi_speed
Definition: adswio.h:616
adswio_reset
void adswio_reset(adswio_t *ctx)
Click Reset function.
adswio_generic_multi_read
adswio_err_t adswio_generic_multi_read(adswio_t *ctx, adswio_read_t *rd)
Generic Multi Read function.
adswio_t::alt
digital_in_t alt
Definition: adswio.h:568
adswio_read_t::reg_addr
uint8_t reg_addr
Definition: adswio.h:589
adswio_status_pin_ready
uint8_t adswio_status_pin_ready(adswio_t *ctx)
Ready Pin Status Check function.
adswio_enable_ch
adswio_err_t adswio_enable_ch(adswio_t *ctx, uint8_t channel)
Channel Enable function.
adswio_cfg_t::mosi
pin_name_t mosi
Definition: adswio.h:604
adswio_cfg_setup
void adswio_cfg_setup(adswio_cfg_t *cfg)
Config Object Initialization function.
adswio_mask_alert_set
void adswio_mask_alert_set(adswio_t *ctx, uint16_t alert_mask)
Alert Mask function.
adswio_cfg_t::rst
pin_name_t rst
Definition: adswio.h:610
adswio_cfg_t::alt
pin_name_t alt
Definition: adswio.h:611
adswio_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: adswio.h:618
adswio_handler_t
void(* adswio_handler_t)(uint8_t *)
Click error handler definition.
Definition: adswio.h:553
adswio_cfg_t::cs
pin_name_t cs
Definition: adswio.h:606
adswio_t::rst
digital_out_t rst
Definition: adswio.h:564
adswio_status_data_ready
adswio_err_t adswio_status_data_ready(adswio_t *ctx, uint8_t *drdy, uint16_t *conv_target)
Data Ready Status function.
adswio_get_conv_results
adswio_err_t adswio_get_conv_results(adswio_t *ctx, uint8_t channel, uint16_t *data_out)
Channel Results Get function.
adswio_set_conv_mode
adswio_err_t adswio_set_conv_mode(adswio_t *ctx, uint8_t mode)
Conversion Mode Setup function.
adswio_read_t::n_words
uint8_t n_words
Definition: adswio.h:592
adswio_read_t
Click ctx object definition.
Definition: adswio.h:586
adswio_t::cs
digital_out_t cs
Definition: adswio.h:563
ADSWIO_RETVAL
#define ADSWIO_RETVAL
Definition: adswio.h:93
adswio_enable_diag
adswio_err_t adswio_enable_diag(adswio_t *ctx, uint8_t diagnostic)
Diagnostic Enable function.
adswio_get_diag_results
adswio_err_t adswio_get_diag_results(adswio_t *ctx, uint8_t diagnostic, uint16_t *data_out)
Diagnostic Results Get function.
adswio_exe_command
adswio_err_t adswio_exe_command(adswio_t *ctx, uint16_t cmd_key)
Command Execute function.
adswio_status_live
adswio_err_t adswio_status_live(adswio_t *ctx, uint16_t *status, uint16_t status_mask)
Live Status function.
adswio_generic_write
adswio_err_t adswio_generic_write(adswio_t *ctx, uint8_t reg_addr, uint16_t data_in)
Generic Write function.
adswio_set_ch_func
adswio_err_t adswio_set_ch_func(adswio_t *ctx, uint8_t channel, uint8_t ch_func)
Channel Function Setup function.
adswio_t::spi
spi_master_t spi
Definition: adswio.h:573
adswio_cfg_t::miso
pin_name_t miso
Definition: adswio.h:603