[PATCH 00/11] thermal: clean up output of make W=1

[PATCH 00/11] thermal: clean up output of make W=1

[Amit Kucheria]

Cleanup output of make W=1 inside drivers/thermal. This should allow us to
focus on real issues that tend to get lost in the noise much better.

There is no functional change. This series was generate on top of
linux-next from 20191105.

Regards,
Amit

Amit Kucheria (11):
  thermal: of-thermal: Appease the kernel-doc deity
  thermal: cpu_cooling: Appease the kernel-doc deity
  thermal: step_wise: Appease the kernel-doc deity
  thermal: devfreq_cooling: Appease the kernel-doc deity
  thermal: max77620: Appease the kernel-doc deity
  thermal: mediatek: Appease the kernel-doc deity
  thermal: rockchip: Appease the kernel-doc deity
  thermal: samsung: Appease the kernel-doc deity
  thermal: tegra: Appease the kernel-doc deity
  thermal: amlogic: Appease the kernel-doc deity
  thermal: zx2967: Appease the kernel-doc deity

 drivers/thermal/amlogic_thermal.c    |  6 +++++-
 drivers/thermal/cpu_cooling.c        |  1 +
 drivers/thermal/devfreq_cooling.c    |  3 ++-
 drivers/thermal/fair_share.c         |  4 ++--
 drivers/thermal/gov_bang_bang.c      |  4 ++--
 drivers/thermal/max77620_thermal.c   |  2 +-
 drivers/thermal/mtk_thermal.c        | 12 ++++++------
 drivers/thermal/of-thermal.c         |  2 +-
 drivers/thermal/rockchip_thermal.c   | 22 ++++++++++++++++------
 drivers/thermal/samsung/exynos_tmu.c |  5 ++++-
 drivers/thermal/step_wise.c          |  4 ++--
 drivers/thermal/tegra/soctherm.c     | 15 +++++++++++++--
 drivers/thermal/user_space.c         |  4 ++--
 drivers/thermal/zx2967_thermal.c     |  1 +
 14 files changed, 58 insertions(+), 27 deletions(-)

-- 
2.17.1

[PATCH 07/11] thermal: rockchip: Appease the kernel-doc deity

[Amit Kucheria]

Replace a comment starting with /** by simply /* to avoid having it
interpreted as a kernel-doc comment. Describe missing function
parameters where needed.

Fixes up the following warnings when compiled with make W=1:

linux.git/drivers/thermal/rockchip_thermal.c:27: warning: cannot
understand function prototype: 'enum tshut_mode '
linux.git/drivers/thermal/rockchip_thermal.c:37: warning: cannot
understand function prototype: 'enum tshut_polarity '
linux.git/drivers/thermal/rockchip_thermal.c:46: warning: cannot
understand function prototype: 'enum sensor_id '
linux.git/drivers/thermal/rockchip_thermal.c:56: warning: cannot
understand function prototype: 'enum adc_sort_mode '
linux.git/drivers/thermal/rockchip_thermal.c:123: warning: Function
parameter or member 'chn_id' not described in 'rockchip_tsadc_chip'
linux.git/drivers/thermal/rockchip_thermal.c:123: warning: Function
parameter or member 'control' not described in 'rockchip_tsadc_chip'
linux.git/drivers/thermal/rockchip_thermal.c:167: warning: Function
parameter or member 'sensors' not described in 'rockchip_thermal_data'
linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function
parameter or member 'grf' not described in 'rk_tsadcv2_initialize'
linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function
parameter or member 'regs' not described in 'rk_tsadcv2_initialize'
linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function
parameter or member 'tshut_polarity' not described in
'rk_tsadcv2_initialize'
linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function
parameter or member 'grf' not described in 'rk_tsadcv3_initialize'
linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function
parameter or member 'regs' not described in 'rk_tsadcv3_initialize'
linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function
parameter or member 'tshut_polarity' not described in
'rk_tsadcv3_initialize'
linux.git/drivers/thermal/rockchip_thermal.c:732: warning: Function
parameter or member 'regs' not described in 'rk_tsadcv3_control'
linux.git/drivers/thermal/rockchip_thermal.c:732: warning: Function
parameter or member 'enable' not described in 'rk_tsadcv3_control'
linux.git/drivers/thermal/rockchip_thermal.c:1211: warning: Function
parameter or member 'reset' not described in
'rockchip_thermal_reset_controller'

Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
---
 drivers/thermal/rockchip_thermal.c | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/drivers/thermal/rockchip_thermal.c b/drivers/thermal/rockchip_thermal.c
index 343c2f5c5a259..9ed8085bb7924 100644
--- a/drivers/thermal/rockchip_thermal.c
+++ b/drivers/thermal/rockchip_thermal.c
@@ -19,7 +19,7 @@
 #include <linux/mfd/syscon.h>
 #include <linux/pinctrl/consumer.h>
 
-/**
+/*
  * If the temperature over a period of time High,
  * the resulting TSHUT gave CRU module,let it reset the entire chip,
  * or via GPIO give PMIC.
@@ -29,7 +29,7 @@ enum tshut_mode {
 	TSHUT_MODE_GPIO,
 };
 
-/**
+/*
  * The system Temperature Sensors tshut(tshut) polarity
  * the bit 8 is tshut polarity.
  * 0: low active, 1: high active
@@ -39,7 +39,7 @@ enum tshut_polarity {
 	TSHUT_HIGH_ACTIVE,
 };
 
-/**
+/*
  * The system has two Temperature Sensors.
  * sensor0 is for CPU, and sensor1 is for GPU.
  */
