ldc1101  2.0.0.0
ldc1101.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 LDC1101_H
36 #define LDC1101_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_in.h"
53 #include "drv_spi_master.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
66 #define LDC1101_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
72  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
73 
79 #define LDC1101_RETVAL uint8_t
80 
81 #define LDC1101_OK 0x00
82 #define LDC1101_INIT_ERROR 0xFF
83 
89 #define LDC1101_REG_CFG_RP_MEASUREMENT_DYNAMIC_RANGE 0x01
90 #define LDC1101_REG_CFG_INTERNAL_TIME_CONSTANT_1 0x02
91 #define LDC1101_REG_CFG_INTERNAL_TIME_CONSTANT_2 0x03
92 #define LDC1101_REG_CFG_RP_L_CONVERSION_INTERVAL 0x04
93 #define LDC1101_REG_CFG_ADDITIONAL_DEVICE 0x05
94 #define LDC1101_REG_RP_THRESH_H_LSB 0x06
95 #define LDC1101_REG_RP_THRESH_H_MSB 0x07
96 #define LDC1101_REG_RP_THRESH_L_LSB 0x08
97 #define LDC1101_REG_RP_THRESH_L_MSB 0x09
98 #define LDC1101_REG_CFG_INTB_MODE 0x0A
99 #define LDC1101_REG_CFG_POWER_STATE 0x0B
100 #define LDC1101_REG_AMPLITUDE_CONTROL_REQUIREMENT 0x0C
101 #define LDC1101_REG_L_THRESH_HI_LSB 0x16
102 #define LDC1101_REG_L_THRESH_HI_MSB 0x17
103 #define LDC1101_REG_L_THRESH_LO_LSB 0x18
104 #define LDC1101_REG_L_THRESH_LO_MSB 0x19
105 #define LDC1101_REG_RP_L_MEASUREMENT_STATUS 0x20
106 #define LDC1101_REG_RP_DATA_LSB 0x21
107 #define LDC1101_REG_RP_DATA_MSB 0x22
108 #define LDC1101_REG_L_DATA_LSB 0x23
109 #define LDC1101_REG_L_DATA_MSB 0x24
110 #define LDC1101_REG_LHR_RCOUNT_LSB 0x30
111 #define LDC1101_REG_LHR_RCOUNT_MSB 0x31
112 #define LDC1101_REG_LHR_OFFSET_LSB 0x32
113 #define LDC1101_REG_LHR_OFFSET_MSB 0x33
114 #define LDC1101_REG_CFG_LHR 0x34
115 #define LDC1101_REG_LHR_DATA_LSB 0x38
116 #define LDC1101_REG_LHR_DATA_MID 0x39
117 #define LDC1101_REG_LHR_DATA_MSB 0x3A
118 #define LDC1101_REG_LHR_STATUS 0x3B
119 #define LDC1101_REG_DEVICE_RID_VALUE 0x3E
120 #define LDC1101_REG_CHIP_ID 0x3F
121 
127 #define LDC1101_CHIP_ID_VAL 0xD4
128 
134 #define LDC1101_RP_SET_RP_MAX_IS_DRIVEN 0x00
135 #define LDC1101_RP_SET_RP_MAX_CURRENT_IS_IGNORED 0x80
136 #define LDC1101_RP_SET_RP_MAX_96KOhm 0x00
137 #define LDC1101_RP_SET_RP_MAX_48KOhm 0x10
138 #define LDC1101_RP_SET_RP_MAX_24KOhm 0x20
139 #define LDC1101_RP_SET_RP_MAX_12KOhm 0x30
140 #define LDC1101_RP_SET_RP_MAX_6KOhm 0x40
141 #define LDC1101_RP_SET_RP_MAX_3KOhm 0x50
142 #define LDC1101_RP_SET_RP_MAX_1_5KOhm 0x60
143 #define LDC1101_RP_SET_RP_MAX_0_75KOh 0x70
144 #define LDC1101_RP_SET_RP_MIN_96KOhm 0x00
145 #define LDC1101_RP_SET_RP_MIN_48KOhm 0x01
146 #define LDC1101_RP_SET_RP_MIN_24KOhm 0x02
147 #define LDC1101_RP_SET_RP_MIN_12KOhm 0x03
148 #define LDC1101_RP_SET_RP_MIN_6KOhm 0x04
149 #define LDC1101_RP_SET_RP_MIN_3KOhm 0x05
150 #define LDC1101_RP_SET_RP_MIN_1_5KOhm 0x06
151 #define LDC1101_RP_SET_RP_MIN_0_75KOh 0x07
152 
158 #define LDC1101_TC1_C1_0_75pF 0x00
159 #define LDC1101_TC1_C1_1_5pF 0x40
160 #define LDC1101_TC1_C1_3pF 0x80
161 #define LDC1101_TC1_C1_6pF 0xC0
162 #define LDC1101_TC1_R1_417kOhm 0x00
163 #define LDC1101_TC1_R1_212_7kOhm 0x10
164 #define LDC1101_TC1_R1_21_1kOhm 0x1F
165 
171 #define LDC1101_TC2_C2_3pF 0x00
172 #define LDC1101_TC2_C2_6pF 0x40
173 #define LDC1101_TC2_C2_12pF 0x80
174 #define LDC1101_TC2_C2_24pF 0xC0
175 #define LDC1101_TC2_R2_835kOhm 0x00
176 #define LDC1101_TC2_R2_426_4kOhm 0x20
177 #define LDC1101_TC2_R2_30_5kOhm 0x3F
178 
184 #define LDC1101_DIG_CFG_MIN_FREQ_500kHz 0x00
185 #define LDC1101_DIG_CFG_MIN_FREQ_118kHz 0xD0
186 #define LDC1101_DIG_CFG_MIN_FREQ_8MHz 0xF0
187 #define LDC1101_DIG_CFG_RESP_TIME_192s 0x02
188 #define LDC1101_DIG_CFG_RESP_TIME_384s 0x03
189 #define LDC1101_DIG_CFG_RESP_TIME_768s 0x04
190 #define LDC1101_DIG_CFG_RESP_TIME_1536s 0x05
191 #define LDC1101_DIG_CFG_RESP_TIME_3072s 0x06
192 #define LDC1101_DIG_CFG_RESP_TIME_6144s 0x07
193 
199 #define LDC1101_ALT_CFG_SHUTDOWN_ENABLE 0x02
200 #define LDC1101_ALT_CFG_SHUTDOWN_DISABLE 0x00
201 #define LDC1101_ALT_CFG_L_OPTIMAL_DISABLED 0x00
202 #define LDC1101_ALT_CFG_L_OPTIMAL_ENABLE 0x01
203 #define LDC1101_ALT_CFG_R_OPTIMAL_ENABLE 0x02
204 #define LDC1101_REQ_AMPLINTUDE_REGUL_CONVERT 0x00
205 #define LDC1101_CONTINUES_CONVERT 0x01
206 
212 #define LDC1101_INTB_MODE_DONT_REPORT_INTB_ON_SDO_PIN 0x00
213 #define LDC1101_INTB_MODE_REPORT_INTB_ON_SDO_PIN 0x80
214 #define LDC1101_INTB_MODE_REPORT_LHR_DATA_READY 0x20
215 #define LDC1101_INTB_MODE_L_CONVERSION_TO_L_THRESHOLDS 0x10
216 #define LDC1101_INTB_MODE_L_CONVERSION_TO_L_HIGH_THRESHOLDS 0x08
217 #define LDC1101_INTB_MODE_REPORT_RP_L_DATA_READY 0x04
218 #define LDC1101_INTB_MODE_RP_CONVERSION_TO_L_THRESHOLDS 0x02
219 #define LDC1101_INTB_MODE_RP_CONVERSION_TO_L_HIGH_THRESHOLDS 0x01
220 #define LDC1101_INTB_MODE_NO_OUTPUT 0x00
221 
227 #define LDC1101_FUNC_MODE_ACTIVE_MODE_DEF_CFG 0x00
228 #define LDC1101_RES_L_MEAS_REF_CNT_DEF_CFG 0x00
229 #define LDC1101_RES_OFF_L_MEAS_REF_CNT_DEF_CFG 0x00
230 
236 #define LDC1101_FUNC_MODE_ACTIVE_CONVERSION_MODE 0x00
237 #define LDC1101_FUNC_MODE_SLEEP_MODE 0x01
238 #define LDC1101_FUNC_MODE_SHUTDOWN_MODE 0x02
239 
245 #define LDC1101_SENSOR_FREQ_DIV_NO 0x00
246 #define LDC1101_SENSOR_FREQ_DIV_BY_2 0x01
247 #define LDC1101_SENSOR_FREQ_DIV_BY_4 0x02
248 #define LDC1101_SENSOR_FREQ_DIV_BY_8 0x04
249 
255 #define LDC1101_LHR_CFG_FREQUENCY_NOT_DIVIDED 0x00
256 #define LDC1101_LHR_CFG_FREQUENCY_DIVIDED_BY_2 0x01
257 #define LDC1101_LHR_CFG_FREQUENCY_DIVIDED_BY_4 0x02
258 #define LDC1101_LHR_CFG_FREQUENCY_DIVIDED_BY_8 0x03
259  // End group macro
262 // --------------------------------------------------------------- PUBLIC TYPES
271 typedef struct
272 {
273  digital_out_t cs;
274 
275  // Input pins
276 
277  digital_in_t pwm;
278  digital_in_t int_pin;
279 
280  // Modules
281 
282  spi_master_t spi;
283  pin_name_t chip_select;
284 
285 } ldc1101_t;
286 
290 typedef struct
291 {
292  // Communication gpio pins
293 
294  pin_name_t miso;
295  pin_name_t mosi;
296  pin_name_t sck;
297  pin_name_t cs;
298 
299  // Additional gpio pins
300 
301  pin_name_t pwm;
302  pin_name_t int_pin;
303 
304  // static variable
305 
306  uint32_t spi_speed;
307  uint8_t spi_mode;
308  spi_master_chip_select_polarity_t cs_polarity;
309 
310 } ldc1101_cfg_t;
311  // End types group
313 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
314 
319 #ifdef __cplusplus
320 extern "C"{
321 #endif
322 
332 
341 
516 
529 (
530  ldc1101_t *ctx,
531  uint8_t *wr_buf,
532  uint16_t wr_len,
533  uint8_t *rd_buf,
534  uint16_t rd_len
535 );
536 
546 void ldc1101_generic_write ( ldc1101_t *ctx, uint8_t reg_addr, uint8_t tx_data );
547 
557 uint8_t ldc1101_generic_read ( ldc1101_t *ctx, uint8_t reg_addr );
558 
571 void ldc1101_set_power_mode ( ldc1101_t *ctx, uint8_t pwr_mode );
572 
579 
586 
593 
600 uint16_t ldc1101_get_rp_data ( ldc1101_t *ctx );
601 
608 uint16_t ldc1101_get_l_data ( ldc1101_t *ctx );
609 
617 
618 
619 #ifdef __cplusplus
620 }
621 #endif
622 #endif // _LDC1101_H_
623  // End public_function group
626 
627 // ------------------------------------------------------------------------- END
ldc1101_get_interrupt
uint8_t ldc1101_get_interrupt(ldc1101_t *ctx)
Functions for get interrupt pin status.
ldc1101_get_l_data
uint16_t ldc1101_get_l_data(ldc1101_t *ctx)
Functions for reads L data.
ldc1101_t::cs
digital_out_t cs
Definition: ldc1101.h:273
ldc1101_default_cfg
void ldc1101_default_cfg(ldc1101_t *ctx)
Click Default Configuration function.
ldc1101_cfg_t::pwm
pin_name_t pwm
Definition: ldc1101.h:301
ldc1101_cfg_t::sck
pin_name_t sck
Definition: ldc1101.h:296
ldc1101_t::pwm
digital_in_t pwm
Definition: ldc1101.h:277
ldc1101_init
LDC1101_RETVAL ldc1101_init(ldc1101_t *ctx, ldc1101_cfg_t *cfg)
Initialization function.
LDC1101_RETVAL
#define LDC1101_RETVAL
Definition: ldc1101.h:79
ldc1101_cfg_t::miso
pin_name_t miso
Definition: ldc1101.h:294
ldc1101_go_to_l_mode
void ldc1101_go_to_l_mode(ldc1101_t *ctx)
Functions for go to L mode.
ldc1101_cfg_t::spi_mode
uint8_t spi_mode
Definition: ldc1101.h:307
ldc1101_get_status
uint8_t ldc1101_get_status(ldc1101_t *ctx)
Functions for reads status.
ldc1101_generic_write
void ldc1101_generic_write(ldc1101_t *ctx, uint8_t reg_addr, uint8_t tx_data)
Functions for write one byte on address.
ldc1101_generic_transfer
void ldc1101_generic_transfer(ldc1101_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
ldc1101_cfg_t
Click configuration structure definition.
Definition: ldc1101.h:291
ldc1101_cfg_t::int_pin
pin_name_t int_pin
Definition: ldc1101.h:302
ldc1101_generic_read
uint8_t ldc1101_generic_read(ldc1101_t *ctx, uint8_t reg_addr)
Functions for read byte from address.
ldc1101_cfg_t::spi_speed
uint32_t spi_speed
Definition: ldc1101.h:306
ldc1101_cfg_t::cs
pin_name_t cs
Definition: ldc1101.h:297
ldc1101_t::spi
spi_master_t spi
Definition: ldc1101.h:282
ldc1101_t
Click ctx object definition.
Definition: ldc1101.h:272
ldc1101_get_rp_data
uint16_t ldc1101_get_rp_data(ldc1101_t *ctx)
Functions for reads RP data.
ldc1101_cfg_t::mosi
pin_name_t mosi
Definition: ldc1101.h:295
ldc1101_go_to_r_mode
void ldc1101_go_to_r_mode(ldc1101_t *ctx)
Functions for go to RP mode.
ldc1101_cfg_setup
void ldc1101_cfg_setup(ldc1101_cfg_t *cfg)
Config Object Initialization function.
ldc1101_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ldc1101.h:308
ldc1101_t::int_pin
digital_in_t int_pin
Definition: ldc1101.h:278
ldc1101_set_power_mode
void ldc1101_set_power_mode(ldc1101_t *ctx, uint8_t pwr_mode)
Set power mode function.
ldc1101_t::chip_select
pin_name_t chip_select
Definition: ldc1101.h:283