From patchwork Tue Sep 26 05:40:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 144782 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:cae8:0:b0:403:3b70:6f57 with SMTP id r8csp1768225vqu; Tue, 26 Sep 2023 01:55:53 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEwEgEyONZS4477pLAjzHoEv8fxyk6cv5lmmeepi/FXMg/FbMm7vq56acHCc9/EccKM7naJ X-Received: by 2002:a05:6a00:1494:b0:68b:a137:373d with SMTP id v20-20020a056a00149400b0068ba137373dmr3365503pfu.17.1695718553021; Tue, 26 Sep 2023 01:55:53 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1695718553; cv=none; d=google.com; s=arc-20160816; b=sDXnFWvs05XtBCWzKHQZFbI22zu29cOjm460SVhf4ktFjnrYpRJ6s0cW1rr7D0xRXI C+QF3PgfiOIhxDIn3vpvg+SqtWayKu2cAHTRjUmFLeSGD3qRJMXlCswPimkv+hn4orC9 m00Ik6t+JC5Mf28bbV3qpYk7GaTQhDbdBNEhOSZjJrHCKfEhIUHgfBdBUL/wepeksJ6B wLuaeecFCgwZxsA2RLiT+VNAqY19EX27mZhIUl3LRW9tlmHLqetBN57+qjptbW63ln/y Ai8fEpThCCk9gppFresdZhFmQMw2F+GzjniWAJH7P/1Zy7rl0bvEGKcMpH/QGTYMZCOI xmIA== 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=yJdqhIQUoxN3D+nrxuHC+beu2HfHdtlmGmJ8QrD3jjA=; fh=zHpwlsOVl0Cz07hzn0PlocNKwKvBzGt1boyV9hEmcgc=; b=GSS9bbKJV3If1Rs+2fZjnpDEKKs07izVdqdf8BVBfz8lh2rtd5vVA/IgDfaYtIpfNZ /b5J/rCc/xm1KCABuKUO8wq6Dl8oFYw1bZ7l/neFXtP/o2t+9lc/GHGxsEqy2yKHnxQA iNWdyGcpKRNUNnindbqVXojhUFATboPNIbATHKd34+VinuR/1qqVVnuo/vHF2aBml+qb 4mAQPhvKUaWos7nP7xKG9binZr9QTWNII3DT2ulZbHpDCKr0HYW/NiAxzyKiYWcrDEx5 nqe/e7WP4MVoaDxgEBk74fky8IFZeF6cTUDroy3ruKDTupKEX8evwfTruUOLpVnpf1Wf LdAQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=3C72IN31; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from lipwig.vger.email (lipwig.vger.email. [2620:137:e000::3:3]) by mx.google.com with ESMTPS id f50-20020a056a000b3200b0068fe7c4147esi11416522pfu.391.2023.09.26.01.55.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 26 Sep 2023 01:55:52 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) client-ip=2620:137:e000::3:3; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=3C72IN31; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by lipwig.vger.email (Postfix) with ESMTP id 8EEF78226F5F; Mon, 25 Sep 2023 22:40:45 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at lipwig.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233646AbjIZFkZ (ORCPT + 26 others); Tue, 26 Sep 2023 01:40:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35094 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229461AbjIZFkW (ORCPT ); Tue, 26 Sep 2023 01:40:22 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0D11DD7; Mon, 25 Sep 2023 22:40:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To: Content-ID:Content-Description:In-Reply-To:References; bh=yJdqhIQUoxN3D+nrxuHC+beu2HfHdtlmGmJ8QrD3jjA=; b=3C72IN311QgUJmOTBwHef3jvHz D/6BWxPdut/DNXGkeSlXZ5ZFTHHaghz591pozsAi89KC69RMYc7+wQXZU91pjgzzaBq9R6v93Q8og 8Lv5oamM4/cnxE7dg9deHjEazP0epHw3nQU2fYD12B0jaKPR1AT33Y7BiEqtERsNluYAteFHPkERK PggJVW3Ok6D6beS2/uN+UKelEhbYBlZWvTVMKJi7BiDavEObfvWSvlamr+SpfjSXV9ykd/w6XXEmJ OdQ0JrKMnY2DotAehJVemHy37Fb3eiPPD1uzq9KZKaID2gP+tQ/AgB5yOLpRyJ9/FM0Hp/Q38N45M oIrtqaKQ==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1ql0nu-00FdT0-0M; Tue, 26 Sep 2023 05:40:14 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , kernel test robot , Liming Sun , Hans de Goede , =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Mark Gross , Vadim Pasternak , platform-driver-x86@vger.kernel.org Subject: [PATCH] platform/mellanox: tmfifo: fix kernel-doc warnings Date: Mon, 25 Sep 2023 22:40:11 -0700 Message-ID: <20230926054013.11450-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Mon, 25 Sep 2023 22:40:45 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1778089777174777162 X-GMAIL-MSGID: 1778089777174777162 Fix kernel-doc notation for structs and struct members to prevent these warnings: mlxbf-tmfifo.c:73: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_vring ' mlxbf-tmfifo.c:128: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_vdev ' mlxbf-tmfifo.c:146: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_irq_info ' mlxbf-tmfifo.c:158: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_io ' mlxbf-tmfifo.c:182: warning: cannot understand function prototype: 'struct mlxbf_tmfifo ' mlxbf-tmfifo.c:208: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_msg_hdr ' mlxbf-tmfifo.c:138: warning: Function parameter or member 'config' not described in 'mlxbf_tmfifo_vdev' mlxbf-tmfifo.c:212: warning: Function parameter or member 'unused' not described in 'mlxbf_tmfifo_msg_hdr' Fixes: 1357dfd7261f ("platform/mellanox: Add TmFifo driver for Mellanox BlueField Soc") Fixes: bc05ea63b394 ("platform/mellanox: Add BlueField-3 support in the tmfifo driver") Signed-off-by: Randy Dunlap Reported-by: kernel test robot Closes: lore.kernel.org/r/202309252330.saRU491h-lkp@intel.com Cc: Liming Sun Cc: Hans de Goede Cc: Ilpo Järvinen Cc: Mark Gross Cc: Vadim Pasternak Cc: platform-driver-x86@vger.kernel.org --- drivers/platform/mellanox/mlxbf-tmfifo.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff -- a/drivers/platform/mellanox/mlxbf-tmfifo.c b/drivers/platform/mellanox/mlxbf-tmfifo.c --- a/drivers/platform/mellanox/mlxbf-tmfifo.c +++ b/drivers/platform/mellanox/mlxbf-tmfifo.c @@ -53,7 +53,7 @@ struct mlxbf_tmfifo; /** - * mlxbf_tmfifo_vring - Structure of the TmFifo virtual ring + * struct mlxbf_tmfifo_vring - Structure of the TmFifo virtual ring * @va: virtual address of the ring * @dma: dma address of the ring * @vq: pointer to the virtio virtqueue @@ -113,12 +113,13 @@ enum { }; /** - * mlxbf_tmfifo_vdev - Structure of the TmFifo virtual device + * struct mlxbf_tmfifo_vdev - Structure of the TmFifo virtual device * @vdev: virtio device, in which the vdev.id.device field has the * VIRTIO_ID_xxx id to distinguish the virtual device. * @status: status of the device * @features: supported features of the device * @vrings: array of tmfifo vrings of this device + * @config: non-anonymous union for cons and net * @config.cons: virtual console config - * select if vdev.id.device is VIRTIO_ID_CONSOLE * @config.net: virtual network config - @@ -138,7 +139,7 @@ struct mlxbf_tmfifo_vdev { }; /** - * mlxbf_tmfifo_irq_info - Structure of the interrupt information + * struct mlxbf_tmfifo_irq_info - Structure of the interrupt information * @fifo: pointer to the tmfifo structure * @irq: interrupt number * @index: index into the interrupt array @@ -150,7 +151,7 @@ struct mlxbf_tmfifo_irq_info { }; /** - * mlxbf_tmfifo_io - Structure of the TmFifo IO resource (for both rx & tx) + * struct mlxbf_tmfifo_io - Structure of the TmFifo IO resource (for both rx & tx) * @ctl: control register offset (TMFIFO_RX_CTL / TMFIFO_TX_CTL) * @sts: status register offset (TMFIFO_RX_STS / TMFIFO_TX_STS) * @data: data register offset (TMFIFO_RX_DATA / TMFIFO_TX_DATA) @@ -162,7 +163,7 @@ struct mlxbf_tmfifo_io { }; /** - * mlxbf_tmfifo - Structure of the TmFifo + * struct mlxbf_tmfifo - Structure of the TmFifo * @vdev: array of the virtual devices running over the TmFifo * @lock: lock to protect the TmFifo access * @res0: mapped resource block 0 @@ -198,7 +199,7 @@ struct mlxbf_tmfifo { }; /** - * mlxbf_tmfifo_msg_hdr - Structure of the TmFifo message header + * struct mlxbf_tmfifo_msg_hdr - Structure of the TmFifo message header * @type: message type * @len: payload length in network byte order. Messages sent into the FIFO * will be read by the other side as data stream in the same byte order. @@ -208,6 +209,7 @@ struct mlxbf_tmfifo { struct mlxbf_tmfifo_msg_hdr { u8 type; __be16 len; + /* private: */ u8 unused[5]; } __packed __aligned(sizeof(u64));