[PATCH v2] spi: s3c64xx: fix all kernel-doc warnings

[PATCH v2] spi: s3c64xx: fix all kernel-doc warnings

[Randy Dunlap]

Add kernel-doc for one struct member and use the correct function name
to eliminate kernel-doc warnings:

Warning: include/linux/platform_data/spi-s3c64xx.h:40 struct member
 'polling' not described in 's3c64xx_spi_info'
Warning: include/linux/platform_data/spi-s3c64xx.h:51 expecting prototype
 for s3c64xx_spi_set_platdata(). Prototype was for
 s3c64xx_spi0_set_platdata() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@oss.qualcomm.com>
---
v2: add tag; rebase & resend

Cc: Andi Shyti <andi.shyti@kernel.org>
Cc: Tudor Ambarus <tudor.ambarus@linaro.org>
Cc: linux-spi@vger.kernel.org
Cc: linux-samsung-soc@vger.kernel.org
Cc: linux-arm-kernel@lists.infradead.org

 include/linux/platform_data/spi-s3c64xx.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20260415.orig/include/linux/platform_data/spi-s3c64xx.h
+++ linux-next-20260415/include/linux/platform_data/spi-s3c64xx.h
@@ -30,6 +30,7 @@ struct s3c64xx_spi_csinfo {
  * @src_clk_nr: Clock source index for the CLK_CFG[SPI_CLKSEL] field.
  * @num_cs: Number of CS this controller emulates.
  * @no_cs: Used when CS line is not connected.
+ * @polling: Using polling mode when %true (no 'dmas' property in devicetree)
  * @cfg_gpio: Configure pins for this SPI controller.
  */
 struct s3c64xx_spi_info {
@@ -41,7 +42,7 @@ struct s3c64xx_spi_info {
 };
 
 /**
- * s3c64xx_spi_set_platdata - SPI Controller configure callback by the board
+ * s3c64xx_spi0_set_platdata - SPI Controller configure callback by the board
  *				initialization code.
  * @src_clk_nr: Clock the SPI controller is to use to generate SPI clocks.
  * @num_cs: Number of elements in the 'cs' array.

Re: [PATCH v2] spi: s3c64xx: fix all kernel-doc warnings

[Tudor Ambarus]

Hi!

You missed adding the SPI maintainer. +Mark.

Also, there's another kdoc warning in that file. Do you care to fix it?

scripts/kernel-doc -none include/linux/platform_data/spi-s3c64xx.h
Warning: include/linux/platform_data/spi-s3c64xx.h:40 struct member 'polling' not described in 's3c64xx_spi_info'
Warning: include/linux/platform_data/spi-s3c64xx.h:51 expecting prototype for s3c64xx_spi_set_platdata(). Prototype was for s3c64xx_spi0_set_platdata() instead

Cheers,
ta

On 4/17/26 1:40 AM, Randy Dunlap wrote:
> Add kernel-doc for one struct member and use the correct function name
> to eliminate kernel-doc warnings:
> 
> Warning: include/linux/platform_data/spi-s3c64xx.h:40 struct member
>  'polling' not described in 's3c64xx_spi_info'
> Warning: include/linux/platform_data/spi-s3c64xx.h:51 expecting prototype
>  for s3c64xx_spi_set_platdata(). Prototype was for
>  s3c64xx_spi0_set_platdata() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@oss.qualcomm.com>
> ---
> v2: add tag; rebase & resend
> 
> Cc: Andi Shyti <andi.shyti@kernel.org>
> Cc: Tudor Ambarus <tudor.ambarus@linaro.org>
> Cc: linux-spi@vger.kernel.org
> Cc: linux-samsung-soc@vger.kernel.org
> Cc: linux-arm-kernel@lists.infradead.org
> 
>  include/linux/platform_data/spi-s3c64xx.h |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> --- linux-next-20260415.orig/include/linux/platform_data/spi-s3c64xx.h
> +++ linux-next-20260415/include/linux/platform_data/spi-s3c64xx.h
> @@ -30,6 +30,7 @@ struct s3c64xx_spi_csinfo {
>   * @src_clk_nr: Clock source index for the CLK_CFG[SPI_CLKSEL] field.
>   * @num_cs: Number of CS this controller emulates.
>   * @no_cs: Used when CS line is not connected.
> + * @polling: Using polling mode when %true (no 'dmas' property in devicetree)
>   * @cfg_gpio: Configure pins for this SPI controller.
>   */
>  struct s3c64xx_spi_info {
> @@ -41,7 +42,7 @@ struct s3c64xx_spi_info {
>  };
>  
>  /**
> - * s3c64xx_spi_set_platdata - SPI Controller configure callback by the board
> + * s3c64xx_spi0_set_platdata - SPI Controller configure callback by the board
>   *				initialization code.
>   * @src_clk_nr: Clock the SPI controller is to use to generate SPI clocks.
>   * @num_cs: Number of elements in the 'cs' array.

Re: [PATCH v2] spi: s3c64xx: fix all kernel-doc warnings

[Tudor Ambarus]

On 5/6/26 3:28 PM, Tudor Ambarus wrote:
> Hi!
> 
> You missed adding the SPI maintainer. +Mark.
> 
> Also, there's another kdoc warning in that file. Do you care to fix it?
> 
> scripts/kernel-doc -none include/linux/platform_data/spi-s3c64xx.h
> Warning: include/linux/platform_data/spi-s3c64xx.h:40 struct member 'polling' not described in 's3c64xx_spi_info'
> Warning: include/linux/platform_data/spi-s3c64xx.h:51 expecting prototype for s3c64xx_spi_set_platdata(). Prototype was for s3c64xx_spi0_set_platdata() instead


Ah, I misread, both are fixed.

Reviewed-by: Tudor Ambarus <tudor.ambarus@linaro.org>