From mboxrd@z Thu Jan 1 00:00:00 1970 From: Viresh Kumar Subject: Re: [PATCH 09/11] thermal: tegra: Appease the kernel-doc deity Date: Thu, 7 Nov 2019 07:52:01 +0530 Message-ID: <20191107022201.emiylbnnqahfqrl5@vireshk-i7> References: <4cba46c100cb504a52e52062bdf4e4a4e9427b99.1573046440.git.amit.kucheria@linaro.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Content-Disposition: inline In-Reply-To: <4cba46c100cb504a52e52062bdf4e4a4e9427b99.1573046440.git.amit.kucheria@linaro.org> Sender: linux-kernel-owner@vger.kernel.org To: Amit Kucheria Cc: linux-kernel@vger.kernel.org, edubezval@gmail.com, Amit Daniel Kachhap , Amit Kucheria , Bartlomiej Zolnierkiewicz , Daniel Lezcano , Guillaume La Roque , Heiko Stuebner , Javi Merino , Jonathan Hunter , Jun Nie , Krzysztof Kozlowski , Kukjin Kim , Matthias Brugger , Shawn Guo , Thierry Reding , Zhang Rui , linux-pm@vger.kernel.org, linux-tegra@vger.kernel.org List-Id: linux-tegra@vger.kernel.org On 06-11-19, 18:58, Amit Kucheria wrote: > Fix up the following warning when compiled with make W=1: > > linux.git/drivers/thermal/tegra/soctherm.c:369: warning: Function parameter or member 'value' not described in 'ccroc_writel' > linux.git/drivers/thermal/tegra/soctherm.c:369: warning: Excess function parameter 'v' description in 'ccroc_writel' > linux.git/drivers/thermal/tegra/soctherm.c:447: warning: Function parameter or member 'dev' not described in 'enforce_temp_range' > linux.git/drivers/thermal/tegra/soctherm.c:772: warning: Function parameter or member 'sg' not described in 'tegra_soctherm_set_hwtrips' > linux.git/drivers/thermal/tegra/soctherm.c:772: warning: Function parameter or member 'tz' not described in 'tegra_soctherm_set_hwtrips' > linux.git/drivers/thermal/tegra/soctherm.c:944: warning: Function parameter or member 'ts' not described in 'soctherm_oc_intr_enable' > linux.git/drivers/thermal/tegra/soctherm.c:1167: warning: Function parameter or member 'data' not described in 'soctherm_oc_irq_disable' > linux.git/drivers/thermal/tegra/soctherm.c:1167: warning: Excess function parameter 'irq_data' description in 'soctherm_oc_irq_disable' > linux.git/drivers/thermal/tegra/soctherm.c:1224: warning: Function parameter or member 'ctrlr' not described in 'soctherm_irq_domain_xlate_twocell' > linux.git/drivers/thermal/tegra/soctherm.c:1686: warning: Function parameter or member 'pdev' not described in 'soctherm_init_hw_throt_cdev' > linux.git/drivers/thermal/tegra/soctherm.c:1764: warning: Function parameter or member 'ts' not described in 'throttlectl_cpu_level_cfg' > linux.git/drivers/thermal/tegra/soctherm.c:1812: warning: Function parameter or member 'ts' not described in 'throttlectl_cpu_level_select' > linux.git/drivers/thermal/tegra/soctherm.c:1855: warning: Function parameter or member 'ts' not described in 'throttlectl_cpu_mn' > linux.git/drivers/thermal/tegra/soctherm.c:1886: warning: Function parameter or member 'ts' not described in 'throttlectl_gpu_level_select' > linux.git/drivers/thermal/tegra/soctherm.c:1928: warning: Function parameter or member 'ts' not described in 'soctherm_throttle_program' > > Signed-off-by: Amit Kucheria > --- > drivers/thermal/tegra/soctherm.c | 15 +++++++++++++-- > 1 file changed, 13 insertions(+), 2 deletions(-) > > diff --git a/drivers/thermal/tegra/soctherm.c b/drivers/thermal/tegra/soctherm.c > index 5acaad3a594f3..66e0639da4bf2 100644 > --- a/drivers/thermal/tegra/soctherm.c > +++ b/drivers/thermal/tegra/soctherm.c > @@ -360,7 +360,7 @@ static struct soctherm_oc_irq_chip_data soc_irq_cdata; > /** > * ccroc_writel() - writes a value to a CCROC register > * @ts: pointer to a struct tegra_soctherm > - * @v: the value to write > + * @value: the value to write > * @reg: the register offset > * > * Writes @v to @reg. No return value. > @@ -435,6 +435,7 @@ static int tegra_thermctl_get_temp(void *data, int *out_temp) > > /** > * enforce_temp_range() - check and enforce temperature range [min, max] > + * @dev: struct device * of the SOC_THERM instance > * @trip_temp: the trip temperature to check > * > * Checks and enforces the permitted temperature range that SOC_THERM > @@ -747,6 +748,8 @@ static int get_hot_temp(struct thermal_zone_device *tz, int *trip, int *temp) > /** > * tegra_soctherm_set_hwtrips() - set HW trip point from DT data > * @dev: struct device * of the SOC_THERM instance > + * @sg: pointer to the sensor group to set the thermtrip temperature for > + * @tz: struct thermal_zone_device * > * > * Configure the SOC_THERM HW trip points, setting "THERMTRIP" > * "THROTTLE" trip points , using "thermtrips", "critical" or "hot" > @@ -931,6 +934,7 @@ static irqreturn_t soctherm_thermal_isr_thread(int irq, void *dev_id) > > /** > * soctherm_oc_intr_enable() - Enables the soctherm over-current interrupt > + * @ts: pointer to a struct tegra_soctherm > * @alarm: The soctherm throttle id > * @enable: Flag indicating enable the soctherm over-current > * interrupt or disable it > @@ -1156,7 +1160,7 @@ static void soctherm_oc_irq_enable(struct irq_data *data) > > /** > * soctherm_oc_irq_disable() - Disables overcurrent interrupt requests > - * @irq_data: The interrupt request information > + * @data: The interrupt request information > * > * Clears the interrupt request enable bit of the overcurrent > * interrupt request chip data. > @@ -1206,6 +1210,7 @@ static int soctherm_oc_irq_map(struct irq_domain *h, unsigned int virq, > /** > * soctherm_irq_domain_xlate_twocell() - xlate for soctherm interrupts > * @d: Interrupt request domain > + * @ctrlr: Controller device tree node > * @intspec: Array of u32s from DTs "interrupt" property > * @intsize: Number of values inside the intspec array > * @out_hwirq: HW IRQ value associated with this interrupt > @@ -1681,6 +1686,7 @@ static int soctherm_throt_cfg_parse(struct device *dev, > /** > * soctherm_init_hw_throt_cdev() - Parse the HW throttle configurations > * and register them as cooling devices. > + * @pdev: Pointer to platform_device struct > */ > static void soctherm_init_hw_throt_cdev(struct platform_device *pdev) > { > @@ -1751,6 +1757,7 @@ static void soctherm_init_hw_throt_cdev(struct platform_device *pdev) > > /** > * throttlectl_cpu_level_cfg() - programs CCROC NV_THERM level config > + * @ts: pointer to a struct tegra_soctherm > * @level: describing the level LOW/MED/HIGH of throttling > * > * It's necessary to set up the CPU-local CCROC NV_THERM instance with > @@ -1798,6 +1805,7 @@ static void throttlectl_cpu_level_cfg(struct tegra_soctherm *ts, int level) > > /** > * throttlectl_cpu_level_select() - program CPU pulse skipper config > + * @ts: pointer to a struct tegra_soctherm > * @throt: the LIGHT/HEAVY of throttle event id > * > * Pulse skippers are used to throttle clock frequencies. This > @@ -1841,6 +1849,7 @@ static void throttlectl_cpu_level_select(struct tegra_soctherm *ts, > > /** > * throttlectl_cpu_mn() - program CPU pulse skipper configuration > + * @ts: pointer to a struct tegra_soctherm > * @throt: the LIGHT/HEAVY of throttle event id > * > * Pulse skippers are used to throttle clock frequencies. This > @@ -1874,6 +1883,7 @@ static void throttlectl_cpu_mn(struct tegra_soctherm *ts, > > /** > * throttlectl_gpu_level_select() - selects throttling level for GPU > + * @ts: pointer to a struct tegra_soctherm > * @throt: the LIGHT/HEAVY of throttle event id > * > * This function programs soctherm's interface to GK20a NV_THERM to select > @@ -1918,6 +1928,7 @@ static int soctherm_oc_cfg_program(struct tegra_soctherm *ts, > > /** > * soctherm_throttle_program() - programs pulse skippers' configuration > + * @ts: pointer to a struct tegra_soctherm > * @throt: the LIGHT/HEAVY of the throttle event id. > * > * Pulse skippers are used to throttle clock frequencies. Reviewed-by: Viresh Kumar -- viresh