diff mbox series

[16/20] input: misc: drv260x: Fix kernel-doc formatting and remove one abuse

Message ID 20201104162427.2984742-17-lee.jones@linaro.org
State Accepted
Commit 463a74c2d34db531269849c1a7d4c2089f210ea8
Headers show
Series Rid W=1 issues from Input | expand

Commit Message

Lee Jones Nov. 4, 2020, 4:24 p.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'input_dev' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'client' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regmap' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'work' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'enable_gpio' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regulator' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'magnitude' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'mode' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'library' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'rated_voltage' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'overdrive_voltage' not described in 'drv260x_data'
 drivers/input/misc/drv260x.c:244: warning: Function parameter or member 'voltage' not described in 'drv260x_calculate_voltage'

Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Dan Murphy <dmurphy@ti.com>
Cc: linux-input@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/input/misc/drv260x.c | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

Comments

Dmitry Torokhov Nov. 9, 2020, 6:13 a.m. UTC | #1
On Wed, Nov 04, 2020 at 04:24:23PM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'input_dev' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'client' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regmap' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'work' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'enable_gpio' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'regulator' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'magnitude' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'mode' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'library' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'rated_voltage' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:194: warning: Function parameter or member 'overdrive_voltage' not described in 'drv260x_data'

>  drivers/input/misc/drv260x.c:244: warning: Function parameter or member 'voltage' not described in 'drv260x_calculate_voltage'

> 

> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>

> Cc: Dan Murphy <dmurphy@ti.com>

> Cc: linux-input@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/input/misc/drv260x.c | 26 +++++++++++++-------------

>  1 file changed, 13 insertions(+), 13 deletions(-)

> 

> diff --git a/drivers/input/misc/drv260x.c b/drivers/input/misc/drv260x.c

> index 79d7fa710a714..fabe106d499d4 100644

> --- a/drivers/input/misc/drv260x.c

> +++ b/drivers/input/misc/drv260x.c

> @@ -167,17 +167,17 @@

>  

>  /**

>   * struct drv260x_data -

> - * @input_dev - Pointer to the input device

> - * @client - Pointer to the I2C client

> - * @regmap - Register map of the device

> - * @work - Work item used to off load the enable/disable of the vibration

> - * @enable_gpio - Pointer to the gpio used for enable/disabling

> - * @regulator - Pointer to the regulator for the IC

> - * @magnitude - Magnitude of the vibration event

> - * @mode - The operating mode of the IC (LRA_NO_CAL, ERM or LRA)

> - * @library - The vibration library to be used

> - * @rated_voltage - The rated_voltage of the actuator

> - * @overdriver_voltage - The over drive voltage of the actuator

> + * @input_dev: Pointer to the input device

> + * @client: Pointer to the I2C client

> + * @regmap: Register map of the device

> + * @work: Work item used to off load the enable/disable of the vibration

> + * @enable_gpio: Pointer to the gpio used for enable/disabling

> + * @regulator: Pointer to the regulator for the IC

> + * @magnitude: Magnitude of the vibration event

> + * @mode: The operating mode of the IC (LRA_NO_CAL, ERM or LRA)

> + * @library: The vibration library to be used

> + * @rated_voltage: The rated_voltage of the actuator

> + * @overdriver_voltage: The over drive voltage of the actuator


Applied with this typo fixed as well.

>  **/

>  struct drv260x_data {

>  	struct input_dev *input_dev;

> @@ -234,12 +234,12 @@ static const struct reg_default drv260x_reg_defs[] = {

>  #define DRV260X_DEF_RATED_VOLT		0x90

>  #define DRV260X_DEF_OD_CLAMP_VOLT	0x90

>  

> -/**

> +/*

>   * Rated and Overdriver Voltages:

>   * Calculated using the formula r = v * 255 / 5.6

>   * where r is what will be written to the register

>   * and v is the rated or overdriver voltage of the actuator

> - **/

> + */

>  static int drv260x_calculate_voltage(unsigned int voltage)

>  {

>  	return (voltage * 255 / 5600);

> -- 

> 2.25.1

> 


Thanks.

-- 
Dmitry
diff mbox series

Patch

diff --git a/drivers/input/misc/drv260x.c b/drivers/input/misc/drv260x.c
index 79d7fa710a714..fabe106d499d4 100644
--- a/drivers/input/misc/drv260x.c
+++ b/drivers/input/misc/drv260x.c
@@ -167,17 +167,17 @@ 
 
 /**
  * struct drv260x_data -
- * @input_dev - Pointer to the input device
- * @client - Pointer to the I2C client
- * @regmap - Register map of the device
- * @work - Work item used to off load the enable/disable of the vibration
- * @enable_gpio - Pointer to the gpio used for enable/disabling
- * @regulator - Pointer to the regulator for the IC
- * @magnitude - Magnitude of the vibration event
- * @mode - The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
- * @library - The vibration library to be used
- * @rated_voltage - The rated_voltage of the actuator
- * @overdriver_voltage - The over drive voltage of the actuator
+ * @input_dev: Pointer to the input device
+ * @client: Pointer to the I2C client
+ * @regmap: Register map of the device
+ * @work: Work item used to off load the enable/disable of the vibration
+ * @enable_gpio: Pointer to the gpio used for enable/disabling
+ * @regulator: Pointer to the regulator for the IC
+ * @magnitude: Magnitude of the vibration event
+ * @mode: The operating mode of the IC (LRA_NO_CAL, ERM or LRA)
+ * @library: The vibration library to be used
+ * @rated_voltage: The rated_voltage of the actuator
+ * @overdriver_voltage: The over drive voltage of the actuator
 **/
 struct drv260x_data {
 	struct input_dev *input_dev;
@@ -234,12 +234,12 @@  static const struct reg_default drv260x_reg_defs[] = {
 #define DRV260X_DEF_RATED_VOLT		0x90
 #define DRV260X_DEF_OD_CLAMP_VOLT	0x90
 
-/**
+/*
  * Rated and Overdriver Voltages:
  * Calculated using the formula r = v * 255 / 5.6
  * where r is what will be written to the register
  * and v is the rated or overdriver voltage of the actuator
- **/
+ */
 static int drv260x_calculate_voltage(unsigned int voltage)
 {
 	return (voltage * 255 / 5600);