From patchwork Thu Jan 11 04:57:36 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 187171 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2411:b0:101:2151:f287 with SMTP id m17csp1232320dyi; Wed, 10 Jan 2024 20:57:59 -0800 (PST) X-Google-Smtp-Source: AGHT+IHA73f4SMptp6tqMFmSGQgSIzQC5YvJD5zdWIv+hN56DpRV4At4Ddt/r4VBt/tIukIQAEQG X-Received: by 2002:a05:600c:548f:b0:40e:4a72:b954 with SMTP id iv15-20020a05600c548f00b0040e4a72b954mr44439wmb.182.1704949079447; Wed, 10 Jan 2024 20:57:59 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704949079; cv=none; d=google.com; s=arc-20160816; b=O+DTY244jG6kxJ0dU+sbMVM2YS3c25Ezy7/edhEti6PU44uYWxc1QzC7MrRhNO8cnr hTWc2ug9zFVc8iF7jS8zbLsA+V3alalH/2QNdx/NqbgXVRQCHCITygbSZi1hC83QBVK2 Xr2uvuuARzauqw5Io+60omRBHJoNS7t8DweMv0Y9UuFCdGFIdLAJnrRYYSqpBY62QwFM /26peBnLGUXuewsVL7h3GhsT0Nwurcdom2bLdKcabB+xSeFhqXXY+FOGJ7x+5cmJOArC T3PfHRGFO2+gI7RNrG+OEKPIf3epYbQaK6BcDkn/ixIPoHok0V2I+tLlLuM3gmTmoT96 KO4g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=32J24GHc57Fohhb0X9exlI2oFEDZDXgIwq9fIgFZJzQ=; fh=r5PfUE0OnWSET2/UCsn8AeCqwMmd/4PEF2zsWGujttQ=; b=qCgGg/CG4RAbRiCvRiD/98+8fm+3ldJW7HY5xQs8VAik4qw7+2oi46c+5DghwWFKqy d3dV3r4NHTItO+7Z+uPo+gJ/N56VD4RgWavTf+wq5qSgoNlucsB+6ZwHDYMiL8Pl/IpT VtPrItKs6ZRxB4/100ybTAxL/v7JTxOhLX+1nZ0yX2CJxnxchTW6pNTb+S4nDJPyTike nqdbw8YoR3f2zXjjcBU+v7ehr2DshA/Q7oP/3u13jLgB/dNcRZM9dvFXPPucbWEXBlJ5 /Xwollw2KhLC6I82CIjZIOOG8/lDk4Ud6LyhNSc7tTY8Glds052rCwmEPfVKst43ULyS 0cLw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=vn5JYEQE; spf=pass (google.com: domain of linux-kernel+bounces-23065-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-23065-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id n16-20020a170906089000b00a28f023581csi141259eje.630.2024.01.10.20.57.59 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Jan 2024 20:57:59 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-23065-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=vn5JYEQE; spf=pass (google.com: domain of linux-kernel+bounces-23065-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-23065-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id E2FF61F239CF for ; Thu, 11 Jan 2024 04:57:58 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id D7B0023CA; Thu, 11 Jan 2024 04:57:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="vn5JYEQE" Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A9C441FB0; Thu, 11 Jan 2024 04:57:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=32J24GHc57Fohhb0X9exlI2oFEDZDXgIwq9fIgFZJzQ=; b=vn5JYEQEKeExbC/McC/AL0Tzbk 9FgtWaREyiUKskoMsOnH8ggub2Awh9G9AaOBXjBziqExIVVgeH52K9nhVtj2gtGPPIhA+YNT6uMEk /ZhY+mmK4OORnn+KRy0SEA0SBC/yG0iGu5bAx1ar9qEO3HhDo/SRMUJq40ebBMUNgj7HCNJBgMc6Q aB747q7kzr/N4cHDstptHXzhDuH3sug8jKtOZRrtuCDrtIK8Shme0pQYgiRYUXyw0OaeVjRKN0OcV UuYaulfxUY1aM8pvnh05OUnG8r8qYaNZzr1ZBD3xMGeggzKH77qD3bbGea8rWLSXxv/wFzeRE67uf SCBKsAjw==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rNn8L-00FsFR-0o; Thu, 11 Jan 2024 04:57:37 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Liam Girdwood , Mark Brown , linux-sound@vger.kernel.org, Jaroslav Kysela , Takashi Iwai Subject: [PATCH] ASoC: p1022_rdk: fix all kernel-doc warnings Date: Wed, 10 Jan 2024 20:57:36 -0800 Message-ID: <20240111045736.7500-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787768685537895696 X-GMAIL-MSGID: 1787768685537895696 Fix several kernel-doc warnings in p1022_rdk.c: p1022_rdk.c:70: warning: cannot understand function prototype: 'struct machine_data ' p1022_rdk.c:90: warning: Function parameter or struct member 'card' not described in 'p1022_rdk_machine_probe' p1022_rdk.c:90: warning: No description found for return value of 'p1022_rdk_machine_probe' p1022_rdk.c:129: warning: Function parameter or struct member 'substream' not described in 'p1022_rdk_startup' p1022_rdk.c:129: warning: No description found for return value of 'p1022_rdk_startup' p1022_rdk.c:162: warning: Function parameter or struct member 'card' not described in 'p1022_rdk_machine_remove' p1022_rdk.c:162: warning: No description found for return value of 'p1022_rdk_machine_remove' p1022_rdk.c:187: warning: cannot understand function prototype: 'const struct snd_soc_ops p1022_rdk_ops = ' p1022_rdk.c:199: warning: Function parameter or struct member 'pdev' not described in 'p1022_rdk_probe' p1022_rdk.c:199: warning: No description found for return value of 'p1022_rdk_probe' p1022_rdk.c:349: warning: Function parameter or struct member 'pdev' not described in 'p1022_rdk_remove' p1022_rdk.c:376: warning: No description found for return value of 'p1022_rdk_init' Signed-off-by: Randy Dunlap Cc: Liam Girdwood Cc: Mark Brown Cc: linux-sound@vger.kernel.org Cc: Jaroslav Kysela Cc: Takashi Iwai --- sound/soc/fsl/p1022_rdk.c | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff -- a/sound/soc/fsl/p1022_rdk.c b/sound/soc/fsl/p1022_rdk.c --- a/sound/soc/fsl/p1022_rdk.c +++ b/sound/soc/fsl/p1022_rdk.c @@ -61,7 +61,7 @@ static inline void guts_set_dmuxcr(struc /* There's only one global utilities register */ static phys_addr_t guts_phys; -/** +/* * machine_data: machine-specific ASoC device data * * This structure contains data for a single sound platform device on an @@ -80,11 +80,14 @@ struct machine_data { }; /** - * p1022_rdk_machine_probe: initialize the board + * p1022_rdk_machine_probe - initialize the board + * @card: ASoC card instance * * This function is used to initialize the board-specific hardware. * * Here we program the DMACR and PMUXCR registers. + * + * Returns: %0 on success or negative errno value on error */ static int p1022_rdk_machine_probe(struct snd_soc_card *card) { @@ -119,11 +122,14 @@ static int p1022_rdk_machine_probe(struc } /** - * p1022_rdk_startup: program the board with various hardware parameters + * p1022_rdk_startup - program the board with various hardware parameters + * @substream: ASoC substream object * * This function takes board-specific information, like clock frequencies * and serial data formats, and passes that information to the codec and * transport drivers. + * + * Returns: %0 on success or negative errno value on error */ static int p1022_rdk_startup(struct snd_pcm_substream *substream) { @@ -153,10 +159,13 @@ static int p1022_rdk_startup(struct snd_ } /** - * p1022_rdk_machine_remove: Remove the sound device + * p1022_rdk_machine_remove - Remove the sound device + * @card: ASoC card instance * * This function is called to remove the sound device for one SSI. We * de-program the DMACR and PMUXCR register. + * + * Returns: %0 on success or negative errno value on error */ static int p1022_rdk_machine_remove(struct snd_soc_card *card) { @@ -181,7 +190,7 @@ static int p1022_rdk_machine_remove(stru return 0; } -/** +/* * p1022_rdk_ops: ASoC machine driver operations */ static const struct snd_soc_ops p1022_rdk_ops = { @@ -189,11 +198,14 @@ static const struct snd_soc_ops p1022_rd }; /** - * p1022_rdk_probe: platform probe function for the machine driver + * p1022_rdk_probe - platform probe function for the machine driver + * @pdev: platform device pointer * * Although this is a machine driver, the SSI node is the "master" node with * respect to audio hardware connections. Therefore, we create a new ASoC * device for each new SSI node that has a codec attached. + * + * Returns: %0 on success or negative errno value on error */ static int p1022_rdk_probe(struct platform_device *pdev) { @@ -341,7 +353,8 @@ error_put: } /** - * p1022_rdk_remove: remove the platform device + * p1022_rdk_remove - remove the platform device + * @pdev: platform device pointer * * This function is called when the platform device is removed. */ @@ -368,9 +381,11 @@ static struct platform_driver p1022_rdk_ }; /** - * p1022_rdk_init: machine driver initialization. + * p1022_rdk_init - machine driver initialization. * * This function is called when this module is loaded. + * + * Returns: %0 on success or negative errno value on error */ static int __init p1022_rdk_init(void) { @@ -391,7 +406,7 @@ static int __init p1022_rdk_init(void) } /** - * p1022_rdk_exit: machine driver exit + * p1022_rdk_exit - machine driver exit * * This function is called when this driver is unloaded. */