elan_i2c.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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. #ifndef _ELAN_I2C_H
  16. #define _ELAN_I2C_H
  17. #include <linux/types.h>
  18. #define ETP_ENABLE_ABS 0x0001
  19. #define ETP_ENABLE_CALIBRATE 0x0002
  20. #define ETP_DISABLE_CALIBRATE 0x0000
  21. #define ETP_DISABLE_POWER 0x0001
  22. #define ETP_PRESSURE_OFFSET 25
  23. #define ETP_CALIBRATE_MAX_LEN 3
  24. #define ETP_FEATURE_REPORT_MK BIT(0)
  25. #define ETP_REPORT_ID 0x5D
  26. #define ETP_TP_REPORT_ID 0x5E
  27. #define ETP_TP_REPORT_ID2 0x5F
  28. #define ETP_REPORT_ID2 0x60 /* High precision report */
  29. #define ETP_REPORT_ID_OFFSET 2
  30. #define ETP_TOUCH_INFO_OFFSET 3
  31. #define ETP_FINGER_DATA_OFFSET 4
  32. #define ETP_HOVER_INFO_OFFSET 30
  33. #define ETP_MK_DATA_OFFSET 33 /* For high precision reports */
  34. #define ETP_MAX_REPORT_LEN 39
  35. #define ETP_MAX_FINGERS 5
  36. #define ETP_FINGER_DATA_LEN 5
  37. /* IAP Firmware handling */
  38. #define ETP_PRODUCT_ID_FORMAT_STRING "%d.0"
  39. #define ETP_FW_NAME "elan_i2c_" ETP_PRODUCT_ID_FORMAT_STRING ".bin"
  40. #define ETP_IAP_START_ADDR 0x0083
  41. #define ETP_FW_IAP_PAGE_ERR (1 << 5)
  42. #define ETP_FW_IAP_INTF_ERR (1 << 4)
  43. #define ETP_FW_PAGE_SIZE 64
  44. #define ETP_FW_PAGE_SIZE_128 128
  45. #define ETP_FW_PAGE_SIZE_512 512
  46. #define ETP_FW_SIGNATURE_SIZE 6
  47. struct i2c_client;
  48. struct completion;
  49. enum tp_mode {
  50. IAP_MODE = 1,
  51. MAIN_MODE
  52. };
  53. struct elan_transport_ops {
  54. int (*initialize)(struct i2c_client *client);
  55. int (*sleep_control)(struct i2c_client *, bool sleep);
  56. int (*power_control)(struct i2c_client *, bool enable);
  57. int (*set_mode)(struct i2c_client *client, u8 mode);
  58. int (*calibrate)(struct i2c_client *client);
  59. int (*calibrate_result)(struct i2c_client *client, u8 *val);
  60. int (*get_baseline_data)(struct i2c_client *client,
  61. bool max_baseliune, u8 *value);
  62. int (*get_version)(struct i2c_client *client, u8 pattern, bool iap,
  63. u8 *version);
  64. int (*get_sm_version)(struct i2c_client *client, u8 pattern,
  65. u16 *ic_type, u8 *version, u8 *clickpad);
  66. int (*get_checksum)(struct i2c_client *client, bool iap, u16 *csum);
  67. int (*get_product_id)(struct i2c_client *client, u16 *id);
  68. int (*get_max)(struct i2c_client *client,
  69. unsigned int *max_x, unsigned int *max_y);
  70. int (*get_resolution)(struct i2c_client *client,
  71. u8 *hw_res_x, u8 *hw_res_y);
  72. int (*get_num_traces)(struct i2c_client *client,
  73. unsigned int *x_tracenum,
  74. unsigned int *y_tracenum);
  75. int (*iap_get_mode)(struct i2c_client *client, enum tp_mode *mode);
  76. int (*iap_reset)(struct i2c_client *client);
  77. int (*prepare_fw_update)(struct i2c_client *client, u16 ic_type,
  78. u8 iap_version, u16 fw_page_size);
  79. int (*write_fw_block)(struct i2c_client *client, u16 fw_page_size,
  80. const u8 *page, u16 checksum, int idx);
  81. int (*finish_fw_update)(struct i2c_client *client,
  82. struct completion *reset_done);
  83. int (*get_report_features)(struct i2c_client *client, u8 pattern,
  84. unsigned int *features,
  85. unsigned int *report_len);
  86. int (*get_report)(struct i2c_client *client, u8 *report,
  87. unsigned int report_len);
  88. int (*get_pressure_adjustment)(struct i2c_client *client,
  89. int *adjustment);
  90. int (*get_pattern)(struct i2c_client *client, u8 *pattern);
  91. };
  92. extern const struct elan_transport_ops elan_smbus_ops, elan_i2c_ops;
  93. #endif /* _ELAN_I2C_H */