include/linux/rmi.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Copyright (c) 2011-2016 Synaptics Incorporated
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
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
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
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
87  * @dmax - the maximum distance (in sensor units) the kernel tracking allows two
105  * struct rmi_gpio_data - overrides defaults for a single F30/F3A GPIOs/LED
107  * @buttonpad - the touchpad is a buttonpad, so enable only the first actual
109  * @trackstick_buttons - Set when the function 30 or 3a is handling the physical
111  * @disable - the touchpad incorrectly reports F30/F3A and it should be ignored.
123  *	DEFAULT - use the default value set by the firmware config
124  *	OFF - explicitly disable the register
125  *	ON - explicitly enable the register
134  * struct rmi_f01_power_management -When non-zero, these values will be written
139  * @nosleep - specifies whether the device is permitted to sleep or doze (that
142  * @wakeup_threshold - controls the capacitance threshold at which the touch
144  * @doze_holdoff - controls how long the touch sensor waits after the last
146  * @doze_interval - controls the interval between checks for finger presence
157  * struct rmi_device_platform_data_spi - provides parameters used in SPI
164  * @block_delay - for standard SPI transactions consisting of both a read and
167  * @split_read_block_delay_us - for V2 SPI transactions consisting of both a
170  * @read_delay_us - the delay between each byte of a read operation in normal
172  * @write_delay_us - the delay between each byte of a write operation in normal
174  * @split_read_byte_delay_us - the delay between each byte of a read operation
176  * @pre_delay_us - the delay before the start of a SPI transaction.  This is
179  * @post_delay_us - the delay after the completion of an SPI transaction.  This
182  * @cs_assert - For systems where the SPI subsystem does not control the CS/SSB
206  * struct rmi_device_platform_data - system specific configuration info.
208  * @reset_delay_ms - after issuing a reset command to the touch sensor, the
210  * re-initialize.  You can override the default wait period here.
226  * struct rmi_function_descriptor - RMI function base addresses
236  * are 16-bit values to include the current page address.
252  * struct rmi_transport_dev - represent an RMI transport device
276  * struct rmi_transport_ops - defines transport protocol operations.
290  * struct rmi_driver - driver for an RMI4 sensor on the RMI bus.
313  * struct rmi_device - represents an RMI4 sensor device on the RMI bus.