Re: [PATCH v11 1/6] pinctrl: s32cc: add/fix some comments

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
- [Low] Kernel-doc style comments use `/*` instead of `/**`.
- [Low] Typo 'pards' instead of 'pads' in the `struct s32_pinctrl_context` comment.
- [Low] Stylistic regression: capitalizing the first letter of a log message in `dev_err_probe`.
--

commit 0e69d63aa3bf617928fdc20d2e9e07024a115811
Author: Khristine Andreea Barbulescu <khristineandreea.barbulescu@oss.nxp.com>

pinctrl: s32cc: add/fix some comments

This commit adds and fixes some comments and print statements in the
s32cc pinctrl driver.

> diff --git a/drivers/pinctrl/nxp/pinctrl-s32cc.c b/drivers/pinctrl/nxp/pinctrl-s32cc.c
> index fe7cd641fddd0..4f88c24e62a21 100644
> --- a/drivers/pinctrl/nxp/pinctrl-s32cc.c
> +++ b/drivers/pinctrl/nxp/pinctrl-s32cc.c
> @@ -60,6 +60,12 @@ static u32 get_pin_func(u32 pinmux)
>  	return pinmux & GENMASK(3, 0);
>  }
>  
> +/*
> + * struct s32_pinctrl_mem_region - memory region for a set of SIUL2 registers

[Severity: Low]
This isn't a bug, but since these comments are written in the kernel-doc
format, should they begin with "/**" instead of "/*"? Using "/*" prevents the
scripts/kernel-doc parsing tool from reading them and integrating them into
the generated documentation.

> + * @map: regmap used for this range
> + * @pin_range: the pins controlled by these registers
> + * @name: name of the current range
> + */
>  struct s32_pinctrl_mem_region {
>  	struct regmap *map;

[ ... ]

> @@ -79,20 +85,22 @@ struct gpio_pin_config {
>  };
>  
>  /*
> - * Pad config save/restore for power suspend/resume.
> + * struct s32_pinctrl_context - pad config save/restore for suspend/resume
> + * @pads: saved values for the pards

[Severity: Low]
This isn't a bug, but there's a typo here. Should "pards" be "pads"?

>  */
>  struct s32_pinctrl_context {
>  	unsigned int *pads;
>  };
>  
>  /*
> + * struct s32_pinctrl - private driver data

[Severity: Low]
This is another instance where a kernel-doc style comment begins with "/*"
instead of "/**". Does this need to be updated to match the standard
documentation style?

>   * @dev: a pointer back to containing device
>   * @pctl: a pointer to the pinctrl device structure
>   * @regions: reserved memory regions with start/end pin
>   * @info: structure containing information about the pin

[ ... ]

> @@ -974,7 +982,7 @@ int s32_pinctrl_probe(struct platform_device *pdev,
>  					    ipctl);
>  	if (IS_ERR(ipctl->pctl))
>  		return dev_err_probe(&pdev->dev, PTR_ERR(ipctl->pctl),
> -				     "could not register s32 pinctrl driver\n");
> +				     "Could not register s32 pinctrl driver\n");

[Severity: Low]
This isn't a bug, but the Linux kernel coding style generally prefers starting
dev_err_probe messages with a lower-case letter. Is there a specific reason to
capitalize "Could" here?

>  
>  #ifdef CONFIG_PM_SLEEP
>  	saved_context = &ipctl->saved_context;

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260610132116.1998140-1-khristineandreea.barbulescu@oss.nxp.com?part=1