diff mbox series

[06/11] thermal: mediatek: Appease the kernel-doc deity

Message ID 2961e4ac4b32ea7db8b5f6916751a5c02ee85960.1573046440.git.amit.kucheria@linaro.org
State Superseded
Headers show
Series thermal: clean up output of make W=1 | expand

Commit Message

Amit Kucheria Nov. 6, 2019, 1:28 p.m. UTC
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/mtk_thermal.c:374: warning: cannot understand
function prototype: 'const struct mtk_thermal_data mt8173_thermal_data =
'
linux.git/drivers/thermal/mtk_thermal.c:413: warning: cannot understand
function prototype: 'const struct mtk_thermal_data mt2701_thermal_data =
'
linux.git/drivers/thermal/mtk_thermal.c:443: warning: cannot understand
function prototype: 'const struct mtk_thermal_data mt2712_thermal_data =
'
linux.git/drivers/thermal/mtk_thermal.c:499: warning: cannot understand
function prototype: 'const struct mtk_thermal_data mt8183_thermal_data =
'
linux.git/drivers/thermal/mtk_thermal.c:529: warning: Function parameter
or member 'sensno' not described in 'raw_to_mcelsius'

Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>

---
 drivers/thermal/mtk_thermal.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

-- 
2.17.1

Comments

Viresh Kumar Nov. 7, 2019, 2:19 a.m. UTC | #1
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/mtk_thermal.c:374: warning: cannot understand

> function prototype: 'const struct mtk_thermal_data mt8173_thermal_data =

> '

> linux.git/drivers/thermal/mtk_thermal.c:413: warning: cannot understand

> function prototype: 'const struct mtk_thermal_data mt2701_thermal_data =

> '

> linux.git/drivers/thermal/mtk_thermal.c:443: warning: cannot understand

> function prototype: 'const struct mtk_thermal_data mt2712_thermal_data =

> '

> linux.git/drivers/thermal/mtk_thermal.c:499: warning: cannot understand

> function prototype: 'const struct mtk_thermal_data mt8183_thermal_data =

> '

> linux.git/drivers/thermal/mtk_thermal.c:529: warning: Function parameter

> or member 'sensno' not described in 'raw_to_mcelsius'

> 

> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>

> ---

>  drivers/thermal/mtk_thermal.c | 12 ++++++------

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

> 

> diff --git a/drivers/thermal/mtk_thermal.c b/drivers/thermal/mtk_thermal.c

> index acf4854cbb8b8..76e30603d4d58 100644

> --- a/drivers/thermal/mtk_thermal.c

> +++ b/drivers/thermal/mtk_thermal.c

> @@ -358,7 +358,7 @@ static const int mt7622_mux_values[MT7622_NUM_SENSORS] = { 0, };

>  static const int mt7622_vts_index[MT7622_NUM_SENSORS] = { VTS1 };

>  static const int mt7622_tc_offset[MT7622_NUM_CONTROLLER] = { 0x0, };

>  

> -/**

> +/*

>   * The MT8173 thermal controller has four banks. Each bank can read up to

>   * four temperature sensors simultaneously. The MT8173 has a total of 5

>   * temperature sensors. We use each bank to measure a certain area of the

> @@ -400,7 +400,7 @@ static const struct mtk_thermal_data mt8173_thermal_data = {

>  	.sensor_mux_values = mt8173_mux_values,

>  };

>  

> -/**

> +/*

>   * The MT2701 thermal controller has one bank, which can read up to

>   * three temperature sensors simultaneously. The MT2701 has a total of 3

>   * temperature sensors.

> @@ -430,7 +430,7 @@ static const struct mtk_thermal_data mt2701_thermal_data = {

>  	.sensor_mux_values = mt2701_mux_values,

>  };

>  

> -/**

> +/*

>   * The MT2712 thermal controller has one bank, which can read up to

>   * four temperature sensors simultaneously. The MT2712 has a total of 4

>   * temperature sensors.

> @@ -484,7 +484,7 @@ static const struct mtk_thermal_data mt7622_thermal_data = {

>  	.sensor_mux_values = mt7622_mux_values,

>  };

>  

> -/**

> +/*

>   * The MT8183 thermal controller has one bank for the current SW framework.

>   * The MT8183 has a total of 6 temperature sensors.

>   * There are two thermal controller to control the six sensor.

> @@ -495,7 +495,6 @@ static const struct mtk_thermal_data mt7622_thermal_data = {

>   * data, and this indeed needs the temperatures of the individual banks

>   * for making better decisions.

>   */

