digiin2  2.1.0.0
digiin2.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 DIGIIN2_H
29 #define DIGIIN2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_spi_master.h"
52 #include "spi_specifics.h"
53 
74 #define DIGIIN2_REG_DISTATE 0x00
75 #define DIGIIN2_REG_FAULT 0x01
76 #define DIGIIN2_REG_F1MASK 0x02
77 #define DIGIIN2_REG_CNFG1 0x03
78 #define DIGIIN2_REG_CNFG2 0x04
79 #define DIGIIN2_REG_CNFG3 0x05
80 #define DIGIIN2_REG_CNFG4 0x06
81 #define DIGIIN2_REG_CNFG5 0x07
82 #define DIGIIN2_REG_CNFG6 0x08
83 #define DIGIIN2_REG_CNFG7 0x09
84 #define DIGIIN2_REG_CNFG8 0x0A
85 #define DIGIIN2_REG_GLOBLCFG 0x0B
86 #define DIGIIN2_REG_LED 0x0C
87 #define DIGIIN2_REG_FAULT2 0x0D
88 #define DIGIIN2_REG_F2MASK 0x0E
89 #define DIGIIN2_REG_START_STOP 0x0F
90 #define DIGIIN2_REG_CNT1_LSB 0x10
91 #define DIGIIN2_REG_CNT1_MSB 0x11
92 #define DIGIIN2_REG_CNT2_LSB 0x12
93 #define DIGIIN2_REG_CNT2_MSB 0x13
94 #define DIGIIN2_REG_CNT3_LSB 0x14
95 #define DIGIIN2_REG_CNT3_MSB 0x15
96 #define DIGIIN2_REG_CNT4_LSB 0x16
97 #define DIGIIN2_REG_CNT4_MSB 0x17
98 #define DIGIIN2_REG_CNT5_LSB 0x18
99 #define DIGIIN2_REG_CNT5_MSB 0x19
100 #define DIGIIN2_REG_CNT6_LSB 0x1A
101 #define DIGIIN2_REG_CNT6_MSB 0x1B
102 #define DIGIIN2_REG_CNT7_LSB 0x1C
103 #define DIGIIN2_REG_CNT7_MSB 0x1D
104 #define DIGIIN2_REG_CNT8_LSB 0x1E
105 #define DIGIIN2_REG_CNT8_MSB 0x1F
106  // digiin2_reg
108 
123 #define DIGIIN2_CHANNEL_1_MASK 0x01
124 #define DIGIIN2_CHANNEL_2_MASK 0x02
125 #define DIGIIN2_CHANNEL_3_MASK 0x04
126 #define DIGIIN2_CHANNEL_4_MASK 0x08
127 #define DIGIIN2_CHANNEL_5_MASK 0x10
128 #define DIGIIN2_CHANNEL_6_MASK 0x20
129 #define DIGIIN2_CHANNEL_7_MASK 0x40
130 #define DIGIIN2_CHANNEL_8_MASK 0x80
131 
136 #define DIGIIN2_CHANNEL_1_SEL 0x00
137 #define DIGIIN2_CHANNEL_2_SEL 0x01
138 #define DIGIIN2_CHANNEL_3_SEL 0x02
139 #define DIGIIN2_CHANNEL_4_SEL 0x03
140 #define DIGIIN2_CHANNEL_5_SEL 0x04
141 #define DIGIIN2_CHANNEL_6_SEL 0x05
142 #define DIGIIN2_CHANNEL_7_SEL 0x06
143 #define DIGIIN2_CHANNEL_8_SEL 0x07
144 
149 #define DIGIIN2_CRC_ERROR_FLAG 0x80
150 #define DIGIIN2_POR 0x40
151 #define DIGIIN2_FAULT2 0x20
152 #define DIGIIN2_TERMAL_SHUTDOWN 0x10
153 #define DIGIIN2_TEMPERATURE_ALARM 0x08
154 #define DIGIIN2_V24_UNDERVOLTAGE 0x04
155 #define DIGIIN2_VM_VOLTAGE_LOW 0x02
156 
161 #define DIGIIN2_CRC_ERROR_FLAG_MASK 0x80
162 #define DIGIIN2_FAULT2_MASK 0x20
163 #define DIGIIN2_TERMAL_SHUTDOWN_MASK 0x10
164 #define DIGIIN2_TEMPERATURE_ALARM_MASK 0x08
165 #define DIGIIN2_V24_UNDERVOLTAGE_MASK 0x04
166 #define DIGIIN2_VM_VOLTAGE_LOW_MASK 0x02
167 
172 #define DIGIIN2_HITHR_HIGH 0x80
173 #define DIGIIN2_HITHR_LOW 0x00
174 #define DIGIIN2_SINK_MODE 0x00
175 #define DIGIIN2_SOURCE_MODE 0x40
176 #define DIGIIN2_CURR_OFF 0x00
177 #define DIGIIN2_CURR_X1 0x10
178 #define DIGIIN2_CURR_X3 0x20
179 #define DIGIIN2_CURR_TTL_OFF 0x30
180 #define DIGIIN2_GLITCH_FIL_EN 0x08
181 #define DIGIIN2_GLITCH_FIL_DIS 0x00
182 #define DIGIIN2_GLITCH_FIL_DELAY_50_US 0x00
183 #define DIGIIN2_GLITCH_FIL_DELAY_100_US 0x01
184 #define DIGIIN2_GLITCH_FIL_DELAY_400_US 0x02
185 #define DIGIIN2_GLITCH_FIL_DELAY_800_US 0x03
186 #define DIGIIN2_GLITCH_FIL_DELAY_1600_US 0x04
187 #define DIGIIN2_GLITCH_FIL_DELAY_3200_US 0x05
188 #define DIGIIN2_GLITCH_FIL_DELAY_12800_US 0x06
189 #define DIGIIN2_GLITCH_FIL_DELAY_20_MS 0x07
190 
195 #define DIGIIN2_GPO_CFG_LED 0x80
196 #define DIGIIN2_GPO_CFG_LEDINT 0x00
197 #define DIGIIN2_LEDINT_CFG_GPO 0x00
198 #define DIGIIN2_LEDINT_CFG_VMLOW 0x40
199 #define DIGIIN2_LED9_ON 0x00
200 #define DIGIIN2_LED9_OFF 0x20
201 #define DIGIIN2_FSPICLEAR_READ 0x10
202 #define DIGIIN2_FSPICLEAR_AUTO 0x00
203 #define DIGIIN2_CLR_FILTER_ON 0x08
204 #define DIGIIN2_CLR_FILTER_OFF 0x00
205 #define DIGIIN2_REFDISHTCFG_DIS 0x00
206 #define DIGIIN2_REFDISHTCFG_EN 0x01
207 
212 #define DIGIIN2_LED_1_MASK 0x01
213 #define DIGIIN2_LED_2_MASK 0x02
214 #define DIGIIN2_LED_3_MASK 0x04
215 #define DIGIIN2_LED_4_MASK 0x08
216 #define DIGIIN2_LED_5_MASK 0x10
217 #define DIGIIN2_LED_6_MASK 0x20
218 #define DIGIIN2_LED_7_MASK 0x40
219 #define DIGIIN2_LED_8_MASK 0x80
220 
225 #define DIGIIN2_VAUV_UNDER_TRESHOLD 0x10
226 #define DIGIIN2_SPI8_CLK_ERROR 0x08
227 #define DIGIIN2_OTSHDN2_ERROR 0x04
228 #define DIGIIN2_RFDIO_ERROR 0x02
229 #define DIGIIN2_RFDIS_ERROR 0x01
230 
235 #define DIGIIN2_VAUV_UNDER_TRESHOLD_MASK 0x10
236 #define DIGIIN2_SPI8_CLK_ERROR_MASK 0x08
237 #define DIGIIN2_OTSHDN2_ERROR_MASK 0x04
238 #define DIGIIN2_RFDIO_ERROR_MASK 0x02
239 #define DIGIIN2_RFDIS_ERROR_MASK 0x01
240 
245 #define DIGIIN2_PIN_STATE_HIGH 0x01
246 #define DIGIIN2_PIN_STATE_LOW 0x00
247 
252 #define DIGIIN2_CRC_ENABLED 0x01
253 #define DIGIIN2_CRC_DISABLED 0x00
254 
259 #define DIGIIN2_CHIP_ADDRESS_00 0x00
260 #define DIGIIN2_CHIP_ADDRESS_01 0x40
261 #define DIGIIN2_CHIP_ADDRESS_10 0x80
262 #define DIGIIN2_CHIP_ADDRESS_11 0xC0
263 
264 
265 
274 #define DIGIIN2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
275 #define DIGIIN2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
276  // digiin2_set
278 
293 #define DIGIIN2_MAP_MIKROBUS( cfg, mikrobus ) \
294  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
295  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
296  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
297  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
298  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_AN ); \
299  cfg.ltc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
300  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
301  // digiin2_map // digiin2
304 
309 typedef struct
310 {
311  // Output pins
312  digital_out_t ltc;
314  // Input pins
315  digital_in_t rdy;
316  digital_in_t flt;
318  // Modules
319  spi_master_t spi;
321  pin_name_t chip_select;
323  uint8_t device_address;
324  uint8_t crc_en;
326 } digiin2_t;
327 
332 typedef struct
333 {
334  // Communication gpio pins
335  pin_name_t miso;
336  pin_name_t mosi;
337  pin_name_t sck;
338  pin_name_t cs;
340  // Additional gpio pins
341  pin_name_t rdy;
342  pin_name_t ltc;
343  pin_name_t flt;
345  // static variable
346  uint32_t spi_speed;
347  spi_master_mode_t spi_mode;
348  spi_master_chip_select_polarity_t cs_polarity;
350 } digiin2_cfg_t;
351 
356 typedef enum
357 {
359  DIGIIN2_ERROR = -1
360 
362 
379 
393 err_t digiin2_init ( digiin2_t *ctx, digiin2_cfg_t *cfg );
394 
408 
418 void digiin2_set_dev_address ( digiin2_t *ctx, uint8_t device_address );
419 
434 err_t digiin2_generic_write ( digiin2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
435 
450 err_t digiin2_generic_read ( digiin2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
451 
461 void digiin2_set_ltc_pin ( digiin2_t *ctx, uint8_t pin_state );
462 
472 
482 
496 err_t digiin2_write_reg ( digiin2_t *ctx, uint8_t reg, uint8_t data_in );
497 
511 err_t digiin2_read_reg ( digiin2_t *ctx, uint8_t reg, uint8_t *data_out );
512 
526 err_t digiin2_read_ch_counter ( digiin2_t *ctx, uint8_t channel_sel, uint16_t *data_out );
527 
537 
538 #ifdef __cplusplus
539 }
540 #endif
541 #endif // DIGIIN2_H
542  // digiin2
544 
545 // ------------------------------------------------------------------------ END
digiin2_cfg_t::sck
pin_name_t sck
Definition: digiin2.h:337
digiin2_cfg_t
DIGI IN 2 Click configuration object.
Definition: digiin2.h:333
digiin2_generic_read
err_t digiin2_generic_read(digiin2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
DIGI IN 2 data reading function.
digiin2_cfg_t::miso
pin_name_t miso
Definition: digiin2.h:335
digiin2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: digiin2.h:348
digiin2_read_reg
err_t digiin2_read_reg(digiin2_t *ctx, uint8_t reg, uint8_t *data_out)
DIGI IN 2 register reading function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
digiin2_t::crc_en
uint8_t crc_en
Definition: digiin2.h:324
digiin2_t::rdy
digital_in_t rdy
Definition: digiin2.h:315
digiin2_set_dev_address
void digiin2_set_dev_address(digiin2_t *ctx, uint8_t device_address)
DIGI IN 2 set device address function.
digiin2_set_ltc_pin
void digiin2_set_ltc_pin(digiin2_t *ctx, uint8_t pin_state)
DIGI IN 2 set LTC pin function.
DIGIIN2_OK
@ DIGIIN2_OK
Definition: digiin2.h:358
digiin2_cfg_t::cs
pin_name_t cs
Definition: digiin2.h:338
digiin2_t::ltc
digital_out_t ltc
Definition: digiin2.h:312
digiin2_generic_write
err_t digiin2_generic_write(digiin2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
DIGI IN 2 data writing function.
digiin2_t::chip_select
pin_name_t chip_select
Definition: digiin2.h:321
digiin2_t::flt
digital_in_t flt
Definition: digiin2.h:316
digiin2_cfg_t::ltc
pin_name_t ltc
Definition: digiin2.h:342
digiin2_return_value_t
digiin2_return_value_t
DIGI IN 2 Click return value data.
Definition: digiin2.h:357
digiin2_cfg_t::flt
pin_name_t flt
Definition: digiin2.h:343
digiin2_pulse_latch
void digiin2_pulse_latch(digiin2_t *ctx)
DIGI IN 2 send latch pulse function.
digiin2_get_flt_pin
uint8_t digiin2_get_flt_pin(digiin2_t *ctx)
DIGI IN 2 get FLT pin state function.
digiin2_t
DIGI IN 2 Click context object.
Definition: digiin2.h:310
digiin2_t::device_address
uint8_t device_address
Definition: digiin2.h:323
digiin2_cfg_t::mosi
pin_name_t mosi
Definition: digiin2.h:336
digiin2_t::spi
spi_master_t spi
Definition: digiin2.h:319
digiin2_read_ch_counter
err_t digiin2_read_ch_counter(digiin2_t *ctx, uint8_t channel_sel, uint16_t *data_out)
DIGI IN 2 channel counter reading function.
digiin2_init
err_t digiin2_init(digiin2_t *ctx, digiin2_cfg_t *cfg)
DIGI IN 2 initialization function.
digiin2_cfg_t::spi_speed
uint32_t spi_speed
Definition: digiin2.h:346
digiin2_get_rdy_pin
uint8_t digiin2_get_rdy_pin(digiin2_t *ctx)
DIGI IN 2 get RDY pin state function.
digiin2_default_cfg
err_t digiin2_default_cfg(digiin2_t *ctx)
DIGI IN 2 default configuration function.
digiin2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: digiin2.h:347
digiin2_write_reg
err_t digiin2_write_reg(digiin2_t *ctx, uint8_t reg, uint8_t data_in)
DIGI IN 2 register write function.
digiin2_cfg_setup
void digiin2_cfg_setup(digiin2_cfg_t *cfg)
DIGI IN 2 configuration object setup function.
DIGIIN2_ERROR
@ DIGIIN2_ERROR
Definition: digiin2.h:359
digiin2_cfg_t::rdy
pin_name_t rdy
Definition: digiin2.h:341