From patchwork Thu Nov 24 06:19:18 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 25327 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp3220554wrr; Wed, 23 Nov 2022 22:24:45 -0800 (PST) X-Google-Smtp-Source: AA0mqf5EyHwthGdeCukuknQoGTZBsTovmZeh40VGOGxS4SKHN8mFZdaf20BbWwzwQxdChtZJg1ip X-Received: by 2002:a17:906:c40b:b0:7ae:1e53:95b2 with SMTP id u11-20020a170906c40b00b007ae1e5395b2mr26128623ejz.333.1669271085487; Wed, 23 Nov 2022 22:24:45 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669271085; cv=none; d=google.com; s=arc-20160816; b=YufKVCaD7zYsRQ7NZTfkAw77WRzd5OCkuOn/Uk2ThIIuQL89TYyGtBI1yJvqfnogFG A9dJcTHf7TwvQXK0YlgPNGaQXIKQIsvpV49cPiWXyRH1zu7O9RIb0m7ngL8G4yCyi/0L mGZclJijSdoynHyL2yqvM+M6W+TZQ1OieDZ8AJ6mYMRCGUbGCR3rYYaewf5ier2b3m5R Gln31G2tGJp88vEkkNrOnm+oOJV5Vn2Qi8qN3pkljt0q8lyTiXjQSERiPiuZND0dZQ55 +uQ3IzTdEIeR8ZJ7GyWKbmarN38Rq84IiZdktvN+VnTlh0ImgOEZ/EnzHqy3Hhzx4B0z 3nRA== 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=P23NM4nqAWcCFp4nIBC+iBFsGGXl6v5G4NOLEXdr/Fo=; b=WEjl/DjJaZtZ1gJCVQpysM/3546PwqSTYCwLeLi1flhjkYAT6SF/7djnUjYy2z01Rh gYY30f23tR06BmRElZpi1DLO0BNfplwnBDi3O1TM1M7klvpGtrim2qwXgnlO52h//fUG 22/BXCnjXiLZCyx/yRXqbAbjQN84lbDJnKtun5Ni6nhM8EVdQdPzkIUCdfq0YDQKSAmn ceXkSKiRGLqIZGorNaxQntET5Wye1g1g+oG2bNP1m2RWCs3VPp5TqMOXRiRNaHxYBRjt tYECKTFDB+y16EHCe05O0atD8f0Pwu2Pd8qCfCsairlW0Q3lh2Lo3znLpiBMph/GwNmg 1+Ng== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b="ALEa6F/K"; 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 b15-20020a056402084f00b0046453c36c4csi262236edz.513.2022.11.23.22.24.22; Wed, 23 Nov 2022 22:24:45 -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=casper.20170209 header.b="ALEa6F/K"; 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 S229471AbiKXGTc (ORCPT + 99 others); Thu, 24 Nov 2022 01:19:32 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57432 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229445AbiKXGTb (ORCPT ); Thu, 24 Nov 2022 01:19:31 -0500 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C9D549372C for ; Wed, 23 Nov 2022 22:19:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; 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=P23NM4nqAWcCFp4nIBC+iBFsGGXl6v5G4NOLEXdr/Fo=; b=ALEa6F/KeLi9otJnpTEIXidIiY BFrnoWsAtTXugJqm+QRWGfg9/rmGmGBu/LbDgTioAVHHxH7fJDhZH35Gm4pyekz7M8+ErAUzlM7bz ufs3lnyNUorX6063iEGamdHk5TXDnowAkWn1qbcvt0RE0FBxE6haf0IUhO165E3eAyAiAN6vHr6su v3ROavVTG594onRGtOezIurHgM4IjcxYilnTs1MZMWmU7W2Gpg1abgB8KM+g7OUxjVGiniJH4IGV5 c45CFGDxaDagLvx+PsEUMyYX4zjFcozktjd4Al17U1CUS9RQSKenqP2ceJXmmvlDmzI0hBm0mal4E BtrwWUTQ==; Received: from [2601:1c2:d80:3110::a2e7] (helo=casper.infradead.org) by casper.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1oy5a6-008RmS-7B; Thu, 24 Nov 2022 06:19:30 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , kernel test robot , Mauro Carvalho Chehab , John Bonesio , Anatolij Gustschin , linuxppc-dev@lists.ozlabs.org, Michael Ellerman Subject: [PATCH] powerpc/mpc52xx_lpbfifo: fix all kernel-doc warnings Date: Wed, 23 Nov 2022 22:19:18 -0800 Message-Id: <20221124061918.1967-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.38.1 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?1750357597654432185?= X-GMAIL-MSGID: =?utf-8?q?1750357597654432185?= Fix multiple kernel-doc warnings in mpc52xx_lpbfifo.c: arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c:377: warning: expecting prototype for mpc52xx_lpbfifo_bcom_poll(). Prototype was for mpc52xx_lpbfifo_poll() instead mpc52xx_lpbfifo.c:221: warning: No description found for return value of 'mpc52xx_lpbfifo_irq' mpc52xx_lpbfifo.c:327: warning: No description found for return value of 'mpc52xx_lpbfifo_bcom_irq' mpc52xx_lpbfifo.c:398: warning: No description found for return value of 'mpc52xx_lpbfifo_submit' mpc52xx_lpbfifo.c:64: warning: Function parameter or member 'req' not described in 'mpc52xx_lpbfifo_kick' mpc52xx_lpbfifo.c:220: warning: contents before sections mpc52xx_lpbfifo.c:223: warning: Function parameter or member 'irq' not described in 'mpc52xx_lpbfifo_irq' mpc52xx_lpbfifo.c:223: warning: Function parameter or member 'dev_id' not described in 'mpc52xx_lpbfifo_irq' mpc52xx_lpbfifo.c:328: warning: contents before sections mpc52xx_lpbfifo.c:331: warning: Function parameter or member 'irq' not described in 'mpc52xx_lpbfifo_bcom_irq' mpc52xx_lpbfifo.c:331: warning: Function parameter or member 'dev_id' not described in 'mpc52xx_lpbfifo_bcom_irq' Reported-by: kernel test robot Signed-off-by: Randy Dunlap Cc: Mauro Carvalho Chehab Cc: John Bonesio Cc: Anatolij Gustschin Cc: linuxppc-dev@lists.ozlabs.org Cc: Michael Ellerman --- arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff -- a/arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c b/arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c --- a/arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c +++ b/arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c @@ -59,6 +59,8 @@ static struct mpc52xx_lpbfifo lpbfifo; /** * mpc52xx_lpbfifo_kick - Trigger the next block of data to be transferred + * + * @req: Pointer to request structure */ static void mpc52xx_lpbfifo_kick(struct mpc52xx_lpbfifo_request *req) { @@ -178,6 +180,8 @@ static void mpc52xx_lpbfifo_kick(struct /** * mpc52xx_lpbfifo_irq - IRQ handler for LPB FIFO + * @irq: IRQ number to be handled + * @dev_id: device ID cookie * * On transmit, the dma completion irq triggers before the fifo completion * triggers. Handle the dma completion here instead of the LPB FIFO Bestcomm @@ -216,6 +220,8 @@ static void mpc52xx_lpbfifo_kick(struct * or nested spinlock condition. The out path is non-trivial, so * extra fiddling is done to make sure all paths lead to the same * outbound code. + * + * Return: irqreturn code (%IRQ_HANDLED) */ static irqreturn_t mpc52xx_lpbfifo_irq(int irq, void *dev_id) { @@ -320,8 +326,12 @@ static irqreturn_t mpc52xx_lpbfifo_irq(i /** * mpc52xx_lpbfifo_bcom_irq - IRQ handler for LPB FIFO Bestcomm task + * @irq: IRQ number to be handled + * @dev_id: device ID cookie * * Only used when receiving data. + * + * Return: irqreturn code (%IRQ_HANDLED) */ static irqreturn_t mpc52xx_lpbfifo_bcom_irq(int irq, void *dev_id) { @@ -372,7 +382,7 @@ static irqreturn_t mpc52xx_lpbfifo_bcom_ } /** - * mpc52xx_lpbfifo_bcom_poll - Poll for DMA completion + * mpc52xx_lpbfifo_poll - Poll for DMA completion */ void mpc52xx_lpbfifo_poll(void) { @@ -393,6 +403,8 @@ EXPORT_SYMBOL(mpc52xx_lpbfifo_poll); /** * mpc52xx_lpbfifo_submit - Submit an LPB FIFO transfer request. * @req: Pointer to request structure + * + * Return: %0 on success, -errno code on error */ int mpc52xx_lpbfifo_submit(struct mpc52xx_lpbfifo_request *req) {