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

pinctrl: sirf: pinctrl-atlas7: Fix a bunch of documentation misdemeanours

>From ill formatted kerneldoc, to incomplete *and* incorrect struct headers,
through to formatting issues and missing attribute descriptions.

Fixes the following W=1 kernel build warning(s):

drivers/pinctrl/sirf/pinctrl-atlas7.c:197: warning: Function parameter or member 'id' not described in 'atlas7_pad_config'
drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'func' not described in 'atlas7_pad_status'
drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'pull' not described in 'atlas7_pad_status'
drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'dstr' not described in 'atlas7_pad_status'
drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'reserved' not described in 'atlas7_pad_status'
drivers/pinctrl/sirf/pinctrl-atlas7.c:359: warning: Cannot understand * @dev: a pointer back to containing device
on line 359 - I thought it was a doc line
drivers/pinctrl/sirf/pinctrl-atlas7.c:4794: warning: Function parameter or member 'pad_type' not described in 'atlas7_pull_info'
drivers/pinctrl/sirf/pinctrl-atlas7.c:4917: warning: Function parameter or member 'reserved' not described in 'atlas7_ds_info'
drivers/pinctrl/sirf/pinctrl-atlas7.c:5617: warning: Function parameter or member 'a7gc' not described in 'atlas7_gpio_to_bank'
drivers/pinctrl/sirf/pinctrl-atlas7.c:5617: warning: Function parameter or member 'gpio' not described in 'atlas7_gpio_to_bank'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Cc: Barry Song <baohua@kernel.org>
Link: https://lore.kernel.org/r/20200713144930.1034632-3-lee.jones@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

authored by

Lee Jones and committed by
Linus Walleij
bef63e66 80fa3300

+9 -12
+9 -12
drivers/pinctrl/sirf/pinctrl-atlas7.c
··· 169 169 170 170 /** 171 171 * struct atlas7_pad_conf - Atlas7 Pad Configuration 172 - * @id The ID of this Pad. 172 + * @id: The ID of this Pad. 173 173 * @type: The type of this Pad. 174 174 * @mux_reg: The mux register offset. 175 175 * This register contains the mux. ··· 210 210 .ad_ctrl_bit = adb, \ 211 211 } 212 212 213 - /** 213 + /* 214 214 * struct atlas7_pad_status - Atlas7 Pad status 215 215 */ 216 216 struct atlas7_pad_status { ··· 355 355 struct atlas7_gpio_bank banks[]; 356 356 }; 357 357 358 - /** 359 - * @dev: a pointer back to containing device 360 - * @virtbase: the offset to the controller in virtual memory 361 - */ 362 358 struct atlas7_pmx { 363 359 struct device *dev; 364 360 struct pinctrl_dev *pctl; ··· 372 376 * refer to A7DA IO Summary - CS-314158-DD-4E.xls 373 377 */ 374 378 375 - /*Pads in IOC RTC & TOP */ 379 + /* Pads in IOC RTC & TOP */ 376 380 static const struct pinctrl_pin_desc atlas7_ioc_pads[] = { 377 381 /* RTC PADs */ 378 382 PINCTRL_PIN(0, "rtc_gpio_0"), ··· 4777 4781 4778 4782 /** 4779 4783 * struct atlas7_pull_info - Atlas7 Pad pull info 4780 - * @type:The type of this Pad. 4781 - * @mask:The mas value of this pin's pull bits. 4782 - * @v2s: The map of pull register value to pull status. 4783 - * @s2v: The map of pull status to pull register value. 4784 + * @pad_type: The type of this Pad. 4785 + * @mask: The mas value of this pin's pull bits. 4786 + * @v2s: The map of pull register value to pull status. 4787 + * @s2v: The map of pull status to pull register value. 4784 4788 */ 4785 4789 struct atlas7_pull_info { 4786 4790 u8 pad_type; ··· 4904 4908 * @type: The type of this Pad. 4905 4909 * @mask: The mask value of this pin's pull bits. 4906 4910 * @imval: The immediate value of drives trength register. 4911 + * @reserved: Reserved space 4907 4912 */ 4908 4913 struct atlas7_ds_info { 4909 4914 u8 type; ··· 5606 5609 arch_initcall(atlas7_pinmux_init); 5607 5610 5608 5611 5609 - /** 5612 + /* 5610 5613 * The Following is GPIO Code 5611 5614 */ 5612 5615 static inline struct