1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (c) 2011-2016 Synaptics Incorporated
4 * Copyright (c) 2011 Unixphere
9 #include <linux/kernel.h>
10 #include <linux/device.h>
11 #include <linux/interrupt.h>
12 #include <linux/input.h>
13 #include <linux/kfifo.h>
14 #include <linux/list.h>
15 #include <linux/module.h>
16 #include <linux/types.h>
18 #define NAME_BUFFER_SIZE 256
21 * struct rmi_2d_axis_alignment - target axis alignment
22 * @swap_axes: set to TRUE if desired to swap x- and y-axis
23 * @flip_x: set to TRUE if desired to flip direction on x-axis
24 * @flip_y: set to TRUE if desired to flip direction on y-axis
25 * @clip_x_low - reported X coordinates below this setting will be clipped to
27 * @clip_x_high - reported X coordinates above this setting will be clipped to
29 * @clip_y_low - reported Y coordinates below this setting will be clipped to
31 * @clip_y_high - reported Y coordinates above this setting will be clipped to
33 * @offset_x - this value will be added to all reported X coordinates
34 * @offset_y - this value will be added to all reported Y coordinates
35 * @rel_report_enabled - if set to true, the relative reporting will be
36 * automatically enabled for this sensor.
38 struct rmi_2d_axis_alignment {
52 /** This is used to override any hints an F11 2D sensor might have provided
53 * as to what type of sensor it is.
55 * @rmi_f11_sensor_default - do not override, determine from F11_2D_QUERY14 if
57 * @rmi_f11_sensor_touchscreen - treat the sensor as a touchscreen (direct
59 * @rmi_f11_sensor_touchpad - thread the sensor as a touchpad (indirect
62 enum rmi_sensor_type {
63 rmi_sensor_default = 0,
64 rmi_sensor_touchscreen,
68 #define RMI_F11_DISABLE_ABS_REPORT BIT(0)
71 * struct rmi_2d_sensor_data - overrides defaults for a 2D sensor.
72 * @axis_align - provides axis alignment overrides (see above).
73 * @sensor_type - Forces the driver to treat the sensor as an indirect
74 * pointing device (touchpad) rather than a direct pointing device
75 * (touchscreen). This is useful when F11_2D_QUERY14 register is not
77 * @disable_report_mask - Force data to not be reported even if it is supported
79 * @topbuttonpad - Used with the "5 buttons touchpads" found on the Lenovo 40
81 * @kernel_tracking - most moderns RMI f11 firmwares implement Multifinger
82 * Type B protocol. However, there are some corner cases where the user
83 * triggers some jumps by tapping with two fingers on the touchpad.
84 * Use this setting and dmax to filter out these jumps.
85 * Also, when using an old sensor using MF Type A behavior, set to true to
86 * report an actual MT protocol B.
87 * @dmax - the maximum distance (in sensor units) the kernel tracking allows two
88 * distincts fingers to be considered the same.
90 struct rmi_2d_sensor_platform_data {
91 struct rmi_2d_axis_alignment axis_align;
92 enum rmi_sensor_type sensor_type;
95 int disable_report_mask;
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 PS/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;
121 * Set the state of a register
122 * DEFAULT - use the default value set by the firmware config
123 * OFF - explicitly disable the register
124 * ON - explicitly enable the register
127 RMI_REG_STATE_DEFAULT = 0,
128 RMI_REG_STATE_OFF = 1,
133 * struct rmi_f01_power_management -When non-zero, these values will be written
134 * to the touch sensor to override the default firmware settigns. For a
135 * detailed explanation of what each field does, see the corresponding
136 * documention in the RMI4 specification.
138 * @nosleep - specifies whether the device is permitted to sleep or doze (that
139 * is, enter a temporary low power state) when no fingers are touching the
141 * @wakeup_threshold - controls the capacitance threshold at which the touch
142 * sensor will decide to wake up from that low power state.
143 * @doze_holdoff - controls how long the touch sensor waits after the last
144 * finger lifts before entering the doze state, in units of 100ms.
145 * @doze_interval - controls the interval between checks for finger presence
146 * when the touch sensor is in doze mode, in units of 10ms.
148 struct rmi_f01_power_management {
149 enum rmi_reg_state nosleep;
156 * struct rmi_device_platform_data_spi - provides parameters used in SPI
157 * communications. All Synaptics SPI products support a standard SPI
158 * interface; some also support what is called SPI V2 mode, depending on
159 * firmware and/or ASIC limitations. In V2 mode, the touch sensor can
160 * support shorter delays during certain operations, and these are specified
161 * separately from the standard mode delays.
163 * @block_delay - for standard SPI transactions consisting of both a read and
164 * write operation, the delay (in microseconds) between the read and write
166 * @split_read_block_delay_us - for V2 SPI transactions consisting of both a
167 * read and write operation, the delay (in microseconds) between the read and
169 * @read_delay_us - the delay between each byte of a read operation in normal
171 * @write_delay_us - the delay between each byte of a write operation in normal
173 * @split_read_byte_delay_us - the delay between each byte of a read operation
175 * @pre_delay_us - the delay before the start of a SPI transaction. This is
176 * typically useful in conjunction with custom chip select assertions (see
178 * @post_delay_us - the delay after the completion of an SPI transaction. This
179 * is typically useful in conjunction with custom chip select assertions (see
181 * @cs_assert - For systems where the SPI subsystem does not control the CS/SSB
182 * line, or where such control is broken, you can provide a custom routine to
183 * handle a GPIO as CS/SSB. This routine will be called at the beginning and
184 * end of each SPI transaction. The RMI SPI implementation will wait
185 * pre_delay_us after this routine returns before starting the SPI transfer;
186 * and post_delay_us after completion of the SPI transfer(s) before calling it
187 * with assert==FALSE.
189 struct rmi_device_platform_data_spi {
191 u32 split_read_block_delay_us;
194 u32 split_read_byte_delay_us;
200 void *cs_assert_data;
201 int (*cs_assert)(const void *cs_assert_data, const bool assert);
205 * struct rmi_device_platform_data - system specific configuration info.
207 * @reset_delay_ms - after issuing a reset command to the touch sensor, the
208 * driver waits a few milliseconds to give the firmware a chance to
209 * re-initialize. You can override the default wait period here.
210 * @irq: irq associated with the attn gpio line, or negative
212 struct rmi_device_platform_data {
216 struct rmi_device_platform_data_spi spi_data;
218 /* function handler pdata */
219 struct rmi_2d_sensor_platform_data sensor_pdata;
220 struct rmi_f01_power_management power_management;
221 struct rmi_f30_data f30_data;
225 * struct rmi_function_descriptor - RMI function base addresses
227 * @query_base_addr: The RMI Query base address
228 * @command_base_addr: The RMI Command base address
229 * @control_base_addr: The RMI Control base address
230 * @data_base_addr: The RMI Data base address
231 * @interrupt_source_count: The number of irqs this RMI function needs
232 * @function_number: The RMI function number
234 * This struct is used when iterating the Page Description Table. The addresses
235 * are 16-bit values to include the current page address.
238 struct rmi_function_descriptor {
240 u16 command_base_addr;
241 u16 control_base_addr;
243 u8 interrupt_source_count;
251 * struct rmi_transport_dev - represent an RMI transport device
253 * @dev: Pointer to the communication device, e.g. i2c or spi
254 * @rmi_dev: Pointer to the RMI device
255 * @proto_name: name of the transport protocol (SPI, i2c, etc)
256 * @ops: pointer to transport operations implementation
258 * The RMI transport device implements the glue between different communication
259 * buses such as I2C and SPI.
262 struct rmi_transport_dev {
264 struct rmi_device *rmi_dev;
266 const char *proto_name;
267 const struct rmi_transport_ops *ops;
269 struct rmi_device_platform_data pdata;
271 struct input_dev *input;
275 * struct rmi_transport_ops - defines transport protocol operations.
277 * @write_block: Writing a block of data to the specified address
278 * @read_block: Read a block of data from the specified address.
280 struct rmi_transport_ops {
281 int (*write_block)(struct rmi_transport_dev *xport, u16 addr,
282 const void *buf, size_t len);
283 int (*read_block)(struct rmi_transport_dev *xport, u16 addr,
284 void *buf, size_t len);
285 int (*reset)(struct rmi_transport_dev *xport, u16 reset_addr);
289 * struct rmi_driver - driver for an RMI4 sensor on the RMI bus.
291 * @driver: Device driver model driver
292 * @reset_handler: Called when a reset is detected.
293 * @clear_irq_bits: Clear the specified bits in the current interrupt mask.
294 * @set_irq_bist: Set the specified bits in the current interrupt mask.
295 * @store_productid: Callback for cache product id from function 01
296 * @data: Private data pointer
300 struct device_driver driver;
302 int (*reset_handler)(struct rmi_device *rmi_dev);
303 int (*clear_irq_bits)(struct rmi_device *rmi_dev, unsigned long *mask);
304 int (*set_irq_bits)(struct rmi_device *rmi_dev, unsigned long *mask);
305 int (*store_productid)(struct rmi_device *rmi_dev);
306 int (*set_input_params)(struct rmi_device *rmi_dev,
307 struct input_dev *input);
312 * struct rmi_device - represents an RMI4 sensor device on the RMI bus.
314 * @dev: The device created for the RMI bus
315 * @number: Unique number for the device on the bus.
316 * @driver: Pointer to associated driver
317 * @xport: Pointer to the transport interface
324 struct rmi_driver *driver;
325 struct rmi_transport_dev *xport;
329 struct rmi4_attn_data {
330 unsigned long irq_status;
335 struct rmi_driver_data {
336 struct list_head function_list;
338 struct rmi_device *rmi_dev;
340 struct rmi_function *f01_container;
341 struct rmi_function *f34_container;
342 bool bootloader_mode;
347 unsigned long *irq_status;
348 unsigned long *fn_irq_bits;
349 unsigned long *current_irq_mask;
350 unsigned long *new_irq_mask;
351 struct mutex irq_mutex;
352 struct input_dev *input;
354 struct irq_domain *irqdomain;
358 u8 num_rx_electrodes;
359 u8 num_tx_electrodes;
362 struct mutex enabled_mutex;
364 struct rmi4_attn_data attn_data;
365 DECLARE_KFIFO(attn_fifo, struct rmi4_attn_data, 16);
368 int rmi_register_transport_device(struct rmi_transport_dev *xport);
369 void rmi_unregister_transport_device(struct rmi_transport_dev *xport);
371 void rmi_set_attn_data(struct rmi_device *rmi_dev, unsigned long irq_status,
372 void *data, size_t size);
374 int rmi_driver_suspend(struct rmi_device *rmi_dev, bool enable_wake);
375 int rmi_driver_resume(struct rmi_device *rmi_dev, bool clear_wake);