Commit 6d31fa6a authored by Lee Jones's avatar Lee Jones Committed by Geert Uytterhoeven

pinctrl: rza1: Demote some kerneldoc headers and fix others

Some description blocks are void of any description/documentation,
others are missing 'struct' identifiers, there are also a couple of
misspellings of function parameter names.  Fix all of them.

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

 drivers/pinctrl/pinctrl-rza1.c:81: warning: cannot understand function prototype: 'struct rza1_bidir_pin '
 drivers/pinctrl/pinctrl-rza1.c:90: warning: cannot understand function prototype: 'struct rza1_bidir_entry '
 drivers/pinctrl/pinctrl-rza1.c:98: warning: cannot understand function prototype: 'struct rza1_swio_pin '
 drivers/pinctrl/pinctrl-rza1.c:108: warning: cannot understand function prototype: 'struct rza1_swio_entry '
 drivers/pinctrl/pinctrl-rza1.c:116: warning: cannot understand function prototype: 'struct rza1_pinmux_conf '
 drivers/pinctrl/pinctrl-rza1.c:443: warning: cannot understand function prototype: 'struct rza1_mux_conf '
 drivers/pinctrl/pinctrl-rza1.c:462: warning: cannot understand function prototype: 'struct rza1_port '
 drivers/pinctrl/pinctrl-rza1.c:482: warning: cannot understand function prototype: 'struct rza1_pinctrl '
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'port' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'pin' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'func' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:546: warning: Function parameter or member 'rza1_pctl' not described in 'rza1_pinmux_get_flags'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'port' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'reg' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'bit' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:575: warning: Function parameter or member 'set' not described in 'rza1_set_bit'
 drivers/pinctrl/pinctrl-rza1.c:672: warning: Function parameter or member 'rza1_pctl' not described in 'rza1_pin_mux_single'
 drivers/pinctrl/pinctrl-rza1.c:672: warning: Excess function parameter 'pinctrl' description in 'rza1_pin_mux_single'
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Acked-by: default avatarJacopo Mondi <jacopo@jmondi.org>
Link: https://lore.kernel.org/r/20200713144930.1034632-21-lee.jones@linaro.orgSigned-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
parent a5e8b53a
...@@ -75,7 +75,7 @@ ...@@ -75,7 +75,7 @@
* RZ/A1 pinmux flags * RZ/A1 pinmux flags
*/ */
/** /*
* rza1_bidir_pin - describe a single pin that needs bidir flag applied. * rza1_bidir_pin - describe a single pin that needs bidir flag applied.
*/ */
struct rza1_bidir_pin { struct rza1_bidir_pin {
...@@ -83,7 +83,7 @@ struct rza1_bidir_pin { ...@@ -83,7 +83,7 @@ struct rza1_bidir_pin {
u8 func: 4; u8 func: 4;
}; };
/** /*
* rza1_bidir_entry - describe a list of pins that needs bidir flag applied. * rza1_bidir_entry - describe a list of pins that needs bidir flag applied.
* Each struct rza1_bidir_entry describes a port. * Each struct rza1_bidir_entry describes a port.
*/ */
...@@ -92,7 +92,7 @@ struct rza1_bidir_entry { ...@@ -92,7 +92,7 @@ struct rza1_bidir_entry {
const struct rza1_bidir_pin *pins; const struct rza1_bidir_pin *pins;
}; };
/** /*
* rza1_swio_pin - describe a single pin that needs swio flag applied. * rza1_swio_pin - describe a single pin that needs swio flag applied.
*/ */
struct rza1_swio_pin { struct rza1_swio_pin {
...@@ -102,7 +102,7 @@ struct rza1_swio_pin { ...@@ -102,7 +102,7 @@ struct rza1_swio_pin {
u16 input: 1; u16 input: 1;
}; };
/** /*
* rza1_swio_entry - describe a list of pins that needs swio flag applied * rza1_swio_entry - describe a list of pins that needs swio flag applied
*/ */
struct rza1_swio_entry { struct rza1_swio_entry {
...@@ -110,7 +110,7 @@ struct rza1_swio_entry { ...@@ -110,7 +110,7 @@ struct rza1_swio_entry {
const struct rza1_swio_pin *pins; const struct rza1_swio_pin *pins;
}; };
/** /*
* rza1_pinmux_conf - group together bidir and swio pinmux flag tables * rza1_pinmux_conf - group together bidir and swio pinmux flag tables
*/ */
struct rza1_pinmux_conf { struct rza1_pinmux_conf {
...@@ -431,7 +431,7 @@ static const struct rza1_pinmux_conf rza1l_pmx_conf = { ...@@ -431,7 +431,7 @@ static const struct rza1_pinmux_conf rza1l_pmx_conf = {
* RZ/A1 types * RZ/A1 types
*/ */
/** /**
* rza1_mux_conf - describes a pin multiplexing operation * struct rza1_mux_conf - describes a pin multiplexing operation
* *
* @id: the pin identifier from 0 to RZA1_NPINS * @id: the pin identifier from 0 to RZA1_NPINS
* @port: the port where pin sits on * @port: the port where pin sits on
...@@ -450,7 +450,7 @@ struct rza1_mux_conf { ...@@ -450,7 +450,7 @@ struct rza1_mux_conf {
}; };
/** /**
* rza1_port - describes a pin port * struct rza1_port - describes a pin port
* *
* This is mostly useful to lock register writes per-bank and not globally. * This is mostly useful to lock register writes per-bank and not globally.
* *
...@@ -467,12 +467,12 @@ struct rza1_port { ...@@ -467,12 +467,12 @@ struct rza1_port {
}; };
/** /**
* rza1_pinctrl - RZ pincontroller device * struct rza1_pinctrl - RZ pincontroller device
* *
* @dev: parent device structure * @dev: parent device structure
* @mutex: protect [pinctrl|pinmux]_generic functions * @mutex: protect [pinctrl|pinmux]_generic functions
* @base: logical address base * @base: logical address base
* @nports: number of pin controller ports * @nport: number of pin controller ports
* @ports: pin controller banks * @ports: pin controller banks
* @pins: pin array for pinctrl core * @pins: pin array for pinctrl core
* @desc: pincontroller desc for pinctrl core * @desc: pincontroller desc for pinctrl core
...@@ -536,7 +536,7 @@ static inline int rza1_pinmux_get_swio(unsigned int port, ...@@ -536,7 +536,7 @@ static inline int rza1_pinmux_get_swio(unsigned int port,
return -ENOENT; return -ENOENT;
} }
/** /*
* rza1_pinmux_get_flags() - return pinmux flags associated to a pin * rza1_pinmux_get_flags() - return pinmux flags associated to a pin
*/ */
static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin, static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin,
...@@ -566,7 +566,7 @@ static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin, ...@@ -566,7 +566,7 @@ static unsigned int rza1_pinmux_get_flags(unsigned int port, unsigned int pin,
* RZ/A1 SoC operations * RZ/A1 SoC operations
*/ */
/** /*
* rza1_set_bit() - un-locked set/clear a single bit in pin configuration * rza1_set_bit() - un-locked set/clear a single bit in pin configuration
* registers * registers
*/ */
...@@ -664,7 +664,7 @@ static inline int rza1_pin_get(struct rza1_port *port, unsigned int pin) ...@@ -664,7 +664,7 @@ static inline int rza1_pin_get(struct rza1_port *port, unsigned int pin)
/** /**
* rza1_pin_mux_single() - configure pin multiplexing on a single pin * rza1_pin_mux_single() - configure pin multiplexing on a single pin
* *
* @pinctrl: RZ/A1 pin controller device * @rza1_pctl: RZ/A1 pin controller device
* @mux_conf: pin multiplexing descriptor * @mux_conf: pin multiplexing descriptor
*/ */
static int rza1_pin_mux_single(struct rza1_pinctrl *rza1_pctl, static int rza1_pin_mux_single(struct rza1_pinctrl *rza1_pctl,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment