All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 00/14] ASoC: clean up kernel-doc warnings
@ 2026-07-14  1:44 Randy Dunlap
  2026-07-14  1:44 ` [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format Randy Dunlap
                   ` (13 more replies)
  0 siblings, 14 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm

Clean up a bunch of kernel-doc warnings in the ASoC code.

[PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format
[PATCH 02/14] ASoC: fsl_asrc_common: fix all kernel-doc warnings
[PATCH 03/14] ASoC: fsl_asrc: avoid kernel-doc warnings
[PATCH 04/14] ASoC: fsl-dma: fix all kernel-doc warnings
[PATCH 05/14] ASoC: fsl_easrc: use struct keyword on structs
[PATCH 06/14] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments
[PATCH 07/14] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings
[PATCH 08/14] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions
[PATCH 09/14] ASoC: uniphier: don't use "/**" for non-kernel-doc comment
[PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field
[PATCH 11/14] ASoC: soc-acpi: fix all kernel-doc warnings
[PATCH 12/14] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format
[PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment
[PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments

 include/sound/sdca_function.h       |    6 
 include/sound/soc-acpi.h            |   23 +--
 include/sound/wm8904.h              |    4 
 include/uapi/sound/snd_ar_tokens.h  |    2 
 include/uapi/sound/snd_sst_tokens.h |  165 +++++++++++++-------------
 sound/soc/codecs/ntpfw.h            |   11 -
 sound/soc/fsl/fsl_asrc.h            |    6 
 sound/soc/fsl/fsl_asrc_common.h     |    8 -
 sound/soc/fsl/fsl_dma.h             |    4 
 sound/soc/fsl/fsl_easrc.h           |    4 
 sound/soc/fsl/mpc5200_dma.h         |    4 
 sound/soc/fsl/mpc5200_psc_i2s.c     |    8 +
 sound/soc/fsl/p1022_ds.c            |    4 
 sound/soc/uniphier/aio.h            |    2 
 14 files changed, 136 insertions(+), 115 deletions(-)

Cc: Jaroslav Kysela <perex@perex.cz>
Cc: Takashi Iwai <tiwai@suse.com>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org
Cc: Charles Keepax <ckeepax@opensource.cirrus.com>
Cc: Maciej Strozek <mstrozek@opensource.cirrus.com>
Cc: Bard Liao <yung-chuan.liao@linux.intel.com>
Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.dev>
Cc: patches@opensource.cirrus.com
Cc: Srinivas Kandagatla <srini@kernel.org>
Cc: linux-arm-msm@vger.kernel.org

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14 10:20   ` Mark Brown
  2026-07-14  1:44 ` [PATCH 02/14] ASoC: fsl_asrc_common: fix all kernel-doc warnings Randy Dunlap
                   ` (12 subsequent siblings)
  13 siblings, 1 reply; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Don't use "/**" for a non-kernel-doc comment.
Use kernel-doc notation to document the parameters and return value of
ntpfw_load().

Fixes these warnings:
Warning: ../sound/soc/codecs/ntpfw.h:2 This comment starts with '/**', but isn't a kernel-doc comment.
 * ntpfw.h - Firmware helper functions for Neofidelity codecs
Warning: sound/soc/codecs/ntpfw.h:20 function parameter 'i2c' not described in 'ntpfw_load'
Warning: sound/soc/codecs/ntpfw.h:20 function parameter 'name' not described in 'ntpfw_load'
Warning: sound/soc/codecs/ntpfw.h:20 function parameter 'magic' not described in 'ntpfw_load'
Warning: sound/soc/codecs/ntpfw.h:20 No description found for return value of 'ntpfw_load'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>

 sound/soc/codecs/ntpfw.h |   11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

--- linext-2026-0710.orig/sound/soc/codecs/ntpfw.h
+++ linext-2026-0710/sound/soc/codecs/ntpfw.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * ntpfw.h - Firmware helper functions for Neofidelity codecs
  *
  * Copyright (c) 2024, SaluteDevices. All Rights Reserved.
@@ -13,10 +13,11 @@
 /**
  * ntpfw_load - load firmware to amplifier over i2c interface.
  *
- * @i2c		Pointer to amplifier's I2C client.
- * @name	Firmware file name.
- * @magic	Magic number to validate firmware.
- * @return	0 or error code upon error.
+ * @i2c:	Pointer to amplifier's I2C client.
+ * @name:	Firmware file name.
+ * @magic:	Magic number to validate firmware.
+ *
+ * Returns:	0 or error code upon error.
  */
 int ntpfw_load(struct i2c_client *i2c, const char *name, const u32 magic);
 

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 02/14] ASoC: fsl_asrc_common: fix all kernel-doc warnings
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
  2026-07-14  1:44 ` [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 03/14] ASoC: fsl_asrc: avoid " Randy Dunlap
                   ` (11 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Add missing struct fields for struct fsl_asrc_m2m_cap.
Add the missing "struct" keyword on struct kernel-doc headings.

Warning: ../sound/soc/fsl/fsl_asrc_common.h:65 cannot understand function prototype: 'struct fsl_asrc_pair'
Warning: ../sound/soc/fsl/fsl_asrc_common.h:129 cannot understand function prototype: 'struct fsl_asrc'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/fsl_asrc_common.h |    8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

--- linext-2026-0710.orig/sound/soc/fsl/fsl_asrc_common.h
+++ linext-2026-0710/sound/soc/fsl/fsl_asrc_common.h
@@ -28,7 +28,9 @@ enum asrc_pair_index {
  * @chan_min: minimum channel number
  * @chan_max: maximum channel number
  * @rate_in: minimum rate
- * @rate_out: maximum rete
+ * @rate_in_count: number of array elements in @rate_in
+ * @rate_out: maximum rate
+ * @rate_out_count: number of array elements in @rate_out
  */
 struct fsl_asrc_m2m_cap {
 	u64 fmt_in;
@@ -42,7 +44,7 @@ struct fsl_asrc_m2m_cap {
 };
 
 /**
- * fsl_asrc_pair: ASRC Pair common data
+ * struct fsl_asrc_pair - ASRC Pair common data
  *
  * @asrc: pointer to its parent module
  * @error: error record
@@ -90,7 +92,7 @@ struct fsl_asrc_pair {
 };
 
 /**
- * fsl_asrc: ASRC common data
+ * struct fsl_asrc - ASRC common data
  *
  * @dma_params_rx: DMA parameters for receive channel
  * @dma_params_tx: DMA parameters for transmit channel

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 03/14] ASoC: fsl_asrc: avoid kernel-doc warnings
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
  2026-07-14  1:44 ` [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format Randy Dunlap
  2026-07-14  1:44 ` [PATCH 02/14] ASoC: fsl_asrc_common: fix all kernel-doc warnings Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 04/14] ASoC: fsl-dma: fix all " Randy Dunlap
                   ` (10 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Use the struct keyword to describe structs in kernel-doc format. This
prevents kernel-doc warnings:

Warning: ../sound/soc/fsl/fsl_asrc.h:452 cannot understand function prototype: 'struct fsl_asrc_soc_data'
Warning: ../sound/soc/fsl/fsl_asrc.h:463 cannot understand function prototype: 'struct fsl_asrc_pair_priv'
Warning: ../sound/soc/fsl/fsl_asrc.h:475 cannot understand function prototype: 'struct fsl_asrc_priv'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/fsl_asrc.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- linext-2026-0710.orig/sound/soc/fsl/fsl_asrc.h
+++ linext-2026-0710/sound/soc/fsl/fsl_asrc.h
@@ -444,7 +444,7 @@ struct dma_block {
 };
 
 /**
- * fsl_asrc_soc_data: soc specific data
+ * struct fsl_asrc_soc_data - soc specific data
  *
  * @use_edma: using edma as dma device or not
  * @channel_bits: width of ASRCNCR register for each pair
@@ -457,7 +457,7 @@ struct fsl_asrc_soc_data {
 };
 
 /**
- * fsl_asrc_pair_priv: ASRC Pair private data
+ * struct fsl_asrc_pair_priv - ASRC Pair private data
  *
  * @config: configuration profile
  */
@@ -466,7 +466,7 @@ struct fsl_asrc_pair_priv {
 };
 
 /**
- * fsl_asrc_priv: ASRC private data
+ * struct fsl_asrc_priv - ASRC private data
  *
  * @asrck_clk: clock sources to driver ASRC internal logic
  * @soc: soc specific data

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 04/14] ASoC: fsl-dma: fix all kernel-doc warnings
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (2 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 03/14] ASoC: fsl_asrc: avoid " Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 05/14] ASoC: fsl_easrc: use struct keyword on structs Randy Dunlap
                   ` (9 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Don't use "/**" for non-kernel-doc comments to avoid kernel-doc warnings:

Warning: ../sound/soc/fsl/fsl_dma.h:95 This comment starts with '/**', but isn't a kernel-doc comment.
 *  List Descriptor for extended chaining mode DMA operations.
Warning: ../sound/soc/fsl/fsl_dma.h:110 This comment starts with '/**', but isn't a kernel-doc comment.
 *  Link Descriptor for basic and extended chaining mode DMA operations.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/fsl_dma.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linext-2026-0710.orig/sound/soc/fsl/fsl_dma.h
+++ linext-2026-0710/sound/soc/fsl/fsl_dma.h
@@ -92,7 +92,7 @@ static inline u32 CCSR_DMA_ECLNDAR_ADDR(
 #define CCSR_DMA_ATR_SNOOP      	0x00050000
 #define CCSR_DMA_ATR_ESAD_MASK  	0x0000000F
 
-/**
+/*
  *  List Descriptor for extended chaining mode DMA operations.
  *
  *  The CLSDAR register points to the first (in a linked-list) List
@@ -107,7 +107,7 @@ struct fsl_dma_list_descriptor {
 	u8 res[8];      	/* Reserved */
 } __attribute__ ((aligned(32), packed));
 
-/**
+/*
  *  Link Descriptor for basic and extended chaining mode DMA operations.
  *
  *  A Link Descriptor points to a single DMA buffer.  Each link descriptor

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 05/14] ASoC: fsl_easrc: use struct keyword on structs
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (3 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 04/14] ASoC: fsl-dma: fix all " Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 06/14] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments Randy Dunlap
                   ` (8 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Use the documented format for kernel-doc of structs to prevent
kernel-doc warnings:

Warning: ../sound/soc/fsl/fsl_easrc.h:606 cannot understand function prototype: 'struct fsl_easrc_ctx_priv'
Warning: ../sound/soc/fsl/fsl_easrc.h:641 cannot understand function prototype: 'struct fsl_easrc_priv'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/fsl_easrc.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linext-2026-0710.orig/sound/soc/fsl/fsl_easrc.h
+++ linext-2026-0710/sound/soc/fsl/fsl_easrc.h
@@ -584,7 +584,7 @@ struct fsl_easrc_slot {
 };
 
 /**
- * fsl_easrc_ctx_priv: EASRC context private data
+ * struct fsl_easrc_ctx_priv - EASRC context private data
  *
  * @in_params: input parameter
  * @out_params:  output parameter
@@ -625,7 +625,7 @@ struct fsl_easrc_ctx_priv {
 };
 
 /**
- * fsl_easrc_priv: EASRC private data
+ * struct fsl_easrc_priv - EASRC private data
  *
  * @slot: slot setting
  * @firmware_hdr:  the header of firmware

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 06/14] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (4 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 05/14] ASoC: fsl_easrc: use struct keyword on structs Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 07/14] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings Randy Dunlap
                   ` (7 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Use the documented format for kernel-doc of structs and the correct
struct name to prevent kernel-doc warnings:

Warning: ../sound/soc/fsl/mpc5200_dma.h:21 cannot understand function prototype: 'struct psc_dma_stream'
Warning: ../sound/soc/fsl/mpc5200_dma.h:50 cannot understand function prototype: 'struct psc_dma'
Warning: sound/soc/fsl/mpc5200_dma.h:35 expecting prototype for struct psc_ac97_stream. Prototype was for struct psc_dma_stream instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/mpc5200_dma.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linext-2026-0710.orig/sound/soc/fsl/mpc5200_dma.h
+++ linext-2026-0710/sound/soc/fsl/mpc5200_dma.h
@@ -9,7 +9,7 @@
 #define PSC_STREAM_NAME_LEN 32
 
 /**
- * psc_ac97_stream - Data specific to a single stream (playback or capture)
+ * struct psc_dma_stream - Data specific to a single stream (playback or capture)
  * @active:		flag indicating if the stream is active
  * @psc_dma:		pointer back to parent psc_dma data structure
  * @bcom_task:		bestcomm task structure
@@ -36,7 +36,7 @@ struct psc_dma_stream {
 };
 
 /**
- * psc_dma - Private driver data
+ * struct psc_dma - Private driver data
  * @name: short name for this device ("PSC0", "PSC1", etc)
  * @psc_regs: pointer to the PSC's registers
  * @fifo_regs: pointer to the PSC's FIFO registers

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 07/14] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (5 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 06/14] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 08/14] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions Randy Dunlap
                   ` (6 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Add missing kernel-doc for function parameters.
Use kernel-doc format for function return value descriptions.
Use the "var" keyword to describe a data definition.

These changes avoid all kernel-doc warnings in this file:

Warning: ../sound/soc/fsl/mpc5200_psc_i2s.c:123 cannot understand function prototype: 'const struct snd_soc_dai_ops psc_i2s_dai_ops ='
Warning: sound/soc/fsl/mpc5200_psc_i2s.c:87 function parameter 'cpu_dai' not described in 'psc_i2s_set_sysclk'
Warning: sound/soc/fsl/mpc5200_psc_i2s.c:87 No description found for return value of 'psc_i2s_set_sysclk'
Warning: sound/soc/fsl/mpc5200_psc_i2s.c:106 function parameter 'cpu_dai' not described in 'psc_i2s_set_fmt'
Warning: sound/soc/fsl/mpc5200_psc_i2s.c:106 No description found for return value of 'psc_i2s_set_fmt'
Warning: sound/soc/fsl/mpc5200_psc_i2s.c:123 cannot understand function prototype: 'const struct snd_soc_dai_ops psc_i2s_dai_ops ='

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/mpc5200_psc_i2s.c |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

--- linext-2026-0710.orig/sound/soc/fsl/mpc5200_psc_i2s.c
+++ linext-2026-0710/sound/soc/fsl/mpc5200_psc_i2s.c
@@ -79,9 +79,12 @@ static int psc_i2s_hw_params(struct snd_
  * and we don't care about the frequency.  Return an error if the direction
  * is not SND_SOC_CLOCK_IN.
  *
+ * @cpu_dai: DAI runtime data pointer
  * @clk_id: reserved, should be zero
  * @freq: the frequency of the given clock ID, currently ignored
  * @dir: SND_SOC_CLOCK_IN (clock slave) or SND_SOC_CLOCK_OUT (clock master)
+ *
+ * Returns: %0 on success or %-EINVAL on failure.
  */
 static int psc_i2s_set_sysclk(struct snd_soc_dai *cpu_dai,
 			      int clk_id, unsigned int freq, int dir)
@@ -101,7 +104,10 @@ static int psc_i2s_set_sysclk(struct snd
  * This driver only supports I2S mode.  Return an error if the format is
  * not SND_SOC_DAIFMT_I2S.
  *
+ * @cpu_dai: DAI runtime data pointer
  * @format: one of SND_SOC_DAIFMT_xxx
+ *
+ * Returns: %0 on success or %-EINVAL on failure.
  */
 static int psc_i2s_set_fmt(struct snd_soc_dai *cpu_dai, unsigned int format)
 {
@@ -119,7 +125,7 @@ static int psc_i2s_set_fmt(struct snd_so
  */
 
 /**
- * psc_i2s_dai_template: template CPU Digital Audio Interface
+ * var psc_i2s_dai_ops - template CPU Digital Audio Interface
  */
 static const struct snd_soc_dai_ops psc_i2s_dai_ops = {
 	.hw_params	= psc_i2s_hw_params,

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 08/14] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (6 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 07/14] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 09/14] ASoC: uniphier: don't use "/**" for non-kernel-doc comment Randy Dunlap
                   ` (5 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

The kernel-doc short description is assumed to be a function unless
indicated by a keyword. Add the missing keyword (struct, var) to avoid
kernel-doc warnings:

Warning: sound/soc/fsl/p1022_ds.c:62 cannot understand function prototype: 'struct machine_data'
Warning: sound/soc/fsl/p1022_ds.c:182 cannot understand function prototype: 'const struct snd_soc_ops p1022_ds_ops ='

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Shengjiu Wang <shengjiu.wang@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org

 sound/soc/fsl/p1022_ds.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linext-2026-0710.orig/sound/soc/fsl/p1022_ds.c
+++ linext-2026-0710/sound/soc/fsl/p1022_ds.c
@@ -55,7 +55,7 @@ static inline void guts_set_dmuxcr(struc
 static phys_addr_t guts_phys;
 
 /**
- * machine_data: machine-specific ASoC device data
+ * struct machine_data - machine-specific ASoC device data
  *
  * This structure contains data for a single sound platform device on an
  * P1022 DS.  Some of the data is taken from the device tree.
@@ -178,7 +178,7 @@ static int p1022_ds_machine_remove(struc
 }
 
 /**
- * p1022_ds_ops: ASoC machine driver operations
+ * var p1022_ds_ops - ASoC machine driver operations
  */
 static const struct snd_soc_ops p1022_ds_ops = {
 	.startup = p1022_ds_startup,

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 09/14] ASoC: uniphier: don't use "/**" for non-kernel-doc comment
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (7 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 08/14] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field Randy Dunlap
                   ` (4 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Use a C-style "/*" comment to avoid multiple kernel-doc warnings:

Warning: ../sound/soc/uniphier/aio.h:159 Cannot find identifier on line:
 * 'SoftWare MAPping' setting of UniPhier AIO registers.
Warning: ../sound/soc/uniphier/aio.h:160 Cannot find identifier on line: *
Warning: ../sound/soc/uniphier/aio.h:161 This comment starts with '/**', but isn't a kernel-doc comment.
 * We have to setup 'virtual' register maps to access 'real' registers of AIO.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>

 sound/soc/uniphier/aio.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linext-2026-0710.orig/sound/soc/uniphier/aio.h
+++ linext-2026-0710/sound/soc/uniphier/aio.h
@@ -156,7 +156,7 @@ struct uniphier_aio_selector {
 	int hw;
 };
 
-/**
+/*
  * 'SoftWare MAPping' setting of UniPhier AIO registers.
  *
  * We have to setup 'virtual' register maps to access 'real' registers of AIO.

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (8 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 09/14] ASoC: uniphier: don't use "/**" for non-kernel-doc comment Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  8:40   ` Charles Keepax
  2026-07-14  1:44 ` [PATCH 11/14] ASoC: soc-acpi: fix all kernel-doc warnings Randy Dunlap
                   ` (3 subsequent siblings)
  13 siblings, 1 reply; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Add a kernel-doc comment for @is_volatile in struct sdca_control.
Correct 2 malformed enum names to match the enums.
Fixes 3 warnings:

Warning: include/sound/sdca_function.h:306 expecting prototype for enum sdca_set_index_range. Prototype was for enum sdca_fdl_set_index_range instead

Warning: include/sound/sdca_function.h:829 struct member 'is_volatile' not described in 'sdca_control'

Warning: include/sound/sdca_function.h:1152 expecting prototype for enum sdca_xu_reset_machanism. Prototype was for enum sdca_xu_reset_mechanism instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Charles Keepax <ckeepax@opensource.cirrus.com>
Cc: Maciej Strozek <mstrozek@opensource.cirrus.com>
Cc: Bard Liao <yung-chuan.liao@linux.intel.com>
Cc: Pierre-Louis Bossart <pierre-louis.bossart@linux.dev>
Cc: patches@opensource.cirrus.com

 include/sound/sdca_function.h |    6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

--- linext-2026-0710.orig/include/sound/sdca_function.h
+++ linext-2026-0710/include/sound/sdca_function.h
@@ -298,7 +298,7 @@ enum sdca_xu_controls {
 };
 
 /**
- * enum sdca_set_index_range - Column definitions UMP SetIndex
+ * enum sdca_fdl_set_index_range - Column definitions UMP SetIndex
  */
 enum sdca_fdl_set_index_range {
 	SDCA_FDL_SET_INDEX_SET_NUMBER			= 0,
@@ -803,6 +803,8 @@ struct sdca_control_range {
  * @mode: Access mode of the Control.
  * @layers: Bitmask of access layers of the Control.
  * @deferrable: Indicates if the access to the Control can be deferred.
+ * @is_volatile: Indicates the Control registers are forced to be treated
+ *  as volatile.
  * @has_default: Indicates the Control has a default value to be written.
  * @has_reset: Indicates the Control has a defined reset value.
  * @has_fixed: Indicates the Control only supports a single value.
@@ -1144,7 +1146,7 @@ struct sdca_entity_hide {
 };
 
 /**
- * enum sdca_xu_reset_machanism - SDCA FDL Resets
+ * enum sdca_xu_reset_mechanism - SDCA FDL Resets
  */
 enum sdca_xu_reset_mechanism {
 	SDCA_XU_RESET_FUNCTION				= 0x0,

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 11/14] ASoC: soc-acpi: fix all kernel-doc warnings
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (9 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 12/14] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format Randy Dunlap
                   ` (2 subsequent siblings)
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Add missing "struct" keyword to kernel-doc for structs.
Describe @mach_params in struct snd_soc_acpi_mach.
Don't document callback parameters with '@' as though they are kernel-doc.

These changes avoid all kernel-doc warnings in this header file.

Examples:
Warning: ../include/sound/soc-acpi.h:77 cannot understand function prototype: 'struct snd_soc_acpi_mach_params'
Warning: ../include/sound/soc-acpi.h:101 cannot understand function prototype: 'struct snd_soc_acpi_endpoint'
Warning: ../include/sound/soc-acpi.h:115 cannot understand function prototype: 'struct snd_soc_acpi_adr_device'
Warning: ../include/sound/soc-acpi.h:132 cannot understand function prototype: 'struct snd_soc_acpi_link_adr'
Warning: ../include/sound/soc-acpi.h:209 cannot understand function prototype: 'struct snd_soc_acpi_mach'

Warning: include/sound/soc-acpi.h:230 struct member 'mach_params' not described in 'snd_soc_acpi_mach'
Warning: include/sound/soc-acpi.h:230 Excess struct member 'card' description in 'snd_soc_acpi_mach'
Warning: include/sound/soc-acpi.h:230 Excess struct member 'mach' description in 'snd_soc_acpi_mach'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>

 include/sound/soc-acpi.h |   23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

--- linext-2026-0710.orig/include/sound/soc-acpi.h
+++ linext-2026-0710/include/sound/soc-acpi.h
@@ -57,7 +57,7 @@ static inline struct snd_soc_acpi_mach *
 #endif
 
 /**
- * snd_soc_acpi_mach_params: interface for machine driver configuration
+ * struct snd_soc_acpi_mach_params - interface for machine driver configuration
  *
  * @acpi_ipc_irq_index: used for BYT-CR detection
  * @platform: string used for HDAudio codec support
@@ -93,7 +93,7 @@ struct snd_soc_acpi_mach_params {
 };
 
 /**
- * snd_soc_acpi_endpoint - endpoint descriptor
+ * struct snd_soc_acpi_endpoint - endpoint descriptor
  * @num: endpoint number (mandatory, unique per device)
  * @aggregated: 0 (independent) or 1 (logically grouped)
  * @group_position: zero-based order (only when @aggregated is 1)
@@ -107,7 +107,7 @@ struct snd_soc_acpi_endpoint {
 };
 
 /**
- * snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device
+ * struct snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device
  * @adr: 64 bit ACPI _ADR value
  * @num_endpoints: number of endpoints for this device
  * @endpoints: array of endpoints
@@ -121,7 +121,7 @@ struct snd_soc_acpi_adr_device {
 };
 
 /**
- * snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices
+ * struct snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices
  * @mask: one bit set indicates the link this list applies to
  * @num_adr: ARRAY_SIZE of devices
  * @adr_d: array of devices
@@ -167,8 +167,8 @@ struct snd_soc_acpi_link_adr {
 #define SND_SOC_ACPI_TPLG_INTEL_CODEC_NAME BIT(4)
 
 /**
- * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are
- * related to the hardware, except for the firmware and topology file names.
+ * struct snd_soc_acpi_mach - ACPI-based machine descriptor. Most of the fields
+ * are related to the hardware, except for the firmware and topology file names.
  * A platform supported by legacy and Sound Open Firmware (SOF) would expose
  * all firmware/topology related fields.
  *
@@ -192,6 +192,7 @@ struct snd_soc_acpi_link_adr {
  * the initial selection in the snd_soc_acpi_mach table.
  * @pdata: intended for platform data or machine specific-ops. This structure
  *  is not constant since this field may be updated at run-time
+ * @mach_params: machine driver configuration
  * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled
  * @tplg_quirk_mask: quirks to select different topology files dynamically
  * @get_function_tplg_files: This is an optional callback, if specified then instead of
@@ -199,11 +200,11 @@ struct snd_soc_acpi_link_adr {
  *	files to be loaded.
  *	Return value: The number of the files or negative ERRNO. 0 means that the single topology
  *		      file should be used, no function topology split can be used on the machine.
- *	@card: the pointer of the card
- *	@mach: the pointer of the machine driver
- *	@prefix: the prefix of the topology file name. Typically, it is the path.
- *	@tplg_files: the pointer of the array of the topology file names.
- *	@best_effort: ignore non supported links and try to build the card in best effort
+ *	card: the pointer of the card
+ *	mach: the pointer of the machine driver
+ *	prefix: the prefix of the topology file name. Typically, it is the path.
+ *	tplg_files: the pointer of the array of the topology file names.
+ *	best_effort: ignore non supported links and try to build the card in best effort
  *		      with supported links
  */
 /* Descriptor for SST ASoC machine driver */

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 12/14] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (10 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 11/14] ASoC: soc-acpi: fix all kernel-doc warnings Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  1:44 ` [PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment Randy Dunlap
  2026-07-14  1:44 ` [PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments Randy Dunlap
  13 siblings, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Convert enum SKL_TKNS to kernel-doc format:
- use '@' instead of '%' for enum items
- add missing enum values
- correct a few enum names in the comments
- remove the comment for %SKL_TKN_U16_PIN_INST_ID since it is undefined
- fix a few typos

Warning: include/uapi/sound/snd_sst_tokens.h:11 Cannot find identifier on line:
 * %SKL_TKN_UUID:               Module UUID
Warning: ../include/uapi/sound/snd_sst_tokens.h:12 Cannot find identifier on line: *
Warning: ../include/uapi/sound/snd_sst_tokens.h:13 Cannot find identifier on line:
 * %SKL_TKN_U8_BLOCK_TYPE:      Type of the private data block.Can be:
Warning: include/uapi/sound/snd_sst_tokens.h:14 This comment starts with '/**', but isn't a kernel-doc comment.
 *                              tuples, bytes, short and words

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>

 include/uapi/sound/snd_sst_tokens.h |  165 +++++++++++++-------------
 1 file changed, 87 insertions(+), 78 deletions(-)

--- linext-2026-0710.orig/include/uapi/sound/snd_sst_tokens.h
+++ linext-2026-0710/include/uapi/sound/snd_sst_tokens.h
@@ -9,43 +9,47 @@
 #define __SND_SST_TOKENS_H__
 
 /**
- * %SKL_TKN_UUID:               Module UUID
+ * enum SKL_TKNS - SST tokens definitions
  *
- * %SKL_TKN_U8_BLOCK_TYPE:      Type of the private data block.Can be:
+ * @SKL_TKN_UUID:               Module UUID
+ *
+ * @SKL_TKN_U8_BLOCK_TYPE:      Type of the private data block.Can be:
  *                              tuples, bytes, short and words
  *
- * %SKL_TKN_U8_IN_PIN_TYPE:     Input pin type,
+ * @SKL_TKN_U8_NUM_BLOCKS:      FIXME
+ *
+ * @SKL_TKN_U8_IN_PIN_TYPE:     Input pin type,
  *                              homogenous=0, heterogenous=1
  *
- * %SKL_TKN_U8_OUT_PIN_TYPE:    Output pin type,
+ * @SKL_TKN_U8_OUT_PIN_TYPE:    Output pin type,
  *                              homogenous=0, heterogenous=1
- * %SKL_TKN_U8_DYN_IN_PIN:      Configure Input pin dynamically
+ * @SKL_TKN_U8_DYN_IN_PIN:      Configure Input pin dynamically
  *                              if true
  *
- * %SKL_TKN_U8_DYN_OUT_PIN:     Configure Output pin dynamically
+ * @SKL_TKN_U8_DYN_OUT_PIN:     Configure Output pin dynamically
  *                              if true
  *
- * %SKL_TKN_U8_IN_QUEUE_COUNT:  Store the number of Input pins
+ * @SKL_TKN_U8_IN_QUEUE_COUNT:  Store the number of Input pins
  *
- * %SKL_TKN_U8_OUT_QUEUE_COUNT: Store the number of Output pins
+ * @SKL_TKN_U8_OUT_QUEUE_COUNT: Store the number of Output pins
  *
- * %SKL_TKN_U8_TIME_SLOT:       TDM slot number
+ * @SKL_TKN_U8_TIME_SLOT:       TDM slot number
  *
- * %SKL_TKN_U8_CORE_ID:         Stores module affinity value.Can take
+ * @SKL_TKN_U8_CORE_ID:         Stores module affinity value. Can take
  *                              the values:
  *                              SKL_AFFINITY_CORE_0 = 0,
  *                              SKL_AFFINITY_CORE_1,
  *                              SKL_AFFINITY_CORE_MAX
  *
- * %SKL_TKN_U8_MOD_TYPE:        Module type value.
+ * @SKL_TKN_U8_MOD_TYPE:        Module type value.
  *
- * %SKL_TKN_U8_CONN_TYPE:       Module connection type can be a FE,
+ * @SKL_TKN_U8_CONN_TYPE:       Module connection type can be a FE,
  *                              BE or NONE as defined :
  *                              SKL_PIPE_CONN_TYPE_NONE = 0,
  *                              SKL_PIPE_CONN_TYPE_FE = 1 (HOST_DMA)
  *                              SKL_PIPE_CONN_TYPE_BE = 2 (LINK_DMA)
  *
- * %SKL_TKN_U8_DEV_TYPE:        Type of device to which the module is
+ * @SKL_TKN_U8_DEV_TYPE:        Type of device to which the module is
  *                              connected
  *                              Can take the values:
  *                              SKL_DEVICE_BT = 0x0,
@@ -56,43 +60,43 @@
  *                              SKL_DEVICE_HDAHOST = 0x5,
  *                              SKL_DEVICE_NONE
  *
- * %SKL_TKN_U8_HW_CONN_TYPE:    Connection type of the HW to which the
+ * @SKL_TKN_U8_HW_CONN_TYPE:    Connection type of the HW to which the
  *                              module is connected
  *                              SKL_CONN_NONE = 0,
  *                              SKL_CONN_SOURCE = 1,
  *                              SKL_CONN_SINK = 2
  *
- * %SKL_TKN_U16_PIN_INST_ID:    Stores the pin instance id
+ * @SKL_TKN_U16_MOD_INST_ID:    Stores the module instance id
  *
- * %SKL_TKN_U16_MOD_INST_ID:    Stores the mdule instance id
+ * @SKL_TKN_U16_BLOCK_SIZE:     FIXME
  *
- * %SKL_TKN_U32_MAX_MCPS:       Module max mcps value
+ * @SKL_TKN_U32_MAX_MCPS:       Module max mcps value
  *
- * %SKL_TKN_U32_MEM_PAGES:      Module resource pages
+ * @SKL_TKN_U32_MEM_PAGES:      Module resource pages
  *
- * %SKL_TKN_U32_OBS:            Stores Output Buffer size
+ * @SKL_TKN_U32_OBS:            Stores Output Buffer size
  *
- * %SKL_TKN_U32_IBS:            Stores input buffer size
+ * @SKL_TKN_U32_IBS:            Stores input buffer size
  *
- * %SKL_TKN_U32_VBUS_ID:        Module VBUS_ID. PDM=0, SSP0=0,
+ * @SKL_TKN_U32_VBUS_ID:        Module VBUS_ID. PDM=0, SSP0=0,
  *                              SSP1=1,SSP2=2,
  *                              SSP3=3, SSP4=4,
  *                              SSP5=5, SSP6=6,INVALID
  *
- * %SKL_TKN_U32_PARAMS_FIXUP:   Module Params fixup mask
- * %SKL_TKN_U32_CONVERTER:      Module params converter mask
- * %SKL_TKN_U32_PIPE_ID:        Stores the pipe id
+ * @SKL_TKN_U32_PARAMS_FIXUP:   Module Params fixup mask
+ * @SKL_TKN_U32_CONVERTER:      Module params converter mask
+ * @SKL_TKN_U32_PIPE_ID:        Stores the pipe id
  *
- * %SKL_TKN_U32_PIPE_CONN_TYPE: Type of the token to which the pipe is
- *                              connected to. It can be
+ * @SKL_TKN_U32_PIPE_CONN_TYPE: Type of the token to which the pipe is
+ *                              connected. It can be
  *                              SKL_PIPE_CONN_TYPE_NONE = 0,
  *                              SKL_PIPE_CONN_TYPE_FE = 1 (HOST_DMA),
  *                              SKL_PIPE_CONN_TYPE_BE = 2 (LINK_DMA),
  *
- * %SKL_TKN_U32_PIPE_PRIORITY:  Pipe priority value
- * %SKL_TKN_U32_PIPE_MEM_PGS:   Pipe resource pages
+ * @SKL_TKN_U32_PIPE_PRIORITY:  Pipe priority value
+ * @SKL_TKN_U32_PIPE_MEM_PGS:   Pipe resource pages
  *
- * %SKL_TKN_U32_DIR_PIN_COUNT:  Value for the direction to set input/output
+ * @SKL_TKN_U32_DIR_PIN_COUNT:  Value for the direction to set input/output
  *                              formats and the pin count.
  *                              The first 4 bits have the direction
  *                              value and the next 4 have
@@ -104,23 +108,23 @@
  *                              and output made by reading direction
  *                              token.
  *
- * %SKL_TKN_U32_FMT_CH:         Supported channel count
+ * @SKL_TKN_U32_FMT_CH:         Supported channel count
  *
- * %SKL_TKN_U32_FMT_FREQ:       Supported frequency/sample rate
+ * @SKL_TKN_U32_FMT_FREQ:       Supported frequency/sample rate
  *
- * %SKL_TKN_U32_FMT_BIT_DEPTH:  Supported container size
+ * @SKL_TKN_U32_FMT_BIT_DEPTH:  Supported container size
  *
- * %SKL_TKN_U32_FMT_SAMPLE_SIZE:Number of samples in the container
+ * @SKL_TKN_U32_FMT_SAMPLE_SIZE:Number of samples in the container
  *
- * %SKL_TKN_U32_FMT_CH_CONFIG:  Supported channel configurations for the
+ * @SKL_TKN_U32_FMT_CH_CONFIG:  Supported channel configurations for the
  *                              input/output.
  *
- * %SKL_TKN_U32_FMT_INTERLEAVE: Interleaving style which can be per
+ * @SKL_TKN_U32_FMT_INTERLEAVE: Interleaving style which can be per
  *                              channel or per sample. The values can be :
  *                              SKL_INTERLEAVING_PER_CHANNEL = 0,
  *                              SKL_INTERLEAVING_PER_SAMPLE = 1,
  *
- * %SKL_TKN_U32_FMT_SAMPLE_TYPE:
+ * @SKL_TKN_U32_FMT_SAMPLE_TYPE:
  *                              Specifies the sample type. Can take the
  *                              values: SKL_SAMPLE_TYPE_INT_MSB = 0,
  *                              SKL_SAMPLE_TYPE_INT_LSB = 1,
@@ -128,104 +132,109 @@
  *                              SKL_SAMPLE_TYPE_INT_UNSIGNED = 3,
  *                              SKL_SAMPLE_TYPE_FLOAT = 4
  *
- * %SKL_TKN_U32_CH_MAP:         Channel map values
- * %SKL_TKN_U32_MOD_SET_PARAMS: It can take these values:
+ * @SKL_TKN_U32_FMT_CH_MAP:     Channel map values
+ * @SKL_TKN_U32_PIN_MOD_ID:     FIXME
+ * @SKL_TKN_U32_PIN_INST_ID:    FIXME
+ * @SKL_TKN_U32_MOD_SET_PARAMS: It can take these values:
  *                              SKL_PARAM_DEFAULT, SKL_PARAM_INIT,
  *                              SKL_PARAM_SET, SKL_PARAM_BIND
  *
- * %SKL_TKN_U32_MOD_PARAM_ID:   ID of the module params
+ * @SKL_TKN_U32_MOD_PARAM_ID:   ID of the module params
  *
- * %SKL_TKN_U32_CAPS_SET_PARAMS:
+ * @SKL_TKN_U32_CAPS_SET_PARAMS:
  *                              Set params value
  *
- * %SKL_TKN_U32_CAPS_PARAMS_ID: Params ID
+ * @SKL_TKN_U32_CAPS_PARAMS_ID: Params ID
  *
- * %SKL_TKN_U32_CAPS_SIZE:      Caps size
+ * @SKL_TKN_U32_CAPS_SIZE:      Caps size
  *
- * %SKL_TKN_U32_PROC_DOMAIN:    Specify processing domain
+ * @SKL_TKN_U32_PROC_DOMAIN:    Specify processing domain
  *
- * %SKL_TKN_U32_LIB_COUNT:      Specifies the number of libraries
+ * @SKL_TKN_U32_LIB_COUNT:      Specifies the number of libraries
  *
- * %SKL_TKN_STR_LIB_NAME:       Specifies the library name
+ * @SKL_TKN_STR_LIB_NAME:       Specifies the library name
  *
- * %SKL_TKN_U32_PMODE:		Specifies the power mode for pipe
+ * @SKL_TKN_U32_PMODE:		Specifies the power mode for pipe
  *
- * %SKL_TKL_U32_D0I3_CAPS:	Specifies the D0i3 capability for module
+ * @SKL_TKL_U32_D0I3_CAPS:	Specifies the D0i3 capability for module (typo)
+ * @SKL_TKN_U32_D0I3_CAPS:      Specifies the D0i3 capability for module
  *
- * %SKL_TKN_U32_DMA_BUF_SIZE:	DMA buffer size in millisec
+ * @SKL_TKN_U32_DMA_BUF_SIZE:	DMA buffer size in millisec
  *
- * %SKL_TKN_U32_PIPE_DIR:       Specifies pipe direction. Can be
+ * @SKL_TKN_U32_PIPE_DIRECTION: Specifies pipe direction. Can be
  *                              playback/capture.
  *
- * %SKL_TKN_U32_NUM_CONFIGS:    Number of pipe configs
+ * @SKL_TKN_U32_NUM_CONFIGS:    Number of pipe configs
  *
- * %SKL_TKN_U32_PATH_MEM_PGS:   Size of memory (in pages) required for pipeline
+ * @SKL_TKN_U32_PATH_MEM_PGS:   Size of memory (in pages) required for pipeline
  *                              and its data
  *
- * %SKL_TKN_U32_PIPE_CONFIG_ID: Config id for the modules in the pipe
+ * @SKL_TKN_U32_PIPE_CONFIG_ID: Config id for the modules in the pipe
  *                              and PCM params supported by that pipe
  *                              config. This is used as index to fill
  *                              up the pipe config and module config
  *                              structure.
  *
- * %SKL_TKN_U32_CFG_FREQ:
- * %SKL_TKN_U8_CFG_CHAN:
- * %SKL_TKN_U8_CFG_BPS:         PCM params (freq, channels, bits per sample)
+ * @SKL_TKN_U32_CFG_FREQ:       FIXME
+ * @SKL_TKN_U8_CFG_CHAN:        FIXME
+ * @SKL_TKN_U8_CFG_BPS:         PCM params (freq, channels, bits per sample)
  *                              supported for each of the pipe configs.
  *
- * %SKL_TKN_CFG_MOD_RES_ID:     Module's resource index for each of the
+ * @SKL_TKN_CFG_MOD_RES_ID:     Module's resource index for each of the
  *                              pipe config
  *
- * %SKL_TKN_CFG_MOD_FMT_ID:     Module's interface index for each of the
+ * @SKL_TKN_CFG_MOD_FMT_ID:     Module's interface index for each of the
  *                              pipe config
  *
- * %SKL_TKN_U8_NUM_MOD:         Number of modules in the manifest
+ * @SKL_TKN_U8_NUM_MOD:         Number of modules in the manifest
  *
- * %SKL_TKN_MM_U8_MOD_IDX:      Current index of the module in the manifest
+ * @SKL_TKN_MM_U8_MOD_IDX:      Current index of the module in the manifest
  *
- * %SKL_TKN_MM_U8_NUM_RES:      Number of resources for the module
+ * @SKL_TKN_MM_U8_NUM_RES:      Number of resources for the module
  *
- * %SKL_TKN_MM_U8_NUM_INTF:     Number of interfaces for the module
+ * @SKL_TKN_MM_U8_NUM_INTF:     Number of interfaces for the module
  *
- * %SKL_TKN_MM_U32_RES_ID:      Resource index for the resource info to
+ * @SKL_TKN_MM_U32_RES_ID:      Resource index for the resource info to
  *                              be filled into.
  *                              A module can support multiple resource
- *                              configuration and is represnted as a
+ *                              configuration and is represented as a
  *                              resource table. This index is used to
  *                              fill information into appropriate index.
  *
- * %SKL_TKN_MM_U32_CPS:         DSP cycles per second
+ * @SKL_TKN_MM_U32_CPS:         DSP cycles per second
  *
- * %SKL_TKN_MM_U32_DMA_SIZE:    Allocated buffer size for gateway DMA
+ * @SKL_TKN_MM_U32_DMA_SIZE:    Allocated buffer size for gateway DMA
  *
- * %SKL_TKN_MM_U32_CPC:         DSP cycles allocated per frame
+ * @SKL_TKN_MM_U32_CPC:         DSP cycles allocated per frame
  *
- * %SKL_TKN_MM_U32_RES_PIN_ID:  Resource pin index in the module
+ * @SKL_TKN_MM_U32_RES_PIN_ID:  Resource pin index in the module
  *
- * %SKL_TKN_MM_U32_INTF_PIN_ID: Interface index in the module
+ * @SKL_TKN_MM_U32_INTF_PIN_ID: Interface index in the module
  *
- * %SKL_TKN_MM_U32_PIN_BUF:     Buffer size of the module pin
+ * @SKL_TKN_MM_U32_PIN_BUF:     Buffer size of the module pin
  *
- * %SKL_TKN_MM_U32_FMT_ID:      Format index for each of the interface/
+ * @SKL_TKN_MM_U32_FMT_ID:      Format index for each of the interface/
  *                              format information to be filled into.
  *
- * %SKL_TKN_MM_U32_NUM_IN_FMT:  Number of input formats
- * %SKL_TKN_MM_U32_NUM_OUT_FMT: Number of output formats
+ * @SKL_TKN_MM_U32_NUM_IN_FMT:  Number of input formats
+ * @SKL_TKN_MM_U32_NUM_OUT_FMT: Number of output formats
  *
- * %SKL_TKN_U32_ASTATE_IDX:     Table Index for the A-State entry to be filled
+ * @SKL_TKN_U32_ASTATE_IDX:     Table Index for the A-State entry to be filled
  *                              with kcps and clock source
  *
- * %SKL_TKN_U32_ASTATE_COUNT:   Number of valid entries in A-State table
+ * @SKL_TKN_U32_ASTATE_COUNT:   Number of valid entries in A-State table
  *
- * %SKL_TKN_U32_ASTATE_KCPS:    Specifies the core load threshold (in kilo
+ * @SKL_TKN_U32_ASTATE_KCPS:    Specifies the core load threshold (in kilo
  *                              cycles per second) below which DSP is clocked
  *                              from source specified by clock source.
  *
- * %SKL_TKN_U32_ASTATE_CLK_SRC: Clock source for A-State entry
+ * @SKL_TKN_U32_ASTATE_CLK_SRC: Clock source for A-State entry
+ *
+ * @SKL_TKN_U32_FMT_CFG_IDX:    Format config index
  *
- * %SKL_TKN_U32_FMT_CFG_IDX:    Format config index
+ * @SKL_TKN_MAX:                Max value for enum SKL_TKNS
  *
- * module_id and loadable flags dont have tokens as these values will be
+ * module_id and loadable flags don't have tokens as these values will be
  * read from the DSP FW manifest
  *
  * Tokens defined can be used either in the manifest or widget private data.

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (11 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 12/14] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  8:05   ` Srinivas Kandagatla
  2026-07-14  1:44 ` [PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments Randy Dunlap
  13 siblings, 1 reply; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Modify the "/**" to use "/*" instead since this is not a kernel-doc
comment. This avoids all kernel-doc warnings in this header file:

Warning: include/uapi/sound/snd_ar_tokens.h:61 Cannot find identifier on line:
 * %AR_TKN_U32_SUB_GRAPH_INSTANCE_ID:           Sub Graph Instance Id
Warning: ../include/uapi/sound/snd_ar_tokens.h:62 Cannot find identifier on line: *
Warning: ../include/uapi/sound/snd_ar_tokens.h:63 Cannot find identifier on line:
 * %AR_TKN_U32_SUB_GRAPH_PERF_MODE:             Performance mode of subgraph
Warning: include/uapi/sound/snd_ar_tokens.h:64 This comment starts with '/**', but isn't a kernel-doc comment.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: Srinivas Kandagatla <srini@kernel.org>
Cc: linux-arm-msm@vger.kernel.org

 include/uapi/sound/snd_ar_tokens.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linext-2026-0710.orig/include/uapi/sound/snd_ar_tokens.h
+++ linext-2026-0710/include/uapi/sound/snd_ar_tokens.h
@@ -58,7 +58,7 @@ enum ar_event_types {
 #define SND_SOC_AR_TPLG_FE_BE_GRAPH_CTL_MIX	256
 #define SND_SOC_AR_TPLG_VOL_CTL			257
 
-/**
+/*
  * %AR_TKN_U32_SUB_GRAPH_INSTANCE_ID:		Sub Graph Instance Id
  *
  * %AR_TKN_U32_SUB_GRAPH_PERF_MODE:		Performance mode of subgraph

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments
  2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
                   ` (12 preceding siblings ...)
  2026-07-14  1:44 ` [PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment Randy Dunlap
@ 2026-07-14  1:44 ` Randy Dunlap
  2026-07-14  8:41   ` Charles Keepax
  13 siblings, 1 reply; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14  1:44 UTC (permalink / raw)
  To: linux-sound
  Cc: Randy Dunlap, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood,
	Mark Brown

Modify these errant comments to use "/*" since they are not kernel-doc
comments.

Warning: include/sound/wm8904.h:119 This comment starts with '/**', but isn't a kernel-doc comment.
 * DRC configurations are specified with a label and a set of register
Warning: ../include/sound/wm8904.h:134 This comment starts with '/**', but isn't a kernel-doc comment.
 * ReTune Mobile configurations are specified with a label, sample

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>

 include/sound/wm8904.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linext-2026-0710.orig/include/sound/wm8904.h
+++ linext-2026-0710/include/sound/wm8904.h
@@ -116,7 +116,7 @@
 #define WM8904_DRC_REGS  4
 #define WM8904_EQ_REGS   24
 
-/**
+/*
  * DRC configurations are specified with a label and a set of register
  * values to write (the enable bits will be ignored).  At runtime an
  * enumerated control will be presented for each DRC block allowing
@@ -131,7 +131,7 @@ struct wm8904_drc_cfg {
 	u16 regs[WM8904_DRC_REGS];
 };
 
-/**
+/*
  * ReTune Mobile configurations are specified with a label, sample
  * rate and set of values to write (the enable bits will be ignored).
  *

^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment
  2026-07-14  1:44 ` [PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment Randy Dunlap
@ 2026-07-14  8:05   ` Srinivas Kandagatla
  0 siblings, 0 replies; 22+ messages in thread
From: Srinivas Kandagatla @ 2026-07-14  8:05 UTC (permalink / raw)
  To: Randy Dunlap, linux-sound
  Cc: Jaroslav Kysela, Takashi Iwai, Shengjiu Wang, Xiubo Li,
	Fabio Estevam, Nicolin Chen, linuxppc-dev, Charles Keepax,
	Maciej Strozek, Bard Liao, Pierre-Louis Bossart, patches,
	Srinivas Kandagatla, linux-arm-msm, Liam Girdwood, Mark Brown



On 7/14/26 2:44 AM, Randy Dunlap wrote:
> Modify the "/**" to use "/*" instead since this is not a kernel-doc
> comment. This avoids all kernel-doc warnings in this header file:
> 
> Warning: include/uapi/sound/snd_ar_tokens.h:61 Cannot find identifier on line:
>  * %AR_TKN_U32_SUB_GRAPH_INSTANCE_ID:           Sub Graph Instance Id
> Warning: ../include/uapi/sound/snd_ar_tokens.h:62 Cannot find identifier on line: *
> Warning: ../include/uapi/sound/snd_ar_tokens.h:63 Cannot find identifier on line:
>  * %AR_TKN_U32_SUB_GRAPH_PERF_MODE:             Performance mode of subgraph
> Warning: include/uapi/sound/snd_ar_tokens.h:64 This comment starts with '/**', but isn't a kernel-doc comment.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>


Reviewed-by: Srinivas Kandagatla <srinivas.kandagatla@oss.qualcomm.com>

--srini
> ---
> Cc: Liam Girdwood <lgirdwood@gmail.com>
> Cc: Mark Brown <broonie@kernel.org>
> Cc: Srinivas Kandagatla <srini@kernel.org>
> Cc: linux-arm-msm@vger.kernel.org
> 
>  include/uapi/sound/snd_ar_tokens.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linext-2026-0710.orig/include/uapi/sound/snd_ar_tokens.h
> +++ linext-2026-0710/include/uapi/sound/snd_ar_tokens.h
> @@ -58,7 +58,7 @@ enum ar_event_types {
>  #define SND_SOC_AR_TPLG_FE_BE_GRAPH_CTL_MIX	256
>  #define SND_SOC_AR_TPLG_VOL_CTL			257
>  
> -/**
> +/*
>   * %AR_TKN_U32_SUB_GRAPH_INSTANCE_ID:		Sub Graph Instance Id
>   *
>   * %AR_TKN_U32_SUB_GRAPH_PERF_MODE:		Performance mode of subgraph



^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field
  2026-07-14  1:44 ` [PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field Randy Dunlap
@ 2026-07-14  8:40   ` Charles Keepax
  0 siblings, 0 replies; 22+ messages in thread
From: Charles Keepax @ 2026-07-14  8:40 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-sound, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Maciej Strozek, Bard Liao, Pierre-Louis Bossart, patches,
	Srinivas Kandagatla, linux-arm-msm, Liam Girdwood, Mark Brown

On Mon, Jul 13, 2026 at 06:44:41PM -0700, Randy Dunlap wrote:
> Add a kernel-doc comment for @is_volatile in struct sdca_control.
> Correct 2 malformed enum names to match the enums.
> Fixes 3 warnings:
> 
> Warning: include/sound/sdca_function.h:306 expecting prototype for enum sdca_set_index_range. Prototype was for enum sdca_fdl_set_index_range instead
> 
> Warning: include/sound/sdca_function.h:829 struct member 'is_volatile' not described in 'sdca_control'
> 
> Warning: include/sound/sdca_function.h:1152 expecting prototype for enum sdca_xu_reset_machanism. Prototype was for enum sdca_xu_reset_mechanism instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---

Thanks for fixing those up.

Reviewed-by: Charles Keepax <ckeepax@opensource.cirrus.com>

Thanks,
Charles

^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments
  2026-07-14  1:44 ` [PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments Randy Dunlap
@ 2026-07-14  8:41   ` Charles Keepax
  0 siblings, 0 replies; 22+ messages in thread
From: Charles Keepax @ 2026-07-14  8:41 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-sound, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Maciej Strozek, Bard Liao, Pierre-Louis Bossart, patches,
	Srinivas Kandagatla, linux-arm-msm, Liam Girdwood, Mark Brown

On Mon, Jul 13, 2026 at 06:44:45PM -0700, Randy Dunlap wrote:
> Modify these errant comments to use "/*" since they are not kernel-doc
> comments.
> 
> Warning: include/sound/wm8904.h:119 This comment starts with '/**', but isn't a kernel-doc comment.
>  * DRC configurations are specified with a label and a set of register
> Warning: ../include/sound/wm8904.h:134 This comment starts with '/**', but isn't a kernel-doc comment.
>  * ReTune Mobile configurations are specified with a label, sample
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---

Reviewed-by: Charles Keepax <ckeepax@opensource.cirrus.com>

Thanks,
Charles

^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format
  2026-07-14  1:44 ` [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format Randy Dunlap
@ 2026-07-14 10:20   ` Mark Brown
  2026-07-14 15:57     ` Randy Dunlap
  0 siblings, 1 reply; 22+ messages in thread
From: Mark Brown @ 2026-07-14 10:20 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-sound, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood

[-- Attachment #1: Type: text/plain, Size: 460 bytes --]

On Mon, Jul 13, 2026 at 06:44:32PM -0700, Randy Dunlap wrote:
> Don't use "/**" for a non-kernel-doc comment.
> Use kernel-doc notation to document the parameters and return value of
> ntpfw_load().

As mentioned in submitting-patches.rst when submitting a patch series
you should supply a cover letter for that patch series which describes
the overall content of the series.  This helps people understand what
they are looking at and how things fit together.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format
  2026-07-14 10:20   ` Mark Brown
@ 2026-07-14 15:57     ` Randy Dunlap
  2026-07-14 16:02       ` Randy Dunlap
  2026-07-14 17:09       ` Mark Brown
  0 siblings, 2 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14 15:57 UTC (permalink / raw)
  To: Mark Brown
  Cc: linux-sound, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood



On 7/14/26 3:20 AM, Mark Brown wrote:
> On Mon, Jul 13, 2026 at 06:44:32PM -0700, Randy Dunlap wrote:
>> Don't use "/**" for a non-kernel-doc comment.
>> Use kernel-doc notation to document the parameters and return value of
>> ntpfw_load().
> 
> As mentioned in submitting-patches.rst when submitting a patch series
> you should supply a cover letter for that patch series which describes
> the overall content of the series.  This helps people understand what
> they are looking at and how things fit together.

Are you saying that my cover letter was insufficient?

https://lore.kernel.org/all/20260714014445.569992-1-rdunlap@infradead.org/

-- 
~Randy



^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format
  2026-07-14 15:57     ` Randy Dunlap
@ 2026-07-14 16:02       ` Randy Dunlap
  2026-07-14 17:09       ` Mark Brown
  1 sibling, 0 replies; 22+ messages in thread
From: Randy Dunlap @ 2026-07-14 16:02 UTC (permalink / raw)
  To: Mark Brown
  Cc: linux-sound, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood



On 7/14/26 8:57 AM, Randy Dunlap wrote:
> 
> 
> On 7/14/26 3:20 AM, Mark Brown wrote:
>> On Mon, Jul 13, 2026 at 06:44:32PM -0700, Randy Dunlap wrote:
>>> Don't use "/**" for a non-kernel-doc comment.
>>> Use kernel-doc notation to document the parameters and return value of
>>> ntpfw_load().
>>
>> As mentioned in submitting-patches.rst when submitting a patch series
>> you should supply a cover letter for that patch series which describes
>> the overall content of the series.  This helps people understand what
>> they are looking at and how things fit together.
> 
> Are you saying that my cover letter was insufficient?
> 
> https://lore.kernel.org/all/20260714014445.569992-1-rdunlap@infradead.org/
> 

Ah, somehow I missing sending that one directly to you. My bad.

Should I resend the series?

thanks.

-- 
~Randy



^ permalink raw reply	[flat|nested] 22+ messages in thread

* Re: [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format
  2026-07-14 15:57     ` Randy Dunlap
  2026-07-14 16:02       ` Randy Dunlap
@ 2026-07-14 17:09       ` Mark Brown
  1 sibling, 0 replies; 22+ messages in thread
From: Mark Brown @ 2026-07-14 17:09 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-sound, Jaroslav Kysela, Takashi Iwai, Shengjiu Wang,
	Xiubo Li, Fabio Estevam, Nicolin Chen, linuxppc-dev,
	Charles Keepax, Maciej Strozek, Bard Liao, Pierre-Louis Bossart,
	patches, Srinivas Kandagatla, linux-arm-msm, Liam Girdwood

[-- Attachment #1: Type: text/plain, Size: 630 bytes --]

On Tue, Jul 14, 2026 at 08:57:06AM -0700, Randy Dunlap wrote:
> On 7/14/26 3:20 AM, Mark Brown wrote:

> > As mentioned in submitting-patches.rst when submitting a patch series
> > you should supply a cover letter for that patch series which describes
> > the overall content of the series.  This helps people understand what
> > they are looking at and how things fit together.

> Are you saying that my cover letter was insufficient?

> https://lore.kernel.org/all/20260714014445.569992-1-rdunlap@infradead.org/

Well, quite apart from anything else you didn't send to to me so as far
as my inbox is concerned it doesn't exist.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

^ permalink raw reply	[flat|nested] 22+ messages in thread

end of thread, other threads:[~2026-07-14 17:10 UTC | newest]

Thread overview: 22+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-14  1:44 [PATCH 00/14] ASoC: clean up kernel-doc warnings Randy Dunlap
2026-07-14  1:44 ` [PATCH 01/14] ASoC: codecs: NeoFidelity: repair the kernel-doc format Randy Dunlap
2026-07-14 10:20   ` Mark Brown
2026-07-14 15:57     ` Randy Dunlap
2026-07-14 16:02       ` Randy Dunlap
2026-07-14 17:09       ` Mark Brown
2026-07-14  1:44 ` [PATCH 02/14] ASoC: fsl_asrc_common: fix all kernel-doc warnings Randy Dunlap
2026-07-14  1:44 ` [PATCH 03/14] ASoC: fsl_asrc: avoid " Randy Dunlap
2026-07-14  1:44 ` [PATCH 04/14] ASoC: fsl-dma: fix all " Randy Dunlap
2026-07-14  1:44 ` [PATCH 05/14] ASoC: fsl_easrc: use struct keyword on structs Randy Dunlap
2026-07-14  1:44 ` [PATCH 06/14] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments Randy Dunlap
2026-07-14  1:44 ` [PATCH 07/14] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings Randy Dunlap
2026-07-14  1:44 ` [PATCH 08/14] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions Randy Dunlap
2026-07-14  1:44 ` [PATCH 09/14] ASoC: uniphier: don't use "/**" for non-kernel-doc comment Randy Dunlap
2026-07-14  1:44 ` [PATCH 10/14] ASoC: SDCA: correct enum names and add a missing struct field Randy Dunlap
2026-07-14  8:40   ` Charles Keepax
2026-07-14  1:44 ` [PATCH 11/14] ASoC: soc-acpi: fix all kernel-doc warnings Randy Dunlap
2026-07-14  1:44 ` [PATCH 12/14] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format Randy Dunlap
2026-07-14  1:44 ` [PATCH 13/14] ASoC: qcom: audioreach: use C-style "/*" comment Randy Dunlap
2026-07-14  8:05   ` Srinivas Kandagatla
2026-07-14  1:44 ` [PATCH 14/14] ASoC: wm8904: don't use "/**" for non-kernel-doc comments Randy Dunlap
2026-07-14  8:41   ` Charles Keepax

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.