blob: a9074ac9364fd7eebbd2ebaae3fe98726e3c4c5e [file] [log] [blame]
David Brazdil0f672f62019-12-10 10:32:29 +00001/* SPDX-License-Identifier: GPL-2.0-only */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002/*
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 *
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000013 * 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/* IAP Firmware handling */
30#define ETP_PRODUCT_ID_FORMAT_STRING "%d.0"
31#define ETP_FW_NAME "elan_i2c_" ETP_PRODUCT_ID_FORMAT_STRING ".bin"
32#define ETP_IAP_START_ADDR 0x0083
33#define ETP_FW_IAP_PAGE_ERR (1 << 5)
34#define ETP_FW_IAP_INTF_ERR (1 << 4)
35#define ETP_FW_PAGE_SIZE 64
36#define ETP_FW_SIGNATURE_SIZE 6
37
38struct i2c_client;
39struct completion;
40
41enum tp_mode {
42 IAP_MODE = 1,
43 MAIN_MODE
44};
45
46struct elan_transport_ops {
47 int (*initialize)(struct i2c_client *client);
48 int (*sleep_control)(struct i2c_client *, bool sleep);
49 int (*power_control)(struct i2c_client *, bool enable);
50 int (*set_mode)(struct i2c_client *client, u8 mode);
51
52 int (*calibrate)(struct i2c_client *client);
53 int (*calibrate_result)(struct i2c_client *client, u8 *val);
54
55 int (*get_baseline_data)(struct i2c_client *client,
56 bool max_baseliune, u8 *value);
57
58 int (*get_version)(struct i2c_client *client, bool iap, u8 *version);
59 int (*get_sm_version)(struct i2c_client *client,
60 u16 *ic_type, u8 *version, u8 *clickpad);
61 int (*get_checksum)(struct i2c_client *client, bool iap, u16 *csum);
62 int (*get_product_id)(struct i2c_client *client, u16 *id);
63
64 int (*get_max)(struct i2c_client *client,
65 unsigned int *max_x, unsigned int *max_y);
66 int (*get_resolution)(struct i2c_client *client,
67 u8 *hw_res_x, u8 *hw_res_y);
68 int (*get_num_traces)(struct i2c_client *client,
69 unsigned int *x_tracenum,
70 unsigned int *y_tracenum);
71
72 int (*iap_get_mode)(struct i2c_client *client, enum tp_mode *mode);
73 int (*iap_reset)(struct i2c_client *client);
74
75 int (*prepare_fw_update)(struct i2c_client *client);
76 int (*write_fw_block)(struct i2c_client *client,
77 const u8 *page, u16 checksum, int idx);
78 int (*finish_fw_update)(struct i2c_client *client,
79 struct completion *reset_done);
80
81 int (*get_report)(struct i2c_client *client, u8 *report);
82 int (*get_pressure_adjustment)(struct i2c_client *client,
83 int *adjustment);
84 int (*get_pattern)(struct i2c_client *client, u8 *pattern);
85};
86
87extern const struct elan_transport_ops elan_smbus_ops, elan_i2c_ops;
88
89#endif /* _ELAN_I2C_H */