GitHub-Mirror/Star64_linux
2
0
Fork 0
mirror of https://github.com/Fishwaldo/Star64_linux.git synced 2025-06-07 07:08:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
>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>
This commit is contained in:
Lee Jones 2020-07-13 15:49:07 +01:00 • committed by Linus Walleij
parent 80fa3300b7
commit bef63e6615
1 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
drivers/pinctrl/sirf/pinctrl-atlas7.c
View file

@ -169,7 +169,7 @@ struct dt_params {
/** /**
* struct atlas7_pad_conf - Atlas7 Pad Configuration * 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. * @type: The type of this Pad.
* @mux_reg: The mux register offset. * @mux_reg: The mux register offset.
* This register contains the mux. * This register contains the mux.
@ -210,7 +210,7 @@ struct atlas7_pad_config {
.ad_ctrl_bit = adb, \ .ad_ctrl_bit = adb, \
} }
/** /*
* struct atlas7_pad_status - Atlas7 Pad status * struct atlas7_pad_status - Atlas7 Pad status
*/ */
struct atlas7_pad_status { struct atlas7_pad_status {
@ -355,10 +355,6 @@ struct atlas7_gpio_chip {
struct atlas7_gpio_bank banks[]; 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 atlas7_pmx {
struct device *dev; struct device *dev;
struct pinctrl_dev *pctl; struct pinctrl_dev *pctl;
@ -376,7 +372,7 @@ struct atlas7_pmx {
* refer to A7DA IO Summary - CS-314158-DD-4E.xls * refer to A7DA IO Summary - CS-314158-DD-4E.xls
*/ */
/*Pads in IOC RTC & TOP */ /* Pads in IOC RTC & TOP */
static const struct pinctrl_pin_desc atlas7_ioc_pads[] = { static const struct pinctrl_pin_desc atlas7_ioc_pads[] = {
/* RTC PADs */ /* RTC PADs */
PINCTRL_PIN(0, "rtc_gpio_0"), PINCTRL_PIN(0, "rtc_gpio_0"),
@ -4781,10 +4777,10 @@ struct map_data {
/** /**
* struct atlas7_pull_info - Atlas7 Pad pull info * 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. * @mask: The mas value of this pin's pull bits.
* @v2s: The map of pull register value to pull status. * @v2s: The map of pull register value to pull status.
* @s2v: The map of pull status to pull register value. * @s2v: The map of pull status to pull register value.
*/ */
struct atlas7_pull_info { struct atlas7_pull_info {
u8 pad_type; u8 pad_type;
@ -4908,6 +4904,7 @@ static const struct atlas7_ds_ma_info atlas7_ma2ds_map[] = {
* @type: The type of this Pad. * @type: The type of this Pad.
* @mask: The mask value of this pin's pull bits. * @mask: The mask value of this pin's pull bits.
* @imval: The immediate value of drives trength register. * @imval: The immediate value of drives trength register.
* @reserved: Reserved space
*/ */
struct atlas7_ds_info { struct atlas7_ds_info {
u8 type; u8 type;
@ -5609,7 +5606,7 @@ static int __init atlas7_pinmux_init(void)
arch_initcall(atlas7_pinmux_init); arch_initcall(atlas7_pinmux_init);
/** /*
* The Following is GPIO Code * The Following is GPIO Code
*/ */
static inline struct static inline struct