@@ -48,7 +48,7 @@ enum sensor_id {
 	SENSOR_GPU,
 };
 
-/**
+/*
  * The conversion table has the adc value and temperature.
  * ADC_DECREMENT: the adc value is of diminishing.(e.g. rk3288_code_table)
  * ADC_INCREMENT: the adc value is incremental.(e.g. rk3368_code_table)
@@ -80,13 +80,14 @@ struct chip_tsadc_table {
 
 /**
  * struct rockchip_tsadc_chip - hold the private data of tsadc chip
- * @chn_id[SOC_MAX_SENSORS]: the sensor id of chip correspond to the channel
+ * @chn_id: array of sensor ids of chip corresponding to the channel
  * @chn_num: the channel number of tsadc chip
  * @tshut_temp: the hardware-controlled shutdown temperature value
  * @tshut_mode: the hardware-controlled shutdown mode (0:CRU 1:GPIO)
  * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
  * @initialize: SoC special initialize tsadc controller method
  * @irq_ack: clear the interrupt
+ * @control: enable/disable method for the tsadc controller
  * @get_temp: get the temperature
  * @set_alarm_temp: set the high temperature interrupt
  * @set_tshut_temp: set the hardware-controlled shutdown temperature
@@ -139,7 +140,7 @@ struct rockchip_thermal_sensor {
  * @chip: pointer to the platform/configuration data
  * @pdev: platform device of thermal
  * @reset: the reset controller of tsadc
- * @sensors[SOC_MAX_SENSORS]: the thermal sensor
+ * @sensors: array of thermal sensors
  * @clk: the controller clock is divided by the exteral 24MHz
  * @pclk: the advanced peripherals bus clock
  * @grf: the general register file will be used to do static set by software
@@ -590,6 +591,9 @@ static int rk_tsadcv2_code_to_temp(const struct chip_tsadc_table *table,
 
 /**
  * rk_tsadcv2_initialize - initialize TASDC Controller.
+ * @grf: the general register file will be used to do static set by software
+ * @regs: the base address of tsadc controller
+ * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
  *
  * (1) Set TSADC_V2_AUTO_PERIOD:
  *     Configure the interleave between every two accessing of
@@ -624,6 +628,9 @@ static void rk_tsadcv2_initialize(struct regmap *grf, void __iomem *regs,
 
 /**
  * rk_tsadcv3_initialize - initialize TASDC Controller.
+ * @grf: the general register file will be used to do static set by software
+ * @regs: the base address of tsadc controller
+ * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
  *
  * (1) The tsadc control power sequence.
  *
@@ -723,6 +730,8 @@ static void rk_tsadcv2_control(void __iomem *regs, bool enable)
 
 /**
  * rk_tsadcv3_control - the tsadc controller is enabled or disabled.
+ * @regs: the base address of tsadc controller
+ * @enable: boolean flag to enable the controller
  *
  * NOTE: TSADC controller works at auto mode, and some SoCs need set the
  * tsadc_q_sel bit on TSADCV2_AUTO_CON[1]. The (1024 - tsadc_q) as output
@@ -1206,6 +1215,7 @@ rockchip_thermal_register_sensor(struct platform_device *pdev,
 
 /**
  * Reset TSADC Controller, reset all tsadc registers.
+ * @reset: the reset controller of tsadc
  */
 static void rockchip_thermal_reset_controller(struct reset_control *reset)
 {
-- 
2.17.1

Re: [PATCH 07/11] thermal: rockchip: Appease the kernel-doc deity

[Viresh Kumar]

On 06-11-19, 18:58, Amit Kucheria wrote:
> Replace a comment starting with /** by simply /* to avoid having it
> interpreted as a kernel-doc comment. Describe missing function
> parameters where needed.
> 
> Fixes up the following warnings when compiled with make W=1:
> 
> linux.git/drivers/thermal/rockchip_thermal.c:27: warning: cannot
> understand function prototype: 'enum tshut_mode '
> linux.git/drivers/thermal/rockchip_thermal.c:37: warning: cannot
> understand function prototype: 'enum tshut_polarity '
> linux.git/drivers/thermal/rockchip_thermal.c:46: warning: cannot
> understand function prototype: 'enum sensor_id '
> linux.git/drivers/thermal/rockchip_thermal.c:56: warning: cannot
> understand function prototype: 'enum adc_sort_mode '
> linux.git/drivers/thermal/rockchip_thermal.c:123: warning: Function
> parameter or member 'chn_id' not described in 'rockchip_tsadc_chip'
> linux.git/drivers/thermal/rockchip_thermal.c:123: warning: Function
> parameter or member 'control' not described in 'rockchip_tsadc_chip'
> linux.git/drivers/thermal/rockchip_thermal.c:167: warning: Function
> parameter or member 'sensors' not described in 'rockchip_thermal_data'
> linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function
> parameter or member 'grf' not described in 'rk_tsadcv2_initialize'
> linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function
> parameter or member 'regs' not described in 'rk_tsadcv2_initialize'
> linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function
> parameter or member 'tshut_polarity' not described in
> 'rk_tsadcv2_initialize'
> linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function
> parameter or member 'grf' not described in 'rk_tsadcv3_initialize'
> linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function
> parameter or member 'regs' not described in 'rk_tsadcv3_initialize'
> linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function
> parameter or member 'tshut_polarity' not described in
> 'rk_tsadcv3_initialize'
> linux.git/drivers/thermal/rockchip_thermal.c:732: warning: Function
> parameter or member 'regs' not described in 'rk_tsadcv3_control'
> linux.git/drivers/thermal/rockchip_thermal.c:732: warning: Function
> parameter or member 'enable' not described in 'rk_tsadcv3_control'
> linux.git/drivers/thermal/rockchip_thermal.c:1211: warning: Function
> parameter or member 'reset' not described in
> 'rockchip_thermal_reset_controller'
> 
> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
> ---
>  drivers/thermal/rockchip_thermal.c | 22 ++++++++++++++++------
>  1 file changed, 16 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/thermal/rockchip_thermal.c b/drivers/thermal/rockchip_thermal.c
> index 343c2f5c5a259..9ed8085bb7924 100644
> --- a/drivers/thermal/rockchip_thermal.c
> +++ b/drivers/thermal/rockchip_thermal.c
> @@ -19,7 +19,7 @@
>  #include <linux/mfd/syscon.h>
>  #include <linux/pinctrl/consumer.h>
>  
> -/**
> +/*
>   * If the temperature over a period of time High,
>   * the resulting TSHUT gave CRU module,let it reset the entire chip,
>   * or via GPIO give PMIC.
> @@ -29,7 +29,7 @@ enum tshut_mode {
>  	TSHUT_MODE_GPIO,
>  };
>  
> -/**
> +/*
>   * The system Temperature Sensors tshut(tshut) polarity
>   * the bit 8 is tshut polarity.
>   * 0: low active, 1: high active
> @@ -39,7 +39,7 @@ enum tshut_polarity {
>  	TSHUT_HIGH_ACTIVE,
>  };
>  
> -/**
> +/*
>   * The system has two Temperature Sensors.
>   * sensor0 is for CPU, and sensor1 is for GPU.
>   */
> @@ -48,7 +48,7 @@ enum sensor_id {
>  	SENSOR_GPU,
>  };
>  
> -/**
> +/*
>   * The conversion table has the adc value and temperature.
>   * ADC_DECREMENT: the adc value is of diminishing.(e.g. rk3288_code_table)
>   * ADC_INCREMENT: the adc value is incremental.(e.g. rk3368_code_table)
> @@ -80,13 +80,14 @@ struct chip_tsadc_table {
>  
>  /**
>   * struct rockchip_tsadc_chip - hold the private data of tsadc chip
> - * @chn_id[SOC_MAX_SENSORS]: the sensor id of chip correspond to the channel
> + * @chn_id: array of sensor ids of chip corresponding to the channel
>   * @chn_num: the channel number of tsadc chip
>   * @tshut_temp: the hardware-controlled shutdown temperature value
>   * @tshut_mode: the hardware-controlled shutdown mode (0:CRU 1:GPIO)
>   * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
>   * @initialize: SoC special initialize tsadc controller method
>   * @irq_ack: clear the interrupt
> + * @control: enable/disable method for the tsadc controller
>   * @get_temp: get the temperature
>   * @set_alarm_temp: set the high temperature interrupt
>   * @set_tshut_temp: set the hardware-controlled shutdown temperature
> @@ -139,7 +140,7 @@ struct rockchip_thermal_sensor {
>   * @chip: pointer to the platform/configuration data
>   * @pdev: platform device of thermal
>   * @reset: the reset controller of tsadc
> - * @sensors[SOC_MAX_SENSORS]: the thermal sensor
> + * @sensors: array of thermal sensors
>   * @clk: the controller clock is divided by the exteral 24MHz
>   * @pclk: the advanced peripherals bus clock
>   * @grf: the general register file will be used to do static set by software
> @@ -590,6 +591,9 @@ static int rk_tsadcv2_code_to_temp(const struct chip_tsadc_table *table,
>  
>  /**
>   * rk_tsadcv2_initialize - initialize TASDC Controller.
> + * @grf: the general register file will be used to do static set by software
> + * @regs: the base address of tsadc controller
> + * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
>   *
>   * (1) Set TSADC_V2_AUTO_PERIOD:
>   *     Configure the interleave between every two accessing of
> @@ -624,6 +628,9 @@ static void rk_tsadcv2_initialize(struct regmap *grf, void __iomem *regs,
>  
>  /**
>   * rk_tsadcv3_initialize - initialize TASDC Controller.
> + * @grf: the general register file will be used to do static set by software
> + * @regs: the base address of tsadc controller
> + * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
>   *
>   * (1) The tsadc control power sequence.
>   *
> @@ -723,6 +730,8 @@ static void rk_tsadcv2_control(void __iomem *regs, bool enable)
>  
>  /**
>   * rk_tsadcv3_control - the tsadc controller is enabled or disabled.
> + * @regs: the base address of tsadc controller
> + * @enable: boolean flag to enable the controller
>   *
>   * NOTE: TSADC controller works at auto mode, and some SoCs need set the
>   * tsadc_q_sel bit on TSADCV2_AUTO_CON[1]. The (1024 - tsadc_q) as output
> @@ -1206,6 +1215,7 @@ rockchip_thermal_register_sensor(struct platform_device *pdev,
>  
>  /**
>   * Reset TSADC Controller, reset all tsadc registers.
> + * @reset: the reset controller of tsadc
>   */
>  static void rockchip_thermal_reset_controller(struct reset_control *reset)
>  {

Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org>

-- 
viresh