From: Lee Jones <lee.jones@linaro.org>
To: broonie@kernel.org, lgirdwood@gmail.com, perex@perex.cz, tiwai@suse.com
Cc: alsa-devel@alsa-project.org, Timur Tabi <timur@kernel.org>,
Xiubo Li <Xiubo.Lee@gmail.com>,
Fabio Estevam <festevam@gmail.com>,
linuxppc-dev@lists.ozlabs.org, linux-kernel@vger.kernel.org,
Nicolin Chen <nicoleotsuka@gmail.com>,
Lee Jones <lee.jones@linaro.org>,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2 03/28] ASoC: fsl: fsl-asoc-card: Use correct format when providing struct documentation
Date: Tue, 7 Jul 2020 15:37:17 +0100 [thread overview]
Message-ID: <20200707143742.2959960-4-lee.jones@linaro.org> (raw)
In-Reply-To: <20200707143742.2959960-1-lee.jones@linaro.org>
Struct kerneldoc headers need to be prefixed with 'struct $NAME', else
the checker gets confused.
Fixes the following W=1 kernel build warning(s):
sound/soc/fsl/fsl-asoc-card.c:43: warning: cannot understand function prototype: 'struct codec_priv '
sound/soc/fsl/fsl-asoc-card.c:60: warning: cannot understand function prototype: 'struct cpu_priv '
sound/soc/fsl/fsl-asoc-card.c:83: warning: cannot understand function prototype: 'struct fsl_asoc_card_priv '
sound/soc/fsl/fsl-asoc-card.c:104: warning: cannot understand function prototype: 'const struct snd_soc_dapm_route audio_map[] = '
Also the size of the struct does not belong in the description:
sound/soc/fsl/fsl-asoc-card.c:65: warning: Function parameter or member 'sysclk_freq' not described in 'cpu_priv'
sound/soc/fsl/fsl-asoc-card.c:65: warning: Function parameter or member 'sysclk_dir' not described in 'cpu_priv'
sound/soc/fsl/fsl-asoc-card.c:65: warning: Function parameter or member 'sysclk_id' not described in 'cpu_priv'
sound/soc/fsl/fsl-asoc-card.c:95: warning: Function parameter or member 'dai_link' not described in 'fsl_asoc_card_priv'
Cc: Timur Tabi <timur@kernel.org>
Cc: Nicolin Chen <nicoleotsuka@gmail.com>
Cc: Xiubo Li <Xiubo.Lee@gmail.com>
Cc: Fabio Estevam <festevam@gmail.com>
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
sound/soc/fsl/fsl-asoc-card.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/sound/soc/fsl/fsl-asoc-card.c b/sound/soc/fsl/fsl-asoc-card.c
index 57ea1b072326b..3b1fd8c9316d8 100644
--- a/sound/soc/fsl/fsl-asoc-card.c
+++ b/sound/soc/fsl/fsl-asoc-card.c
@@ -33,7 +33,7 @@
#define DAI_FMT_BASE (SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF)
/**
- * CODEC private data
+ * struct codec_priv - CODEC private data
*
* @mclk_freq: Clock rate of MCLK
* @mclk_id: MCLK (or main clock) id for set_sysclk()
@@ -48,11 +48,11 @@ struct codec_priv {
};
/**
- * CPU private data
+ * struct cpu_priv - CPU private data
*
- * @sysclk_freq[2]: SYSCLK rates for set_sysclk()
- * @sysclk_dir[2]: SYSCLK directions for set_sysclk()
- * @sysclk_id[2]: SYSCLK ids for set_sysclk()
+ * @sysclk_freq: SYSCLK rates for set_sysclk()
+ * @sysclk_dir: SYSCLK directions for set_sysclk()
+ * @sysclk_id: SYSCLK ids for set_sysclk()
* @slot_width: Slot width of each frame
*
* Note: [1] for tx and [0] for rx
@@ -65,9 +65,9 @@ struct cpu_priv {
};
/**
- * Freescale Generic ASOC card private data
+ * struct fsl_asoc_card_priv - Freescale Generic ASOC card private data
*
- * @dai_link[3]: DAI link structure including normal one and DPCM link
+ * @dai_link: DAI link structure including normal one and DPCM link
* @pdev: platform device pointer
* @codec_priv: CODEC private data
* @cpu_priv: CPU private data
@@ -94,7 +94,7 @@ struct fsl_asoc_card_priv {
char name[32];
};
-/**
+/*
* This dapm route map exsits for DPCM link only.
* The other routes shall go through Device Tree.
*
--
2.25.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2020-07-07 14:40 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-07 14:37 [PATCH v2 00/28] Clean-up ASoC's W=1 build warnings Lee Jones
2020-07-07 14:37 ` [PATCH v2 01/28] ASoC: atmel: atmel-pcm-dma: Demote function header which is clearly not kerneldoc Lee Jones
2020-07-07 14:37 ` [PATCH v2 02/28] ASoC: atmel: atmel_ssc_dai: " Lee Jones
2020-07-07 14:37 ` Lee Jones [this message]
2020-07-07 14:37 ` [PATCH v2 04/28] ASoC: fsl: fsl_asrc: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-07 14:37 ` [PATCH v2 05/28] ASoC: fsl: fsl_ssi: " Lee Jones
2020-07-07 14:37 ` [PATCH v2 06/28] ASoC: fsl: fsl_ssi_dbg: " Lee Jones
2020-07-07 14:37 ` [PATCH v2 07/28] ASoC: fsl: fsl_spdif: Use correct formatting when denoting struct documentation Lee Jones
2020-07-07 14:37 ` [PATCH v2 08/28] ASoC: fsl: fsl_spdif: Update 'struct fsl_spdif_priv's descriptions Lee Jones
2020-07-07 14:37 ` [PATCH v2 09/28] ASoC: fsl: fsl_esai: Fix a bunch of kerneldoc issues Lee Jones
2020-07-07 14:37 ` [PATCH v2 10/28] ASoC: fsl: fsl_esai: Add descriptions for 'tx_mask' and 'rx_mask' to 'fsl_esai' Lee Jones
2020-07-07 14:37 ` [PATCH v2 11/28] ASoC: pxa: pxa-ssp: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 12/28] ASoC: codecs: ak4458: Remove set but never checked variable 'ret' Lee Jones
2020-07-07 14:37 ` [PATCH v2 13/28] ASoC: qcom: qdsp6: q6asm: Provide documentation for WMA 'codec_profile' Lee Jones
2020-07-07 14:37 ` [PATCH v2 14/28] ASoC: samsung: pcm: Demote half-documented kerneldoc header Lee Jones
2020-07-08 8:39 ` Sylwester Nawrocki
2020-07-07 14:37 ` [PATCH v2 15/28] ASoC: samsung: spdif: Fix 3 misspelled struct properties Lee Jones
2020-07-07 14:37 ` [PATCH v2 16/28] ASoC: sunxi: sun4i-i2s: Demote half-documented kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 17/28] ASoC: uniphier: aio-core: Fix incorrectly named struct property and remove another Lee Jones
2020-07-07 14:37 ` [PATCH v2 18/28] ASoC: sunxi: sun4i-spdif: Fix misspelling of 'reg_dac_txdata' Lee Jones
2020-07-07 14:37 ` [PATCH v2 19/28] ASoC: ux500: ux500_msp_i2s: Remove unused variables 'reg_val_DR' and 'reg_val_TSTDR' Lee Jones
2020-07-07 14:37 ` [PATCH v2 20/28] ASoC: sti: uniperif: Mark 'uni_tdm_hw' as __maybe_unused Lee Jones
2020-07-08 13:34 ` Arnaud POULIQUEN
2020-07-07 14:37 ` [PATCH v2 21/28] ASoC: ti: omap-mcbsp-st: Remove set, but unused variable 'w' Lee Jones
2020-07-07 14:37 ` [PATCH v2 22/28] ASoC: codecs: da7210: Fix formatting issues in da7210_set_dai_pll() header Lee Jones
2020-07-07 14:37 ` [PATCH v2 23/28] ASoC: soc-ac97: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 24/28] ASoC: codecs: jz4770: Remove defined but never used variable 'mic_boost_tlv' Lee Jones
2020-07-07 14:37 ` [PATCH v2 25/28] ASoC: codecs: rt5631: Demote misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-07 14:37 ` [PATCH v2 26/28] ASoC: codecs: rt5659: Remove many unused const variables Lee Jones
2020-07-07 14:37 ` [PATCH v2 27/28] ASoC: codecs: tlv320aic26: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 28/28] ASoC: codecs: wm8400: Remove a bunch of unused variables Lee Jones
2020-07-07 14:38 ` [PATCH v2 00/28] Clean-up ASoC's W=1 build warnings Mark Brown
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=20200707143742.2959960-4-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=Xiubo.Lee@gmail.com \
--cc=alsa-devel@alsa-project.org \
--cc=broonie@kernel.org \
--cc=festevam@gmail.com \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=nicoleotsuka@gmail.com \
--cc=perex@perex.cz \
--cc=timur@kernel.org \
--cc=tiwai@suse.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;
as well as URLs for NNTP newsgroup(s).