Message ID | 20240121051858.17647-1-rdunlap@infradead.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-31972-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:2bc4:b0:101:a8e8:374 with SMTP id hx4csp1990360dyb; Sun, 21 Jan 2024 01:25:07 -0800 (PST) X-Google-Smtp-Source: AGHT+IFWniWlfRugHX/B9V2sicqYF0t0l8wNDvaGjNQxnvgxBcVmJtppJdnlCt2H7yhzmMhVJT5m X-Received: by 2002:ac8:4e51:0:b0:42a:3934:328f with SMTP id e17-20020ac84e51000000b0042a3934328fmr787276qtw.66.1705829106967; Sun, 21 Jan 2024 01:25:06 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1705829106; cv=pass; d=google.com; s=arc-20160816; b=XusVz0RrdthlYy1iORH/0u3cBNuXcNXJSd3gitqGd3twITT0hGE7Uxq3nDAvdTYDAs /X4Y1Puy1WuvGRAIy8Zzd6+pwy3SXPRT2Ycmuf5Whq5XjUXa8QLkTVqrFFgfumYwP/cM SqQXOgap7QivQaCBCd7Tey7AfREnaLvuYX3U6+1DKwx+uE21YwYKGHk16Z+06GJxRPoi gUDqIV47oI5gkxEej9/HS403da9TiQA4h0vq2gHfsJ6Xl+fIeyW1WaVlBITxSLBkAeZx gsArXSMZhVy5GHPrcoDjDpJFplFfbkTBVa16PHjH11SrqNZsaIU1VxVNkaIxyzvZYyfS A3mg== 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=ZQhtfV8ocb6IW7VM8vOjHJAD+DetDPqhUntwAuu2V9M=; fh=K2TqNGTdaTUv/IriVFJeR3RyuzN8iYI9rRBFJFhXdbg=; b=txKCY2+GPHwJWrsBnzhi/7fulbUZdd0B2QkCQ7BR7DWKh2DRQ6z3tptyu7oLySRbdr ELD6dmIy2eJEJYkMrk5IBKytk13+l04iJaGt4UQ26qkVhKjZ3eQaU/jtSOM0rE8ceOBD v4nPxk0a6pubkyN7O2GZ7FawyfPrplCE2dHiic/pdXAmN/Htw/qao88gXQI2EJ8rT0lp VKetET2V/Y7dqO9j3GPhtVlvoMmgL6aYytfQC3upbpnmSo9tOgS4Pul8wFMtm9EQH7ld 6dXt+gOIILcHkDvYe78k22riuoT5PJTQSkSKotx/q4Fbjqef+z62hkn3px6kq16wgXMG +S+g== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=2Myz9u0b; arc=pass (i=1 dkim=pass dkdomain=infradead.org); spf=pass (google.com: domain of linux-kernel+bounces-31972-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-31972-ouuuleilei=gmail.com@vger.kernel.org" Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id v8-20020a05622a144800b0042a17c59760si3133690qtx.625.2024.01.21.01.25.06 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 21 Jan 2024 01:25:06 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-31972-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=2Myz9u0b; arc=pass (i=1 dkim=pass dkdomain=infradead.org); spf=pass (google.com: domain of linux-kernel+bounces-31972-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-31972-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 ny.mirrors.kernel.org (Postfix) with ESMTPS id C061F1C220B7 for <ouuuleilei@gmail.com>; Sun, 21 Jan 2024 05:20:14 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 37E90364DB; Sun, 21 Jan 2024 05:19:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="2Myz9u0b" 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 DEBDE36AE4; Sun, 21 Jan 2024 05:18:59 +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=1705814341; cv=none; b=gtNwWONnSl4oxc1+Q2O21Rsr6kMtymIJjDTbyoqBGZCKeEXXvsY/UoPip1WB0UCzacwDmTbYkAfM+5GZ447P/9dhNd/QS6O0bzN16+dq+SPkPbMGTYpgH8XzGOkaNpn0BVYaENAejmvTvoq+0wyu/WzzKiRxxPqT7dywVFv1lLg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705814341; c=relaxed/simple; bh=33wh/HnX9KwU/ZtNv+g5CnyuEPqn19cIE+EgZJ7bIOY=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type; b=EI2GbBHvkRUi8qBXP//nQR7U9KSPJhNAsEC3UBoeirZweHA0TZwpZIIIO1ihfdcO0V/JV3S4PeDSNrezzfnM5bvTV6HTdqRhYi6yaGW7HmNIc6fZp7ntcRS0MpmIC5bort2UVLeISx7I0RXLTipo71552LjtgDm8t9rXKtAqR20= 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=2Myz9u0b; 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: Content-Type:MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To: Content-ID:Content-Description:In-Reply-To:References; bh=ZQhtfV8ocb6IW7VM8vOjHJAD+DetDPqhUntwAuu2V9M=; b=2Myz9u0b24ZNoh0ffiKXpQnTzh egHVz841MwVoFwf8VUnXbf7RCY2nxmDP8Yx0yWLdMxulq7mJLAfY3CnX/D2Tszt4uDd6zF4+i34is 5nMGvzlaFi3VQ+ElLyl3xNusxiXZp0BLGN662EQ/JrDhWjb9fpw+0c82WVSTLo4cUulgfnjKanvTl fKZ+jdDIDz5qGormFkhTMYHy+Hm4D+GpXVcsV9X43pWRZUVbb1XAy3oObKY/0ub+EXpjFXl76cIpx YIff7nzjqceHmz6e4+rbihZjP55cXKMP67Mkkn5itpZdfxhX/cYff/o+XLAh7eIfKT6kaSk6GIEZj YFurHaSA==; Received: from [50.53.50.0] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rRQEV-008uOq-0m; Sun, 21 Jan 2024 05:18:59 +0000 From: Randy Dunlap <rdunlap@infradead.org> To: linux-kernel@vger.kernel.org Cc: Randy Dunlap <rdunlap@infradead.org>, =?utf-8?q?Emilio_L=C3=B3pez?= <emilio@elopez.com.ar>, Michael Turquette <mturquette@baylibre.com>, Stephen Boyd <sboyd@kernel.org>, linux-clk@vger.kernel.org, Chen-Yu Tsai <wens@csie.org>, Jernej Skrabec <jernej.skrabec@gmail.com>, Samuel Holland <samuel@sholland.org>, linux-arm-kernel@lists.infradead.org, linux-sunxi@lists.linux.dev Subject: [PATCH] clk: sunxi: usb: fix kernel-doc warnings Date: Sat, 20 Jan 2024 21:18:57 -0800 Message-ID: <20240121051858.17647-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788691461446314026 X-GMAIL-MSGID: 1788691461446314026 |
Series |
clk: sunxi: usb: fix kernel-doc warnings
|
|
Commit Message
Randy Dunlap
Jan. 21, 2024, 5:18 a.m. UTC
Move the function description comment to immediately above the
function implementation, the add function parameter descriptions to
prevent kernel-doc warnings:
clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Emilio López <emilio@elopez.com.ar>
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-clk@vger.kernel.org
Cc: Chen-Yu Tsai <wens@csie.org>
Cc: Jernej Skrabec <jernej.skrabec@gmail.com>
Cc: Samuel Holland <samuel@sholland.org>
Cc: linux-arm-kernel@lists.infradead.org
Cc: linux-sunxi@lists.linux.dev
---
drivers/clk/sunxi/clk-usb.c | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
Comments
On Sat, 20 Jan 2024 21:18:57 -0800 Randy Dunlap <rdunlap@infradead.org> wrote: > Move the function description comment to immediately above the > function implementation, the add function parameter descriptions to > prevent kernel-doc warnings: > > clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead > clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup' > clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup' > clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup' Reviewed-by: Andre Przywara <andre.przywara@arm.com> Cheers, Andre > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Emilio López <emilio@elopez.com.ar> > Cc: Michael Turquette <mturquette@baylibre.com> > Cc: Stephen Boyd <sboyd@kernel.org> > Cc: linux-clk@vger.kernel.org > Cc: Chen-Yu Tsai <wens@csie.org> > Cc: Jernej Skrabec <jernej.skrabec@gmail.com> > Cc: Samuel Holland <samuel@sholland.org> > Cc: linux-arm-kernel@lists.infradead.org > Cc: linux-sunxi@lists.linux.dev > --- > drivers/clk/sunxi/clk-usb.c | 9 ++++++--- > 1 file changed, 6 insertions(+), 3 deletions(-) > > diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c > --- a/drivers/clk/sunxi/clk-usb.c > +++ b/drivers/clk/sunxi/clk-usb.c > @@ -73,9 +73,6 @@ static const struct reset_control_ops su > .deassert = sunxi_usb_reset_deassert, > }; > > -/** > - * sunxi_usb_clk_setup() - Setup function for usb gate clocks > - */ > > #define SUNXI_USB_MAX_SIZE 32 > > @@ -85,6 +82,12 @@ struct usb_clk_data { > bool reset_needs_clk; > }; > > +/** > + * sunxi_usb_clk_setup() - Setup function for usb gate clocks > + * @node: &struct device_node for the clock > + * @data: &struct usb_clk_data for the clock > + * @lock: spinlock for the clock > + */ > static void __init sunxi_usb_clk_setup(struct device_node *node, > const struct usb_clk_data *data, > spinlock_t *lock) >
Dne nedelja, 21. januar 2024 ob 06:18:57 CET je Randy Dunlap napisal(a): > Move the function description comment to immediately above the > function implementation, the add function parameter descriptions to > prevent kernel-doc warnings: > > clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead > clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup' > clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup' > clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup' > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Emilio López <emilio@elopez.com.ar> > Cc: Michael Turquette <mturquette@baylibre.com> > Cc: Stephen Boyd <sboyd@kernel.org> > Cc: linux-clk@vger.kernel.org > Cc: Chen-Yu Tsai <wens@csie.org> > Cc: Jernej Skrabec <jernej.skrabec@gmail.com> > Cc: Samuel Holland <samuel@sholland.org> > Cc: linux-arm-kernel@lists.infradead.org > Cc: linux-sunxi@lists.linux.dev Acked-by: Jernej Skrabec <jernej.skrabec@gmail.com> Best regards, Jernej
Dne nedelja, 21. januar 2024 ob 06:18:57 CET je Randy Dunlap napisal(a): > Move the function description comment to immediately above the > function implementation, the add function parameter descriptions to > prevent kernel-doc warnings: > > clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead > clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup' > clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup' > clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_clk_setup' > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Emilio López <emilio@elopez.com.ar> > Cc: Michael Turquette <mturquette@baylibre.com> > Cc: Stephen Boyd <sboyd@kernel.org> > Cc: linux-clk@vger.kernel.org > Cc: Chen-Yu Tsai <wens@csie.org> > Cc: Jernej Skrabec <jernej.skrabec@gmail.com> > Cc: Samuel Holland <samuel@sholland.org> > Cc: linux-arm-kernel@lists.infradead.org > Cc: linux-sunxi@lists.linux.dev Merged, thanks! Best regards, Jernej
diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c --- a/drivers/clk/sunxi/clk-usb.c +++ b/drivers/clk/sunxi/clk-usb.c @@ -73,9 +73,6 @@ static const struct reset_control_ops su .deassert = sunxi_usb_reset_deassert, }; -/** - * sunxi_usb_clk_setup() - Setup function for usb gate clocks - */ #define SUNXI_USB_MAX_SIZE 32 @@ -85,6 +82,12 @@ struct usb_clk_data { bool reset_needs_clk; }; +/** + * sunxi_usb_clk_setup() - Setup function for usb gate clocks + * @node: &struct device_node for the clock + * @data: &struct usb_clk_data for the clock + * @lock: spinlock for the clock + */ static void __init sunxi_usb_clk_setup(struct device_node *node, const struct usb_clk_data *data, spinlock_t *lock)