Go to the documentation of this file.
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
59 #define TOUCHPAD3_GENERAL_INDEX_LOCATION 0x00
65 #define TOUCHPAD3_GENERAL_RX_CH_ADD 0x01
66 #define TOUCHPAD3_GENERAL_TX_CH_ADD 0x02
67 #define TOUCHPAD3_GENERAL_RX_SC_L_ADD 0x04
68 #define TOUCHPAD3_GENERAL_RX_SC_H_ADD 0x05
69 #define TOUCHPAD3_GENERAL_TX_SC_L_ADD 0x06
70 #define TOUCHPAD3_GENERAL_TX_SC_H_ADD 0x07
77 #define TOUCHPAD3_GENERAL_RX_CH 0x05
78 #define TOUCHPAD3_GENERAL_TX_CH 0x04
79 #define TOUCHPAD3_GENERAL_RX_SC_L 0x33
80 #define TOUCHPAD3_GENERAL_RX_SC_H 0x33
81 #define TOUCHPAD3_GENERAL_TX_SC_L 0x00
82 #define TOUCHPAD3_GENERAL_TX_SC_H 0x40
88 #define TOUCHPAD3_DECODING_INDEX_LOCATION 0x30
94 #define TOUCHPAD3_DEC_FLIP_STATE_ADD 0x00
95 #define TOUCHPAD3_DEC_NUM_AVG_ADD 0x01
96 #define TOUCHPAD3_DEC_MIN_TOUCH_DISTANCE_ADD 0x04
102 #define TOUCHPAD3_DEC_FLIP_STATE 0x04
103 #define TOUCHPAD3_DEC_NUM_AVG 0x08
104 #define TOUCHPAD3_DEC_MIN_TOUCH_DISTANCE 0x01
122 #define TOUCHPAD3_REG_WRITE 0x55, 0x04, 0x15
124 #define TOUCHPAD3_RX_MAP_INDEX_ADD 0x01
125 #define TOUCHPAD3_RX_CH1_ADD 0x00
126 #define TOUCHPAD3_RX_CH2_ADD 0x01
127 #define TOUCHPAD3_RX_CH3_ADD 0x02
128 #define TOUCHPAD3_RX_CH4_ADD 0x03
129 #define TOUCHPAD3_RX_CH5_ADD 0x04
135 #define TOUCHPAD3_RX_CH1 0x08
136 #define TOUCHPAD3_RX_CH2 0x07
137 #define TOUCHPAD3_RX_CH3 0x06
138 #define TOUCHPAD3_RX_CH4 0x05
139 #define TOUCHPAD3_RX_CH5 0x04
145 #define TOUCHPAD3_TX_MAP_INDEX_ADD 0x02
146 #define TOUCHPAD3_TX_CH1_ADD 0x00
147 #define TOUCHPAD3_TX_CH2_ADD 0x01
148 #define TOUCHPAD3_TX_CH3_ADD 0x02
149 #define TOUCHPAD3_TX_CH4_ADD 0x03
155 #define TOUCHPAD3_TX_CH1 0x0D
156 #define TOUCHPAD3_TX_CH2 0x06
157 #define TOUCHPAD3_TX_CH3 0x03
158 #define TOUCHPAD3_TX_CH4 0x02
164 #define TOUCHPAD3_SET_COMMAND 0x55
165 #define TOUCHPAD3_CMD_ENABLE_TOUCH 0x00
166 #define TOUCHPAD3_CMD_DISABLE_TOUCH 0x01
167 #define TOUCHPAD3_CMD_SCAN_BASELINE 0x14
168 #define TOUCHPAD3_CMD_WRITE_REGISTER 0x15
169 #define TOUCHPAD3_CMD_READ_REGISTER 0x16
170 #define TOUCHPAD3_CMD_WRITE_NVRAM 0x17
171 #define TOUCHPAD3_CMD_SOFTWARE_SLEEP 0x18
172 #define TOUCHPAD3_CMD_ERASE_NVRAM 0x19
173 #define TOUCHPAD3_CMD_MANUFACTURING_TEST 0x1A
174 #define TOUCHPAD3_CMD_DEVICE_ID 0x83
180 #define TOUCHPAD3_GENERAL_INDEX_BYTE 0x00
181 #define TOUCHPAD3_SENSOR_MAP_RX_INDEX_BYTE 0x01
182 #define TOUCHPAD3_SENSOR_MAP_TX_INDEX_BYTE 0x02
183 #define TOUCHPAD3_SELF_INDEX_BYTE 0x10
184 #define TOUCHPAD3_MUTUAL_INDEX_BYTE 0x20
185 #define TOUCHPAD3_DECODING_INDEX_BYTE 0x30
186 #define TOUCHPAD3_GESTURES_INDEX_BYTE 0x50
187 #define TOUCHPAD3_CONFIGURATION_INDEX_BYTE 0xF0
188 #define TOUCHPAD3_I_O_STATUS_INDEX_BYTE 0xF1
194 #define TOUCHPAD3_GENERAL_OFFSET_BYTE_RX_CHANNELS 0x01
195 #define TOUCHPAD3_GENERAL_OFFSET_BYTE_TX_CHANNELS 0x02
196 #define TOUCHPAD3_GENERAL_OFFSET_BYTE_RX_SCALING_LSB 0x04
197 #define TOUCHPAD3_GENERAL_OFFSET_BYTE_RX_SCALING_MSB 0x05
198 #define TOUCHPAD3_GENERAL_OFFSET_BYTE_TX_SCALING_LSB 0x06
199 #define TOUCHPAD3_GENERAL_OFFSET_BYTE_TX_SCALING_MSB 0x07
206 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_0 0x00
207 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_1 0x01
208 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_2 0x02
209 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_3 0x03
210 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_4 0x04
211 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_5 0x05
212 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_6 0x06
213 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_7 0x07
214 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_8 0x08
215 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_9 0x09
216 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_10 0x0A
217 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_11 0x0B
218 #define TOUCHPAD3_SENSOR_MAP_RX_OFFSET_BYTE_RX_PIN_MAP_12 0x0C
224 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_0 0x00
225 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_1 0x01
226 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_2 0x02
227 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_3 0x03
228 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_4 0x04
229 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_5 0x05
230 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_6 0x06
231 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_7 0x07
232 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_8 0x08
233 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_9 0x09
234 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_10 0x0A
235 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_11 0x0B
236 #define TOUCHPAD3_SENSOR_MAP_TX_OFFSET_BYTE_RX_PIN_MAP_12 0x0C
242 #define TOUCHPAD3_SELF_OFFSET_BYTE_SELF_SCAN_TIME 0x00
243 #define TOUCHPAD3_SELF_OFFSET_BYTE_SELF_THRESHOLD 0x01
249 #define TOUCHPAD3_MUTUAL_OFFSET_BYTE_MUTUAL_SCAN_TIME 0x00
250 #define TOUCHPAD3_MUTUAL_OFFSET_BYTE_MUTUAL_THRESHOLD 0x01
256 #define TOUCHPAD3_DECODING_OFFSET_BYTE_FLIP_STATE 0x00
257 #define TOUCHPAD3_DECODING_OFFSET_BYTE_NUMBER_OF_AVG 0x01
258 #define TOUCHPAD3_DECODING_OFFSET_BYTE_MIN_TOUCH_DIST 0x04
259 #define TOUCHPAD3_DECODING_OFFSET_BYTE_PEN_DOWN_TIMER 0x05
260 #define TOUCHPAD3_DECODING_OFFSET_BYTE_PEN_UP_TIMER 0x06
261 #define TOUCHPAD3_DECODING_OFFSET_BYTE_TOUCH_SUPPR_VALUE 0x07
267 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_RX_SWIPE_LEN 0x00
268 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_TX_SWIPE_LEN 0x01
269 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_SWIPE_BOUNDARY 0x02
270 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_SWIPE_HOLD_THD 0x03
271 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_SWIPE_TIME_LSB 0x04
272 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_SWIPE_TIME_MSB 0x05
273 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_TAP_TIME_LSB 0x06
274 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_TAP_TIME_MSB 0x07
275 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_TAP_THD 0x08
276 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_MIN_SWIPE_VELOCITY 0x09
277 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_DOUBLE_TAP_TIME_LSB 0x0A
278 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_DOUBLE_TAP_TIME_MSB 0x0B
279 #define TOUCHPAD3_GESTURES_OFFSET_BYTE_GESTURE_EDGE_KEEP_OUT 0x0C
285 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_SLP_LSW_LSB 0x00
286 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_SLP_LSW_MSB 0x01
287 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_SLP_MSW_LSB 0x02
288 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_SLP_MSW_MSB 0x03
289 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_TOUCH_PCK_CFG 0x07
290 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_GESTURE_PCK_CFG 0x09
291 #define TOUCHPAD3_CONFIG_OFFSET_BYTE_STATUS_PCK_CFG 0x0A
297 #define TOUCHPAD3_IOSTATUS_OFFSET_BYTE_TX_SHORT_STATUS_LSB 0x02
298 #define TOUCHPAD3_IOSTATUS_OFFSET_BYTE_TX_SHORT_STATUS_MSB 0x03
299 #define TOUCHPAD3_IOSTATUS_OFFSET_BYTE_RX_SHORT_STATUS_LSB 0x06
300 #define TOUCHPAD3_IOSTATUS_OFFSET_BYTE_RX_SHORT_STATUS_MSB 0x07
306 #define TOUCHPAD3_CONFIG_TOUCH_GESTURE_PCK_DISABLE 0x01
307 #define TOUCHPAD3_CONFIG_TOUCH_GESTURE_PCK_ENABLE 0x81
313 #define TOUCHPAD3_TOUCH_GESTURE_DISABLE 0x00
314 #define TOUCHPAD3_TOUCH_GESTURE_ENABLE 0x01
320 #define TOUCHPAD3_GESTURE_SINGLE_TAP 0x10
321 #define TOUCHPAD3_GESTURE_SINGLE_TAP_HOLD 0x11
322 #define TOUCHPAD3_GESTURE_DOUBLE_TAP 0x20
323 #define TOUCHPAD3_GESTURE_UP_SWIPE 0x31
324 #define TOUCHPAD3_GESTURE_UP_SWIPE_HOLD 0x32
325 #define TOUCHPAD3_GESTURE_RIGHT_SWIPE 0x41
326 #define TOUCHPAD3_GESTURE_RIGHT_SWIPE_HOLD 0x42
327 #define TOUCHPAD3_GESTURE_DOWN_SWIPE 0x51
328 #define TOUCHPAD3_GESTURE_DOWN_SWIPE_HOLD 0x52
329 #define TOUCHPAD3_GESTURE_LEFT_SWIPE 0x61
330 #define TOUCHPAD3_GESTURE_LEFT_SWIPE_HOLD 0x62
336 #define TOUCHPAD3_CMD_STATUS_SUCCESS 0x00
337 #define TOUCHPAD3_CMD_STATUS_PARAM_OUT_OF_RANGE 0x80
338 #define TOUCHPAD3_CMD_STATUS_TIMEOUT 0xFE
339 #define TOUCHPAD3_CMD_STATUS_UNRECOGNIZED 0xFF
340 #define TOUCHPAD3_CMD_STATUS_INVALID_PARAM 0xFD
341 #define TOUCHPAD3_CMD_STATUS_MISSING_OR_EXTRA_PARAM 0xFC
347 #define TOUCHPAD3_T_AND_G_ID_BIT_MASK 0x0F
348 #define TOUCHPAD3_TCH_STATE_BIT_MASK 0x01
349 #define TOUCHPAD3_PEN_STATE_BIT_MASK 0x01
350 #define TOUCHPAD3_5_BIT_MASK 0x1F
356 #define TOUCHPAD3_INT_STATUS_LOW 0x00
357 #define TOUCHPAD3_INT_STATUS_HIGH 0x01
363 #define TOUCHPAD3_STATUS_ERROR 0x00
364 #define TOUCHPAD3_STATUS_SUCCESS 0x01
370 #define TOUCHPAD3_STATE_TCH 0x00
371 #define TOUCHPAD3_STATE_GST 0x01
372 #define TOUCHPAD3_LEN_TCH 0x05
373 #define TOUCHPAD3_LEN_GST 0x02
380 #define TOUCHPAD3_SET_DEV_ADDR 0x25
398 #define TOUCHPAD3_MAP_MIKROBUS( cfg, mikrobus ) \
399 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
400 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
401 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
402 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
768 #endif // TOUCHPAD3_H
uint16_t x_axis
Definition: main.c:31
@ TOUCHPAD3_ERROR
Definition: touchpad3.h:465
uint8_t touchpad3_read_reg(touchpad3_t *ctx, uint8_t index_loc, uint8_t offset_loc, uint8_t *read_data, uint8_t *p_response)
Touchpad 3 read register data function.
uint8_t slave_address
Definition: touchpad3.h:423
pin_name_t rst
Definition: touchpad3.h:436
@ TOUCHPAD3_OK
Definition: touchpad3.h:464
err_t touchpad3_default_cfg(touchpad3_t *ctx)
Touchpad 3 default configuration function.
err_t touchpad3_generic_write(touchpad3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Touchpad 3 I2C writing function.
pin_name_t sda
Definition: touchpad3.h:434
uint8_t i2c_address
Definition: touchpad3.h:440
Touchpad 3 Click configuration object.
Definition: touchpad3.h:432
i2c_master_t i2c
Definition: touchpad3.h:420
uint32_t i2c_speed
Definition: touchpad3.h:439
uint8_t touchpad3_get_int(touchpad3_t *ctx)
Touchpad 3 get interrupt function..
digital_out_t rst
Definition: touchpad3.h:414
pin_name_t int_pin
Definition: touchpad3.h:437
void touchpad3_decoding_configuration(touchpad3_t *ctx)
Touchpad 3 decoding configuration function.
uint8_t touchpad3_get_touch(touchpad3_t *ctx, touch_data_t *tch_data, uint16_t *x_axis, uint16_t *y_axis)
Touchpad 3 get touch data function.
Definition: touchpad3.h:445
uint8_t touchpad3_config_touch(touchpad3_t *ctx, uint8_t en_touch)
Touchpad 3 configure touch function.
uint8_t touchpad3_manufacturing_test(touchpad3_t *ctx)
Touchpad 3 manufacturing test function.
void touchpad3_hw_reset(touchpad3_t *ctx)
Touchpad 3 hardware reset function.
pin_name_t scl
Definition: touchpad3.h:433
uint8_t touchpad3_cmd_protocol(touchpad3_t *ctx, cmd_protocol_t cmd_data, uint8_t *p_tx_data, uint8_t *p_rx_data)
Touchpad 3 command protocol function.
touchpad3_return_value_t
Touchpad 3 Click return value data.
Definition: touchpad3.h:463
uint8_t tch_state
Definition: touchpad3.h:447
digital_in_t int_pin
Definition: touchpad3.h:417
void touchpad3_cfg_setup(touchpad3_cfg_t *cfg)
Touchpad 3 configuration object setup function.
err_t touchpad3_init(touchpad3_t *ctx, touchpad3_cfg_t *cfg)
Touchpad 3 initialization function.
uint8_t touchpad3_write_reg(touchpad3_t *ctx, uint8_t index_loc, uint8_t offset_loc, uint8_t tx_data, uint8_t *p_response)
Touchpad 3 write register data function.
Touchpad 3 Click context object.
Definition: touchpad3.h:412
void touchpad3_sensor_mapping_configuration(touchpad3_t *ctx)
Touchpad 3 sensor mapping configuration function.
uint8_t cmd
Definition: touchpad3.h:453
uint8_t touchpad3_config_gesture(touchpad3_t *ctx, uint8_t en_gesture)
Touchpad 3 configure gesture function.
uint8_t touchpad3_get_gesture(touchpad3_t *ctx, touch_data_t *gst_data, uint8_t *gesture)
Touchpad 3 get gesture data function.
uint8_t pen_state
Definition: touchpad3.h:448
uint16_t y_axis
Definition: main.c:32
uint32_t touchpad3_get_device_id(touchpad3_t *ctx)
Touchpad 3 get device id function.
uint8_t n_rx_bytes
Definition: touchpad3.h:455
void touchpad3_general_configuration(touchpad3_t *ctx)
Touchpad 3 general configuration function.
Definition: touchpad3.h:452
uint8_t n_tx_bytes
Definition: touchpad3.h:454
uint8_t touch_id
Definition: touchpad3.h:446
err_t touchpad3_generic_read(touchpad3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Touchpad 3 I2C reading function.