From 139a185215e1e79ebcd1d33081985b2a6c30d0eb Mon Sep 17 00:00:00 2001 From: davidycchen Date: Mon, 29 Nov 2021 14:15:32 +0800 Subject: synaptics: update driver version to 0115 Update core lib. to 1.21 Bugs fixed. Have a callback to handle unexpected identify report generated from firmware. Able to handle the extra CRC bytes. Have the helper thread support. - Enable 'ENABLE_HELPER' if willing to activate this feature. - Have a sample code to start a helper task when an unexpected reset is detected. Set device into bootloader mode if failing to set up app fw. Support custom 'fw status' report ($c2). Add the implementations of custom gesture. - 'ENABLE_WAKEUP_GESTURE' is disabled in default. Enable if willing to enter LPWG mode in suspend. Bug: 208162255 Signed-off-by: davidycchen Change-Id: Idfd45502293aa6fa42b8602a9bc663cb85301a45 --- tcm/synaptics_touchcom_core_dev.h | 166 +++++++++++++++++++++++++++++++++++--- 1 file changed, 153 insertions(+), 13 deletions(-) (limited to 'tcm/synaptics_touchcom_core_dev.h') diff --git a/tcm/synaptics_touchcom_core_dev.h b/tcm/synaptics_touchcom_core_dev.h index f877af1..1b0eb2c 100644 --- a/tcm/synaptics_touchcom_core_dev.h +++ b/tcm/synaptics_touchcom_core_dev.h @@ -44,7 +44,7 @@ #include "syna_tcm2_platform.h" -#define SYNA_TCM_CORE_LIB_VERSION 0x0113 +#define SYNA_TCM_CORE_LIB_VERSION 0x0115 /** @@ -532,9 +532,10 @@ struct tcm_touch_data_blob { }; /** - * @section: Callback function used for custom entity parsing in touch report + * @section: Callback function used to parse custom touch entity * - * Allow to implement the custom handling for"new" custom entity in touch report + * Allow to invoke the customized implementation to parse touch data inside + * touch report. * * @param * [ in] code: the code of current touch entity @@ -545,20 +546,21 @@ struct tcm_touch_data_blob { * [in/out] report_offset: offset of current position in touch report, * the updated position should be returned. * [ in] report_size: size of given touch report - * [ in] callback_data: pointer to caller data passed to callback function + * [ in] callback_data: pointer to caller data * * @return * on success, 0 or positive value; otherwise, negative value on error. */ -typedef int (*tcm_touch_data_parse_callback_t) (const unsigned char code, +typedef int (*tcm_custom_touch_entity_callback_t) (const unsigned char code, const unsigned char *config, unsigned int *config_offset, const unsigned char *report, unsigned int *report_offset, unsigned int report_size, void *callback_data); /** - * @section: Callback function used for custom gesture parsing in touch report + * @section: Callback function used to parse custom gesture data * - * Allow to implement the custom handling for gesture data. + * Allow to invoke the customized implementation to get gesture data inside + * touch report. * * @param * [ in] code: the code of current touch entity @@ -569,16 +571,30 @@ typedef int (*tcm_touch_data_parse_callback_t) (const unsigned char code, * [in/out] report_offset: offset of current position in touch report, * the updated position should be returned. * [ in] report_size: size of given touch report - * [ in] callback_data: pointer to caller data passed to callback function + * [ in] callback_data: pointer to caller data * * @return * on success, 0 or positive value; otherwise, negative value on error. */ -typedef int (*tcm_gesture_parse_callback_t) (const unsigned char code, +typedef int (*tcm_custom_gesture_callback_t) (const unsigned char code, const unsigned char *config, unsigned int *config_offset, const unsigned char *report, unsigned int *report_offset, unsigned int report_size, void *callback_data); +/** + * @section: Callback function being invoked once getting a reset + * + * Allow to invoke the customized implementation to handle the unexpected reset + * including self-reset, external reset, and so on. + * + * @param + * [ in] callback_data: pointer to caller data + * + * @return + * none. + */ +typedef void (*tcm_reset_occurrence_callback_t) (void *callback_data); + /** * @section: TouchComm Message Handling Wrapper * @@ -622,6 +638,11 @@ struct tcm_message_data_blob { */ bool predict_reads; unsigned int predict_length; + + /* variables for the crc appended + */ + bool has_crc; + unsigned short crc_bytes; }; /** @@ -723,11 +744,16 @@ struct tcm_dev { /* callbacks * custom_touch_data_parse_func: custom touch data entity parsing * custom_gesture_parse_func : custom gesture data entity parsing + * cb_custom_touch_entity: callback to parse custom touch entity + * cb_custom_gesture : callback to parse custom gesture + * cb_reset_occurrence : callback once reset occurrence */ - tcm_touch_data_parse_callback_t custom_touch_data_parse_func; - void *cbdata_touch_data_parse; - tcm_gesture_parse_callback_t custom_gesture_parse_func; - void *cbdata_gesture_parse; + tcm_custom_touch_entity_callback_t cb_custom_touch_entity; + void *cbdata_touch_entity; + tcm_custom_gesture_callback_t cb_custom_gesture; + void *cbdata_gesture; + tcm_reset_occurrence_callback_t cb_reset_occurrence; + void *cbdata_reset; }; /* end of structure syna_tcm_dev */ @@ -1100,5 +1126,119 @@ static inline int syna_tcm_write(struct tcm_dev *tcm_dev, return hw_if->ops_write_data(hw_if, wr_data, wr_len); } +/** + * @section: CRC Calculation Function + * + * @brief: syna_tcm_crc6 + * Return the crc-6 calculated + * + * @brief: syna_tcm_crc16 + * Return the crc-16 calculated + */ + +/** + * syna_tcm_crc6() + * + * Calculate the crc-6 with polynomial and return + * + * @param + * [ in] p: byte array for the calculation + * [ in] bits: number of bits + * + * @return + * the crc-6 value + */ +static inline unsigned char syna_tcm_crc6(unsigned char *p, + unsigned int bits) +{ + unsigned short r = 0x003F << 2; + unsigned short x; + static unsigned short crc6_table[16] = { + 0, 268, 536, 788, 1072, 1340, 1576, 1828, + 2144, 2412, 2680, 2932, 3152, 3420, 3656, 3908 + }; + + for (; bits > 8; bits -= 8) { + r ^= *p++; + r = (r << 4) ^ crc6_table[r >> 4]; + r = (r << 4) ^ crc6_table[r >> 4]; + } + + if (bits > 0) { + x = *p; + while (bits--) { + if (x & 0x80) + r ^= 0x80; + + x <<= 1; + r <<= 1; + if (r & 0x100) + r ^= (0x03 << 2); + } + } + + return (unsigned char)((r >> 2) & 0x3F); +} +/** + * syna_tcm_crc16() + * + * Calculate the crc-16 for TouchCom packet. + * + * @param + * [ in] p: byte array for the calculation + * [ in] len: length in bytes + * [ in] val: the initial value given + * + * @return + * the crc-16 value + */ +static inline unsigned short syna_tcm_crc16(unsigned char *p, + unsigned int len, unsigned short val) +{ + unsigned short r = val; + static unsigned short crc16_table[256] = { + 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7, + 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF, + 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6, + 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE, + 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485, + 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D, + 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4, + 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC, + 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823, + 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B, + 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12, + 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A, + 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41, + 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49, + 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70, + 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78, + 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F, + 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067, + 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E, + 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256, + 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D, + 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405, + 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C, + 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634, + 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB, + 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3, + 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A, + 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92, + 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9, + 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1, + 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8, + 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0 + }; + + if (len == 0) + return r; + + while (len--) + r = (r << 8) ^ crc16_table[(r >> 8) ^ *p++]; + + return r; +} + #endif /* end of _SYNAPTICS_TOUCHCOM_CORE_DEV_H_ */ -- cgit v1.2.3