From patchwork Thu Aug 29 08:51:29 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen-Yu Tsai X-Patchwork-Id: 13782808 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org 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.lore.kernel.org (Postfix) with ESMTPS id 5AFD1C83027 for ; Thu, 29 Aug 2024 09:02:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From: Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=SGXU5ZUf9Kum8MvTiT62dktX9ZINShim7TcYLEwJ+xA=; b=GSxFCrFbSJKsF57Z0NMob0JRt3 XdxkYqMC1yooSwIfe9KP4wSohD5hwqPUuSK8ZC5bGl7CqhsfHsuxyfNgvg+i4iHul8B2kqlt5l7jC Z3isMlI70pRHlKSkxWslQ/AyYyL2ne5PwUrlM3aQbiG6t8xsFn/lTD+uEVvF3mDkseos41EcxsWu5 z1LNvgPcxz32UYPkpZpLYwypKAW3ooGsNi7GW4odJpVtIkqexR+WrIChg+6NeLkD3eoFdUTGkwGaY +RXo0i6mxpPsVa18I6VQsldHCK8YjgSJjFqMvmAZ44boC0RedCnF0ALwlTqV/RmIbIqIRU3P97oyU zYfQbclA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjb2e-00000001GNl-1mAj; Thu, 29 Aug 2024 09:02:08 +0000 Received: from mail-pg1-x52d.google.com ([2607:f8b0:4864:20::52d]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjasz-00000001Dul-0jj6 for linux-arm-kernel@lists.infradead.org; Thu, 29 Aug 2024 08:52:10 +0000 Received: by mail-pg1-x52d.google.com with SMTP id 41be03b00d2f7-7cd9e4f550dso124898a12.0 for ; Thu, 29 Aug 2024 01:52:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921528; x=1725526328; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=SGXU5ZUf9Kum8MvTiT62dktX9ZINShim7TcYLEwJ+xA=; b=hC2La3uPgXR8ZxBvcYfIOvPx2ymUBd2Lw7bxNHgh5jdkPFiOLuI/V9kntEocpSIgDg 241EGxlnrfqK6CtAUpbr6wCbf3GatQggaQkCT4DlPjXsAhZEp86TObbqA3VD3ryysG5+ eSdYmZCvgP9PnkTWcF8qXDg3IG0o668U38VoU= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921528; x=1725526328; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=SGXU5ZUf9Kum8MvTiT62dktX9ZINShim7TcYLEwJ+xA=; b=asUfXfBjlu0b9DpsCTZUxwAcXR42QZmYnLtURkE33AOKvTHV1cBZj+ZYz7kK0yXnnw sTTIw5md8WbHUrVMZpn9RdLNwpmhAXlyM/Bql0tQtdKcD7Bu6nmka/FWrwwM83z3Nlrf MhW52iGL1ShkkNl8GqwAg1G6dg7F5Mab4FW/Pp5JdimITyAQ/mZDT15M1YWNkS3qKsGU YraOgH/yk9gsFFFhW2ihdqMnFMTWNd4ZwR9WsMTC7ZRfAXa5MFqecioWiT+75bj7TvkB hZ/YXz/KyZ3eKyGAODqSRxmgX3QsCLH0/mgAc4rksz6w4J6IhvJ0TEoIuZoUeCCB//Ie 1FxA== X-Forwarded-Encrypted: i=1; AJvYcCUBYdm+94Z84hj3d+DPhcj359l6tgB3fDDhHIyWuwIr84cd1fwAmIQWTHQ2+jsd398+UheArk/ABzRJsGK1TawS@lists.infradead.org X-Gm-Message-State: AOJu0Yz3YrTVZbdj6jMs/I6QQsgJUmFQM7dWx+wsYK9YvVOtkLK7gT46 Zn2Tbjkszu6Qim/idKXEZxAqJrdwbM7ZARyVlKVRGXFZVjGcUVDDnd6mlibBfQ== X-Google-Smtp-Source: AGHT+IHUyBDCpfIX5P3V2AMkg3EedGNWdt2N5Ptsh59Vr2CDGX3G67sN2tw4UC/flCPqMmOzvy7RXA== X-Received: by 2002:a17:903:32c1:b0:202:4bd9:aeb4 with SMTP id d9443c01a7336-2050c237b8cmr20017425ad.17.1724921528190; Thu, 29 Aug 2024 01:52:08 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:fbe5:6d6c:1cc7:23f3]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20515543fbdsm6924165ad.218.2024.08.29.01.52.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:07 -0700 (PDT) From: Chen-Yu Tsai To: Mark Brown , Liam Girdwood Cc: Chen-Yu Tsai , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Andy Shevchenko Subject: [PATCH v2 09/10] regulator: of: Fix kerneldoc format for of_regulator_bulk_get_all() Date: Thu, 29 Aug 2024 16:51:29 +0800 Message-ID: <20240829085131.1361701-10-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240829085131.1361701-1-wenst@chromium.org> References: <20240829085131.1361701-1-wenst@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240829_015209_240172_7251A648 X-CRM114-Status: GOOD ( 14.62 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org of_regulator_bulk_get_all() has a comment section that pretty much resembles a kerneldoc block, except that the block begins with "/*" instead of "/**". Fix that and also rework the "Return" section and the error code terminology so that it is the same as the other kerneldoc blocks in the same file. Fixes: 27b9ecc7a9ba ("regulator: Add of_regulator_bulk_get_all") Signed-off-by: Chen-Yu Tsai --- Changes since v1: - New patch --- drivers/regulator/of_regulator.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c index dfa9f42d4629..cec8c3647a00 100644 --- a/drivers/regulator/of_regulator.c +++ b/drivers/regulator/of_regulator.c @@ -737,20 +737,21 @@ static int is_supply_name(const char *name) return 0; } -/* +/** * of_regulator_bulk_get_all - get multiple regulator consumers * * @dev: Device to supply * @np: device node to search for consumers * @consumers: Configuration of consumers; clients are stored here. * - * @return number of regulators on success, an errno on failure. - * * This helper function allows drivers to get several regulator * consumers in one operation. If any of the regulators cannot be * acquired then any regulators that were allocated will be freed * before returning to the caller, and @consumers will not be * changed. + * + * Return: Number of regulators on success, or a negative error number + * on failure. */ int of_regulator_bulk_get_all(struct device *dev, struct device_node *np, struct regulator_bulk_data **consumers)