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

pinctrl: pinctrl-single: Fix struct/function documentation blocks

Add some missing attributes/parameter descriptions, remove other
superfluous ones, add struct header titles and fix misspellings.

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

drivers/pinctrl/pinctrl-single.c:50: warning: Function parameter or member 'mask' not described in 'pcs_func_vals'
drivers/pinctrl/pinctrl-single.c:97: warning: Function parameter or member 'conf' not described in 'pcs_function'
drivers/pinctrl/pinctrl-single.c:97: warning: Function parameter or member 'nconfs' not described in 'pcs_function'
drivers/pinctrl/pinctrl-single.c:659: warning: Function parameter or member 'pin_pos' not described in 'pcs_add_pin'
drivers/pinctrl/pinctrl-single.c:985: warning: Excess function parameter 'pctldev' description in 'pcs_parse_one_pinctrl_entry'
drivers/pinctrl/pinctrl-single.c:1357: warning: Cannot understand * @reg: virtual address of interrupt register
drivers/pinctrl/pinctrl-single.c:1377: warning: Function parameter or member 'pcs_soc' not described in 'pcs_irq_set'
drivers/pinctrl/pinctrl-single.c:1377: warning: Function parameter or member 'irq' not described in 'pcs_irq_set'
drivers/pinctrl/pinctrl-single.c:1377: warning: Function parameter or member 'enable' not described in 'pcs_irq_set'
drivers/pinctrl/pinctrl-single.c:1458: warning: Function parameter or member 'pcs_soc' not described in 'pcs_irq_handle'
drivers/pinctrl/pinctrl-single.c:1458: warning: Excess function parameter 'pcs_irq' description in 'pcs_irq_handle'
drivers/pinctrl/pinctrl-single.c:1506: warning: Excess function parameter 'irq' description in 'pcs_irq_chain_handler'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Acked-by: Tony Lindgren <tony@atomide.com>
Cc: Tony Lindgren <tony@atomide.com>
Cc: Haojian Zhuang <haojian.zhuang@linaro.org>
Cc: linux-omap@vger.kernel.org
Link: https://lore.kernel.org/r/20200713144930.1034632-22-lee.jones@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

authored by

Lee Jones and committed by
Linus Walleij
0ba5ab00 e1524ea8

+10 -3
+10 -3
drivers/pinctrl/pinctrl-single.c
··· 42 42 * struct pcs_func_vals - mux function register offset and value pair 43 43 * @reg: register virtual address 44 44 * @val: register value 45 + * @mask: mask 45 46 */ 46 47 struct pcs_func_vals { 47 48 void __iomem *reg; ··· 84 83 * @nvals: number of entries in vals array 85 84 * @pgnames: array of pingroup names the function uses 86 85 * @npgnames: number of pingroup names the function uses 86 + * @conf: array of pin configurations 87 + * @nconfs: number of pin configurations available 87 88 * @node: list node 88 89 */ 89 90 struct pcs_function { ··· 656 653 * pcs_add_pin() - add a pin to the static per controller pin array 657 654 * @pcs: pcs driver instance 658 655 * @offset: register offset from base 656 + * @pin_pos: unused 659 657 */ 660 658 static int pcs_add_pin(struct pcs_device *pcs, unsigned offset, 661 659 unsigned pin_pos) ··· 963 959 964 960 /** 965 961 * pcs_parse_one_pinctrl_entry() - parses a device tree mux entry 966 - * @pctldev: pin controller device 967 962 * @pcs: pinctrl driver instance 968 963 * @np: device node of the mux entry 969 964 * @map: map entry ··· 1356 1353 } 1357 1354 return ret; 1358 1355 } 1356 + 1359 1357 /** 1358 + * struct pcs_interrupt 1360 1359 * @reg: virtual address of interrupt register 1361 1360 * @hwirq: hardware irq number 1362 1361 * @irq: virtual irq number ··· 1373 1368 1374 1369 /** 1375 1370 * pcs_irq_set() - enables or disables an interrupt 1371 + * @pcs_soc: SoC specific settings 1372 + * @irq: interrupt 1373 + * @enable: enable or disable the interrupt 1376 1374 * 1377 1375 * Note that this currently assumes one interrupt per pinctrl 1378 1376 * register that is typically used for wake-up events. ··· 1456 1448 1457 1449 /** 1458 1450 * pcs_irq_handle() - common interrupt handler 1459 - * @pcs_irq: interrupt data 1451 + * @pcs_soc: SoC specific settings 1460 1452 * 1461 1453 * Note that this currently assumes we have one interrupt bit per 1462 1454 * mux register. This interrupt is typically used for wake-up events. ··· 1504 1496 1505 1497 /** 1506 1498 * pcs_irq_handle() - handler for the dedicated chained interrupt case 1507 - * @irq: interrupt 1508 1499 * @desc: interrupt descriptor 1509 1500 * 1510 1501 * Use this if you have a separate interrupt for each