pinctrl: pinctrl-rockchip: Fix a bunch of kerneldoc misdemeanours (e1524ea8) · Commits · 戴 / test

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>

drivers/pinctrl/pinctrl-rockchip.c

+12 −10

Original line number	Diff line number	Diff line
		@@ -63,7 +63,7 @@ enum rockchip_pinctrl_type {
		RK3399,
		};

		/**
		/*
		* Encode variants of iomux registers into a type variable
		*/
		#define IOMUX_GPIO_ONLY BIT(0)
		@@ -74,6 +74,7 @@ enum rockchip_pinctrl_type {
		#define IOMUX_WIDTH_2BIT BIT(5)

		/**
		* struct rockchip_iomux
		* @type: iomux variant using IOMUX_* constants
		* @offset: if initialized to -1 it will be autocalculated, by specifying
		* an initial offset value the relevant source offset can be reset
		@@ -84,7 +85,7 @@ struct rockchip_iomux {
		int offset;
		};

		/**
		/*
		* enum type index corresponding to rockchip_perpin_drv_list arrays index.
		*/
		enum rockchip_pin_drv_type {
		@@ -96,7 +97,7 @@ enum rockchip_pin_drv_type {
		DRV_TYPE_MAX
		};

		/**
		/*
		* enum type index corresponding to rockchip_pull_list arrays index.
		*/
		enum rockchip_pin_pull_type {
		@@ -106,6 +107,7 @@ enum rockchip_pin_pull_type {
		};

		/**
		* struct rockchip_drv
		* @drv_type: drive strength variant using rockchip_perpin_drv_type
		* @offset: if initialized to -1 it will be autocalculated, by specifying
		* an initial offset value the relevant source offset can be reset
		@@ -119,8 +121,9 @@ struct rockchip_drv {
		};

		/**
		* struct rockchip_pin_bank
		* @reg_base: register base of the gpio bank
		* @reg_pull: optional separate register for additional pull settings
		* @regmap_pull: optional separate register for additional pull settings
		* @clk: clock of the gpio bank
		* @irq: interrupt of the gpio bank
		* @saved_masks: Saved content of GPIO_INTEN at suspend time.
		@@ -138,6 +141,8 @@ struct rockchip_drv {
		* @gpio_chip: gpiolib chip
		* @grange: gpio range
		* @slock: spinlock for the gpio bank
		* @toggle_edge_mode: bit mask to toggle (falling/rising) edge mode
		* @recalced_mask: bit mask to indicate a need to recalulate the mask
		* @route_mask: bits describing the routing pins of per bank
		*/
		struct rockchip_pin_bank {
		@@ -312,6 +317,7 @@ enum rockchip_mux_route_location {
		* @bank_num: bank number.
		* @pin: index at register or used to calc index.
		* @func: the min pin.
		* @route_location: the mux route location (same, pmu, grf).
		* @route_offset: the max pin.
		* @route_val: the register offset.
		*/
		@@ -324,8 +330,6 @@ struct rockchip_mux_route_data {
		u32 route_val;
		};

		/**
		*/
		struct rockchip_pin_ctrl {
		struct rockchip_pin_bank *pin_banks;
		u32 nr_banks;
		@@ -363,9 +367,7 @@ struct rockchip_pin_config {
		* @name: name of the pin group, used to lookup the group.
		* @pins: the pins included in this group.
		* @npins: number of pins included in this group.
		* @func: the mux function number to be programmed when selected.
		* @configs: the config values to be set for each pin
		* @nconfigs: number of configs for each pin
		* @data: local pin configuration
		*/
		struct rockchip_pin_group {
		const char *name;
		@@ -378,7 +380,7 @@ struct rockchip_pin_group {
		* struct rockchip_pmx_func: represent a pin function.
		* @name: name of the pin function, used to lookup the function.
		* @groups: one or more names of pin groups that provide this function.
		* @num_groups: number of groups included in @groups.
		* @ngroups: number of groups included in @groups.
		*/
		struct rockchip_pmx_func {
		const char *name;

Admin message