Commit 7e909891 authored by Lee Jones's avatar Lee Jones Committed by Dmitry Torokhov

Input: synaptics-rmi4 - fix kerneldoc warnings

Fixes the kerneldoc warnings from building the driver with W=1.
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20201104162427.2984742-2-lee.jones@linaro.org
[dtor: folded together several Lee's patches; added more descriptions]
Signed-off-by: default avatarDmitry Torokhov <dmitry.torokhov@gmail.com>
parent 45353186
...@@ -286,7 +286,7 @@ void rmi_unregister_function(struct rmi_function *fn) ...@@ -286,7 +286,7 @@ void rmi_unregister_function(struct rmi_function *fn)
/** /**
* rmi_register_function_handler - register a handler for an RMI function * rmi_register_function_handler - register a handler for an RMI function
* @handler: RMI handler that should be registered. * @handler: RMI handler that should be registered.
* @module: pointer to module that implements the handler * @owner: pointer to module that implements the handler
* @mod_name: name of the module implementing the handler * @mod_name: name of the module implementing the handler
* *
* This function performs additional setup of RMI function handler and * This function performs additional setup of RMI function handler and
......
...@@ -103,12 +103,14 @@ struct f01_basic_properties { ...@@ -103,12 +103,14 @@ struct f01_basic_properties {
#define RMI_F01_CTRL0_CONFIGURED_BIT BIT(7) #define RMI_F01_CTRL0_CONFIGURED_BIT BIT(7)
/** /**
* @ctrl0 - see the bit definitions above. * struct f01_device_control - controls basic sensor functions
* @doze_interval - controls the interval between checks for finger presence *
* @ctrl0: see the bit definitions above.
* @doze_interval: controls the interval between checks for finger presence
* when the touch sensor is in doze mode, in units of 10ms. * when the touch sensor is in doze mode, in units of 10ms.
* @wakeup_threshold - controls the capacitance threshold at which the touch * @wakeup_threshold: controls the capacitance threshold at which the touch
* sensor will decide to wake up from that low power state. * sensor will decide to wake up from that low power state.
* @doze_holdoff - controls how long the touch sensor waits after the last * @doze_holdoff: controls how long the touch sensor waits after the last
* finger lifts before entering the doze state, in units of 100ms. * finger lifts before entering the doze state, in units of 100ms.
*/ */
struct f01_device_control { struct f01_device_control {
......
This diff is collapsed.
...@@ -42,6 +42,8 @@ ...@@ -42,6 +42,8 @@
/** /**
* enum rmi_f54_report_type - RMI4 F54 report types * enum rmi_f54_report_type - RMI4 F54 report types
* *
* @F54_REPORT_NONE: No Image Report.
*
* @F54_8BIT_IMAGE: Normalized 8-Bit Image Report. The capacitance variance * @F54_8BIT_IMAGE: Normalized 8-Bit Image Report. The capacitance variance
* from baseline for each pixel. * from baseline for each pixel.
* *
...@@ -64,6 +66,10 @@ ...@@ -64,6 +66,10 @@
* Report. Set Low reference to its minimum value and high * Report. Set Low reference to its minimum value and high
* references to its maximum value, then report the raw * references to its maximum value, then report the raw
* capacitance for each pixel. * capacitance for each pixel.
*
* @F54_MAX_REPORT_TYPE:
* Maximum number of Report Types. Used for sanity
* checking.
*/ */
enum rmi_f54_report_type { enum rmi_f54_report_type {
F54_REPORT_NONE = 0, F54_REPORT_NONE = 0,
......
...@@ -17,12 +17,16 @@ ...@@ -17,12 +17,16 @@
* struct rmi_i2c_xport - stores information for i2c communication * struct rmi_i2c_xport - stores information for i2c communication
* *
* @xport: The transport interface structure * @xport: The transport interface structure
* @client: The I2C client device structure
* *
* @page_mutex: Locks current page to avoid changing pages in unexpected ways. * @page_mutex: Locks current page to avoid changing pages in unexpected ways.
* @page: Keeps track of the current virtual page * @page: Keeps track of the current virtual page
* *
* @tx_buf: Buffer used for transmitting data to the sensor over i2c. * @tx_buf: Buffer used for transmitting data to the sensor over i2c.
* @tx_buf_size: Size of the buffer * @tx_buf_size: Size of the buffer
*
* @supplies: Array of voltage regulators
* @startup_delay: Milliseconds to pause after powering up the regulators
*/ */
struct rmi_i2c_xport { struct rmi_i2c_xport {
struct rmi_transport_dev xport; struct rmi_transport_dev xport;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment