From patchwork Tue Jul 7 14:37:19 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11648765 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 3876992A for ; Tue, 7 Jul 2020 14:41:02 +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 C395720775 for ; Tue, 7 Jul 2020 14:41:01 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=alsa-project.org header.i=@alsa-project.org header.b="PDaM0AJ2"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="r7HP2Um+" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C395720775 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 5C8C774C; Tue, 7 Jul 2020 16:40:13 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa0.perex.cz 5C8C774C DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=alsa-project.org; s=default; t=1594132860; bh=9anm3FkVKfmBb4XXKTunqBgnT6EhpaxDcnHMSeJA3mI=; h=From:To:Subject:Date:In-Reply-To:References:Cc:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From; b=PDaM0AJ2UcNuWzsRJ720eofUkuaYYw9soPS33RaKK4nL53Ql3fYEYy8NGpXxB+zOu L2L81qvr3wOHBiDpi3E4MSUWjCZ2Le692NNwGLAj2pnxAdURAzvdlX47HN1CqoLS0+ g470bSdUQvaA5Tg0opboSebm79UachUKLbBb9spk= Received: from alsa1.perex.cz (localhost.localdomain [127.0.0.1]) by alsa1.perex.cz (Postfix) with ESMTP id 1720FF8025A; Tue, 7 Jul 2020 16:38:04 +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 8CFF6F802A9; Tue, 7 Jul 2020 16:37:59 +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-x443.google.com (mail-wr1-x443.google.com [IPv6:2a00:1450:4864:20::443]) (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 5F7FDF800D0 for ; Tue, 7 Jul 2020 16:37:52 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.11.0 alsa1.perex.cz 5F7FDF800D0 Authentication-Results: alsa1.perex.cz; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="r7HP2Um+" Received: by mail-wr1-x443.google.com with SMTP id z15so34119165wrl.8 for ; Tue, 07 Jul 2020 07:37:52 -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=8ZEmbLq4aOW35ukJy4E78RGy/Qq2YYTCi7Pk4jUv8mI=; b=r7HP2Um+H6XCeOCwBS1DBw/EpzOzSEUJxkM7XgIIthlv05WGzKRkQ47pQ5X6uXP71A ypKrE22POdbeeY2SYiKSYp+0bJM2G6LOu9Dhs/bmlribcY4bzFgu7o+yV8JJ1bah0Cmm vjw1YoTgK8XPGVKhIsOn3V/N1oz2oFLm/oHVLgziX0DwQ8CdqxFfgL6ALRVzgTO4P6Tt xX3V0IQI2zKjmknDKyitCn9H5JH9/EXp82c5+d5fYQ/fnculdyIiuPEba2AJqLmP5Vfq yGRj5ztTcdY0SkIGgsfknmzhmUZaXDqsSN8eHFfj1uI+qfFkB1Z6HNymxFIc/yDJ7YWa dKkw== 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=8ZEmbLq4aOW35ukJy4E78RGy/Qq2YYTCi7Pk4jUv8mI=; b=S1BTEBiL5iqnwrpM8cm0/CRjkheDTvf1hbBVZwmw9gHlXyWbugO4wylcSJSH23e4iD Ga3Vi8451f6iAULxLojaFPGoPZ49QhaYKeDn/2kRZIUKM4kHoW1DMyQ2yZCqMfYKIqua 5i4G1NNJmrWyD86D6Y8OgjiMB8t+eIo0Ssos7ctbd1jn35po+Z3qhG0tOjK1i6Vq69Je qFnIJm5k3383azYsE6JugZGTbdpeEX6IjGJ8gy3pSZ9qx1xV3iwP24IekPCV/ZDwZDwD drMuEDdEW0HxaUV4hVXDwdyQhA8mnK6zJCDJ85yUMsKMCRiHkfmlJxs4Ct8kmF6iPgcB pKlQ== X-Gm-Message-State: AOAM531DBxe5SuZ6SvT1pzLLdBi+h4aiWLhffK9ZANTHLtVjj6KQ5pmK ZSImXhR3GOrZufr8+iHALohcLQ== X-Google-Smtp-Source: ABdhPJynxRPirdpdNBTzvVN+pt31jUrDR2b6WfGgXqiarIs1KwfdT8fa7FwWITRji5KKCJTycFwC3A== X-Received: by 2002:a05:6000:128e:: with SMTP id f14mr58976062wrx.276.1594132671960; Tue, 07 Jul 2020 07:37:51 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.206]) by smtp.gmail.com with ESMTPSA id y16sm1276131wro.71.2020.07.07.07.37.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Jul 2020 07:37:51 -0700 (PDT) From: Lee Jones To: broonie@kernel.org, lgirdwood@gmail.com, perex@perex.cz, tiwai@suse.com Subject: [PATCH v2 05/28] ASoC: fsl: fsl_ssi: Demote obvious misuse of kerneldoc to standard comment blocks Date: Tue, 7 Jul 2020 15:37:19 +0100 Message-Id: <20200707143742.2959960-6-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" No attempt has been made to document any of the demoted functions here. Fixes the following W=1 kernel build warning(s): sound/soc/fsl/fsl_ssi.c:380: warning: Function parameter or member 'irq' not described in 'fsl_ssi_isr' sound/soc/fsl/fsl_ssi.c:380: warning: Function parameter or member 'dev_id' not described in 'fsl_ssi_isr' sound/soc/fsl/fsl_ssi.c:406: warning: Function parameter or member 'ssi' not described in 'fsl_ssi_config_enable' sound/soc/fsl/fsl_ssi.c:406: warning: Function parameter or member 'tx' not described in 'fsl_ssi_config_enable' sound/soc/fsl/fsl_ssi.c:506: warning: Function parameter or member 'ssi' not described in 'fsl_ssi_config_disable' sound/soc/fsl/fsl_ssi.c:506: warning: Function parameter or member 'tx' not described in 'fsl_ssi_config_disable' sound/soc/fsl/fsl_ssi.c:583: warning: Function parameter or member 'ssi' not described in 'fsl_ssi_setup_regvals' sound/soc/fsl/fsl_ssi.c:675: warning: Function parameter or member 'substream' not described in 'fsl_ssi_set_bclk' sound/soc/fsl/fsl_ssi.c:675: warning: Function parameter or member 'dai' not described in 'fsl_ssi_set_bclk' sound/soc/fsl/fsl_ssi.c:675: warning: Function parameter or member 'hw_params' not described in 'fsl_ssi_set_bclk' sound/soc/fsl/fsl_ssi.c:798: warning: Function parameter or member 'substream' not described in 'fsl_ssi_hw_params' sound/soc/fsl/fsl_ssi.c:798: warning: Function parameter or member 'hw_params' not described in 'fsl_ssi_hw_params' sound/soc/fsl/fsl_ssi.c:798: warning: Function parameter or member 'dai' not described in 'fsl_ssi_hw_params' sound/soc/fsl/fsl_ssi.c:1003: warning: Function parameter or member 'dai' not described in 'fsl_ssi_set_dai_fmt' sound/soc/fsl/fsl_ssi.c:1003: warning: Function parameter or member 'fmt' not described in 'fsl_ssi_set_dai_fmt' sound/soc/fsl/fsl_ssi.c:1018: warning: Function parameter or member 'dai' not described in 'fsl_ssi_set_dai_tdm_slot' sound/soc/fsl/fsl_ssi.c:1018: warning: Function parameter or member 'tx_mask' not described in 'fsl_ssi_set_dai_tdm_slot' sound/soc/fsl/fsl_ssi.c:1018: warning: Function parameter or member 'rx_mask' not described in 'fsl_ssi_set_dai_tdm_slot' sound/soc/fsl/fsl_ssi.c:1018: warning: Function parameter or member 'slots' not described in 'fsl_ssi_set_dai_tdm_slot' sound/soc/fsl/fsl_ssi.c:1018: warning: Function parameter or member 'slot_width' not described in 'fsl_ssi_set_dai_tdm_slot' sound/soc/fsl/fsl_ssi.c:1065: warning: Function parameter or member 'substream' not described in 'fsl_ssi_trigger' sound/soc/fsl/fsl_ssi.c:1065: warning: Function parameter or member 'cmd' not described in 'fsl_ssi_trigger' sound/soc/fsl/fsl_ssi.c:1065: warning: Function parameter or member 'dai' not described in 'fsl_ssi_trigger' sound/soc/fsl/fsl_ssi.c:1245: warning: Function parameter or member 'ssi' not described in 'fsl_ssi_hw_init' sound/soc/fsl/fsl_ssi.c:1274: warning: Function parameter or member 'ssi' not described in 'fsl_ssi_hw_clean' sound/soc/fsl/fsl_ssi.c:1292: warning: Function parameter or member 's' not described in 'make_lowercase' Also use correct formatting when documenting structs: sound/soc/fsl/fsl_ssi.c:258: warning: cannot understand function prototype: 'struct fsl_ssi ' 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_ssi.c | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/sound/soc/fsl/fsl_ssi.c b/sound/soc/fsl/fsl_ssi.c index 1a2fa7f181423..5717d664cde1e 100644 --- a/sound/soc/fsl/fsl_ssi.c +++ b/sound/soc/fsl/fsl_ssi.c @@ -203,7 +203,7 @@ struct fsl_ssi_soc_data { }; /** - * fsl_ssi: per-SSI private data + * struct fsl_ssi - per-SSI private data * * @regs: Pointer to the regmap registers * @irq: IRQ of this SSI @@ -373,7 +373,7 @@ static bool fsl_ssi_is_i2s_cbm_cfs(struct fsl_ssi *ssi) SND_SOC_DAIFMT_CBM_CFS; } -/** +/* * Interrupt handler to gather states */ static irqreturn_t fsl_ssi_isr(int irq, void *dev_id) @@ -394,7 +394,7 @@ static irqreturn_t fsl_ssi_isr(int irq, void *dev_id) return IRQ_HANDLED; } -/** +/* * Set SCR, SIER, STCR and SRCR registers with cached values in regvals * * Notes: @@ -474,7 +474,7 @@ static void fsl_ssi_config_enable(struct fsl_ssi *ssi, bool tx) ssi->streams |= BIT(dir); } -/** +/* * Exclude bits that are used by the opposite stream * * When both streams are active, disabling some bits for the current stream @@ -494,7 +494,7 @@ static void fsl_ssi_config_enable(struct fsl_ssi *ssi, bool tx) #define ssi_excl_shared_bits(vals, avals, aactive) \ ((vals) & _ssi_xor_shared_bits(vals, avals, aactive)) -/** +/* * Unset SCR, SIER, STCR and SRCR registers with cached values in regvals * * Notes: @@ -576,7 +576,7 @@ static void fsl_ssi_tx_ac97_saccst_setup(struct fsl_ssi *ssi) } } -/** +/* * Cache critical bits of SIER, SRCR, STCR and SCR to later set them safely */ static void fsl_ssi_setup_regvals(struct fsl_ssi *ssi) @@ -660,7 +660,7 @@ static void fsl_ssi_shutdown(struct snd_pcm_substream *substream, clk_disable_unprepare(ssi->clk); } -/** +/* * Configure Digital Audio Interface bit clock * * Note: This function can be only called when using SSI as DAI master @@ -781,7 +781,7 @@ static int fsl_ssi_set_bclk(struct snd_pcm_substream *substream, return 0; } -/** +/* * Configure SSI based on PCM hardware parameters * * Notes: @@ -996,7 +996,7 @@ static int _fsl_ssi_set_dai_fmt(struct fsl_ssi *ssi, unsigned int fmt) return 0; } -/** +/* * Configure Digital Audio Interface (DAI) Format */ static int fsl_ssi_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt) @@ -1010,7 +1010,7 @@ static int fsl_ssi_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt) return _fsl_ssi_set_dai_fmt(ssi, fmt); } -/** +/* * Set TDM slot number and slot width */ static int fsl_ssi_set_dai_tdm_slot(struct snd_soc_dai *dai, u32 tx_mask, @@ -1054,7 +1054,7 @@ static int fsl_ssi_set_dai_tdm_slot(struct snd_soc_dai *dai, u32 tx_mask, return 0; } -/** +/* * Start or stop SSI and corresponding DMA transaction. * * The DMA channel is in external master start and pause mode, which @@ -1238,7 +1238,7 @@ static struct snd_ac97_bus_ops fsl_ssi_ac97_ops = { .write = fsl_ssi_ac97_write, }; -/** +/* * Initialize SSI registers */ static int fsl_ssi_hw_init(struct fsl_ssi *ssi) @@ -1267,7 +1267,7 @@ static int fsl_ssi_hw_init(struct fsl_ssi *ssi) return 0; } -/** +/* * Clear SSI registers */ static void fsl_ssi_hw_clean(struct fsl_ssi *ssi) @@ -1285,7 +1285,7 @@ static void fsl_ssi_hw_clean(struct fsl_ssi *ssi) regmap_update_bits(ssi->regs, REG_SSI_SCR, SSI_SCR_SSIEN, 0); } } -/** +/* * Make every character in a string lower-case */ static void make_lowercase(char *s)