Commit bef63e66 authored Jul 13, 2020 by Lee Jones Committed by Linus Walleij Jul 16, 2020

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>

parent 80fa3300

drivers/pinctrl/sirf/pinctrl-atlas7.c

+9 −12

Original line number	Diff line number	Diff line
		@@ -169,7 +169,7 @@ struct dt_params {

		/**
		* struct atlas7_pad_conf - Atlas7 Pad Configuration
		* @id The ID of this Pad.
		* @id: The ID of this Pad.
		* @type: The type of this Pad.
		* @mux_reg: The mux register offset.
		* This register contains the mux.
		@@ -210,7 +210,7 @@ struct atlas7_pad_config {
		.ad_ctrl_bit = adb, \
		}

		/**
		/*
		* struct atlas7_pad_status - Atlas7 Pad status
		*/
		struct atlas7_pad_status {
		@@ -355,10 +355,6 @@ struct atlas7_gpio_chip {
		struct atlas7_gpio_bank banks[];
		};

		/**
		* @dev: a pointer back to containing device
		* @virtbase: the offset to the controller in virtual memory
		*/
		struct atlas7_pmx {
		struct device *dev;
		struct pinctrl_dev *pctl;
		@@ -4781,7 +4777,7 @@ struct map_data {

		/**
		* struct atlas7_pull_info - Atlas7 Pad pull info
		* @type:The type of this Pad.
		* @pad_type: The type of this Pad.
		* @mask: The mas value of this pin's pull bits.
		* @v2s: The map of pull register value to pull status.
		* @s2v: The map of pull status to pull register value.
		@@ -4908,6 +4904,7 @@ static const struct atlas7_ds_ma_info atlas7_ma2ds_map[] = {
		* @type: The type of this Pad.
		* @mask: The mask value of this pin's pull bits.
		* @imval: The immediate value of drives trength register.
		* @reserved: Reserved space
		*/
		struct atlas7_ds_info {
		u8 type;
		@@ -5609,7 +5606,7 @@ static int __init atlas7_pinmux_init(void)
		arch_initcall(atlas7_pinmux_init);


		/**
		/*
		* The Following is GPIO Code
		*/
		static inline struct

Admin message