> -

>  static const struct mtk_thermal_data mt8183_thermal_data = {

>  	.auxadc_channel = MT8183_TEMP_AUXADC_CHANNEL,

>  	.num_banks = MT8183_NUM_SENSORS_PER_ZONE,

> @@ -519,7 +518,8 @@ static const struct mtk_thermal_data mt8183_thermal_data = {

>  

>  /**

>   * raw_to_mcelsius - convert a raw ADC value to mcelsius

> - * @mt:		The thermal controller

> + * @mt:	The thermal controller

> + * @sensno:	sensor number

>   * @raw:	raw ADC value


This doesn't look related to $subject

>   *

>   * This converts the raw ADC value to mcelsius using the SoC specific

> -- 

> 2.17.1


-- 
viresh
Viresh Kumar Nov. 7, 2019, 2:20 a.m. UTC | #2
On 07-11-19, 07:49, Viresh Kumar wrote:
> 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/mtk_thermal.c:374: warning: cannot understand

> > function prototype: 'const struct mtk_thermal_data mt8173_thermal_data =

> > '

> > linux.git/drivers/thermal/mtk_thermal.c:413: warning: cannot understand

> > function prototype: 'const struct mtk_thermal_data mt2701_thermal_data =

> > '

> > linux.git/drivers/thermal/mtk_thermal.c:443: warning: cannot understand

> > function prototype: 'const struct mtk_thermal_data mt2712_thermal_data =

> > '

> > linux.git/drivers/thermal/mtk_thermal.c:499: warning: cannot understand

> > function prototype: 'const struct mtk_thermal_data mt8183_thermal_data =

> > '

> > linux.git/drivers/thermal/mtk_thermal.c:529: warning: Function parameter

> > or member 'sensno' not described in 'raw_to_mcelsius'

> > 

> > Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>

> > ---

> >  drivers/thermal/mtk_thermal.c | 12 ++++++------

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

> > 

> > diff --git a/drivers/thermal/mtk_thermal.c b/drivers/thermal/mtk_thermal.c

> > index acf4854cbb8b8..76e30603d4d58 100644

> > --- a/drivers/thermal/mtk_thermal.c

> > +++ b/drivers/thermal/mtk_thermal.c

> > @@ -358,7 +358,7 @@ static const int mt7622_mux_values[MT7622_NUM_SENSORS] = { 0, };

> >  static const int mt7622_vts_index[MT7622_NUM_SENSORS] = { VTS1 };

> >  static const int mt7622_tc_offset[MT7622_NUM_CONTROLLER] = { 0x0, };

> >  

> > -/**

> > +/*

> >   * The MT8173 thermal controller has four banks. Each bank can read up to

> >   * four temperature sensors simultaneously. The MT8173 has a total of 5

> >   * temperature sensors. We use each bank to measure a certain area of the

> > @@ -400,7 +400,7 @@ static const struct mtk_thermal_data mt8173_thermal_data = {

> >  	.sensor_mux_values = mt8173_mux_values,

> >  };

> >  

> > -/**

> > +/*

> >   * The MT2701 thermal controller has one bank, which can read up to

> >   * three temperature sensors simultaneously. The MT2701 has a total of 3

> >   * temperature sensors.

> > @@ -430,7 +430,7 @@ static const struct mtk_thermal_data mt2701_thermal_data = {

> >  	.sensor_mux_values = mt2701_mux_values,

> >  };

> >  

> > -/**

> > +/*

> >   * The MT2712 thermal controller has one bank, which can read up to

> >   * four temperature sensors simultaneously. The MT2712 has a total of 4

> >   * temperature sensors.

> > @@ -484,7 +484,7 @@ static const struct mtk_thermal_data mt7622_thermal_data = {

> >  	.sensor_mux_values = mt7622_mux_values,

> >  };

> >  

> > -/**

> > +/*

> >   * The MT8183 thermal controller has one bank for the current SW framework.

> >   * The MT8183 has a total of 6 temperature sensors.

> >   * There are two thermal controller to control the six sensor.

> > @@ -495,7 +495,6 @@ static const struct mtk_thermal_data mt7622_thermal_data = {

> >   * data, and this indeed needs the temperatures of the individual banks

> >   * for making better decisions.

> >   */

> > -

> >  static const struct mtk_thermal_data mt8183_thermal_data = {

> >  	.auxadc_channel = MT8183_TEMP_AUXADC_CHANNEL,

> >  	.num_banks = MT8183_NUM_SENSORS_PER_ZONE,

> > @@ -519,7 +518,8 @@ static const struct mtk_thermal_data mt8183_thermal_data = {

> >  

> >  /**

> >   * raw_to_mcelsius - convert a raw ADC value to mcelsius

> > - * @mt:		The thermal controller

> > + * @mt:	The thermal controller

> > + * @sensno:	sensor number

> >   * @raw:	raw ADC value

> 

> This doesn't look related to $subject


I take this statement back :)

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


-- 
viresh
diff mbox series

Patch

diff --git a/drivers/thermal/mtk_thermal.c b/drivers/thermal/mtk_thermal.c
index acf4854cbb8b8..76e30603d4d58 100644
--- a/drivers/thermal/mtk_thermal.c
+++ b/drivers/thermal/mtk_thermal.c
@@ -358,7 +358,7 @@  static const int mt7622_mux_values[MT7622_NUM_SENSORS] = { 0, };
 static const int mt7622_vts_index[MT7622_NUM_SENSORS] = { VTS1 };
 static const int mt7622_tc_offset[MT7622_NUM_CONTROLLER] = { 0x0, };
 
-/**
+/*
  * The MT8173 thermal controller has four banks. Each bank can read up to
  * four temperature sensors simultaneously. The MT8173 has a total of 5
  * temperature sensors. We use each bank to measure a certain area of the
@@ -400,7 +400,7 @@  static const struct mtk_thermal_data mt8173_thermal_data = {
 	.sensor_mux_values = mt8173_mux_values,
 };
 
-/**
+/*
  * The MT2701 thermal controller has one bank, which can read up to
  * three temperature sensors simultaneously. The MT2701 has a total of 3
  * temperature sensors.
@@ -430,7 +430,7 @@  static const struct mtk_thermal_data mt2701_thermal_data = {
 	.sensor_mux_values = mt2701_mux_values,
 };
 
-/**
+/*
  * The MT2712 thermal controller has one bank, which can read up to
  * four temperature sensors simultaneously. The MT2712 has a total of 4
  * temperature sensors.
@@ -484,7 +484,7 @@  static const struct mtk_thermal_data mt7622_thermal_data = {
 	.sensor_mux_values = mt7622_mux_values,
 };
 
-/**
+/*
  * The MT8183 thermal controller has one bank for the current SW framework.
  * The MT8183 has a total of 6 temperature sensors.
  * There are two thermal controller to control the six sensor.
@@ -495,7 +495,6 @@  static const struct mtk_thermal_data mt7622_thermal_data = {
  * data, and this indeed needs the temperatures of the individual banks
  * for making better decisions.
  */
-
 static const struct mtk_thermal_data mt8183_thermal_data = {
 	.auxadc_channel = MT8183_TEMP_AUXADC_CHANNEL,
 	.num_banks = MT8183_NUM_SENSORS_PER_ZONE,
@@ -519,7 +518,8 @@  static const struct mtk_thermal_data mt8183_thermal_data = {
 
 /**
  * raw_to_mcelsius - convert a raw ADC value to mcelsius
- * @mt:		The thermal controller
+ * @mt:	The thermal controller
+ * @sensno:	sensor number
  * @raw:	raw ADC value
  *
  * This converts the raw ADC value to mcelsius using the SoC specific