2 * Copyright (c) 2011-2016 Synaptics Incorporated
3 * Copyright (c) 2011 Unixphere
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
12 #include <linux/kernel.h>
13 #include <linux/device.h>
14 #include <linux/interrupt.h>
15 #include <linux/input.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
18 #include <linux/types.h>
20 #define NAME_BUFFER_SIZE 256
23 * struct rmi_2d_axis_alignment - target axis alignment
24 * @swap_axes: set to TRUE if desired to swap x- and y-axis
25 * @flip_x: set to TRUE if desired to flip direction on x-axis
26 * @flip_y: set to TRUE if desired to flip direction on y-axis
27 * @clip_x_low - reported X coordinates below this setting will be clipped to
29 * @clip_x_high - reported X coordinates above this setting will be clipped to
31 * @clip_y_low - reported Y coordinates below this setting will be clipped to
33 * @clip_y_high - reported Y coordinates above this setting will be clipped to
35 * @offset_x - this value will be added to all reported X coordinates
36 * @offset_y - this value will be added to all reported Y coordinates
37 * @rel_report_enabled - if set to true, the relative reporting will be
38 * automatically enabled for this sensor.
40 struct rmi_2d_axis_alignment {
54 /** This is used to override any hints an F11 2D sensor might have provided
55 * as to what type of sensor it is.
57 * @rmi_f11_sensor_default - do not override, determine from F11_2D_QUERY14 if
59 * @rmi_f11_sensor_touchscreen - treat the sensor as a touchscreen (direct
61 * @rmi_f11_sensor_touchpad - thread the sensor as a touchpad (indirect
64 enum rmi_sensor_type {
65 rmi_sensor_default = 0,
66 rmi_sensor_touchscreen,
70 #define RMI_F11_DISABLE_ABS_REPORT BIT(0)
73 * struct rmi_2d_sensor_data - overrides defaults for a 2D sensor.
74 * @axis_align - provides axis alignment overrides (see above).
75 * @sensor_type - Forces the driver to treat the sensor as an indirect
76 * pointing device (touchpad) rather than a direct pointing device
77 * (touchscreen). This is useful when F11_2D_QUERY14 register is not
79 * @disable_report_mask - Force data to not be reported even if it is supported
81 * @topbuttonpad - Used with the "5 buttons touchpads" found on the Lenovo 40
83 * @kernel_tracking - most moderns RMI f11 firmwares implement Multifinger
84 * Type B protocol. However, there are some corner cases where the user
85 * triggers some jumps by tapping with two fingers on the touchpad.
86 * Use this setting and dmax to filter out these jumps.
87 * Also, when using an old sensor using MF Type A behavior, set to true to
88 * report an actual MT protocol B.
89 * @dmax - the maximum distance (in sensor units) the kernel tracking allows two
90 * distincts fingers to be considered the same.
92 struct rmi_2d_sensor_platform_data {
93 struct rmi_2d_axis_alignment axis_align;
94 enum rmi_sensor_type sensor_type;
97 int disable_report_mask;
100 bool kernel_tracking;
105 * struct rmi_f30_data - overrides defaults for a single F30 GPIOs/LED chip.
106 * @buttonpad - the touchpad is a buttonpad, so enable only the first actual
107 * button that is found.
108 * @trackstick_buttons - Set when the function 30 is handling the physical
109 * buttons of the trackstick (as a PD/2 passthrough device.
110 * @disable - the touchpad incorrectly reports F30 and it should be ignored.
111 * This is a special case which is due to misconfigured firmware.
113 struct rmi_f30_data {
115 bool trackstick_buttons;
120 * struct rmi_f01_power - override default power management settings.
123 enum rmi_f01_nosleep {
124 RMI_F01_NOSLEEP_DEFAULT = 0,
125 RMI_F01_NOSLEEP_OFF = 1,
126 RMI_F01_NOSLEEP_ON = 2
130 * struct rmi_f01_power_management -When non-zero, these values will be written
131 * to the touch sensor to override the default firmware settigns. For a
132 * detailed explanation of what each field does, see the corresponding
133 * documention in the RMI4 specification.
135 * @nosleep - specifies whether the device is permitted to sleep or doze (that
136 * is, enter a temporary low power state) when no fingers are touching the
138 * @wakeup_threshold - controls the capacitance threshold at which the touch
139 * sensor will decide to wake up from that low power state.
140 * @doze_holdoff - controls how long the touch sensor waits after the last
141 * finger lifts before entering the doze state, in units of 100ms.
142 * @doze_interval - controls the interval between checks for finger presence
143 * when the touch sensor is in doze mode, in units of 10ms.
145 struct rmi_f01_power_management {
146 enum rmi_f01_nosleep nosleep;
153 * struct rmi_device_platform_data - system specific configuration info.
155 * @reset_delay_ms - after issuing a reset command to the touch sensor, the
156 * driver waits a few milliseconds to give the firmware a chance to
157 * to re-initialize. You can override the default wait period here.
159 struct rmi_device_platform_data {
162 /* function handler pdata */
163 struct rmi_2d_sensor_platform_data *sensor_pdata;
164 struct rmi_f01_power_management power_management;
165 struct rmi_f30_data *f30_data;
169 * struct rmi_function_descriptor - RMI function base addresses
171 * @query_base_addr: The RMI Query base address
172 * @command_base_addr: The RMI Command base address
173 * @control_base_addr: The RMI Control base address
174 * @data_base_addr: The RMI Data base address
175 * @interrupt_source_count: The number of irqs this RMI function needs
176 * @function_number: The RMI function number
178 * This struct is used when iterating the Page Description Table. The addresses
179 * are 16-bit values to include the current page address.
182 struct rmi_function_descriptor {
184 u16 command_base_addr;
185 u16 control_base_addr;
187 u8 interrupt_source_count;
195 * struct rmi_transport_dev - represent an RMI transport device
197 * @dev: Pointer to the communication device, e.g. i2c or spi
198 * @rmi_dev: Pointer to the RMI device
199 * @proto_name: name of the transport protocol (SPI, i2c, etc)
200 * @ops: pointer to transport operations implementation
202 * The RMI transport device implements the glue between different communication
203 * buses such as I2C and SPI.
206 struct rmi_transport_dev {
208 struct rmi_device *rmi_dev;
210 const char *proto_name;
211 const struct rmi_transport_ops *ops;
213 struct rmi_device_platform_data pdata;
215 struct input_dev *input;
222 * struct rmi_transport_ops - defines transport protocol operations.
224 * @write_block: Writing a block of data to the specified address
225 * @read_block: Read a block of data from the specified address.
227 struct rmi_transport_ops {
228 int (*write_block)(struct rmi_transport_dev *xport, u16 addr,
229 const void *buf, size_t len);
230 int (*read_block)(struct rmi_transport_dev *xport, u16 addr,
231 void *buf, size_t len);
232 int (*reset)(struct rmi_transport_dev *xport, u16 reset_addr);
236 * struct rmi_driver - driver for an RMI4 sensor on the RMI bus.
238 * @driver: Device driver model driver
239 * @reset_handler: Called when a reset is detected.
240 * @clear_irq_bits: Clear the specified bits in the current interrupt mask.
241 * @set_irq_bist: Set the specified bits in the current interrupt mask.
242 * @store_productid: Callback for cache product id from function 01
243 * @data: Private data pointer
247 struct device_driver driver;
249 int (*reset_handler)(struct rmi_device *rmi_dev);
250 int (*clear_irq_bits)(struct rmi_device *rmi_dev, unsigned long *mask);
251 int (*set_irq_bits)(struct rmi_device *rmi_dev, unsigned long *mask);
252 int (*store_productid)(struct rmi_device *rmi_dev);
253 int (*set_input_params)(struct rmi_device *rmi_dev,
254 struct input_dev *input);
259 * struct rmi_device - represents an RMI4 sensor device on the RMI bus.
261 * @dev: The device created for the RMI bus
262 * @number: Unique number for the device on the bus.
263 * @driver: Pointer to associated driver
264 * @xport: Pointer to the transport interface
271 struct rmi_driver *driver;
272 struct rmi_transport_dev *xport;
276 struct rmi_driver_data {
277 struct list_head function_list;
279 struct rmi_device *rmi_dev;
281 struct rmi_function *f01_container;
282 bool f01_bootloader_mode;
287 unsigned long *irq_status;
288 unsigned long *fn_irq_bits;
289 unsigned long *current_irq_mask;
290 unsigned long *new_irq_mask;
291 struct mutex irq_mutex;
292 struct input_dev *input;
302 int rmi_register_transport_device(struct rmi_transport_dev *xport);
303 void rmi_unregister_transport_device(struct rmi_transport_dev *xport);
304 int rmi_process_interrupt_requests(struct rmi_device *rmi_dev);
306 int rmi_driver_suspend(struct rmi_device *rmi_dev);
307 int rmi_driver_resume(struct rmi_device *rmi_dev);