From patchwork Tue Jul 7 14:37:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11648811 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 6846092A for ; Tue, 7 Jul 2020 14:44:35 +0000 (UTC) Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id EF93A2073E for ; Tue, 7 Jul 2020 14:44:34 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=alsa-project.org header.i=@alsa-project.org header.b="KD8+EX7e"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="U4icUTAi" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org EF93A2073E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=alsa-devel-bounces@alsa-project.org Received: from alsa1.perex.cz (alsa1.perex.cz [207.180.221.201]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by alsa0.perex.cz (Postfix) with ESMTPS id 5C9BE1614; Tue, 7 Jul 2020 16:43:46 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa0.perex.cz 5C9BE1614 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=alsa-project.org; s=default; t=1594133073; bh=Jp0LzCFksHxz1MhYVp50BeLiJW+G33mEBGiYvvNuW1k=; h=From:To:Subject:Date:In-Reply-To:References:Cc:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From; b=KD8+EX7eWiLSq7hU8FE/+c2gTFwKxHD8sWsrb7ZBuOnnCSwrs+Ljvynfw0ReIHSqT jJf4wLFm3uB1mdWbGL/HrhJxOWeACiuLit6LqpbC5Nm9/wP61fRi4xpoyaJ0/QkdYt ld0+XZC26/B/k3MO2eYPedz+Iz4/fJ75aS+gZPBY= Received: from alsa1.perex.cz (localhost.localdomain [127.0.0.1]) by alsa1.perex.cz (Postfix) with ESMTP id 93E86F80334; Tue, 7 Jul 2020 16:38:18 +0200 (CEST) X-Original-To: alsa-devel@alsa-project.org Delivered-To: alsa-devel@alsa-project.org Received: by alsa1.perex.cz (Postfix, from userid 50401) id A947BF802EC; Tue, 7 Jul 2020 16:38:09 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on alsa1.perex.cz X-Spam-Level: X-Spam-Status: No, score=-0.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from mail-wr1-x442.google.com (mail-wr1-x442.google.com [IPv6:2a00:1450:4864:20::442]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by alsa1.perex.cz (Postfix) with ESMTPS id EA4B3F802C4 for ; Tue, 7 Jul 2020 16:38:01 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa1.perex.cz EA4B3F802C4 Authentication-Results: alsa1.perex.cz; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="U4icUTAi" Received: by mail-wr1-x442.google.com with SMTP id z2so23134150wrp.2 for ; Tue, 07 Jul 2020 07:38:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=YsokizqvcQrYmRK4XFUw9AfpZPmtx9CnTkzjsD5Kh2w=; b=U4icUTAip9+fVemfIStmlUm+NwJ6HLWkl2RVpVYHUx/CKlpWCnzwXVC3CzO6ZJxzhS 2A1u3oeiQiRbLQzl0ReMEMvLcVbjfBld3DOsbinq/HDwtkUHvTpoWwmwIW3JsgEKydrN sT3Mcd7tmzyJB7ZIkVdXvVfah2S5RNbEIcqZBCMnb6IrgPpJML1ZcTZMJjZpFjGT9bwX KFw/rVo796NGAFlBcF22gotYI6DwHJNR9jKSzyYFD5cOe2ZDQ9Y6jIASEoBUkL5rLH3v YxlY2MQtb7I3y0oBmo4AzeIL57N0+DjNcvsd9DRoEZo+/djPEr+HoSNOmqkrC0YQRMhu DvRw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=YsokizqvcQrYmRK4XFUw9AfpZPmtx9CnTkzjsD5Kh2w=; b=W3xdH12YJv7D9ibpqoMVrK+bu7CGPJNDCcVHAMQBQGRjRBp2PaRzlflAU5CKttkpky Na+LfglpGNSdPLZc5T5QdINkSgWRuQyDXeMeGNkALt58B5fgph7h1th5RNEq6iWAzTo7 oFVwuWcTDRhbKg/RtIRbamgFNcO1ZtrO2JeOV23LFBLkgTcazo+jehkQmS0PSeQ1fZxQ L6W5UcL9sd5v+jfukW26OpUwFEhRQrKNKoYRlkces2CmnhenugcHfYpifM9+1zKeo6Lc /17pLmFL99JxCK1RPSILwi3qSnytbPIFsBq/bIECJHQTZZl7yCywe6s8tcvZ4yaPyEsl IWpQ== X-Gm-Message-State: AOAM530svPV/D/2k6jfdWmUN3uam0mTiTBJ2qoor6kqjxLeCm8ze/bYF 5yWZtGzQNAUH9Y4Sdj0BWV+XrA== X-Google-Smtp-Source: ABdhPJyQQtUDPp475nOrZE1vXhOfcyykGtayzQzLC4nanwruesoW0y74DEzt0XwmDnl//B05KWRVDw== X-Received: by 2002:a5d:6990:: with SMTP id g16mr45394243wru.131.1594132681537; Tue, 07 Jul 2020 07:38:01 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.206]) by smtp.gmail.com with ESMTPSA id y16sm1276131wro.71.2020.07.07.07.38.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Jul 2020 07:38:01 -0700 (PDT) From: Lee Jones To: broonie@kernel.org, lgirdwood@gmail.com, perex@perex.cz, tiwai@suse.com Subject: [PATCH v2 09/28] ASoC: fsl: fsl_esai: Fix a bunch of kerneldoc issues Date: Tue, 7 Jul 2020 15:37:23 +0100 Message-Id: <20200707143742.2959960-10-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200707143742.2959960-1-lee.jones@linaro.org> References: <20200707143742.2959960-1-lee.jones@linaro.org> MIME-Version: 1.0 Cc: alsa-devel@alsa-project.org, Timur Tabi , Xiubo Li , Fabio Estevam , linuxppc-dev@lists.ozlabs.org, linux-kernel@vger.kernel.org, Nicolin Chen , Lee Jones , linux-arm-kernel@lists.infradead.org X-BeenThere: alsa-devel@alsa-project.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: alsa-devel-bounces@alsa-project.org Sender: "Alsa-devel" Struct headers require a 'struct $NAME' title, all function parameters require a description and need to be in the format '@.*:', else the checker gets confused. Also demote one kerneldoc header where no effort was made to document any of the function's params. Fixes the following W=1 kernel build warning(s): sound/soc/fsl/fsl_esai.c:30: warning: cannot understand function prototype: 'struct fsl_esai_soc_data ' sound/soc/fsl/fsl_esai.c:61: warning: cannot understand function prototype: 'struct fsl_esai ' sound/soc/fsl/fsl_esai.c:170: warning: Function parameter or member 'dai' not described in 'fsl_esai_divisor_cal' sound/soc/fsl/fsl_esai.c:265: warning: Function parameter or member 'dai' not described in 'fsl_esai_set_dai_sysclk' sound/soc/fsl/fsl_esai.c:265: warning: Function parameter or member 'clk_id' not described in 'fsl_esai_set_dai_sysclk' sound/soc/fsl/fsl_esai.c:265: warning: Function parameter or member 'freq' not described in 'fsl_esai_set_dai_sysclk' sound/soc/fsl/fsl_esai.c:265: warning: Function parameter or member 'dir' not described in 'fsl_esai_set_dai_sysclk' sound/soc/fsl/fsl_esai.c:265: warning: Excess function parameter 'Parameters' description in 'fsl_esai_set_dai_sysclk' sound/soc/fsl/fsl_esai.c:364: warning: Function parameter or member 'dai' not described in 'fsl_esai_set_bclk' sound/soc/fsl/fsl_esai.c:364: warning: Function parameter or member 'tx' not described in 'fsl_esai_set_bclk' sound/soc/fsl/fsl_esai.c:364: warning: Function parameter or member 'freq' not described in 'fsl_esai_set_bclk' Cc: Timur Tabi Cc: Nicolin Chen Cc: Xiubo Li Cc: Fabio Estevam Cc: linuxppc-dev@lists.ozlabs.org Signed-off-by: Lee Jones --- sound/soc/fsl/fsl_esai.c | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/sound/soc/fsl/fsl_esai.c b/sound/soc/fsl/fsl_esai.c index cbcb70d6f8c83..bb3c405df623c 100644 --- a/sound/soc/fsl/fsl_esai.c +++ b/sound/soc/fsl/fsl_esai.c @@ -22,7 +22,7 @@ SNDRV_PCM_FMTBIT_S24_LE) /** - * fsl_esai_soc_data: soc specific data + * struct fsl_esai_soc_data - soc specific data * * @imx: for imx platform * @reset_at_xrun: flags for enable reset operaton @@ -33,7 +33,7 @@ struct fsl_esai_soc_data { }; /** - * fsl_esai: ESAI private data + * struct fsl_esai - ESAI private data * * @dma_params_rx: DMA parameters for receive channel * @dma_params_tx: DMA parameters for transmit channel @@ -160,10 +160,11 @@ static irqreturn_t esai_isr(int irq, void *devid) * This function is used to calculate the divisors of psr, pm, fp and it is * supposed to be called in set_dai_sysclk() and set_bclk(). * + * @dai: SoC DAI + * @tx: current setting is for playback or capture * @ratio: desired overall ratio for the paticipating dividers * @usefp: for HCK setting, there is no need to set fp divider * @fp: bypass other dividers by setting fp directly if fp != 0 - * @tx: current setting is for playback or capture */ static int fsl_esai_divisor_cal(struct snd_soc_dai *dai, bool tx, u32 ratio, bool usefp, u32 fp) @@ -252,11 +253,11 @@ static int fsl_esai_divisor_cal(struct snd_soc_dai *dai, bool tx, u32 ratio, /** * This function mainly configures the clock frequency of MCLK (HCKT/HCKR) * - * @Parameters: - * clk_id: The clock source of HCKT/HCKR + * @dai: SoC DAI + * @clk_id: The clock source of HCKT/HCKR * (Input from outside; output from inside, FSYS or EXTAL) - * freq: The required clock rate of HCKT/HCKR - * dir: The clock direction of HCKT/HCKR + * @freq: The required clock rate of HCKT/HCKR + * @dir: The clock direction of HCKT/HCKR * * Note: If the direction is input, we do not care about clk_id. */ @@ -357,7 +358,7 @@ static int fsl_esai_set_dai_sysclk(struct snd_soc_dai *dai, int clk_id, return 0; } -/** +/* * This function configures the related dividers according to the bclk rate */ static int fsl_esai_set_bclk(struct snd_soc_dai *dai, bool tx, u32 freq)