From: Randy Dunlap <rdunlap@infradead.org>
To: linux-sound@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Liam Girdwood <lgirdwood@gmail.com>,
Mark Brown <broonie@kernel.org>, Jaroslav Kysela <perex@perex.cz>,
Takashi Iwai <tiwai@suse.com>,
Shengjiu Wang <shengjiu.wang@gmail.com>,
Xiubo Li <Xiubo.Lee@gmail.com>,
Fabio Estevam <festevam@gmail.com>,
Nicolin Chen <nicoleotsuka@gmail.com>,
linuxppc-dev@lists.ozlabs.org,
Charles Keepax <ckeepax@opensource.cirrus.com>,
Maciej Strozek <mstrozek@opensource.cirrus.com>,
Bard Liao <yung-chuan.liao@linux.intel.com>,
Pierre-Louis Bossart <pierre-louis.bossart@linux.dev>,
patches@opensource.cirrus.com,
Srinivas Kandagatla <srini@kernel.org>,
linux-arm-msm@vger.kernel.org
Subject: [PATCH 12/14 v2] ASoC: Intel: Skylake: convert SKL_TKNS to kernel-doc format
Date: Tue, 14 Jul 2026 17:05:23 -0700 [thread overview]
Message-ID: <20260715000525.739874-13-rdunlap@infradead.org> (raw)
In-Reply-To: <20260715000525.739874-1-rdunlap@infradead.org>
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>
---
v2: no change
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: linux-sound@vger.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.
next prev parent reply other threads:[~2026-07-15 0:07 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-15 0:05 [PATCH 00/14 v2] ASoC: clean up kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` [PATCH 01/14 v2] ASoC: codecs: NeoFidelity: repair the kernel-doc format Randy Dunlap
2026-07-15 0:05 ` [PATCH 02/14 v2] ASoC: fsl_asrc_common: fix all kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` [PATCH 03/14 v2] ASoC: fsl_asrc: avoid " Randy Dunlap
2026-07-15 0:05 ` [PATCH 04/14 v2] ASoC: fsl-dma: fix all " Randy Dunlap
2026-07-15 0:05 ` [PATCH 05/14 v2] ASoC: fsl_easrc: use struct keyword on structs Randy Dunlap
2026-07-15 0:05 ` [PATCH 06/14 v2] ASoC: fsl: mpc5200_dma: use the struct keyword for kernel-doc comments Randy Dunlap
2026-07-15 0:05 ` [PATCH 07/14 v2] ASoC: fsl: mpc5200_psc_i2s: avoid kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` [PATCH 08/14 v2] ASoC: fsl: p1022_ds: repair kernel-doc short descriptions Randy Dunlap
2026-07-15 0:05 ` [PATCH 09/14 v2] ASoC: uniphier: don't use "/**" for non-kernel-doc comment Randy Dunlap
2026-07-15 0:05 ` [PATCH 10/14 v2] ASoC: SDCA: correct enum names and add a missing struct field Randy Dunlap
2026-07-15 0:05 ` [PATCH 11/14 v2] ASoC: soc-acpi: fix all kernel-doc warnings Randy Dunlap
2026-07-15 0:05 ` Randy Dunlap [this message]
2026-07-15 0:05 ` [PATCH 13/14 v2] ASoC: qcom: audioreach: use C-style "/*" comment Randy Dunlap
2026-07-15 0:05 ` [PATCH 14/14 v2] ASoC: wm8904: don't use "/**" for non-kernel-doc comments Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260715000525.739874-13-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=Xiubo.Lee@gmail.com \
--cc=broonie@kernel.org \
--cc=ckeepax@opensource.cirrus.com \
--cc=festevam@gmail.com \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mstrozek@opensource.cirrus.com \
--cc=nicoleotsuka@gmail.com \
--cc=patches@opensource.cirrus.com \
--cc=perex@perex.cz \
--cc=pierre-louis.bossart@linux.dev \
--cc=shengjiu.wang@gmail.com \
--cc=srini@kernel.org \
--cc=tiwai@suse.com \
--cc=yung-chuan.liao@linux.intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox