1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (c) 2011-2016 Synaptics Incorporated
4*4882a593Smuzhiyun * Copyright (c) 2011 Unixphere
5*4882a593Smuzhiyun */
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun #ifndef _RMI_DRIVER_H
8*4882a593Smuzhiyun #define _RMI_DRIVER_H
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <linux/ctype.h>
11*4882a593Smuzhiyun #include <linux/hrtimer.h>
12*4882a593Smuzhiyun #include <linux/ktime.h>
13*4882a593Smuzhiyun #include <linux/input.h>
14*4882a593Smuzhiyun #include "rmi_bus.h"
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun #define SYNAPTICS_INPUT_DEVICE_NAME "Synaptics RMI4 Touch Sensor"
17*4882a593Smuzhiyun #define SYNAPTICS_VENDOR_ID 0x06cb
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define GROUP(_attrs) { \
20*4882a593Smuzhiyun .attrs = _attrs, \
21*4882a593Smuzhiyun }
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #define PDT_PROPERTIES_LOCATION 0x00EF
24*4882a593Smuzhiyun #define BSR_LOCATION 0x00FE
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #define RMI_PDT_PROPS_HAS_BSR 0x02
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun #define NAME_BUFFER_SIZE 256
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun #define RMI_PDT_ENTRY_SIZE 6
31*4882a593Smuzhiyun #define RMI_PDT_FUNCTION_VERSION_MASK 0x60
32*4882a593Smuzhiyun #define RMI_PDT_INT_SOURCE_COUNT_MASK 0x07
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun #define PDT_START_SCAN_LOCATION 0x00e9
35*4882a593Smuzhiyun #define PDT_END_SCAN_LOCATION 0x0005
36*4882a593Smuzhiyun #define RMI4_END_OF_PDT(id) ((id) == 0x00 || (id) == 0xff)
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun struct pdt_entry {
39*4882a593Smuzhiyun u16 page_start;
40*4882a593Smuzhiyun u8 query_base_addr;
41*4882a593Smuzhiyun u8 command_base_addr;
42*4882a593Smuzhiyun u8 control_base_addr;
43*4882a593Smuzhiyun u8 data_base_addr;
44*4882a593Smuzhiyun u8 interrupt_source_count;
45*4882a593Smuzhiyun u8 function_version;
46*4882a593Smuzhiyun u8 function_number;
47*4882a593Smuzhiyun };
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun #define RMI_REG_DESC_PRESENSE_BITS (32 * BITS_PER_BYTE)
50*4882a593Smuzhiyun #define RMI_REG_DESC_SUBPACKET_BITS (37 * BITS_PER_BYTE)
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun /* describes a single packet register */
53*4882a593Smuzhiyun struct rmi_register_desc_item {
54*4882a593Smuzhiyun u16 reg;
55*4882a593Smuzhiyun unsigned long reg_size;
56*4882a593Smuzhiyun u8 num_subpackets;
57*4882a593Smuzhiyun unsigned long subpacket_map[BITS_TO_LONGS(
58*4882a593Smuzhiyun RMI_REG_DESC_SUBPACKET_BITS)];
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun /*
62*4882a593Smuzhiyun * describes the packet registers for a particular type
63*4882a593Smuzhiyun * (ie query, control, data)
64*4882a593Smuzhiyun */
65*4882a593Smuzhiyun struct rmi_register_descriptor {
66*4882a593Smuzhiyun unsigned long struct_size;
67*4882a593Smuzhiyun unsigned long presense_map[BITS_TO_LONGS(RMI_REG_DESC_PRESENSE_BITS)];
68*4882a593Smuzhiyun u8 num_registers;
69*4882a593Smuzhiyun struct rmi_register_desc_item *registers;
70*4882a593Smuzhiyun };
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun int rmi_read_register_desc(struct rmi_device *d, u16 addr,
73*4882a593Smuzhiyun struct rmi_register_descriptor *rdesc);
74*4882a593Smuzhiyun const struct rmi_register_desc_item *rmi_get_register_desc_item(
75*4882a593Smuzhiyun struct rmi_register_descriptor *rdesc, u16 reg);
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun /*
78*4882a593Smuzhiyun * Calculate the total size of all of the registers described in the
79*4882a593Smuzhiyun * descriptor.
80*4882a593Smuzhiyun */
81*4882a593Smuzhiyun size_t rmi_register_desc_calc_size(struct rmi_register_descriptor *rdesc);
82*4882a593Smuzhiyun int rmi_register_desc_calc_reg_offset(
83*4882a593Smuzhiyun struct rmi_register_descriptor *rdesc, u16 reg);
84*4882a593Smuzhiyun bool rmi_register_desc_has_subpacket(const struct rmi_register_desc_item *item,
85*4882a593Smuzhiyun u8 subpacket);
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun bool rmi_is_physical_driver(struct device_driver *);
88*4882a593Smuzhiyun int rmi_register_physical_driver(void);
89*4882a593Smuzhiyun void rmi_unregister_physical_driver(void);
90*4882a593Smuzhiyun void rmi_free_function_list(struct rmi_device *rmi_dev);
91*4882a593Smuzhiyun struct rmi_function *rmi_find_function(struct rmi_device *rmi_dev, u8 number);
92*4882a593Smuzhiyun int rmi_enable_sensor(struct rmi_device *rmi_dev);
93*4882a593Smuzhiyun int rmi_scan_pdt(struct rmi_device *rmi_dev, void *ctx,
94*4882a593Smuzhiyun int (*callback)(struct rmi_device *rmi_dev, void *ctx,
95*4882a593Smuzhiyun const struct pdt_entry *entry));
96*4882a593Smuzhiyun int rmi_probe_interrupts(struct rmi_driver_data *data);
97*4882a593Smuzhiyun void rmi_enable_irq(struct rmi_device *rmi_dev, bool clear_wake);
98*4882a593Smuzhiyun void rmi_disable_irq(struct rmi_device *rmi_dev, bool enable_wake);
99*4882a593Smuzhiyun int rmi_init_functions(struct rmi_driver_data *data);
100*4882a593Smuzhiyun int rmi_initial_reset(struct rmi_device *rmi_dev, void *ctx,
101*4882a593Smuzhiyun const struct pdt_entry *pdt);
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun const char *rmi_f01_get_product_ID(struct rmi_function *fn);
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun #ifdef CONFIG_RMI4_F03
106*4882a593Smuzhiyun int rmi_f03_overwrite_button(struct rmi_function *fn, unsigned int button,
107*4882a593Smuzhiyun int value);
108*4882a593Smuzhiyun void rmi_f03_commit_buttons(struct rmi_function *fn);
109*4882a593Smuzhiyun #else
rmi_f03_overwrite_button(struct rmi_function * fn,unsigned int button,int value)110*4882a593Smuzhiyun static inline int rmi_f03_overwrite_button(struct rmi_function *fn,
111*4882a593Smuzhiyun unsigned int button, int value)
112*4882a593Smuzhiyun {
113*4882a593Smuzhiyun return 0;
114*4882a593Smuzhiyun }
rmi_f03_commit_buttons(struct rmi_function * fn)115*4882a593Smuzhiyun static inline void rmi_f03_commit_buttons(struct rmi_function *fn) {}
116*4882a593Smuzhiyun #endif
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun #ifdef CONFIG_RMI4_F34
119*4882a593Smuzhiyun int rmi_f34_create_sysfs(struct rmi_device *rmi_dev);
120*4882a593Smuzhiyun void rmi_f34_remove_sysfs(struct rmi_device *rmi_dev);
121*4882a593Smuzhiyun #else
rmi_f34_create_sysfs(struct rmi_device * rmi_dev)122*4882a593Smuzhiyun static inline int rmi_f34_create_sysfs(struct rmi_device *rmi_dev)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun return 0;
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun
rmi_f34_remove_sysfs(struct rmi_device * rmi_dev)127*4882a593Smuzhiyun static inline void rmi_f34_remove_sysfs(struct rmi_device *rmi_dev)
128*4882a593Smuzhiyun {
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun #endif /* CONFIG_RMI_F34 */
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f01_handler;
133*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f03_handler;
134*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f11_handler;
135*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f12_handler;
136*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f30_handler;
137*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f34_handler;
138*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f3a_handler;
139*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f54_handler;
140*4882a593Smuzhiyun extern struct rmi_function_handler rmi_f55_handler;
141*4882a593Smuzhiyun #endif
142