This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.
After these patches are applied, the build system no longer
complains about any W=0 nor W=1 level warnings in drivers/pinctrl.
Hurrah!
Lee Jones (25):
pinctrl: actions: pinctrl-owl: Supply missing 'struct owl_pinctrl'
attribute descriptions
pinctrl: sirf: pinctrl-atlas7: Fix a bunch of documentation
misdemeanours
pinctrl: bcm: pinctrl-bcm281xx: Demote obvious misuse of kerneldoc to
standard comment blocks
pinctrl: bcm: pinctrl-iproc-gpio: Rename incorrectly documented
function param
pinctrl: qcom: pinctrl-msm: Complete 'struct msm_pinctrl'
documentation
pinctrl: samsung: pinctrl-samsung: Demote obvious misuse of kerneldoc
to standard comment blocks
pinctrl: samsung: pinctrl-s3c24xx: Fix formatting issues
pinctrl: samsung: pinctrl-s3c64xx: Fix formatting issues
pinctrl: qcom: pinctrl-msm8976: Remove unused variable
'nav_tsync_groups'
pinctrl: mediatek: pinctrl-mtk-common-v2: Mark
'mtk_default_register_base_names' as __maybe_unused
pinctrl: core: Fix a bunch of kerneldoc issues
pinctrl: pinmux: Add some missing parameter descriptions
pinctrl: devicetree: Add one new attribute description and rename
another two
pinctrl: pinconf-generic: Add function parameter description 'pctldev'
pinctrl: pinctrl-at91-pio4: PM related attribute descriptions
arch: arm: mach-at91: pm: Move prototypes to mutually included header
pinctrl: pinctrl-at91: Demote non-kerneldoc header and complete
another
pinctrl: pinctrl-bm1880: Rename ill documented struct attribute
entries
pinctrl: pinctrl-rockchip: Fix a bunch of kerneldoc misdemeanours
pinctrl: pinctrl-rza1: Demote some kerneldoc headers and fix others
pinctrl: pinctrl-single: Fix struct/function documentation blocks
pinctrl: tegra: pinctrl-tegra194: Do not initialise field twice
pinctrl: meson: pinctrl-meson-a1: Remove unused const variable
'i2c_slave_groups'
pinctrl: mvebu: pinctrl-armada-37xx: Update documentation block for
'struct armada_37xx_pin_group'
pinctrl: pinctrl-amd: Do not define 'struct acpi_device_id' when
!CONFIG_ACPI
arch/arm/mach-at91/pm.c | 17 +++++--------
drivers/pinctrl/actions/pinctrl-owl.c | 4 ++++
drivers/pinctrl/bcm/pinctrl-bcm281xx.c | 6 ++---
drivers/pinctrl/bcm/pinctrl-iproc-gpio.c | 2 +-
drivers/pinctrl/core.c | 12 +++++-----
drivers/pinctrl/devicetree.c | 5 ++--
.../pinctrl/mediatek/pinctrl-mtk-common-v2.h | 2 +-
drivers/pinctrl/meson/pinctrl-meson-a1.c | 5 ----
drivers/pinctrl/mvebu/pinctrl-armada-37xx.c | 7 +++---
drivers/pinctrl/pinconf-generic.c | 3 ++-
drivers/pinctrl/pinctrl-amd.c | 2 ++
drivers/pinctrl/pinctrl-at91-pio4.c | 2 ++
drivers/pinctrl/pinctrl-at91.c | 7 +++++-
drivers/pinctrl/pinctrl-bm1880.c | 4 ++--
drivers/pinctrl/pinctrl-rockchip.c | 22 +++++++++--------
drivers/pinctrl/pinctrl-rza1.c | 24 +++++++++----------
drivers/pinctrl/pinctrl-single.c | 13 +++++++---
drivers/pinctrl/pinmux.c | 5 +++-
drivers/pinctrl/qcom/pinctrl-msm.c | 6 ++++-
drivers/pinctrl/qcom/pinctrl-msm8976.c | 3 ---
drivers/pinctrl/samsung/pinctrl-s3c24xx.c | 6 ++---
drivers/pinctrl/samsung/pinctrl-s3c64xx.c | 6 ++---
drivers/pinctrl/samsung/pinctrl-samsung.c | 4 ++--
drivers/pinctrl/sirf/pinctrl-atlas7.c | 21 +++++++---------
drivers/pinctrl/tegra/pinctrl-tegra194.c | 1 -
include/linux/platform_data/atmel.h | 5 ++++
26 files changed, 107 insertions(+), 87 deletions(-)
--
2.25.1
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'
Cc: Barry Song <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/pinctrl/sirf/pinctrl-atlas7.c | 21 +++++++++------------
1 file changed, 9 insertions(+), 12 deletions(-)
diff --git a/drivers/pinctrl/sirf/pinctrl-atlas7.c b/drivers/pinctrl/sirf/pinctrl-atlas7.c
index 50df9e0844142..e54a6e3cafd23 100644
--- a/drivers/pinctrl/sirf/pinctrl-atlas7.c
+++ b/drivers/pinctrl/sirf/pinctrl-atlas7.c
@@ -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;
@@ -376,7 +372,7 @@ struct atlas7_pmx {
* 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[] = {
/* RTC PADs */
PINCTRL_PIN(0, "rtc_gpio_0"),
@@ -4781,10 +4777,10 @@ struct map_data {
/**
* struct atlas7_pull_info - Atlas7 Pad pull info
- * @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.
+ * @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.
*/
struct atlas7_pull_info {
u8 pad_type;
@@ -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
--
2.25.1
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'
Cc: Heiko Stuebner <[email protected]>
Cc: Jean-Christophe PLAGNIOL-VILLARD <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/pinctrl/pinctrl-rockchip.c | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/drivers/pinctrl/pinctrl-rockchip.c b/drivers/pinctrl/pinctrl-rockchip.c
index c07324d1f2657..c96d810635ad6 100644
--- a/drivers/pinctrl/pinctrl-rockchip.c
+++ b/drivers/pinctrl/pinctrl-rockchip.c
@@ -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;
--
2.25.1
Fixes the following W=1 kernel build warning(s):
drivers/pinctrl/pinctrl-at91-pio4.c:132: warning: Function parameter or member 'pm_wakeup_sources' not described in 'atmel_pioctrl'
drivers/pinctrl/pinctrl-at91-pio4.c:132: warning: Function parameter or member 'pm_suspend_backup' not described in 'atmel_pioctrl'
Cc: Ludovic Desroches <[email protected]>
Cc: Nicolas Ferre <[email protected]>
Cc: Alexandre Belloni <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/pinctrl/pinctrl-at91-pio4.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/drivers/pinctrl/pinctrl-at91-pio4.c b/drivers/pinctrl/pinctrl-at91-pio4.c
index 54222ccddfb19..8e5a5053a47e2 100644
--- a/drivers/pinctrl/pinctrl-at91-pio4.c
+++ b/drivers/pinctrl/pinctrl-at91-pio4.c
@@ -106,6 +106,8 @@ struct atmel_pin {
* @irq_domain: irq domain for the gpio controller.
* @irqs: table containing the hw irq number of the bank. The index of the
* table is the bank id.
+ * @pm_wakeup_sources: bitmap of wakeup sources (lines)
+ * @pm_suspend_backup: backup/restore register values on suspend/resume
* @dev: device entry for the Atmel PIO controller.
* @node: node of the Atmel PIO controller.
*/
--
2.25.1
Kerneldoc struct titles must be followed by whitespace. Also attributes
need to be in the format '@.*: ' else the checker gets confused.
Fixes the following W=1 kernel build warning(s):
drivers/pinctrl/samsung/pinctrl-s3c24xx.c:100: warning: cannot understand function prototype: 'struct s3c24xx_eint_domain_data '
Cc: Kukjin Kim <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Tomasz Figa <[email protected]>
Cc: Sylwester Nawrocki <[email protected]>
Cc: Heiko Stuebner <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/pinctrl/samsung/pinctrl-s3c24xx.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/drivers/pinctrl/samsung/pinctrl-s3c24xx.c b/drivers/pinctrl/samsung/pinctrl-s3c24xx.c
index 9bd0a3de101dd..5e24838a582f5 100644
--- a/drivers/pinctrl/samsung/pinctrl-s3c24xx.c
+++ b/drivers/pinctrl/samsung/pinctrl-s3c24xx.c
@@ -80,7 +80,7 @@ static const struct samsung_pin_bank_type bank_type_2bit = {
}
/**
- * struct s3c24xx_eint_data: EINT common data
+ * struct s3c24xx_eint_data - EINT common data
* @drvdata: pin controller driver data
* @domains: IRQ domains of particular EINT interrupts
* @parents: mapped parent irqs in the main interrupt controller
@@ -92,10 +92,10 @@ struct s3c24xx_eint_data {
};
/**
- * struct s3c24xx_eint_domain_data: per irq-domain data
+ * struct s3c24xx_eint_domain_data - per irq-domain data
* @bank: pin bank related to the domain
* @eint_data: common data
- * eint0_3_parent_only: live eints 0-3 only in the main intc
+ * @eint0_3_parent_only: live eints 0-3 only in the main intc
*/
struct s3c24xx_eint_domain_data {
struct samsung_pin_bank *bank;
--
2.25.1
There has been little to no attempt to document any of the demoted
structures here. These are obviously not kerneldoc headers.
Fixes the following W=1 kernel build warning(s):
drivers/pinctrl/bcm/pinctrl-bcm281xx.c:65: warning: cannot understand function prototype: 'enum bcm281xx_pin_type '
drivers/pinctrl/bcm/pinctrl-bcm281xx.c:79: warning: cannot understand function prototype: 'struct bcm281xx_pin_function '
drivers/pinctrl/bcm/pinctrl-bcm281xx.c:89: warning: cannot understand function prototype: 'struct bcm281xx_pinctrl_data '
Cc: Florian Fainelli <[email protected]>
Cc: Ray Jui <[email protected]>
Cc: Scott Branden <[email protected]>
Cc: [email protected]
Cc: YueHaibing <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/pinctrl/bcm/pinctrl-bcm281xx.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
index 71e6661783006..9ab1f427286a7 100644
--- a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
+++ b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
@@ -59,7 +59,7 @@
#define BCM281XX_HDMI_PIN_REG_MODE_MASK 0x0010
#define BCM281XX_HDMI_PIN_REG_MODE_SHIFT 4
-/**
+/*
* bcm281xx_pin_type - types of pin register
*/
enum bcm281xx_pin_type {
@@ -73,7 +73,7 @@ static enum bcm281xx_pin_type std_pin = BCM281XX_PIN_TYPE_STD;
static enum bcm281xx_pin_type i2c_pin = BCM281XX_PIN_TYPE_I2C;
static enum bcm281xx_pin_type hdmi_pin = BCM281XX_PIN_TYPE_HDMI;
-/**
+/*
* bcm281xx_pin_function- define pin function
*/
struct bcm281xx_pin_function {
@@ -82,7 +82,7 @@ struct bcm281xx_pin_function {
const unsigned ngroups;
};
-/**
+/*
* bcm281xx_pinctrl_data - Broadcom-specific pinctrl data
* @reg_base - base of pinctrl registers
*/
--
2.25.1
thanks.
On 2020-07-13 7:49 a.m., Lee Jones wrote:
> There has been little to no attempt to document any of the demoted
> structures here. These are obviously not kerneldoc headers.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/pinctrl/bcm/pinctrl-bcm281xx.c:65: warning: cannot understand function prototype: 'enum bcm281xx_pin_type '
> drivers/pinctrl/bcm/pinctrl-bcm281xx.c:79: warning: cannot understand function prototype: 'struct bcm281xx_pin_function '
> drivers/pinctrl/bcm/pinctrl-bcm281xx.c:89: warning: cannot understand function prototype: 'struct bcm281xx_pinctrl_data '
>
> Cc: Florian Fainelli <[email protected]>
> Cc: Ray Jui <[email protected]>
> Cc: Scott Branden <[email protected]>
> Cc: [email protected]
> Cc: YueHaibing <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
Acked-by: Scott Branden <[email protected]>
> ---
> drivers/pinctrl/bcm/pinctrl-bcm281xx.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
> index 71e6661783006..9ab1f427286a7 100644
> --- a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
> +++ b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
> @@ -59,7 +59,7 @@
> #define BCM281XX_HDMI_PIN_REG_MODE_MASK 0x0010
> #define BCM281XX_HDMI_PIN_REG_MODE_SHIFT 4
>
> -/**
> +/*
> * bcm281xx_pin_type - types of pin register
> */
> enum bcm281xx_pin_type {
> @@ -73,7 +73,7 @@ static enum bcm281xx_pin_type std_pin = BCM281XX_PIN_TYPE_STD;
> static enum bcm281xx_pin_type i2c_pin = BCM281XX_PIN_TYPE_I2C;
> static enum bcm281xx_pin_type hdmi_pin = BCM281XX_PIN_TYPE_HDMI;
>
> -/**
> +/*
> * bcm281xx_pin_function- define pin function
> */
> struct bcm281xx_pin_function {
> @@ -82,7 +82,7 @@ struct bcm281xx_pin_function {
> const unsigned ngroups;
> };
>
> -/**
> +/*
> * bcm281xx_pinctrl_data - Broadcom-specific pinctrl data
> * @reg_base - base of pinctrl registers
> */
Am Montag, 13. Juli 2020, 16:49:12 CEST schrieb Lee Jones:
> Kerneldoc struct titles must be followed by whitespace. Also attributes
> need to be in the format '@.*: ' else the checker gets confused.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/pinctrl/samsung/pinctrl-s3c24xx.c:100: warning: cannot understand function prototype: 'struct s3c24xx_eint_domain_data '
>
> Cc: Kukjin Kim <[email protected]>
> Cc: Krzysztof Kozlowski <[email protected]>
> Cc: Tomasz Figa <[email protected]>
> Cc: Sylwester Nawrocki <[email protected]>
> Cc: Heiko Stuebner <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
Reviewed-by: Heiko Stuebner <[email protected]>
> ---
> drivers/pinctrl/samsung/pinctrl-s3c24xx.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/pinctrl/samsung/pinctrl-s3c24xx.c b/drivers/pinctrl/samsung/pinctrl-s3c24xx.c
> index 9bd0a3de101dd..5e24838a582f5 100644
> --- a/drivers/pinctrl/samsung/pinctrl-s3c24xx.c
> +++ b/drivers/pinctrl/samsung/pinctrl-s3c24xx.c
> @@ -80,7 +80,7 @@ static const struct samsung_pin_bank_type bank_type_2bit = {
> }
>
> /**
> - * struct s3c24xx_eint_data: EINT common data
> + * struct s3c24xx_eint_data - EINT common data
> * @drvdata: pin controller driver data
> * @domains: IRQ domains of particular EINT interrupts
> * @parents: mapped parent irqs in the main interrupt controller
> @@ -92,10 +92,10 @@ struct s3c24xx_eint_data {
> };
>
> /**
> - * struct s3c24xx_eint_domain_data: per irq-domain data
> + * struct s3c24xx_eint_domain_data - per irq-domain data
> * @bank: pin bank related to the domain
> * @eint_data: common data
> - * eint0_3_parent_only: live eints 0-3 only in the main intc
> + * @eint0_3_parent_only: live eints 0-3 only in the main intc
> */
> struct s3c24xx_eint_domain_data {
> struct samsung_pin_bank *bank;
>
Am Montag, 13. Juli 2020, 16:49:24 CEST schrieb Lee Jones:
> 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'
>
> Cc: Heiko Stuebner <[email protected]>
> Cc: Jean-Christophe PLAGNIOL-VILLARD <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
Reviewed-by: Heiko Stuebner <[email protected]>
Thanks for fixing these doc issues
On Mon, Jul 13, 2020 at 4:49 PM Lee Jones <[email protected]> wrote:
> pinctrl: pinctrl-single: Fix struct/function documentation blocks
This patch didn't apply to v5.8-rc1 so I applied that one separately
after merging in all the other patches from a branch.
Seems to work! So all applied.
Also THANKS for doing this!!
Yours,
Linus Walleij
On Mon, Jul 13, 2020 at 03:49:12PM +0100, Lee Jones wrote:
> Kerneldoc struct titles must be followed by whitespace. Also attributes
> need to be in the format '@.*: ' else the checker gets confused.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/pinctrl/samsung/pinctrl-s3c24xx.c:100: warning: cannot understand function prototype: 'struct s3c24xx_eint_domain_data '
>
> Cc: Kukjin Kim <[email protected]>
> Cc: Krzysztof Kozlowski <[email protected]>
> Cc: Tomasz Figa <[email protected]>
> Cc: Sylwester Nawrocki <[email protected]>
> Cc: Heiko Stuebner <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/pinctrl/samsung/pinctrl-s3c24xx.c | 6 +++---
Thanks, applied.
Best regards,
Krzysztof
On Mon, 20 Jul 2020, Krzysztof Kozlowski wrote:
> On Mon, Jul 13, 2020 at 03:49:12PM +0100, Lee Jones wrote:
> > Kerneldoc struct titles must be followed by whitespace. Also attributes
> > need to be in the format '@.*: ' else the checker gets confused.
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/pinctrl/samsung/pinctrl-s3c24xx.c:100: warning: cannot understand function prototype: 'struct s3c24xx_eint_domain_data '
> >
> > Cc: Kukjin Kim <[email protected]>
> > Cc: Krzysztof Kozlowski <[email protected]>
> > Cc: Tomasz Figa <[email protected]>
> > Cc: Sylwester Nawrocki <[email protected]>
> > Cc: Heiko Stuebner <[email protected]>
> > Cc: [email protected]
> > Signed-off-by: Lee Jones <[email protected]>
> > ---
> > drivers/pinctrl/samsung/pinctrl-s3c24xx.c | 6 +++---
>
> Thanks, applied.
This has already been applied and resides in -next.
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog