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

pinctrl: pinctrl-rockchip: Fix a bunch of kerneldoc misdemeanours

Demote headers which are clearly not kerneldoc, provide titles for
struct definition blocks, fix API slip (bitrot) misspellings and
provide some missing entries.

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

drivers/pinctrl/pinctrl-rockchip.c:82: warning: cannot understand function prototype: 'struct rockchip_iomux '
drivers/pinctrl/pinctrl-rockchip.c:97: warning: Enum value 'DRV_TYPE_IO_DEFAULT' not described in enum 'rockchip_pin_drv_type'
drivers/pinctrl/pinctrl-rockchip.c:97: warning: Enum value 'DRV_TYPE_IO_1V8_OR_3V0' not described in enum 'rockchip_pin_drv_type'
drivers/pinctrl/pinctrl-rockchip.c:97: warning: Enum value 'DRV_TYPE_IO_1V8_ONLY' not described in enum 'rockchip_pin_drv_type'
drivers/pinctrl/pinctrl-rockchip.c:97: warning: Enum value 'DRV_TYPE_IO_1V8_3V0_AUTO' not described in enum 'rockchip_pin_drv_type'
drivers/pinctrl/pinctrl-rockchip.c:97: warning: Enum value 'DRV_TYPE_IO_3V3_ONLY' not described in enum 'rockchip_pin_drv_type'
drivers/pinctrl/pinctrl-rockchip.c:97: warning: Enum value 'DRV_TYPE_MAX' not described in enum 'rockchip_pin_drv_type'
drivers/pinctrl/pinctrl-rockchip.c:106: warning: Enum value 'PULL_TYPE_IO_DEFAULT' not described in enum 'rockchip_pin_pull_type'
drivers/pinctrl/pinctrl-rockchip.c:106: warning: Enum value 'PULL_TYPE_IO_1V8_ONLY' not described in enum 'rockchip_pin_pull_type'
drivers/pinctrl/pinctrl-rockchip.c:106: warning: Enum value 'PULL_TYPE_MAX' not described in enum 'rockchip_pin_pull_type'
drivers/pinctrl/pinctrl-rockchip.c:109: warning: Cannot understand * @drv_type: drive strength variant using rockchip_perpin_drv_type
on line 109 - I thought it was a doc line
drivers/pinctrl/pinctrl-rockchip.c:122: warning: Cannot understand * @reg_base: register base of the gpio bank
on line 109 - I thought it was a doc line
drivers/pinctrl/pinctrl-rockchip.c:325: warning: Function parameter or member 'route_location' not described in 'rockchip_mux_route_data'
drivers/pinctrl/pinctrl-rockchip.c:328: warning: Cannot understand */
on line 109 - I thought it was a doc line
drivers/pinctrl/pinctrl-rockchip.c:375: warning: Function parameter or member 'data' not described in 'rockchip_pin_group'
drivers/pinctrl/pinctrl-rockchip.c:387: warning: Function parameter or member 'ngroups' not described in 'rockchip_pmx_func'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Reviewed-by: Heiko Stuebner <heiko@sntech.de>
Cc: Heiko Stuebner <heiko@sntech.de>
Cc: Jean-Christophe PLAGNIOL-VILLARD <plagnioj@jcrosoft.com>
Cc: linux-rockchip@lists.infradead.org
Link: https://lore.kernel.org/r/20200713144930.1034632-20-lee.jones@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

authored by

Lee Jones and committed by
Linus Walleij
e1524ea8 21f97985

+12 -10
+12 -10
drivers/pinctrl/pinctrl-rockchip.c
··· 63 63 RK3399, 64 64 }; 65 65 66 - /** 66 + /* 67 67 * Encode variants of iomux registers into a type variable 68 68 */ 69 69 #define IOMUX_GPIO_ONLY BIT(0) ··· 74 74 #define IOMUX_WIDTH_2BIT BIT(5) 75 75 76 76 /** 77 + * struct rockchip_iomux 77 78 * @type: iomux variant using IOMUX_* constants 78 79 * @offset: if initialized to -1 it will be autocalculated, by specifying 79 80 * an initial offset value the relevant source offset can be reset ··· 85 84 int offset; 86 85 }; 87 86 88 - /** 87 + /* 89 88 * enum type index corresponding to rockchip_perpin_drv_list arrays index. 90 89 */ 91 90 enum rockchip_pin_drv_type { ··· 97 96 DRV_TYPE_MAX 98 97 }; 99 98 100 - /** 99 + /* 101 100 * enum type index corresponding to rockchip_pull_list arrays index. 102 101 */ 103 102 enum rockchip_pin_pull_type { ··· 107 106 }; 108 107 109 108 /** 109 + * struct rockchip_drv 110 110 * @drv_type: drive strength variant using rockchip_perpin_drv_type 111 111 * @offset: if initialized to -1 it will be autocalculated, by specifying 112 112 * an initial offset value the relevant source offset can be reset ··· 121 119 }; 122 120 123 121 /** 122 + * struct rockchip_pin_bank 124 123 * @reg_base: register base of the gpio bank 125 - * @reg_pull: optional separate register for additional pull settings 124 + * @regmap_pull: optional separate register for additional pull settings 126 125 * @clk: clock of the gpio bank 127 126 * @irq: interrupt of the gpio bank 128 127 * @saved_masks: Saved content of GPIO_INTEN at suspend time. ··· 141 138 * @gpio_chip: gpiolib chip 142 139 * @grange: gpio range 143 140 * @slock: spinlock for the gpio bank 141 + * @toggle_edge_mode: bit mask to toggle (falling/rising) edge mode 142 + * @recalced_mask: bit mask to indicate a need to recalulate the mask 144 143 * @route_mask: bits describing the routing pins of per bank 145 144 */ 146 145 struct rockchip_pin_bank { ··· 317 312 * @bank_num: bank number. 318 313 * @pin: index at register or used to calc index. 319 314 * @func: the min pin. 315 + * @route_location: the mux route location (same, pmu, grf). 320 316 * @route_offset: the max pin. 321 317 * @route_val: the register offset. 322 318 */ ··· 330 324 u32 route_val; 331 325 }; 332 326 333 - /** 334 - */ 335 327 struct rockchip_pin_ctrl { 336 328 struct rockchip_pin_bank *pin_banks; 337 329 u32 nr_banks; ··· 367 363 * @name: name of the pin group, used to lookup the group. 368 364 * @pins: the pins included in this group. 369 365 * @npins: number of pins included in this group. 370 - * @func: the mux function number to be programmed when selected. 371 - * @configs: the config values to be set for each pin 372 - * @nconfigs: number of configs for each pin 366 + * @data: local pin configuration 373 367 */ 374 368 struct rockchip_pin_group { 375 369 const char *name; ··· 380 378 * struct rockchip_pmx_func: represent a pin function. 381 379 * @name: name of the pin function, used to lookup the function. 382 380 * @groups: one or more names of pin groups that provide this function. 383 - * @num_groups: number of groups included in @groups. 381 + * @ngroups: number of groups included in @groups. 384 382 */ 385 383 struct rockchip_pmx_func { 386 384 const char *name;