From patchwork Fri Jan 13 06:39:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 43009 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4e01:0:0:0:0:0 with SMTP id p1csp121767wrt; Thu, 12 Jan 2023 22:57:06 -0800 (PST) X-Google-Smtp-Source: AMrXdXvonNyXB5fjNAnI94hdnA9f5XyDjM6OQfihTpOpEKTiL3mGDerqw7Ql3poNO7i+Rn17PMXP X-Received: by 2002:a17:907:8b11:b0:81b:fbff:a7cc with SMTP id sz17-20020a1709078b1100b0081bfbffa7ccmr68579677ejc.18.1673593026807; Thu, 12 Jan 2023 22:57:06 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1673593026; cv=none; d=google.com; s=arc-20160816; b=NUNIYu+t+G+d5HsnKM2cHyzKHbKdQqELSN9XjucarySKW+Vm0iazafrCVGiYyoDMyO qVYxqpCbcgW6va01wu81SVeKTFYp2meq+CfFSUTCzDwKo6WF6zDsfl/4Pjlf/f7rbt6b gK21T3SOrIpTARQ3GUPYsnG9cc4pDnWkkNRKICCIkRGIqA0umeIDTEj4342ZuTbOCe2c Srhfmq0MZKkiQcYkkHPfxZMnLJK8EMEPOA0tQZGigEWDEa0rTaDwD/+jKMyLT1a6xodT wSKSqNAS++7rqpfEiace4i+r4iIpQnV9kuhieJ/2At82oerAdtQtWQGGMOqGbEd5oAju dapQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=Ae0YtkSy6ycx5DxDjJ9hEzZMOUAvt0aVhp2q7qivpy0=; b=dpF0eu79aE/ZjO23eMSu4GPjPO/vFOBJUKRTvW2HpoD8dbM/QsrzTibfxvti3L/Gex wR7OeW865j0adLto4032Ys8uPIUfnORAX/0UgktDi+ThzGticpNU6P2w/kklPMidM3YZ 4PxfpXPwBVe3WQcZon8D6G7GqD9Tec3+WU4jV9gHdAOyK3Xdm5nA5unhIvTl63xBFkuj AA1+euYKluzTVhtzc7jWWeeSmneNwHMhhn0FmV/wLAdP3uUXDtPwBgGfiPo0RHPZHolu aI3+esG2azrBbkSQqqXkQo8RnCeVDXFBMnw/5xZutyJVPE6DAELjWmtXJsXeaAE6+ipY RdRw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=5Cmm9j5f; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id oz38-20020a1709077da600b008366ae33ecesi20291642ejc.171.2023.01.12.22.56.43; Thu, 12 Jan 2023 22:57:06 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=5Cmm9j5f; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240770AbjAMGz6 (ORCPT + 99 others); Fri, 13 Jan 2023 01:55:58 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56630 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240774AbjAMGy4 (ORCPT ); Fri, 13 Jan 2023 01:54:56 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 861A8BA1 for ; Thu, 12 Jan 2023 22:39:48 -0800 (PST) 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=Ae0YtkSy6ycx5DxDjJ9hEzZMOUAvt0aVhp2q7qivpy0=; b=5Cmm9j5fxRhR4JfIWVBq/18XZD NQ1+y2ZbPL5Fpou6dQmO9FNHtXJ//Pf3VJgLZLy4OIZHrUQlLOvsMdvOZGo1RpSaFr61SxYU9nJbh gcsLqx/nGY85YdQ1KMuY06gaugfVsIxZain/TSnsISAicOrFGLfCrdMkAzUKdkG/pnYuRodHdEB/d 4/6iMGtBVZPFmAJ/qQk4GKkJPDc6zv/kCNEUX7IBCoZ0TSZazqAYuuWUxBwA7O1wwFMvXgB+sZQbX 6q6eptvagE4lXLNmn2AmI4yl8hnX/L+KxMdtecmUayAcQLNsuMIvUicepaWgINb7drVOAp5o0l/O4 OOzDg5xQ==; Received: from [2601:1c2:d80:3110::9307] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1pGDjA-000qXM-2N; Fri, 13 Jan 2023 06:39:48 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Christian Gromm , Greg Kroah-Hartman Subject: [PATCH] most: fix kernel-doc warnings Date: Thu, 12 Jan 2023 22:39:47 -0800 Message-Id: <20230113063947.23174-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1754889481721171430?= X-GMAIL-MSGID: =?utf-8?q?1754889481721171430?= Fix various W=1 kernel-doc warnings in drivers/most/: drivers/most/most_usb.c:669: warning: Excess function parameter 'data' description in 'link_stat_timer_handler' drivers/most/most_usb.c:769: warning: cannot understand function prototype: 'const struct file_operations hdm_usb_fops = ' drivers/most/most_usb.c:776: warning: cannot understand function prototype: 'const struct usb_device_id usbid[] = ' drivers/most/most_cdev.c:301: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Initialization of struct file_operations drivers/most/most_cdev.c:414: warning: Function parameter or member 'args' not described in 'comp_probe' drivers/most/most_snd.c:56: warning: Function parameter or member 'pcm_hardware' not described in 'channel' drivers/most/most_snd.c:56: warning: Function parameter or member 'copy_fn' not described in 'channel' drivers/most/most_snd.c:404: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Initialization of struct snd_pcm_ops drivers/most/most_snd.c:514: warning: Function parameter or member 'device_name' not described in 'audio_probe_channel' drivers/most/most_snd.c:703: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Initialization of the struct most_component Signed-off-by: Randy Dunlap Cc: Christian Gromm Cc: Greg Kroah-Hartman --- Also: what does MOST mean? Can that be added to drivers/most/Kconfig, in a prompt or help text? Also: how about a MAINTAINERS entry for drivers/most/? drivers/most/most_cdev.c | 5 +++-- drivers/most/most_snd.c | 10 ++++++---- drivers/most/most_usb.c | 6 +++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff -- a/drivers/most/most_usb.c b/drivers/most/most_usb.c --- a/drivers/most/most_usb.c +++ b/drivers/most/most_usb.c @@ -660,7 +660,7 @@ static void hdm_request_netinfo(struct m /** * link_stat_timer_handler - schedule work obtaining mac address and link status - * @data: pointer to USB device instance + * @t: pointer to timer_list which holds a pointer to the USB device instance * * The handler runs in interrupt context. That's why we need to defer the * tasks to a work queue. @@ -763,14 +763,14 @@ static void wq_clear_halt(struct work_st mutex_unlock(&mdev->io_mutex); } -/** +/* * hdm_usb_fops - file operation table for USB driver */ static const struct file_operations hdm_usb_fops = { .owner = THIS_MODULE, }; -/** +/* * usb_device_id - ID table for HCD device probing */ static const struct usb_device_id usbid[] = { diff -- a/drivers/most/most_cdev.c b/drivers/most/most_cdev.c --- a/drivers/most/most_cdev.c +++ b/drivers/most/most_cdev.c @@ -297,7 +297,7 @@ static __poll_t comp_poll(struct file *f return mask; } -/** +/* * Initialization of struct file_operations */ static const struct file_operations channel_fops = { @@ -404,8 +404,9 @@ static int comp_tx_completion(struct mos * @channel_id: channel index/ID * @cfg: pointer to actual channel configuration * @name: name of the device to be created + * @args: pointer to array of component parameters (from configfs) * - * This allocates achannel object and creates the device node in /dev + * This allocates a channel object and creates the device node in /dev * * Returns 0 on success or error code otherwise. */ diff -- a/drivers/most/most_snd.c b/drivers/most/most_snd.c --- a/drivers/most/most_snd.c +++ b/drivers/most/most_snd.c @@ -27,6 +27,7 @@ static struct most_component comp; /** * struct channel - private structure to keep channel specific data * @substream: stores the substream structure + * @pcm_hardware: low-level hardware description * @iface: interface for which the channel belongs to * @cfg: channel configuration * @card: registered sound card @@ -38,6 +39,7 @@ static struct most_component comp; * @opened: set when the stream is opened * @playback_task: playback thread * @playback_waitq: waitq used by playback thread + * @copy_fn: copy function for PCM-specific format and width */ struct channel { struct snd_pcm_substream *substream; @@ -400,7 +402,7 @@ static snd_pcm_uframes_t pcm_pointer(str return channel->buffer_pos; } -/** +/* * Initialization of struct snd_pcm_ops */ static const struct snd_pcm_ops pcm_ops = { @@ -501,8 +503,8 @@ static void release_adapter(struct sound * @iface: pointer to interface instance * @channel_id: channel index/ID * @cfg: pointer to actual channel configuration - * @arg_list: string that provides the name of the device to be created in /dev - * plus the desired audio resolution + * @device_name: name of the device to be created in /dev + * @arg_list: string that provides the desired audio resolution * * Creates sound card, pcm device, sets pcm ops and registers sound card. * @@ -699,7 +701,7 @@ static int audio_tx_completion(struct mo return 0; } -/** +/* * Initialization of the struct most_component */ static struct most_component comp = {