From patchwork Mon Feb 12 04:36:04 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 199596 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:50ea:b0:106:860b:bbdd with SMTP id r10csp2272474dyd; Sun, 11 Feb 2024 23:04:43 -0800 (PST) X-Google-Smtp-Source: AGHT+IFfySeDSYW2/sRssAXVpOa4eNY0tLg7JJrYQZK/mQaO/3nnQac/DczGTBCQlfhYgAPDQhrD X-Received: by 2002:a05:6358:70c:b0:17a:df3a:c2af with SMTP id e12-20020a056358070c00b0017adf3ac2afmr3401603rwj.26.1707721483203; Sun, 11 Feb 2024 23:04:43 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707721483; cv=pass; d=google.com; s=arc-20160816; b=HGpjIobQ/Pire/Ywcjatl+8wLmHG9paxwkr2JnWrBlOxLIhi2DlgFe/h/7eqoICsX+ NecYQlJ5PgUpOOYhzvFn13tcXkRrAYtiMc897yHt551/V1Aa0S5zlXfu7j3PD2sc6WJX XcBNnlK67X5JBTujjP/DGxyPBYyxM8ONO/HV2C4l3Z8iiQLuEm1Y6Qwl86xWR2QjunE9 36YvwiLJwzvucvt1mwXwkpR3iLUcLNN54RevPqzQqD6ObLk1uAHb7AUHaVOy51aTknES Jvc/2tKVfvfKwGpIiq/u0HXa5Yz0JDq5oFV9fmGkIwCNTJUr8s97Wy5HgSMsGZHUy7KI GpmQ== ARC-Message-Signature: i=2; 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=08O4r7EagOfxJamjR1JKheKTGIaVmmAOoLfXmfVv1kI=; fh=czDgKv17LS8sOm8UPEEYc/3qXQcpWS+geB7BnekN4WQ=; b=YHmd/DfKO7rA/+us1zIDO/hEOTrVH2+WulZouM5tWzgSr1V6o4KmCmzd64lVSz4OiI e8td1LCNxm1pLJvPFG0Nt8CielR+AcEVageQXeiocIUMRPEzsSRfZSZKJ9Phr4hfH29p +pOF6q6BODdEyJi2pMngdbi77xVeNLWEc+U/ipMeJ2DcosGawktQrK5AjMAPjJwLM0kA WF9LYKcgoBqVCS1mg++lsG+SdgNaNW3dkKv32+6IsAME38/Gle2PzTeoJp+apuEXaSho c8XoDQ5lvtiLrO+t8NngsWV27cTHWZtxQMx6WiR2kft8OQ4wRHKbo+BOKdDNNS1TxQkA oMtA==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b="f/k/2sUs"; arc=pass (i=1 dkim=pass dkdomain=infradead.org); spf=pass (google.com: domain of linux-kernel+bounces-61097-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-61097-ouuuleilei=gmail.com@vger.kernel.org" X-Forwarded-Encrypted: i=2; AJvYcCVdKyJA1FeTodRnswxOitXkxiNDot6imMFLJKyrtsb9h+jsU5IWMytdka235q7RBnnFXsEiYlKk4eui2eSHT8uweWvLMw== Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [2604:1380:45e3:2400::1]) by mx.google.com with ESMTPS id a20-20020a056a000c9400b006dff3ca9e36si4619224pfv.370.2024.02.11.23.04.43 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 11 Feb 2024 23:04:43 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-61097-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b="f/k/2sUs"; arc=pass (i=1 dkim=pass dkdomain=infradead.org); spf=pass (google.com: domain of linux-kernel+bounces-61097-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-61097-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 sv.mirrors.kernel.org (Postfix) with ESMTPS id 4E910284AE3 for ; Mon, 12 Feb 2024 04:36:25 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 98A72749F; Mon, 12 Feb 2024 04:36:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="f/k/2sUs" 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 29D326FA7; Mon, 12 Feb 2024 04:36:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707712567; cv=none; b=Dk+5axoIym9yZRF20SqlcbWe9ygiCWssKhuNvlWpYQt6w8KDbHNXb3v4ZYeWnJvGqXBA8WU/R5HZUTZmDLg8iRlMXkiyQ7qHk+8PzMt0ag9CA4/K/CWRl3TW6622tA3TQ77Rl9ew4RbpsySMZL++o6MmR4vy2NywcHycvlEqt7M= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707712567; c=relaxed/simple; bh=K5Z6Gd9GtIN8kQlUzbKNaoqN7pc1r6LIUiX9Dr2PYKI=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=meq8kwxlEow56L0NhIA9qfE5cealSPq5W4h+eW71b2iWSereArC0q+QxXoyAKnRRDG4zp+6XlD5MhQ2wd4zkVf+UjP/rFXDxBuWeaykyOsQTGdMf9NTaCVu3QXDvn4a01PIsGJtFoHsKo9ZuPqtNi2MdNjeyLBUv0PIOJHfAflw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=f/k/2sUs; arc=none smtp.client-ip=198.137.202.133 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=08O4r7EagOfxJamjR1JKheKTGIaVmmAOoLfXmfVv1kI=; b=f/k/2sUsAIzaH8vGPH09e4pXeX MN0WvhHHiGcaCRdCiQecXqWyrKa3SyCLepVsSA5Bp7eRpH4+5YaOTAdqudPSZo7G3iKWOcSA+tIeF gzZIRWa8sEJ+OGrWgPki5nhgpZW7CJdwNyRt7047z5eaoQmYFQl7lkVzLgvq9m6Kh9HO1mNgKEbQX XLuwoNZ/X0KFUeq7oe7AsSzv88ONG2VjdGkBTIcCnDDF4hlvFILzC3vTp0owL2AprWHj32s8Wrp4X FBnhQ+sjqK9X99BU0uvn48aU5ehU61vqBAPx1NWddYSbbaIdogwV1Ij8E6sQHgVqDaysMOm4HM+Pm L8FTWaGg==; Received: from [50.53.50.0] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rZO32-00000004Jfb-2zA2; Mon, 12 Feb 2024 04:36:04 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Jon Mason , Dave Jiang , Allen Hubbe , ntb@lists.linux.dev Subject: [PATCH v2] NTB: ntb_transport: fix all kernel-doc warnings Date: Sun, 11 Feb 2024 20:36:04 -0800 Message-ID: <20240212043604.12907-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: 1790675761638282740 X-GMAIL-MSGID: 1790675761638282740 Fix all kernel-doc warnings in ntb_transport.c. The function parameters for ntb_transport_create_queue() changed, so update them in the kernel-doc comments. Add a Returns: comment for ntb_transport_register_client_dev(). ntb_transport.c:382: warning: No description found for return value of 'ntb_transport_register_client_dev' ntb_transport.c:1984: warning: Excess function parameter 'rx_handler' description in 'ntb_transport_create_queue' ntb_transport.c:1984: warning: Excess function parameter 'tx_handler' description in 'ntb_transport_create_queue' ntb_transport.c:1984: warning: Excess function parameter 'event_handler' description in 'ntb_transport_create_queue' Signed-off-by: Randy Dunlap Cc: Jon Mason Cc: Dave Jiang Cc: Allen Hubbe Cc: ntb@lists.linux.dev Reviewed-by: Dave Jiang --- v2: ad Dave's Reviewed-by; rebase & resend; drivers/ntb/ntb_transport.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff -- a/drivers/ntb/ntb_transport.c b/drivers/ntb/ntb_transport.c --- a/drivers/ntb/ntb_transport.c +++ b/drivers/ntb/ntb_transport.c @@ -377,6 +377,8 @@ EXPORT_SYMBOL_GPL(ntb_transport_unregist * @device_name: Name of NTB client device * * Register an NTB client device with the NTB transport layer + * + * Returns: %0 on success or -errno code on error */ int ntb_transport_register_client_dev(char *device_name) { @@ -1966,9 +1968,9 @@ static bool ntb_dma_filter_fn(struct dma /** * ntb_transport_create_queue - Create a new NTB transport layer queue - * @rx_handler: receive callback function - * @tx_handler: transmit callback function - * @event_handler: event callback function + * @data: pointer for callback data + * @client_dev: &struct device pointer + * @handlers: pointer to various ntb queue (callback) handlers * * Create a new NTB transport layer queue and provide the queue with a callback * routine for both transmit and receive. The receive callback routine will be