proxfusion  2.0.0.0
proxfusion.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 PROXFUSION_H
36 #define PROXFUSION_H
37 
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define PROXFUSION_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
55 
61 #define PROXFUSION_OK 0
62 #define PROXFUSION_ERROR -1
63 
69 #define PROXFUSION_REG_PR_NUMBER 0x00
70 #define PROXFUSION_REG_SW_NUMBER 0x01
71 #define PROXFUSION_REG_HW_NUMBER 0x02
72 
78 #define PROXFUSION_PR_OK 0x41
79 #define PROXFUSION_SW_IQS620_OK 0x04
80 #define PROXFUSION_SW_IQS620A_OK 0x08
81 #define PROXFUSION_HW_OK 0x82
82 
88 #define PROXFUSION_FREG_SYSTEM 0x10
89 #define PROXFUSION_FREG_GLOBAL_EVENTS 0x11
90 #define PROXFUSION_FREG_UI 0x12
91 #define PROXFUSION_FREG_SAR_HYSTERESIS_UI 0x13
92 #define PROXFUSION_FREG_HALL_EFFECT_UI 0x16
93 
99 #define PROXFUSION_REG_CH_0_LSB 0x20
100 #define PROXFUSION_REG_CH_0_MSB 0x21
101 #define PROXFUSION_REG_CH_1_LSB 0x22
102 #define PROXFUSION_REG_CH_1_MSB 0x23
103 #define PROXFUSION_REG_CH_2_LSB 0x24
104 #define PROXFUSION_REG_CH_2_MSB 0x25
105 #define PROXFUSION_REG_CH_3_LSB 0x26
106 #define PROXFUSION_REG_CH_3_MSB 0x27
107 #define PROXFUSION_REG_CH_4_LSB 0x28
108 #define PROXFUSION_REG_CH_4_MSB 0x29
109 #define PROXFUSION_REG_CH_5_LSB 0x2A
110 #define PROXFUSION_REG_CH_5_MSB 0x2B
111 
117 #define PROXFUSION_REG_LTA_CH_0_LSB 0x30
118 #define PROXFUSION_REG_LTA_CH_0_MSB 0x31
119 #define PROXFUSION_REG_LTA_CH_1_LSB 0x32
120 #define PROXFUSION_REG_LTA_CH_1_MSB 0x33
121 #define PROXFUSION_REG_LTA_CH_2_LSB 0x34
122 #define PROXFUSION_REG_LTA_CH_2_MSB 0x35
123 
129 #define PROXFUSION_REG_SETTINGS_0_0 0x40
130 #define PROXFUSION_REG_SETTINGS_0_1 0x41
131 #define PROXFUSION_REG_SETTINGS_0_2 0x42
132 #define PROXFUSION_REG_SETTINGS_1_0 0x43
133 #define PROXFUSION_REG_SETTINGS_1_1 0x44
134 #define PROXFUSION_REG_SETTINGS_1_2 0x45
135 #define PROXFUSION_REG_SETTINGS_2_0 0x46
136 #define PROXFUSION_REG_SETTINGS_2_1 0x47
137 #define PROXFUSION_REG_SETTINGS_2_2 0x48
138 #define PROXFUSION_REG_SETTINGS_3_0 0x49
139 #define PROXFUSION_REG_SETTINGS_3_1 0x4A
140 #define PROXFUSION_REG_SETTINGS_3_2 0x4B
141 
147 #define PROXFUSION_REG_SETTINGS_4 0x50
148 #define PROXFUSION_REG_SETTINGS_5 0x51
149 #define PROXFUSION_REG_COMPENSATION_CH_0 0x52
150 #define PROXFUSION_REG_COMPENSATION_CH_1 0x53
151 #define PROXFUSION_REG_COMPENSATION_CH_2 0x54
152 #define PROXFUSION_REG_MULTIPLIERS_CH_0 0x55
153 #define PROXFUSION_REG_MULTIPLIERS_CH_1 0x56
154 #define PROXFUSION_REG_MULTIPLIERS_CH_2 0x57
155 
161 #define PROXFUSION_REG_PROX_CH_0 0x60
162 #define PROXFUSION_REG_TOUCH_CH_0 0x61
163 #define PROXFUSION_REG_PROX_CH_1 0x62
164 #define PROXFUSION_REG_TOUCH_CH_1 0x63
165 #define PROXFUSION_REG_PROX_CH_2 0x64
166 #define PROXFUSION_REG_TOUCH_CH_2 0x65
167 #define PROXFUSION_REG_UI_HALY_TIME 0x66
168 
174 #define PROXFUSION_REG_SAR_SETTINGS_CH0 0x70
175 #define PROXFUSION_REG_SAR_SETTINGS_CH1 0x71
176 #define PROXFUSION_REG_QRD_THRESHOLD 0x72
177 #define PROXFUSION_REG_FILTER_HALT_THRESHOLD 0x73
178 #define PROXFUSION_REG_PROX_THRESHOLD 0x74
179 
185 #define PROXFUSION_REG_HYS_UI_SETTINGS 0x80
186 #define PROXFUSION_REG_HYS_FILTER_THRESHOLD 0x81
187 #define PROXFUSION_REG_HYS_PROX_THRESHOLD 0x82
188 #define PROXFUSION_REG_HYS_TOUCH_THRESHOLD 0x83
189 
195 #define PROXFUSION_REG_HALL_SETTINGS_0 0x90
196 #define PROXFUSION_REG_HALL_SETTINGS_1 0x91
197 #define PROXFUSION_REG_HALL_COMPENSATION_4_5 0x92
198 #define PROXFUSION_REG_HALL_MULTIPLIERS_4_5 0x93
199 
205 #define PROXFUSION_REG_HALL_SWITCH_UI 0xA0
206 #define PROXFUSION_REG_HALL_SWITCH_PROX 0xA1
207 #define PROXFUSION_REG_HALL_SWITCH_TOUCH 0xA2
208 
214 #define PROXFUSION_REG_I2C_SETTINGS 0xDA
215 
221 #define PROXFUSION_SYSTEM_RESET ( 0x02 << 6 )
222 #define PROXFUSION_SYSTEM_ATI_RESET ( 0x02 )
223 #define PROXFUSION_EVENT_MODE_0 ( 0x00 << 5 )
224 #define PROXFUSION_EVENT_MODE_1 ( 0x01 << 5 )
225 #define PROXFUSION_CLOCK_16MHz ( 0x00 << 4 )
226 #define PROXFUSION_CLOCK_4MHz ( 0x01 << 4 )
227 #define PROXFUSION_ATI_DESABLED ( 0x00 << 3 )
228 #define PROXFUSION_ATI_ENABLED ( 0x01 << 3 )
229 #define PROXFUSION_ATI_BAND_1_8 ( 0x00 << 3 )
230 #define PROXFUSION_ATI_BAND_1_16 ( 0x01 << 3 )
231 
237 #define PROXFUSION_MASK_SAR_ACTIVE 0x80
238 #define PROXFUSION_MASK_PMU_EVENT 0x40
239 #define PROXFUSION_MASK_SYS_EVENT 0x20
240 #define PROXFUSION_MASK_TEMP_EVENT 0x10
241 #define PROXFUSION_MASK_HYSTERESIS_EVENT 0x08
242 #define PROXFUSION_MASK_HALL_EVENT 0x04
243 #define PROXFUSION_MASK_SAR_EVENT 0x02
244 #define PROXFUSION_MASK_PROX_SENSE_EVENT 0x01
245 
251 #define PROXFUSION_SLAVE_ADDRESS 0x44
252  // End group macro
255 // --------------------------------------------------------------- PUBLIC TYPES
264 typedef struct
265 {
266  // Input pins
267  digital_in_t int_pin;
268 
269  // Modules
270  i2c_master_t i2c;
271 
272  // ctx variable
273  uint8_t slave_address;
274 
275 } proxfusion_t;
276 
280 typedef struct
281 {
282  // Communication gpio pins
283  pin_name_t scl;
284  pin_name_t sda;
285 
286  // Additional gpio pins
287  pin_name_t int_pin;
288 
289  // static variable
290  uint32_t i2c_speed;
291  uint8_t i2c_address;
292 
294  // End types group
296 
297 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
298 
304 #ifdef __cplusplus
305 extern "C"{
306 #endif
307 
317 
330 
354 
368 err_t proxfusion_generic_write ( proxfusion_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
369 
383 err_t proxfusion_generic_read ( proxfusion_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
384 
393 
412 err_t proxfusion_set_system_reg ( proxfusion_t *ctx, uint8_t cfg );
413 
433 err_t proxfusion_set_event_reg ( proxfusion_t *ctx, uint8_t cfg );
434 
435 #ifdef __cplusplus
436 }
437 #endif
438 #endif // _PROXFUSION_H_
439  // End public_function group
442 
443 // ------------------------------------------------------------------------- END
proxfusion_init
err_t proxfusion_init(proxfusion_t *ctx, proxfusion_cfg_t *cfg)
Initialization function.
proxfusion_cfg_t::scl
pin_name_t scl
Definition: proxfusion.h:283
proxfusion_t::slave_address
uint8_t slave_address
Definition: proxfusion.h:273
proxfusion_cfg_setup
void proxfusion_cfg_setup(proxfusion_cfg_t *cfg)
Config Object Initialization function.
proxfusion_cfg_t::int_pin
pin_name_t int_pin
Definition: proxfusion.h:287
proxfusion_generic_read
err_t proxfusion_generic_read(proxfusion_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic read function.
proxfusion_t::int_pin
digital_in_t int_pin
Definition: proxfusion.h:267
proxfusion_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: proxfusion.h:290
proxfusion_get_touch
uint8_t proxfusion_get_touch(proxfusion_t *ctx)
Touch event.
proxfusion_cfg_t::i2c_address
uint8_t i2c_address
Definition: proxfusion.h:291
proxfusion_default_cfg
err_t proxfusion_default_cfg(proxfusion_t *ctx)
Click Default Configuration function.
proxfusion_cfg_t
Click configuration structure definition.
Definition: proxfusion.h:281
proxfusion_t::i2c
i2c_master_t i2c
Definition: proxfusion.h:270
proxfusion_generic_write
err_t proxfusion_generic_write(proxfusion_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic write function.
proxfusion_set_system_reg
err_t proxfusion_set_system_reg(proxfusion_t *ctx, uint8_t cfg)
Sets system register.
proxfusion_cfg_t::sda
pin_name_t sda
Definition: proxfusion.h:284
proxfusion_t
Click ctx object definition.
Definition: proxfusion.h:265
proxfusion_set_event_reg
err_t proxfusion_set_event_reg(proxfusion_t *ctx, uint8_t cfg)
Selecting events.