LibDriver TTP229
Loading...
Searching...
No Matches
driver_ttp229.c
Go to the documentation of this file.
1
36
37#include "driver_ttp229.h"
38
42#define CHIP_NAME "Tontek TTP229"
43#define MANUFACTURER_NAME "Tontek"
44#define SUPPLY_VOLTAGE_MIN 2.4f
45#define SUPPLY_VOLTAGE_MAX 5.5f
46#define MAX_CURRENT 8.0f
47#define TEMPERATURE_MIN -40.0f
48#define TEMPERATURE_MAX 85.0f
49#define DRIVER_VERSION 1000
50
54#define TTP229_ADDRESS (0x57 << 1)
55
66static uint8_t a_ttp229_iic_spi_read(ttp229_handle_t *handle, uint8_t *buf, uint16_t len)
67{
68 if (handle->iic_spi == (uint8_t)TTP229_INTERFACE_IIC) /* iic interface */
69 {
70 if (handle->iic_read_cmd(TTP229_ADDRESS, buf, len) != 0) /* iic read */
71 {
72 return 1; /* return error */
73 }
74
75 return 0; /* success return 0 */
76 }
77 else /* spi interface */
78 {
79 if (handle->spi_read_cmd(buf, len) != 0) /* spi read */
80 {
81 return 1; /* return error */
82 }
83
84 return 0; /* success return 0 */
85 }
86}
87
97uint8_t ttp229_set_interface(ttp229_handle_t *handle, ttp229_interface_t interface)
98{
99 if (handle == NULL) /* check handle */
100 {
101 return 2; /* return error */
102 }
103
104 handle->iic_spi = (uint8_t)interface; /* set interface */
105
106 return 0; /* success return 0 */
107}
108
118uint8_t ttp229_get_interface(ttp229_handle_t *handle, ttp229_interface_t *interface)
119{
120 if (handle == NULL) /* check handle */
121 {
122 return 2; /* return error */
123 }
124
125 *interface = (ttp229_interface_t)(handle->iic_spi); /* get interface */
126
127 return 0; /* success return 0 */
128}
129
140uint8_t ttp229_set_active(ttp229_handle_t *handle, ttp229_active_t active_level)
141{
142 if (handle == NULL) /* check handle */
143 {
144 return 2; /* return error */
145 }
146 if (handle->inited != 1) /* check handle initialization */
147 {
148 return 3; /* return error */
149 }
150
151 handle->active = (uint8_t)active_level; /* set active level */
152
153 return 0; /* success return 0 */
154}
155
166uint8_t ttp229_get_active(ttp229_handle_t *handle, ttp229_active_t *active_level)
167{
168 if (handle == NULL) /* check handle */
169 {
170 return 2; /* return error */
171 }
172 if (handle->inited != 1) /* check handle initialization */
173 {
174 return 3; /* return error */
175 }
176
177 *active_level = (ttp229_active_t)(handle->active); /* set active level */
178
179 return 0; /* success return 0 */
180}
181
192uint8_t ttp229_init(ttp229_handle_t *handle)
193{
194 if (handle == NULL) /* check handle */
195 {
196 return 2; /* return error */
197 }
198 if (handle->debug_print == NULL) /* check debug_print */
199 {
200 return 3; /* return error */
201 }
202 if (handle->iic_init == NULL) /* check iic_init */
203 {
204 handle->debug_print("ttp229: iic_init is null.\n"); /* iic_init is nul */
205
206 return 3; /* return error */
207 }
208 if (handle->iic_deinit == NULL) /* check iic_deinit */
209 {
210 handle->debug_print("ttp229: iic_deinit is null.\n"); /* iic_deinit is null */
211
212 return 3; /* return error */
213 }
214 if (handle->iic_read_cmd == NULL) /* check iic_read_cmd */
215 {
216 handle->debug_print("ttp229: iic_read_cmd is null.\n"); /* iic_read_cmd is null */
217
218 return 3; /* return error */
219 }
220 if (handle->spi_init == NULL) /* check spi_init */
221 {
222 handle->debug_print("ttp229: spi_init is null.\n"); /* spi_init is nul */
223
224 return 3; /* return error */
225 }
226 if (handle->spi_deinit == NULL) /* check spi_deinit */
227 {
228 handle->debug_print("ttp229: spi_deinit is null.\n"); /* spi_deinit is nul */
229
230 return 3; /* return error */
231 }
232 if (handle->spi_read_cmd == NULL) /* check spi_read_cmd */
233 {
234 handle->debug_print("ttp229: spi_read_cmd is null.\n"); /* spi_read_cmd is nul */
235
236 return 3; /* return error */
237 }
238 if (handle->delay_ms == NULL) /* check delay_ms */
239 {
240 handle->debug_print("ttp229: delay_ms is null.\n"); /* delay_ms is null */
241
242 return 3; /* return error */
243 }
244
245 if (handle->iic_spi == (uint8_t)TTP229_INTERFACE_IIC) /* iic interface */
246 {
247 if (handle->iic_init() != 0) /* iic init */
248 {
249 handle->debug_print("ttp229: iic init failed.\n"); /* iic init failed */
250
251 return 1; /* return error */
252 }
253 }
254 else /* spi interface */
255 {
256 if (handle->spi_init() != 0) /* spi init */
257 {
258 handle->debug_print("ttp229: spi init failed.\n"); /* spi init failed */
259
260 return 1; /* return error */
261 }
262 }
263
264 handle->inited = 1; /* flag finish initialization */
265
266 return 0; /* success return 0 */
267}
268
279uint8_t ttp229_deinit(ttp229_handle_t *handle)
280{
281 if (handle == NULL) /* check handle */
282 {
283 return 2; /* return error */
284 }
285 if (handle->inited != 1) /* check handle initialization */
286 {
287 return 3; /* return error */
288 }
289
290 if (handle->iic_spi == (uint8_t)TTP229_INTERFACE_IIC) /* iic interface */
291 {
292 if (handle->iic_init() != 0) /* iic init */
293 {
294 handle->debug_print("ttp229: iic init failed.\n"); /* iic init failed */
295
296 return 1; /* return error */
297 }
298 }
299 else /* spi interface */
300 {
301 if (handle->spi_init() != 0) /* spi init */
302 {
303 handle->debug_print("ttp229: spi init failed.\n"); /* spi init failed */
304
305 return 1; /* return error */
306 }
307 }
308 handle->inited = 0; /* flag close */
309
310 return 0; /* success return 0 */
311}
312
324uint8_t ttp229_read_16_keys(ttp229_handle_t *handle, uint8_t keys[16])
325{
326 uint8_t i;
327 uint8_t buf[2];
328
329 if (handle == NULL) /* check handle */
330 {
331 return 2; /* return error */
332 }
333 if (handle->inited != 1) /* check handle initialization */
334 {
335 return 3; /* return error */
336 }
337
338 if (a_ttp229_iic_spi_read(handle, buf, 2) != 0) /* read data */
339 {
340 handle->debug_print("ttp229: read failed.\n"); /* read failed */
341
342 return 1; /* return error */
343 }
344 for (i = 0; i < 16; i++) /* loop all */
345 {
346 keys[i] = (buf[i / 8] >> (7 - i % 8)) & 0x01; /* get one key */
347 if (handle->active == (uint8_t)(TTP229_ACTIVE_LOW)) /* if active low */
348 {
349 keys[i] = !keys[i]; /* revert */
350 }
351 }
352
353 return 0; /* success return 0 */
354}
355
367uint8_t ttp229_read_8_keys(ttp229_handle_t *handle, uint8_t keys[8])
368{
369 uint8_t i;
370 uint8_t buf[1];
371
372 if (handle == NULL) /* check handle */
373 {
374 return 2; /* return error */
375 }
376 if (handle->inited != 1) /* check handle initialization */
377 {
378 return 3; /* return error */
379 }
380
381 if (a_ttp229_iic_spi_read(handle, buf, 1) != 0) /* read data */
382 {
383 handle->debug_print("ttp229: read failed.\n"); /* read failed */
384
385 return 1; /* return error */
386 }
387 for (i = 0; i < 8; i++) /* loop all */
388 {
389 keys[i] = (buf[i / 8] >> (7 - i % 8)) & 0x01; /* get one key */
390 if (handle->active == (uint8_t)(TTP229_ACTIVE_LOW)) /* if active low */
391 {
392 keys[i] = !keys[i]; /* revert */
393 }
394 }
395
396 return 0; /* success return 0 */
397}
398
411uint8_t ttp229_get_reg(ttp229_handle_t *handle, uint8_t *buf, uint16_t len)
412{
413 if (handle == NULL) /* check handle */
414 {
415 return 2; /* return error */
416 }
417 if (handle->inited != 1) /* check handle initialization */
418 {
419 return 3; /* return error */
420 }
421
422 return a_ttp229_iic_spi_read(handle, buf, len); /* read register */
423}
424
433uint8_t ttp229_info(ttp229_info_t *info)
434{
435 if (info == NULL) /* check handle */
436 {
437 return 2; /* return error */
438 }
439
440 memset(info, 0, sizeof(ttp229_info_t)); /* initialize ttp229 info structure */
441 strncpy(info->chip_name, CHIP_NAME, 32); /* copy chip name */
442 strncpy(info->manufacturer_name, MANUFACTURER_NAME, 32); /* copy manufacturer name */
443 strncpy(info->interface, "IIC SPI", 8); /* copy interface name */
444 info->supply_voltage_min_v = SUPPLY_VOLTAGE_MIN; /* set minimal supply voltage */
445 info->supply_voltage_max_v = SUPPLY_VOLTAGE_MAX; /* set maximum supply voltage */
446 info->max_current_ma = MAX_CURRENT; /* set maximum current */
447 info->temperature_max = TEMPERATURE_MAX; /* set minimal temperature */
448 info->temperature_min = TEMPERATURE_MIN; /* set maximum temperature */
449 info->driver_version = DRIVER_VERSION; /* set driver version */
450
451 return 0; /* success return 0 */
452}
MAX_CURRENT
#define MAX_CURRENT
Definition driver_ttp229.c:46
SUPPLY_VOLTAGE_MAX
#define SUPPLY_VOLTAGE_MAX
Definition driver_ttp229.c:45
TEMPERATURE_MAX
#define TEMPERATURE_MAX
Definition driver_ttp229.c:48
TTP229_ADDRESS
#define TTP229_ADDRESS
chip address definition
Definition driver_ttp229.c:54
MANUFACTURER_NAME
#define MANUFACTURER_NAME
Definition driver_ttp229.c:43
TEMPERATURE_MIN
#define TEMPERATURE_MIN
Definition driver_ttp229.c:47
SUPPLY_VOLTAGE_MIN
#define SUPPLY_VOLTAGE_MIN
Definition driver_ttp229.c:44
CHIP_NAME
#define CHIP_NAME
chip information definition
Definition driver_ttp229.c:42
DRIVER_VERSION
#define DRIVER_VERSION
Definition driver_ttp229.c:49
driver_ttp229.h
driver ttp229 header file
ttp229_active_t
ttp229_active_t
ttp229 active enumeration definition
Definition driver_ttp229.h:72
ttp229_init
uint8_t ttp229_init(ttp229_handle_t *handle)
initialize the chip
Definition driver_ttp229.c:192
ttp229_info_t
struct ttp229_info_s ttp229_info_t
ttp229 information structure definition
ttp229_interface_t
ttp229_interface_t
ttp229 interface enumeration definition
Definition driver_ttp229.h:63
ttp229_set_active
uint8_t ttp229_set_active(ttp229_handle_t *handle, ttp229_active_t active_level)
set the active level
Definition driver_ttp229.c:140
ttp229_get_interface
uint8_t ttp229_get_interface(ttp229_handle_t *handle, ttp229_interface_t *interface)
get the interface
Definition driver_ttp229.c:118
ttp229_deinit
uint8_t ttp229_deinit(ttp229_handle_t *handle)
close the chip
Definition driver_ttp229.c:279
ttp229_read_8_keys
uint8_t ttp229_read_8_keys(ttp229_handle_t *handle, uint8_t keys[8])
read 8 keys
Definition driver_ttp229.c:367
ttp229_info
uint8_t ttp229_info(ttp229_info_t *info)
get chip's information
Definition driver_ttp229.c:433
ttp229_get_active
uint8_t ttp229_get_active(ttp229_handle_t *handle, ttp229_active_t *active_level)
get the active level
Definition driver_ttp229.c:166
ttp229_read_16_keys
uint8_t ttp229_read_16_keys(ttp229_handle_t *handle, uint8_t keys[16])
read 16 keys
Definition driver_ttp229.c:324
ttp229_set_interface
uint8_t ttp229_set_interface(ttp229_handle_t *handle, ttp229_interface_t interface)
set the interface
Definition driver_ttp229.c:97
ttp229_handle_t
struct ttp229_handle_s ttp229_handle_t
ttp229 handle structure definition
TTP229_ACTIVE_LOW
@ TTP229_ACTIVE_LOW
Definition driver_ttp229.h:73
TTP229_INTERFACE_IIC
@ TTP229_INTERFACE_IIC
Definition driver_ttp229.h:64
ttp229_get_reg
uint8_t ttp229_get_reg(ttp229_handle_t *handle, uint8_t *buf, uint16_t len)
get the chip register
Definition driver_ttp229.c:411
ttp229_handle_s::iic_spi
uint8_t iic_spi
Definition driver_ttp229.h:92
ttp229_handle_s::active
uint8_t active
Definition driver_ttp229.h:91
ttp229_handle_s::inited
uint8_t inited
Definition driver_ttp229.h:90
ttp229_handle_s::spi_init
uint8_t(* spi_init)(void)
Definition driver_ttp229.h:85
ttp229_handle_s::delay_ms
void(* delay_ms)(uint32_t ms)
Definition driver_ttp229.h:88
ttp229_handle_s::spi_read_cmd
uint8_t(* spi_read_cmd)(uint8_t *buf, uint16_t len)
Definition driver_ttp229.h:87
ttp229_handle_s::debug_print
void(* debug_print)(const char *const fmt,...)
Definition driver_ttp229.h:89
ttp229_handle_s::iic_init
uint8_t(* iic_init)(void)
Definition driver_ttp229.h:82
ttp229_handle_s::spi_deinit
uint8_t(* spi_deinit)(void)
Definition driver_ttp229.h:86
ttp229_handle_s::iic_read_cmd
uint8_t(* iic_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len)
Definition driver_ttp229.h:84
ttp229_handle_s::iic_deinit
uint8_t(* iic_deinit)(void)
Definition driver_ttp229.h:83
ttp229_info_s::temperature_max
float temperature_max
Definition driver_ttp229.h:107
ttp229_info_s::supply_voltage_max_v
float supply_voltage_max_v
Definition driver_ttp229.h:104
ttp229_info_s::driver_version
uint32_t driver_version
Definition driver_ttp229.h:108
ttp229_info_s::temperature_min
float temperature_min
Definition driver_ttp229.h:106
ttp229_info_s::max_current_ma
float max_current_ma
Definition driver_ttp229.h:105
ttp229_info_s::manufacturer_name
char manufacturer_name[32]
Definition driver_ttp229.h:101
ttp229_info_s::supply_voltage_min_v
float supply_voltage_min_v
Definition driver_ttp229.h:103
ttp229_info_s::interface
char interface[8]
Definition driver_ttp229.h:102
ttp229_info_s::chip_name
char chip_name[32]
Definition driver_ttp229.h:100