From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.ozlabs.org (lists.ozlabs.org [112.213.38.117]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 64257C43458 for ; Tue, 14 Jul 2026 01:46:02 +0000 (UTC) Received: from boromir.ozlabs.org (localhost [127.0.0.1]) by lists.ozlabs.org (Postfix) with ESMTP id 4gzhvS6G7Mz3c2W; Tue, 14 Jul 2026 11:45:08 +1000 (AEST) Authentication-Results: lists.ozlabs.org; arc=none smtp.remote-ip="2607:7c80:54:3::133" ARC-Seal: i=1; a=rsa-sha256; d=lists.ozlabs.org; s=201707; t=1783993508; cv=none; b=ZKmn7cdnsG0nxSq7DX646ZwW1HFWCHCP2E9YmY3EnSoCccuyOiuwj8ogAJe349mA8zN96HbZ6mX8Dsp2Xli28UFkWqOb0utxzIGPvJQILDrreLI3XctcQUhOAZ06zWtzabDCeiiYlSzeBvURthcXP3smSvoutPYSIbll6fncpH3TaeSViaPiesQd/B0mMS5Dj0ldeNV3FMhlb4H/2A2y8F3yMJEqZoDy0sr/UeE5qxw4PjeFbMVEoUVRBSx0axTZoYGWRvzscSxzjwLnTzGI4ny5ZbIZKJ/H2U8tOL4hATw+YBguAAuqYTv5dfUXBk9I/PHk4PZDWFAeTTWHPSMBPA== ARC-Message-Signature: i=1; a=rsa-sha256; d=lists.ozlabs.org; s=201707; t=1783993508; c=relaxed/relaxed; bh=YTu8Os74RYPgh3GgwSwVyQyyad+a4ItU+8/NSbypv4o=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Tk//t7TXvfoPsjtPeu7l756QiD+Z1o4ELqDTzS/geWXDQobXE6ZScMA6sbGDVgsp4ekYZK1TsyyIv/wQjHzv0ujUqFwaqJadIqJMUfwh+dSvfMkmXstJNoE6+zSa5qmBaIAi1mSLDJL0dsgACLslwRjvQjlJ2Iyg3afFEB7zZX+YXma0VB7ZHeQak5yJSu7aSAA7alHMInFKoLRHIBZ80vQ9gNSBSbs4h6uFaxtG67WQir4IRYeFaMHhCzzTG8/NMelwVYKJGa4lhse2yDnWnS4H/rapuek28ePLF8X6LzODUu5MhG7cEkES1wqwdYcmktQNWG+m04M+LGcs6clb8A== ARC-Authentication-Results: i=1; lists.ozlabs.org; dmarc=pass (p=none dis=none) header.from=infradead.org; dkim=pass (2048-bit key; secure) header.d=infradead.org header.i=@infradead.org header.a=rsa-sha256 header.s=bombadil.20210309 header.b=MHi6NKyN; dkim-atps=neutral; spf=pass (client-ip=2607:7c80:54:3::133; helo=bombadil.infradead.org; envelope-from=rdunlap@infradead.org; receiver=lists.ozlabs.org) smtp.mailfrom=infradead.org Authentication-Results: lists.ozlabs.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: lists.ozlabs.org; dkim=pass (2048-bit key; secure) header.d=infradead.org header.i=@infradead.org header.a=rsa-sha256 header.s=bombadil.20210309 header.b=MHi6NKyN; dkim-atps=neutral Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=infradead.org (client-ip=2607:7c80:54:3::133; helo=bombadil.infradead.org; envelope-from=rdunlap@infradead.org; receiver=lists.ozlabs.org) Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange x25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 4gzhvD263mz2ygX for ; Tue, 14 Jul 2026 11:44:56 +1000 (AEST) 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:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=YTu8Os74RYPgh3GgwSwVyQyyad+a4ItU+8/NSbypv4o=; b=MHi6NKyN0kkMe0gEN8StAN+8Y0 0YQG7sh0a2wyB52FRPlsyWkstP+Be174lrAeamIhKJ84ba7zf3vLTOdq6GCEfOopM7TheSZ2hOuMb tdGeQDnrtrUPAMjY9uwYGG49vrn7kUkWPVFTWuCwmL5hIbfUPgU0jQdxFa7suZ6mu2E/AXu10kcCP zWEBY24n4AfD3jihcw2onUIkNA5hqTPSB4o4Q7JWh5Zxm36i9BtURkZ5TG5QjkiGV/2QuqtMr/TFC L8eFysROFIB6WBCBD76nijKOJ0/9FO0hdulST1xIJmzaAChq0S2ibDcVfxP8LPnMbmbTVhaJZSWIW OuNanVeQ==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.99.1 #2 (Red Hat Linux)) id 1wjSCb-0000000AgsR-2XK9; Tue, 14 Jul 2026 01:44:53 +0000 From: Randy Dunlap To: linux-sound@vger.kernel.org Cc: Randy Dunlap , Jaroslav Kysela , Takashi Iwai , Shengjiu Wang , Xiubo Li , Fabio Estevam , Nicolin Chen , linuxppc-dev@lists.ozlabs.org, Charles Keepax , Maciej Strozek , Bard Liao , Pierre-Louis Bossart , patches@opensource.cirrus.com, Srinivas Kandagatla , linux-arm-msm@vger.kernel.org, Liam Girdwood , Mark Brown Subject: [PATCH 11/14] ASoC: soc-acpi: fix all kernel-doc warnings Date: Mon, 13 Jul 2026 18:44:42 -0700 Message-ID: <20260714014445.569992-12-rdunlap@infradead.org> X-Mailer: git-send-email 2.55.0 In-Reply-To: <20260714014445.569992-1-rdunlap@infradead.org> References: <20260714014445.569992-1-rdunlap@infradead.org> X-Mailing-List: linuxppc-dev@lists.ozlabs.org List-Id: List-Help: List-Owner: List-Post: List-Archive: , List-Subscribe: , , List-Unsubscribe: Precedence: list MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Add missing "struct" keyword to kernel-doc for structs. Describe @mach_params in struct snd_soc_acpi_mach. Don't document callback parameters with '@' as though they are kernel-doc. These changes avoid all kernel-doc warnings in this header file. Examples: Warning: ../include/sound/soc-acpi.h:77 cannot understand function prototype: 'struct snd_soc_acpi_mach_params' Warning: ../include/sound/soc-acpi.h:101 cannot understand function prototype: 'struct snd_soc_acpi_endpoint' Warning: ../include/sound/soc-acpi.h:115 cannot understand function prototype: 'struct snd_soc_acpi_adr_device' Warning: ../include/sound/soc-acpi.h:132 cannot understand function prototype: 'struct snd_soc_acpi_link_adr' Warning: ../include/sound/soc-acpi.h:209 cannot understand function prototype: 'struct snd_soc_acpi_mach' Warning: include/sound/soc-acpi.h:230 struct member 'mach_params' not described in 'snd_soc_acpi_mach' Warning: include/sound/soc-acpi.h:230 Excess struct member 'card' description in 'snd_soc_acpi_mach' Warning: include/sound/soc-acpi.h:230 Excess struct member 'mach' description in 'snd_soc_acpi_mach' Signed-off-by: Randy Dunlap --- Cc: Liam Girdwood Cc: Mark Brown include/sound/soc-acpi.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) --- linext-2026-0710.orig/include/sound/soc-acpi.h +++ linext-2026-0710/include/sound/soc-acpi.h @@ -57,7 +57,7 @@ static inline struct snd_soc_acpi_mach * #endif /** - * snd_soc_acpi_mach_params: interface for machine driver configuration + * struct snd_soc_acpi_mach_params - interface for machine driver configuration * * @acpi_ipc_irq_index: used for BYT-CR detection * @platform: string used for HDAudio codec support @@ -93,7 +93,7 @@ struct snd_soc_acpi_mach_params { }; /** - * snd_soc_acpi_endpoint - endpoint descriptor + * struct snd_soc_acpi_endpoint - endpoint descriptor * @num: endpoint number (mandatory, unique per device) * @aggregated: 0 (independent) or 1 (logically grouped) * @group_position: zero-based order (only when @aggregated is 1) @@ -107,7 +107,7 @@ struct snd_soc_acpi_endpoint { }; /** - * snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device + * struct snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device * @adr: 64 bit ACPI _ADR value * @num_endpoints: number of endpoints for this device * @endpoints: array of endpoints @@ -121,7 +121,7 @@ struct snd_soc_acpi_adr_device { }; /** - * snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices + * struct snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices * @mask: one bit set indicates the link this list applies to * @num_adr: ARRAY_SIZE of devices * @adr_d: array of devices @@ -167,8 +167,8 @@ struct snd_soc_acpi_link_adr { #define SND_SOC_ACPI_TPLG_INTEL_CODEC_NAME BIT(4) /** - * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are - * related to the hardware, except for the firmware and topology file names. + * struct snd_soc_acpi_mach - ACPI-based machine descriptor. Most of the fields + * are related to the hardware, except for the firmware and topology file names. * A platform supported by legacy and Sound Open Firmware (SOF) would expose * all firmware/topology related fields. * @@ -192,6 +192,7 @@ struct snd_soc_acpi_link_adr { * the initial selection in the snd_soc_acpi_mach table. * @pdata: intended for platform data or machine specific-ops. This structure * is not constant since this field may be updated at run-time + * @mach_params: machine driver configuration * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled * @tplg_quirk_mask: quirks to select different topology files dynamically * @get_function_tplg_files: This is an optional callback, if specified then instead of @@ -199,11 +200,11 @@ struct snd_soc_acpi_link_adr { * files to be loaded. * Return value: The number of the files or negative ERRNO. 0 means that the single topology * file should be used, no function topology split can be used on the machine. - * @card: the pointer of the card - * @mach: the pointer of the machine driver - * @prefix: the prefix of the topology file name. Typically, it is the path. - * @tplg_files: the pointer of the array of the topology file names. - * @best_effort: ignore non supported links and try to build the card in best effort + * card: the pointer of the card + * mach: the pointer of the machine driver + * prefix: the prefix of the topology file name. Typically, it is the path. + * tplg_files: the pointer of the array of the topology file names. + * best_effort: ignore non supported links and try to build the card in best effort * with supported links */ /* Descriptor for SST ASoC machine driver */