| Message ID | 20200717165538.3275050-27-lee.jones@linaro.org |
|---|---|
| State | Accepted |
| Commit | 8f0f0f2cd20561e2021b053ec9af66f563af0664 |
| Headers | show |
| Series | None | expand |
On Fri 17 Jul 09:55 PDT 2020, Lee Jones wrote: > Kerneldoc is only suitable for documenting functions and struct/enums. > > Fixes the following W=1 kernel build warning(s): > > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL' description in 'PM8XXX_CHANNEL_INTERNAL' > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_125V' description in 'PM8XXX_CHANNEL_INTERNAL' > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL_2' description in 'PM8XXX_CHANNEL_INTERNAL' > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_MUXOFF' description in 'PM8XXX_CHANNEL_INTERNAL' > drivers/iio/adc/qcom-pm8xxx-xoadc.c:412: warning: Function parameter or member 'variant' not described in 'pm8xxx_xoadc' > > Cc: Andy Gross <agross@kernel.org> > Cc: Bjorn Andersson <bjorn.andersson@linaro.org> > Cc: Linus Walleij <linus.walleij@linaro.org> > Cc: linux-arm-msm@vger.kernel.org > Signed-off-by: Lee Jones <lee.jones@linaro.org> Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org> > --- > drivers/iio/adc/qcom-pm8xxx-xoadc.c | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/drivers/iio/adc/qcom-pm8xxx-xoadc.c b/drivers/iio/adc/qcom-pm8xxx-xoadc.c > index c599ffa45a04c..cd5fa30e77df4 100644 > --- a/drivers/iio/adc/qcom-pm8xxx-xoadc.c > +++ b/drivers/iio/adc/qcom-pm8xxx-xoadc.c > @@ -120,7 +120,7 @@ > #define ADC_ARB_USRP_DATA0 0x19D > #define ADC_ARB_USRP_DATA1 0x19C > > -/** > +/* > * Physical channels which MUST exist on all PM variants in order to provide > * proper reference points for calibration. > * > @@ -388,6 +388,7 @@ struct pm8xxx_chan_info { > * struct pm8xxx_xoadc - state container for the XOADC > * @dev: pointer to device > * @map: regmap to access registers > + * @variant: XOADC variant characteristics > * @vref: reference voltage regulator > * characteristics of the channels, and sensible default settings > * @nchans: number of channels, configured by the device tree > -- > 2.25.1 >
On Fri, 17 Jul 2020 13:15:25 -0700 Bjorn Andersson <bjorn.andersson@linaro.org> wrote: > On Fri 17 Jul 09:55 PDT 2020, Lee Jones wrote: > > > Kerneldoc is only suitable for documenting functions and struct/enums. > > > > Fixes the following W=1 kernel build warning(s): > > > > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL' description in 'PM8XXX_CHANNEL_INTERNAL' > > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_125V' description in 'PM8XXX_CHANNEL_INTERNAL' > > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL_2' description in 'PM8XXX_CHANNEL_INTERNAL' > > drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_MUXOFF' description in 'PM8XXX_CHANNEL_INTERNAL' > > drivers/iio/adc/qcom-pm8xxx-xoadc.c:412: warning: Function parameter or member 'variant' not described in 'pm8xxx_xoadc' > > > > Cc: Andy Gross <agross@kernel.org> > > Cc: Bjorn Andersson <bjorn.andersson@linaro.org> > > Cc: Linus Walleij <linus.walleij@linaro.org> > > Cc: linux-arm-msm@vger.kernel.org > > Signed-off-by: Lee Jones <lee.jones@linaro.org> > > Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org> > Applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to play with it. Thanks, Jonathan > > --- > > drivers/iio/adc/qcom-pm8xxx-xoadc.c | 3 ++- > > 1 file changed, 2 insertions(+), 1 deletion(-) > > > > diff --git a/drivers/iio/adc/qcom-pm8xxx-xoadc.c b/drivers/iio/adc/qcom-pm8xxx-xoadc.c > > index c599ffa45a04c..cd5fa30e77df4 100644 > > --- a/drivers/iio/adc/qcom-pm8xxx-xoadc.c > > +++ b/drivers/iio/adc/qcom-pm8xxx-xoadc.c > > @@ -120,7 +120,7 @@ > > #define ADC_ARB_USRP_DATA0 0x19D > > #define ADC_ARB_USRP_DATA1 0x19C > > > > -/** > > +/* > > * Physical channels which MUST exist on all PM variants in order to provide > > * proper reference points for calibration. > > * > > @@ -388,6 +388,7 @@ struct pm8xxx_chan_info { > > * struct pm8xxx_xoadc - state container for the XOADC > > * @dev: pointer to device > > * @map: regmap to access registers > > + * @variant: XOADC variant characteristics > > * @vref: reference voltage regulator > > * characteristics of the channels, and sensible default settings > > * @nchans: number of channels, configured by the device tree > > -- > > 2.25.1 > >
diff --git a/drivers/iio/adc/qcom-pm8xxx-xoadc.c b/drivers/iio/adc/qcom-pm8xxx-xoadc.c index c599ffa45a04c..cd5fa30e77df4 100644 --- a/drivers/iio/adc/qcom-pm8xxx-xoadc.c +++ b/drivers/iio/adc/qcom-pm8xxx-xoadc.c @@ -120,7 +120,7 @@ #define ADC_ARB_USRP_DATA0 0x19D #define ADC_ARB_USRP_DATA1 0x19C -/** +/* * Physical channels which MUST exist on all PM variants in order to provide * proper reference points for calibration. * @@ -388,6 +388,7 @@ struct pm8xxx_chan_info { * struct pm8xxx_xoadc - state container for the XOADC * @dev: pointer to device * @map: regmap to access registers + * @variant: XOADC variant characteristics * @vref: reference voltage regulator * characteristics of the channels, and sensible default settings * @nchans: number of channels, configured by the device tree
Kerneldoc is only suitable for documenting functions and struct/enums. Fixes the following W=1 kernel build warning(s): drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL' description in 'PM8XXX_CHANNEL_INTERNAL' drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_125V' description in 'PM8XXX_CHANNEL_INTERNAL' drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_INTERNAL_2' description in 'PM8XXX_CHANNEL_INTERNAL' drivers/iio/adc/qcom-pm8xxx-xoadc.c:133: warning: Excess function parameter 'PM8XXX_CHANNEL_MUXOFF' description in 'PM8XXX_CHANNEL_INTERNAL' drivers/iio/adc/qcom-pm8xxx-xoadc.c:412: warning: Function parameter or member 'variant' not described in 'pm8xxx_xoadc' Cc: Andy Gross <agross@kernel.org> Cc: Bjorn Andersson <bjorn.andersson@linaro.org> Cc: Linus Walleij <linus.walleij@linaro.org> Cc: linux-arm-msm@vger.kernel.org Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/iio/adc/qcom-pm8xxx-xoadc.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) -- 2.25.1