Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

thermal: tegra: Appease the kernel-doc deity

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 <amit.kucheria@linaro.org>
Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/db764f71253bb2ad569b0aeab4c91207a39317ce.1574242756.git.amit.kucheria@linaro.org

authored by

Amit Kucheria and committed by
Daniel Lezcano
6a6d634c 9625e9e6

+13 -2
+13 -2
drivers/thermal/tegra/soctherm.c
··· 360 360 /** 361 361 * ccroc_writel() - writes a value to a CCROC register 362 362 * @ts: pointer to a struct tegra_soctherm 363 - * @v: the value to write 363 + * @value: the value to write 364 364 * @reg: the register offset 365 365 * 366 366 * Writes @v to @reg. No return value. ··· 435 435 436 436 /** 437 437 * enforce_temp_range() - check and enforce temperature range [min, max] 438 + * @dev: struct device * of the SOC_THERM instance 438 439 * @trip_temp: the trip temperature to check 439 440 * 440 441 * Checks and enforces the permitted temperature range that SOC_THERM ··· 748 747 /** 749 748 * tegra_soctherm_set_hwtrips() - set HW trip point from DT data 750 749 * @dev: struct device * of the SOC_THERM instance 750 + * @sg: pointer to the sensor group to set the thermtrip temperature for 751 + * @tz: struct thermal_zone_device * 751 752 * 752 753 * Configure the SOC_THERM HW trip points, setting "THERMTRIP" 753 754 * "THROTTLE" trip points , using "thermtrips", "critical" or "hot" ··· 934 931 935 932 /** 936 933 * soctherm_oc_intr_enable() - Enables the soctherm over-current interrupt 934 + * @ts: pointer to a struct tegra_soctherm 937 935 * @alarm: The soctherm throttle id 938 936 * @enable: Flag indicating enable the soctherm over-current 939 937 * interrupt or disable it ··· 1160 1156 1161 1157 /** 1162 1158 * soctherm_oc_irq_disable() - Disables overcurrent interrupt requests 1163 - * @irq_data: The interrupt request information 1159 + * @data: The interrupt request information 1164 1160 * 1165 1161 * Clears the interrupt request enable bit of the overcurrent 1166 1162 * interrupt request chip data. ··· 1210 1206 /** 1211 1207 * soctherm_irq_domain_xlate_twocell() - xlate for soctherm interrupts 1212 1208 * @d: Interrupt request domain 1209 + * @ctrlr: Controller device tree node 1213 1210 * @intspec: Array of u32s from DTs "interrupt" property 1214 1211 * @intsize: Number of values inside the intspec array 1215 1212 * @out_hwirq: HW IRQ value associated with this interrupt ··· 1686 1681 /** 1687 1682 * soctherm_init_hw_throt_cdev() - Parse the HW throttle configurations 1688 1683 * and register them as cooling devices. 1684 + * @pdev: Pointer to platform_device struct 1689 1685 */ 1690 1686 static void soctherm_init_hw_throt_cdev(struct platform_device *pdev) 1691 1687 { ··· 1757 1751 1758 1752 /** 1759 1753 * throttlectl_cpu_level_cfg() - programs CCROC NV_THERM level config 1754 + * @ts: pointer to a struct tegra_soctherm 1760 1755 * @level: describing the level LOW/MED/HIGH of throttling 1761 1756 * 1762 1757 * It's necessary to set up the CPU-local CCROC NV_THERM instance with ··· 1805 1798 1806 1799 /** 1807 1800 * throttlectl_cpu_level_select() - program CPU pulse skipper config 1801 + * @ts: pointer to a struct tegra_soctherm 1808 1802 * @throt: the LIGHT/HEAVY of throttle event id 1809 1803 * 1810 1804 * Pulse skippers are used to throttle clock frequencies. This ··· 1849 1841 1850 1842 /** 1851 1843 * throttlectl_cpu_mn() - program CPU pulse skipper configuration 1844 + * @ts: pointer to a struct tegra_soctherm 1852 1845 * @throt: the LIGHT/HEAVY of throttle event id 1853 1846 * 1854 1847 * Pulse skippers are used to throttle clock frequencies. This ··· 1883 1874 1884 1875 /** 1885 1876 * throttlectl_gpu_level_select() - selects throttling level for GPU 1877 + * @ts: pointer to a struct tegra_soctherm 1886 1878 * @throt: the LIGHT/HEAVY of throttle event id 1887 1879 * 1888 1880 * This function programs soctherm's interface to GK20a NV_THERM to select ··· 1928 1918 1929 1919 /** 1930 1920 * soctherm_throttle_program() - programs pulse skippers' configuration 1921 + * @ts: pointer to a struct tegra_soctherm 1931 1922 * @throt: the LIGHT/HEAVY of the throttle event id. 1932 1923 * 1933 1924 * Pulse skippers are used to throttle clock frequencies.