1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Elan I2C/SMBus Touchpad driver 4 * 5 * Copyright (c) 2013 ELAN Microelectronics Corp. 6 * 7 * Author: 林政維 (Duson Lin) <dusonlin@emc.com.tw> 8 * 9 * Based on cyapa driver: 10 * copyright (c) 2011-2012 Cypress Semiconductor, Inc. 11 * copyright (c) 2011-2012 Google, Inc. 12 * 13 * Trademarks are the property of their respective owners. 14 */ 15 16 #ifndef _ELAN_I2C_H 17 #define _ELAN_I2C_H 18 19 #include <linux/types.h> 20 21 #define ETP_ENABLE_ABS 0x0001 22 #define ETP_ENABLE_CALIBRATE 0x0002 23 #define ETP_DISABLE_CALIBRATE 0x0000 24 #define ETP_DISABLE_POWER 0x0001 25 #define ETP_PRESSURE_OFFSET 25 26 27 #define ETP_CALIBRATE_MAX_LEN 3 28 29 #define ETP_FEATURE_REPORT_MK BIT(0) 30 31 #define ETP_REPORT_ID 0x5D 32 #define ETP_TP_REPORT_ID 0x5E 33 #define ETP_TP_REPORT_ID2 0x5F 34 #define ETP_REPORT_ID2 0x60 /* High precision report */ 35 36 #define ETP_REPORT_ID_OFFSET 2 37 #define ETP_TOUCH_INFO_OFFSET 3 38 #define ETP_FINGER_DATA_OFFSET 4 39 #define ETP_HOVER_INFO_OFFSET 30 40 #define ETP_MK_DATA_OFFSET 33 /* For high precision reports */ 41 42 #define ETP_MAX_REPORT_LEN 39 43 44 #define ETP_MAX_FINGERS 5 45 #define ETP_FINGER_DATA_LEN 5 46 47 /* IAP Firmware handling */ 48 #define ETP_PRODUCT_ID_FORMAT_STRING "%d.0" 49 #define ETP_FW_NAME "elan_i2c_" ETP_PRODUCT_ID_FORMAT_STRING ".bin" 50 #define ETP_IAP_START_ADDR 0x0083 51 #define ETP_FW_IAP_PAGE_ERR (1 << 5) 52 #define ETP_FW_IAP_INTF_ERR (1 << 4) 53 #define ETP_FW_PAGE_SIZE 64 54 #define ETP_FW_PAGE_SIZE_128 128 55 #define ETP_FW_PAGE_SIZE_512 512 56 #define ETP_FW_SIGNATURE_SIZE 6 57 58 struct i2c_client; 59 struct completion; 60 61 enum tp_mode { 62 IAP_MODE = 1, 63 MAIN_MODE 64 }; 65 66 struct elan_transport_ops { 67 int (*initialize)(struct i2c_client *client); 68 int (*sleep_control)(struct i2c_client *, bool sleep); 69 int (*power_control)(struct i2c_client *, bool enable); 70 int (*set_mode)(struct i2c_client *client, u8 mode); 71 72 int (*calibrate)(struct i2c_client *client); 73 int (*calibrate_result)(struct i2c_client *client, u8 *val); 74 75 int (*get_baseline_data)(struct i2c_client *client, 76 bool max_baseliune, u8 *value); 77 78 int (*get_version)(struct i2c_client *client, u8 pattern, bool iap, 79 u8 *version); 80 int (*get_sm_version)(struct i2c_client *client, u8 pattern, 81 u16 *ic_type, u8 *version, u8 *clickpad); 82 int (*get_checksum)(struct i2c_client *client, bool iap, u16 *csum); 83 int (*get_product_id)(struct i2c_client *client, u16 *id); 84 85 int (*get_max)(struct i2c_client *client, 86 unsigned int *max_x, unsigned int *max_y); 87 int (*get_resolution)(struct i2c_client *client, 88 u8 *hw_res_x, u8 *hw_res_y); 89 int (*get_num_traces)(struct i2c_client *client, 90 unsigned int *x_tracenum, 91 unsigned int *y_tracenum); 92 93 int (*iap_get_mode)(struct i2c_client *client, enum tp_mode *mode); 94 int (*iap_reset)(struct i2c_client *client); 95 96 int (*prepare_fw_update)(struct i2c_client *client, u16 ic_type, 97 u8 iap_version, u16 fw_page_size); 98 int (*write_fw_block)(struct i2c_client *client, u16 fw_page_size, 99 const u8 *page, u16 checksum, int idx); 100 int (*finish_fw_update)(struct i2c_client *client, 101 struct completion *reset_done); 102 103 int (*get_report_features)(struct i2c_client *client, u8 pattern, 104 unsigned int *features, 105 unsigned int *report_len); 106 int (*get_report)(struct i2c_client *client, u8 *report, 107 unsigned int report_len); 108 int (*get_pressure_adjustment)(struct i2c_client *client, 109 int *adjustment); 110 int (*get_pattern)(struct i2c_client *client, u8 *pattern); 111 }; 112 113 extern const struct elan_transport_ops elan_smbus_ops, elan_i2c_ops; 114 115 #endif /* _ELAN_I2C_H */ 116