From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f169.google.com (mail-pl1-f169.google.com [209.85.214.169]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 779C518C923 for ; Thu, 29 Aug 2024 08:51:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.169 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921512; cv=none; b=ftWn9rY/DeRW/vFPJQgyFxHbhNXy4cR3FSBu3Gzwzyo3s1eZv8y8xdJlYLK2/WkjfLY98qEwLBquXw2wsW+H43viQ5PTg44LDC/UT3pPtKbXf7ZUTXR1JIlNeFUmnNQhCQqpT1oa7GzNOheMo8Nk79rguXySeBIE+TkVLa5nPcw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921512; c=relaxed/simple; bh=eTGOjlJK96LCgsFfSsVVu9aMWx0XcNbrIRxF246XPHQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=hePTkcCzVn3JBEyoKf07ldvftN1y2PeezUaJKIjqy3kRal6Cby8Z2OtoUPjKxB+Lv8CJGRwKM9QsnqKyU4mdNHfbLr2tCG9qywSJ3/tL/4hOOJE9KwWfP9AgNacmKOgrrc3zci7HNmF+AZ5g9PJNWiHqM3ROQy/QO3xoSjYctvk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=FelZ1XdV; arc=none smtp.client-ip=209.85.214.169 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="FelZ1XdV" Received: by mail-pl1-f169.google.com with SMTP id d9443c01a7336-202318c4f45so4165875ad.0 for ; Thu, 29 Aug 2024 01:51:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921511; x=1725526311; darn=vger.kernel.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=heIFKAnQeQ+nyj/vXNO0cty0i3q7712MChM12fe4bG8=; b=FelZ1XdVWwU8f/ISutyBPSZT4LvhKHlrEJB4vYJ1YrbdTCFA0KmOr121rvwlIqLk5J 0Z8849SnxbN3dQ2XaxAfUq8CXkpgAEvcHmuC76X93NnkzHZO+pIiA2F79mBr6Rc9gYSg Ns0sIXhSNsgmf0SCUe86IkDpUHDb2wFqRf2Ic= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921511; x=1725526311; 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=heIFKAnQeQ+nyj/vXNO0cty0i3q7712MChM12fe4bG8=; b=DXDNPLijtt16gnBMMPHEDfVKIuE7D7ZsCbAhAndp6Th/2qckyaBmLHX6o07aODqNkG W/vfxmxFxfHcvM/4W4jB05uVYbJPrCWecPUG/Q7AHOFRC9yVYPnKLRTO09bXYEMvhURW WJ7cZTPumEE0PXe6j+e3qqN26ZsYpb1q8PqG+hrrzaV5n9Ad7cPMtF45cfs+Wh0KjWnF Ais6xnYw8NEj5ylYOY4ngsM83KBPe33J3v6Ze1DVCUcAwctuQ80+VoXxDfQbWcrLpHxQ w4+onR+ZPI3pB4S0RBjT4Eyh7i1hjRF9UxfiK5yN7zxvF2LZuQ1fizgxFCxxoZ5huxiM CTWQ== X-Forwarded-Encrypted: i=1; AJvYcCVhQA9DaJJWW3Eyv2k256tXrq/SMP0bmzt7K1Pt2G/IUtHHynx05ep4zp5wVgrv66iaWPC9gtFk0AkzTqU=@vger.kernel.org X-Gm-Message-State: AOJu0Yw5XwW6XILE6x/4RwwRZbKP4/tHucYZJbACUTlbb98bne/UnP4B qDLaQstvj+BXiWNoJVE4E3SdRIxCcOyp655xEmht3OPb3aFtG1/lrbX3sAhieQ== X-Google-Smtp-Source: AGHT+IEF5DMEz3vypFVgvJ9fuRxtis7hT+mK/UUazZidY3knWdLTfD07eXsusPkoSY4O2j+uwdw9cA== X-Received: by 2002:a17:902:e5c4:b0:202:44a3:e324 with SMTP id d9443c01a7336-2050c34d93fmr23219625ad.21.1724921510665; Thu, 29 Aug 2024 01:51:50 -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.51.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:51:48 -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 01/10] regulator: core: Fix short description for _regulator_check_status_enabled() Date: Thu, 29 Aug 2024 16:51:21 +0800 Message-ID: <20240829085131.1361701-2-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains that _regulator_check_status_enabled() is missing a short description. Since the current description is already quite short, just trim it a bit more and use it as the short description. Fixes: f7d7ad42a9dc ("regulator: Allow regulators to verify enabled during = enable()") Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: none --- drivers/regulator/core.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 9029de5395ee..763048d6f1ed 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c @@ -2707,10 +2707,8 @@ static void _regulator_delay_helper(unsigned int del= ay) } =20 /** - * _regulator_check_status_enabled - * - * A helper function to check if the regulator status can be interpreted - * as 'regulator is enabled'. + * _regulator_check_status_enabled - check if regulator status can be + * interpreted as "regulator is enabled" * @rdev: the regulator device to check * * Return: --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3903618CBE2 for ; Thu, 29 Aug 2024 08:51:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.172 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921514; cv=none; b=H8YBOWbzs56v/u4M+HnrHFTSlDVOkUaRRs+Fi4ZWHXVgCxeJgRKN8GHnyowGjY/wEjTAlc0L9BTJseXiMhPVRkA1l3pw6fdXZouK0WOFkkwIDhniRO878Oe0CLUnS7XwXFsXbXdOI8QVaDgQiFDDcGLT7hhY2FkqfKtyQx2Mzd0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921514; c=relaxed/simple; bh=rI1cuM7zPA2AWIuXq4oowgaExrrcgVvEGWOi1YCarxQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=trBLrd1eKT69xxYjOyLlKNtOJR0o46xlZalSjmW0Pn303q8G8CDHsEYwZjI25HdJf4AnxbpdFp1xyHKi5MFtxIUZ72NoMUo2OXQOsWIRo/Jjn511lba8zNomm6BAdxGN2YOATwVwzwxAcqjO05cwfYA32UBoJGsfo61HckBr6jM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=AcZ4dMvX; arc=none smtp.client-ip=209.85.214.172 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="AcZ4dMvX" Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-201d5af11a4so3455125ad.3 for ; Thu, 29 Aug 2024 01:51:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921512; x=1725526312; darn=vger.kernel.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=7DtBpQpzoEhtHDP36c0mJ9L5tYUfKN1YBrSu8HK2DxM=; b=AcZ4dMvXRL/uzIn5cTJCHvT84f2VsLaK39wTEipV3fQK9Wli9j3oHrND1XeH49zMlC 1KCOuygdhLbkjfD5etkqsmnEy+UwAhEkdwcYlgx/Ogt2APN2hwPiDaOUtMTnAdOVh/yZ qxSxJR5wrwoTfkfQkQ/6Do3UfEMvklKS8US2c= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921512; x=1725526312; 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=7DtBpQpzoEhtHDP36c0mJ9L5tYUfKN1YBrSu8HK2DxM=; b=YnVqApGsVKK8G2WuFNS61IzrKJle2Y6f6mMyXaeC3ILjDZdHL5f3EmCm9yikEErU3c UHS0KvIS3LGtLwpTGvPUeY/mJT1NqH1v3z6mJaSY4okLgcWVYktPkiqQ6QTRc7runLgg WE9GPg3JA1u5FE0Gh/zZHnj5OK9DQk2Tb2mR1Qp53kK0E+/MBrDTaozGPU54ZGig1thT zbRZfhxfGRuy0eKwa6+ZPA1OI8WFt/PaMoTtr94yDwfxGIIdg6BDwf6/xY5dRrStByfv uZR7DWkyKrUdWXBGdNokpgTlWDI+lhMiwxf2v2ewm4iqZAingT9wVi0sdSmp68UvO0lv 9k4w== X-Forwarded-Encrypted: i=1; AJvYcCWOqY6GVxDIppAVVwqnCPoSC/cq2WpbToMy4hB6gcK693nza/NKfnkatzPOtz9NXAA3I1OvDTB+0wWM4bI=@vger.kernel.org X-Gm-Message-State: AOJu0YypgcDE2FUwWy7bby5IVUQxmSbWQOQzfJpJy7mDv5+V/z0Drd+X Nh0rivxjEzoErEhryyadBZG+M6Vf7SMv83HbompqIpYoxRVgzsBIHS9cSgoJ2A== X-Google-Smtp-Source: AGHT+IEcjaIAJ52LI0Yoz6FfV49r57/iDw8FfyvOIgo4jwrVsqHjPRBovzCDzdVCqzFPC1qXPu6OlA== X-Received: by 2002:a17:903:647:b0:205:79c:56f5 with SMTP id d9443c01a7336-2050c3777demr18432935ad.27.1724921512415; Thu, 29 Aug 2024 01:51:52 -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.51.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:51:52 -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 02/10] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value Date: Thu, 29 Aug 2024 16:51:22 +0800 Message-ID: <20240829085131.1361701-3-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" The kerneldoc for regulator_is_supported_voltage() states that the return value is a boolean. That is not correct, as it could return an error number if the check failed. Fix the description by expanding it to cover the valid return values and error conditions. The description is also converted to a proper "Return" section. Fixes: c5f3939b8fe0 ("regulator: core: Support fixed voltages in regulator_= is_supported_voltage()") Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Replaced "true, false" in commit message with "valid return values" - Added articles ("the", "a") to the description based on surrounding and function implementation context --- drivers/regulator/core.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 763048d6f1ed..0ce3fe1774fe 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c @@ -3456,7 +3456,9 @@ EXPORT_SYMBOL_GPL(regulator_get_linear_step); * @min_uV: Minimum required voltage in uV. * @max_uV: Maximum required voltage in uV. * - * Returns a boolean. + * Return: 1 if the voltage range is supported, 0 if not, or a negative er= ror + * number if @regulator's voltage can't be changed and voltage readback + * failed. */ int regulator_is_supported_voltage(struct regulator *regulator, int min_uV, int max_uV) --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 04A5218CC12 for ; Thu, 29 Aug 2024 08:51:55 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.172 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921517; cv=none; b=BL5QaJ3/gcJTzK2kIucZi6UVKxaXO3WNXQ3wbjGhyxs1qJYQBYtVrv9IWzVt18ZCkYvpzqb6LUZxodSMt1baaJdY0tp7mpuLll0jUup84Ii+L0r6S6ja25T5v67pDplrAykNhEafsWDu25RxqVVvRxeXzEVCv+7r1kkQXq3glHk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921517; c=relaxed/simple; bh=CITJ/pXW+PNEYY3huU/lIyFmUCDxWKW9ESaqs7VfFa8=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=IshJYECRmanffJw9e0SZtG6ghoz6B6/5LZBmaZDo4dQU1P3R9aN4jTC9hODGGsnOaw3zMxnSwGjJKb7zcjpRzLadtGBywdkAVl+inqTXLmb+S6svbTk9f5tPk7iNj4Y6zgb/HKzfHf6M5OGno6AT67gfSx/5ShLjR/XJUJmVlVE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=O2OljoS9; arc=none smtp.client-ip=209.85.214.172 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="O2OljoS9" Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-204f52fe74dso3560465ad.1 for ; Thu, 29 Aug 2024 01:51:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921515; x=1725526315; darn=vger.kernel.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=Peh3KRS2otd9KMsQofYzoADoRSJG/N+Ns2pNhtBQcKs=; b=O2OljoS9x9fVCvJ60pIxUL1m5HBIrgWNj9Q2k9eXlJDust0J+E1Sj5JIvOmlrSOXFl k7Q5LtdyfFEESAETSj2bl6fgJaJoXAGQ/84aHsY8HFFKap7q1wuBnzgmTYkPg6ssCgh8 LNX5nwPse86LBpXDZw/yfFokZJhBPTFR2Nwf0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921515; x=1725526315; 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=Peh3KRS2otd9KMsQofYzoADoRSJG/N+Ns2pNhtBQcKs=; b=WjbX81ORqAiGdV7NcHUsmY2FuqKLorHr9VVcxcO+hfSwnUotQZd6+HHNINgPfJPsUP 9Ig5HWx8NPrwwM53GaSeyMCSuPheDagC4NMCn5hg7mAsnCYazGCb7l3iTJOld4k7DuJB Kz58fHPTqzIogChZlF8T90E1cnh3HkRm9SVW2ntWzKYuCQE1bnTCziRLkegsiRTa8xSM 6DvfnKN4nXsqDukCqgmCHSSPHoPQ+fpmBUF/vnt9xu1j8HDNQfAA2nJlOIekIHAJbhe7 iR585iZf0S719L4G1IaJLrgsWUg7xwjonK+kCi90+x+fOee4MoQaquvic+DAOoro/cnG pGCA== X-Forwarded-Encrypted: i=1; AJvYcCVkdVF/9lyg+nIoNeM2SWGdX4V9fkjapXKJStX8WY4mn+I7PvW+nj3WToZPazthSOGEQgyCkkoyb73g20Y=@vger.kernel.org X-Gm-Message-State: AOJu0YyYK9RyiaGt+/g8BkvGWoUQkxAya6C4yBViYgI6YhH1a4Jhh5wh OXcJ/1n1YSvZvLKsKtJbX4qJ0ta6cHVD0VoGA7d1tdKupqTqmSdBBpUC6i2zDA== X-Google-Smtp-Source: AGHT+IGo3tvc2nBfopqiex+TZW5v8gp7UnG5vd9DIk3b/JKNnSyE+2RajYwWR7PuW+PQtgmHbWWHHQ== X-Received: by 2002:a17:902:ec84:b0:203:a0c7:3156 with SMTP id d9443c01a7336-2050c23699amr22263655ad.5.1724921515115; Thu, 29 Aug 2024 01:51:55 -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.51.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:51:54 -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 03/10] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections Date: Thu, 29 Aug 2024 16:51:23 +0800 Message-ID: <20240829085131.1361701-4-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains about missing "Return" section for many documented functions in the regulator core. Many of them actually have descriptions about the return values, just not in the format kernel-doc wants. Convert these to use the proper "Return:" section header. The existing descriptions have been reworded and moved around to fit the grammar and formatting. In a few cases where the functions don't call even more functions and the error numbers are known, those are documented in detail. Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Capitalized first word of first sentence in "Return" section - Added articles ("the", "a") to the description based on surrounding and function implementation context - Indented "Return" section for regulator_is_enabled() --- drivers/regulator/core.c | 101 ++++++++++++++++++++++----------------- 1 file changed, 56 insertions(+), 45 deletions(-) diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 0ce3fe1774fe..d7656b91f5bb 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c @@ -427,8 +427,9 @@ static void regulator_lock_dependent(struct regulator_d= ev *rdev, * * Traverse all child nodes. * Extract the child regulator device node corresponding to the supply nam= e. - * returns the device node corresponding to the regulator if found, else - * returns NULL. + * + * Return: Pointer to the &struct device_node corresponding to the regulat= or + * if found, or %NULL if not found. */ static struct device_node *of_get_child_regulator(struct device_node *pare= nt, const char *prop_name) @@ -460,8 +461,9 @@ static struct device_node *of_get_child_regulator(struc= t device_node *parent, * @supply: regulator supply name * * Extract the regulator device node corresponding to the supply name. - * returns the device node corresponding to the regulator if found, else - * returns NULL. + * + * Return: Pointer to the &struct device_node corresponding to the regulat= or + * if found, or %NULL if not found. */ static struct device_node *of_get_regulator(struct device *dev, const char= *supply) { @@ -2308,13 +2310,13 @@ struct regulator *_regulator_get(struct device *dev= , const char *id, * @dev: device for regulator "consumer" * @id: Supply name or regulator ID. * - * Returns a struct regulator corresponding to the regulator producer, - * or IS_ERR() condition containing errno. - * * Use of supply names configured via set_consumer_device_supply() is * strongly encouraged. It is recommended that the supply name used * should match the name used for the supply and/or the relevant * device pins in the datasheet. + * + * Return: Pointer to a &struct regulator corresponding to the regulator + * producer, or an ERR_PTR() encoded negative error number. */ struct regulator *regulator_get(struct device *dev, const char *id) { @@ -2327,11 +2329,9 @@ EXPORT_SYMBOL_GPL(regulator_get); * @dev: device for regulator "consumer" * @id: Supply name or regulator ID. * - * Returns a struct regulator corresponding to the regulator producer, - * or IS_ERR() condition containing errno. Other consumers will be - * unable to obtain this regulator while this reference is held and the - * use count for the regulator will be initialised to reflect the current - * state of the regulator. + * Other consumers will be unable to obtain this regulator while this + * reference is held and the use count for the regulator will be + * initialised to reflect the current state of the regulator. * * This is intended for use by consumers which cannot tolerate shared * use of the regulator such as those which need to force the @@ -2342,6 +2342,9 @@ EXPORT_SYMBOL_GPL(regulator_get); * strongly encouraged. It is recommended that the supply name used * should match the name used for the supply and/or the relevant * device pins in the datasheet. + * + * Return: Pointer to a &struct regulator corresponding to the regulator + * producer, or an ERR_PTR() encoded negative error number. */ struct regulator *regulator_get_exclusive(struct device *dev, const char *= id) { @@ -2354,9 +2357,6 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive); * @dev: device for regulator "consumer" * @id: Supply name or regulator ID. * - * Returns a struct regulator corresponding to the regulator producer, - * or IS_ERR() condition containing errno. - * * This is intended for use by consumers for devices which can have * some supplies unconnected in normal use, such as some MMC devices. * It can allow the regulator core to provide stub supplies for other @@ -2368,6 +2368,9 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive); * strongly encouraged. It is recommended that the supply name used * should match the name used for the supply and/or the relevant * device pins in the datasheet. + * + * Return: Pointer to a &struct regulator corresponding to the regulator + * producer, or an ERR_PTR() encoded negative error number. */ struct regulator *regulator_get_optional(struct device *dev, const char *i= d) { @@ -2507,12 +2510,12 @@ EXPORT_SYMBOL_GPL(regulator_unregister_supply_alias= ); * lookup the supply * @num_id: Number of aliases to register * - * @return 0 on success, an errno on failure. - * * This helper function allows drivers to register several supply * aliases in one operation. If any of the aliases cannot be * registered any aliases that were registered will be removed * before returning to the caller. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_bulk_register_supply_alias(struct device *dev, const char *const *id, @@ -2837,7 +2840,7 @@ static int _regulator_do_enable(struct regulator_dev = *rdev) * responsible for keeping track of the refcount for a given regulator con= sumer * and applying / unapplying these things. * - * Returns 0 upon no error; -error upon error. + * Return: 0 on success or negative error number on failure. */ static int _regulator_handle_consumer_enable(struct regulator *regulator) { @@ -2863,7 +2866,7 @@ static int _regulator_handle_consumer_enable(struct r= egulator *regulator) * * The opposite of _regulator_handle_consumer_enable(). * - * Returns 0 upon no error; -error upon error. + * Return: 0 on success or a negative error number on failure. */ static int _regulator_handle_consumer_disable(struct regulator *regulator) { @@ -3271,13 +3274,13 @@ static int _regulator_list_voltage(struct regulator= _dev *rdev, * regulator_is_enabled - is the regulator output enabled * @regulator: regulator source * - * Returns positive if the regulator driver backing the source/client - * has requested that the device be enabled, zero if it hasn't, else a - * negative errno code. - * * Note that the device backing this regulator handle can have multiple * users, so it might be enabled even if regulator_enable() was never * called for this particular source. + * + * Return: Positive if the regulator driver backing the source/client + * has requested that the device be enabled, zero if it hasn't, + * else a negative error number. */ int regulator_is_enabled(struct regulator *regulator) { @@ -3298,9 +3301,10 @@ EXPORT_SYMBOL_GPL(regulator_is_enabled); * regulator_count_voltages - count regulator_list_voltage() selectors * @regulator: regulator source * - * Returns number of selectors, or negative errno. Selectors are - * numbered starting at zero, and typically correspond to bitfields - * in hardware registers. + * Return: Number of selectors for @regulator, or negative error number. + * + * Selectors are numbered starting at zero, and typically correspond to + * bitfields in hardware registers. */ int regulator_count_voltages(struct regulator *regulator) { @@ -3322,9 +3326,9 @@ EXPORT_SYMBOL_GPL(regulator_count_voltages); * @selector: identify voltage to list * Context: can sleep * - * Returns a voltage that can be passed to @regulator_set_voltage(), - * zero if this selector code can't be used on this system, or a - * negative errno. + * Return: Voltage for @selector that can be passed to regulator_set_volta= ge(), + * 0 if @selector can't be used on this system, or a negative error + * number on failure. */ int regulator_list_voltage(struct regulator *regulator, unsigned selector) { @@ -3336,8 +3340,8 @@ EXPORT_SYMBOL_GPL(regulator_list_voltage); * regulator_get_regmap - get the regulator's register map * @regulator: regulator source * - * Returns the register map for the given regulator, or an ERR_PTR value - * if the regulator doesn't use regmap. + * Return: Pointer to the &struct regmap for @regulator, or ERR_PTR() + * encoded -%EOPNOTSUPP if @regulator doesn't use regmap. */ struct regmap *regulator_get_regmap(struct regulator *regulator) { @@ -3387,7 +3391,9 @@ EXPORT_SYMBOL_GPL(regulator_get_hardware_vsel_registe= r); * directly written to the regulator registers. The address of the voltage * register can be determined by calling @regulator_get_hardware_vsel_regi= ster. * - * On error a negative errno is returned. + * Return: 0 on success, -%EINVAL if the selector is outside the supported + * range, or -%EOPNOTSUPP if the regulator does not support voltage + * selectors. */ int regulator_list_hardware_vsel(struct regulator *regulator, unsigned selector) @@ -3414,7 +3420,7 @@ EXPORT_SYMBOL_GPL(regulator_list_hardware_vsel); * Request that the regulator be enabled/disabled with the regulator outpu= t at * the predefined voltage or current value. * - * On success 0 is returned, otherwise a negative errno is returned. + * Return: 0 on success or a negative error number on failure. */ int regulator_hardware_enable(struct regulator *regulator, bool enable) { @@ -3438,8 +3444,8 @@ EXPORT_SYMBOL_GPL(regulator_hardware_enable); * regulator_get_linear_step - return the voltage step size between VSEL v= alues * @regulator: regulator source * - * Returns the voltage step size between VSEL values for linear - * regulators, or return 0 if the regulator isn't a linear regulator. + * Return: The voltage step size between VSEL values for linear regulators, + * or 0 if the regulator isn't a linear regulator. */ unsigned int regulator_get_linear_step(struct regulator *regulator) { @@ -4527,7 +4533,7 @@ EXPORT_SYMBOL_GPL(regulator_get_voltage_rdev); * regulator_get_voltage - get regulator output voltage * @regulator: regulator source * - * This returns the current regulator voltage in uV. + * Return: Current regulator voltage in uV, or a negative error number on = failure. * * NOTE: If the regulator is disabled it will return the voltage value. Th= is * function should not be used to determine regulator state. @@ -4611,7 +4617,8 @@ static int _regulator_get_current_limit(struct regula= tor_dev *rdev) * regulator_get_current_limit - get regulator output current * @regulator: regulator source * - * This returns the current supplied by the specified current sink in uA. + * Return: Current supplied by the specified current sink in uA, + * or a negative error number on failure. * * NOTE: If the regulator is disabled it will return the current value. Th= is * function should not be used to determine regulator state. @@ -4779,7 +4786,7 @@ EXPORT_SYMBOL_GPL(regulator_get_error_flags); * If a regulator is an always-on regulator then an individual consumer's * load will still be removed if that consumer is fully disabled. * - * On error a negative errno is returned. + * Return: 0 on success or a negative error number on failure. */ int regulator_set_load(struct regulator *regulator, int uA_load) { @@ -4964,12 +4971,12 @@ int _regulator_bulk_get(struct device *dev, int num= _consumers, * @num_consumers: Number of consumers to register * @consumers: Configuration of consumers; clients are stored here. * - * @return 0 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. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_bulk_get(struct device *dev, int num_consumers, struct regulator_bulk_data *consumers) @@ -4990,12 +4997,13 @@ static void regulator_bulk_enable_async(void *data,= async_cookie_t cookie) * * @num_consumers: Number of consumers * @consumers: Consumer data; clients are stored here. - * @return 0 on success, an errno on failure * * This convenience API allows consumers to enable multiple regulator * clients in a single API call. If any consumers cannot be enabled * then any others that were enabled will be disabled again prior to * return. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_bulk_enable(int num_consumers, struct regulator_bulk_data *consumers) @@ -5039,12 +5047,13 @@ EXPORT_SYMBOL_GPL(regulator_bulk_enable); * * @num_consumers: Number of consumers * @consumers: Consumer data; clients are stored here. - * @return 0 on success, an errno on failure * * This convenience API allows consumers to disable multiple regulator * clients in a single API call. If any consumers cannot be disabled * then any others that were disabled will be enabled again prior to * return. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_bulk_disable(int num_consumers, struct regulator_bulk_data *consumers) @@ -5078,7 +5087,6 @@ EXPORT_SYMBOL_GPL(regulator_bulk_disable); * * @num_consumers: Number of consumers * @consumers: Consumer data; clients are stored here. - * @return 0 on success, an errno on failure * * This convenience API allows consumers to forcibly disable multiple regu= lator * clients in a single API call. @@ -5086,6 +5094,8 @@ EXPORT_SYMBOL_GPL(regulator_bulk_disable); * likely occur if the regulators are not disabled (e.g. over temp). * Although regulator_force_disable function call for some consumers can * return error numbers, the function is called for all consumers. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_bulk_force_disable(int num_consumers, struct regulator_bulk_data *consumers) @@ -5582,8 +5592,9 @@ static struct regulator_coupler generic_regulator_cou= pler =3D { * @cfg: runtime configuration for regulator * * Called by regulator drivers to register a regulator. - * Returns a valid pointer to struct regulator_dev on success - * or an ERR_PTR() on error. + * + * Return: Pointer to a valid &struct regulator_dev on success or + * an ERR_PTR() encoded negative error number on failure. */ struct regulator_dev * regulator_register(struct device *dev, --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C4DE818C35D for ; Thu, 29 Aug 2024 08:51:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.173 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921519; cv=none; b=a+0p8ekLjViu6F4irZY1uTja+jcepGnHDGvIpUeg+GOblArNMyljSGEUrLMO/w3XrlsnKWxazge19Sg3OkhBp0tRVpuWul6h6kwZa0iGIh3oH9Ch1ElIfLf1NpgEKKAhr7++UgKiLLsvwRDGS7nDG7QZQpPV0YuBOQ+Cef1+XsQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921519; c=relaxed/simple; bh=Ke+pQZjKf0p+gJIaQwR13J4j2KBNs5YVJ0+ePSyhd9s=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=fvzwav92end2O3B3XxzrkhIdWTlNsMuy4QnhfC3hybeqjwZzn9FEBrxGWmx0UuE4iVCotCYKeit2fY3JiZesaDnopazqBSpSpc0bZ4j+HnySdqAttoavahMxCxVz9UXMPJpZ3+nJl4mh35uBoxdOZJCT/m+DYFxKFwrhEg4Tq5Q= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=JRcojrtP; arc=none smtp.client-ip=209.85.214.173 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="JRcojrtP" Received: by mail-pl1-f173.google.com with SMTP id d9443c01a7336-202146e93f6so4029875ad.3 for ; Thu, 29 Aug 2024 01:51:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921517; x=1725526317; darn=vger.kernel.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=9eExJ/LSKKVvg9hYH9GnPj/p8H26y4FLjUbJxPPs080=; b=JRcojrtPgmK4Y7PKhFQ+hU/1OWh6CphqAukaG2bddWOO3/gE0QibBpb2csNep6OdkQ JkVYnIvPcYfOW9EILazAnz+XZrPKRNXJrfQXLTZELL+yu9K/w6YMT1TM4F2yDLPKf3Rm 2+RcBf1MW2vZA/SngBLkN0BxlY5DTp3BF/3tY= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921517; x=1725526317; 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=9eExJ/LSKKVvg9hYH9GnPj/p8H26y4FLjUbJxPPs080=; b=iTYrEF5mJSwyYqDtPmvQGyB4L4xIYHsv83C/8eH9IB83nR66Ri57Dhui9BKGvxrjBw JTJaypA4VpHfrG1VRUPyb2mIzjuKtxjdhlOxhlpyE7XjrIvvZU/zra6LPIfadMw34ex3 YmxtyMrWJHKtgpE2bydhBNygdq0cJX+bd9cHRxMcD2SxPLQJ1TOqmzHHDMJLZNJA0iBv qEtVPrp0t+cchoODHUhQLeLQ0lmCfNn9Vdd3wqOFzec07lqlxLH1i5IBewU9XClVNy6/ M3CHilitA4c5fUorHk3vtW1jm2r0SdddAQBOmi/B6xDCP5fe7T9xi1x6VJ+JBuvVrQEd +Spw== X-Forwarded-Encrypted: i=1; AJvYcCWDNYSAulQ+24ITPbNAox3bM2GhBPp8tnCJUDzKq2fLGmJ1fSRYiMhFGFa0o/wXCC6aPFJfBn7lYhhOkik=@vger.kernel.org X-Gm-Message-State: AOJu0Yw5w3vHfusm8WjgJOTkf2VQZdFkz3gQaipMmwPQacsv3IOjP/vE MtPT+XH8livhzO3LiCCU4sqNognM2lEpTRYPbifSiU9mPypz+FVaG+oUcMF1kw== X-Google-Smtp-Source: AGHT+IHUH7tsXNguLatZjd+DWsassoMfMvLOPUoskM9fuBDw+9E/mq7qkdIorWuKes7byOLkDCI3Ag== X-Received: by 2002:a17:902:ce83:b0:202:3ebf:679d with SMTP id d9443c01a7336-2050c3d2936mr21337985ad.37.1724921516915; Thu, 29 Aug 2024 01:51:56 -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.51.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:51:56 -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 04/10] regulator: core: Add missing kerneldoc "Return" sections Date: Thu, 29 Aug 2024 16:51:24 +0800 Message-ID: <20240829085131.1361701-5-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains about missing "Return" section for many documented functions in the regulator core. Some with free-form return value descriptions have been fixed in the previous patch. The remaining are completely missing any mention of return values. Add "Return" sections to these kerneldoc blocks with basic descriptions. In a few cases where the functions don't call even more functions and the error numbers are known, those are documented in detail. Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Capitalized first word of first sentence in "Return" section - Added articles ("the", "a") to the description based on surrounding and function implementation context --- drivers/regulator/core.c | 65 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 63 insertions(+), 2 deletions(-) diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index d7656b91f5bb..0b929ab71188 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c @@ -139,6 +139,8 @@ static bool regulator_ops_is_valid(struct regulator_dev= *rdev, int ops) * once. If a task, which is calling this function is other * than the one, which initially locked the mutex, it will * wait on mutex. + * + * Return: 0 on success or a negative error number on failure. */ static inline int regulator_lock_nested(struct regulator_dev *rdev, struct ww_acquire_ctx *ww_ctx) @@ -1464,6 +1466,8 @@ static int handle_notify_limits(struct regulator_dev = *rdev, * Constraints *must* be set by platform code in order for some * regulator operations to proceed i.e. set_voltage, set_current_limit, * set_mode. + * + * Return: 0 on success or a negative error number on failure. */ static int set_machine_constraints(struct regulator_dev *rdev) { @@ -1702,6 +1706,8 @@ static int set_machine_constraints(struct regulator_d= ev *rdev) * Called by platform initialisation code to set the supply regulator for = this * regulator. This ensures that a regulators supply will also be enabled b= y the * core if it's child is enabled. + * + * Return: 0 on success or a negative error number on failure. */ static int set_supply(struct regulator_dev *rdev, struct regulator_dev *supply_rdev) @@ -1734,6 +1740,8 @@ static int set_supply(struct regulator_dev *rdev, * sources to symbolic names for supplies for use by devices. Devices * should use these symbolic names to request regulators, avoiding the * need to provide board-specific regulator names as platform data. + * + * Return: 0 on success or a negative error number on failure. */ static int set_consumer_device_supply(struct regulator_dev *rdev, const char *consumer_dev_name, @@ -2000,11 +2008,13 @@ static struct regulator_dev *regulator_lookup_by_na= me(const char *name) * @dev: device for regulator "consumer". * @supply: Supply name or regulator ID. * + * Return: pointer to &struct regulator_dev or ERR_PTR() encoded negative = error number. + * * If successful, returns a struct regulator_dev that corresponds to the n= ame * @supply and with the embedded struct device refcount incremented by one. * The refcount must be dropped by calling put_device(). - * On failure one of the following ERR-PTR-encoded values is returned: - * -ENODEV if lookup fails permanently, -EPROBE_DEFER if lookup could succ= eed + * On failure one of the following ERR_PTR() encoded values is returned: + * -%ENODEV if lookup fails permanently, -%EPROBE_DEFER if lookup could su= cceed * in the future. */ static struct regulator_dev *regulator_dev_lookup(struct device *dev, @@ -2451,6 +2461,8 @@ EXPORT_SYMBOL_GPL(regulator_put); * * All lookups for id on dev will instead be conducted for alias_id on * alias_dev. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_register_supply_alias(struct device *dev, const char *id, struct device *alias_dev, @@ -2640,6 +2652,8 @@ static void regulator_ena_gpio_free(struct regulator_= dev *rdev) * * GPIO is enabled in case of initial use. (enable_count is 0) * GPIO is disabled when it is not shared any more. (enable_count <=3D 1) + * + * Return: 0 on success or a negative error number on failure. */ static int regulator_ena_gpio_ctrl(struct regulator_dev *rdev, bool enable) { @@ -2962,6 +2976,8 @@ static int _regulator_enable(struct regulator *regula= tor) * * NOTE: the output value can be set by other drivers, boot loader or may = be * hardwired in the regulator. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_enable(struct regulator *regulator) { @@ -3072,6 +3088,8 @@ static int _regulator_disable(struct regulator *regul= ator) * NOTE: this will only disable the regulator output if no other consumer * devices have it enabled, the regulator device supports disabling and * machine constraints permit this operation. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_disable(struct regulator *regulator) { @@ -3121,6 +3139,8 @@ static int _regulator_force_disable(struct regulator_= dev *rdev) * NOTE: this *will* disable the regulator output even if other consumer * devices have it enabled. This should be used for situations when device * damage will likely occur if the regulator is not disabled (e.g. over te= mp). + * + * Return: 0 on success or a negative error number on failure. */ int regulator_force_disable(struct regulator *regulator) { @@ -3203,6 +3223,8 @@ static void regulator_disable_work(struct work_struct= *work) * NOTE: this will only disable the regulator output if no other consumer * devices have it enabled, the regulator device supports disabling and * machine constraints permit this operation. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_disable_deferred(struct regulator *regulator, int ms) { @@ -3362,6 +3384,9 @@ EXPORT_SYMBOL_GPL(regulator_get_regmap); * hardware or firmware that can make I2C requests behind the kernel's bac= k, * for example. * + * Return: 0 on success, or -%EOPNOTSUPP if the regulator does not support + * voltage selectors. + * * On success, the output parameters @vsel_reg and @vsel_mask are filled in * and 0 is returned, otherwise a negative errno is returned. */ @@ -4216,6 +4241,8 @@ static int regulator_balance_voltage(struct regulator= _dev *rdev, * request voltage that meets the system constraints will be used. * Regulator system constraints must be set for this regulator before * calling this function otherwise this call will fail. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_set_voltage(struct regulator *regulator, int min_uV, int max= _uV) { @@ -4326,6 +4353,8 @@ EXPORT_SYMBOL_GPL(regulator_set_suspend_voltage); * Provided with the starting and ending voltage, this function attempts to * calculate the time in microseconds required to rise or fall to this new * voltage. + * + * Return: ramp time in microseconds, or a negative error number if calcul= ation failed. */ int regulator_set_voltage_time(struct regulator *regulator, int old_uV, int new_uV) @@ -4383,6 +4412,8 @@ EXPORT_SYMBOL_GPL(regulator_set_voltage_time); * * Drivers providing ramp_delay in regulation_constraints can use this as = their * set_voltage_time_sel() operation. + * + * Return: ramp time in microseconds, or a negative error number if calcul= ation failed. */ int regulator_set_voltage_time_sel(struct regulator_dev *rdev, unsigned int old_selector, @@ -4435,6 +4466,8 @@ int regulator_sync_voltage_rdev(struct regulator_dev = *rdev) * Re-apply the last configured voltage. This is intended to be used * where some external control source the consumer is cooperating with * has caused the configured voltage to change. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_sync_voltage(struct regulator *regulator) { @@ -4566,6 +4599,8 @@ EXPORT_SYMBOL_GPL(regulator_get_voltage); * * NOTE: Regulator system constraints must be set for this regulator before * calling this function otherwise this call will fail. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_set_current_limit(struct regulator *regulator, int min_uA, int max_uA) @@ -4639,6 +4674,8 @@ EXPORT_SYMBOL_GPL(regulator_get_current_limit); * * NOTE: Regulator system constraints must be set for this regulator before * calling this function otherwise this call will fail. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_set_mode(struct regulator *regulator, unsigned int mode) { @@ -4700,6 +4737,9 @@ static unsigned int _regulator_get_mode(struct regula= tor_dev *rdev) * @regulator: regulator source * * Get the current regulator operating mode. + * + * Return: Current operating mode as %REGULATOR_MODE_* values, + * or a negative error number on failure. */ unsigned int regulator_get_mode(struct regulator *regulator) { @@ -4746,6 +4786,8 @@ static int _regulator_get_error_flags(struct regulato= r_dev *rdev, * @flags: pointer to store error flags * * Get the current regulator error information. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_get_error_flags(struct regulator *regulator, unsigned int *flags) @@ -4818,6 +4860,9 @@ EXPORT_SYMBOL_GPL(regulator_set_load); * for the regulator also enable bypass mode and the machine * constraints allow this. Bypass mode means that the regulator is * simply passing the input directly to the output with no regulation. + * + * Return: 0 on success or if changing bypass is not possible, or + * a negative error number on failure. */ int regulator_allow_bypass(struct regulator *regulator, bool enable) { @@ -4875,6 +4920,8 @@ EXPORT_SYMBOL_GPL(regulator_allow_bypass); * @nb: notifier block * * Register notifier block to receive regulator events. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_register_notifier(struct regulator *regulator, struct notifier_block *nb) @@ -4890,6 +4937,8 @@ EXPORT_SYMBOL_GPL(regulator_register_notifier); * @nb: notifier block * * Unregister regulator event notifier block. + * + * Return: 0 on success or a negative error number on failure. */ int regulator_unregister_notifier(struct regulator *regulator, struct notifier_block *nb) @@ -5180,6 +5229,8 @@ static void regulator_handle_critical(struct regulato= r_dev *rdev, * * Called by regulator drivers to notify clients a regulator event has * occurred. + * + * Return: %NOTIFY_DONE. */ int regulator_notifier_call_chain(struct regulator_dev *rdev, unsigned long event, void *data) @@ -5198,6 +5249,8 @@ EXPORT_SYMBOL_GPL(regulator_notifier_call_chain); * @mode: Mode to convert * * Convert a regulator mode into a status. + * + * Return: %REGULATOR_STATUS_* value corresponding to given mode. */ int regulator_mode_to_status(unsigned int mode) { @@ -5888,6 +5941,8 @@ EXPORT_SYMBOL_GPL(regulator_unregister); * @dev: ``&struct device`` pointer that is passed to _regulator_suspend() * * Configure each regulator with it's suspend operating parameters for sta= te. + * + * Return: 0 on success or a negative error number on failure. */ static int regulator_suspend(struct device *dev) { @@ -5977,6 +6032,8 @@ EXPORT_SYMBOL_GPL(regulator_has_full_constraints); * * Get rdev regulator driver private data. This call can be used in the * regulator driver context. + * + * Return: Pointer to regulator driver private data. */ void *rdev_get_drvdata(struct regulator_dev *rdev) { @@ -5990,6 +6047,8 @@ EXPORT_SYMBOL_GPL(rdev_get_drvdata); * * Get regulator driver private data. This call can be used in the consumer * driver context when non API regulator specific functions need to be cal= led. + * + * Return: Pointer to regulator driver private data. */ void *regulator_get_drvdata(struct regulator *regulator) { @@ -6011,6 +6070,8 @@ EXPORT_SYMBOL_GPL(regulator_set_drvdata); /** * rdev_get_id - get regulator ID * @rdev: regulator + * + * Return: Regulator ID for @rdev. */ int rdev_get_id(struct regulator_dev *rdev) { --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f181.google.com (mail-pl1-f181.google.com [209.85.214.181]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EDADE18D637 for ; Thu, 29 Aug 2024 08:51:59 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.181 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921521; cv=none; b=ppX35NVA8vw/v9Gzx/R05bVNv70L2GL1QDcJuNw7bLWBAy3+CGWPoB8b2PG6b03dJO3kMwSFtkYx3FFvWGdr/GRsrubOOrl/QlyNldGMDk+T10cuhXihnPfcnhzZZW5/K0WRbb+nQ+zCvT8OYnF3e1ADQdHdUL4Cv8GWUXFqP5Y= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921521; c=relaxed/simple; bh=tqMRQFMDM2g5ylg72XuZPc55O8LFCWQRKQrBNgYLaSg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=D+lP85WM1pCmW+f7Zbx8KdKNRRY55kmK+NCtT5Dka25YvUwItT8Oh9ixHuh6URAvtAXNTyu2luE2+GY59JcZvu5NFe6lD8HOvjV5EKXQLwLSDG/rK0HCI0SJBUQqbbF3es+05Lq+fw8XCStBHulhvi8PoHU8kryV08xkugLJLrU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=Eyfp9BRf; arc=none smtp.client-ip=209.85.214.181 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="Eyfp9BRf" Received: by mail-pl1-f181.google.com with SMTP id d9443c01a7336-20202df1c2fso10765285ad.1 for ; Thu, 29 Aug 2024 01:51:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921519; x=1725526319; darn=vger.kernel.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=+qPNG8Y3Tb15rLUaBWAZZ/ecrzt8HqGuiaoxCHg7qJs=; b=Eyfp9BRfbe6waEGhjePicwTbLKxm+gYGF8q2CfVwk6oEqWHB39rpuw9LKemfTsk041 iENmVbwkCNRLwl4eaZfgl4cVfGDg/EgfSKuitgZ0isIMN8fLd5sHK86VZsNEfRQ5LGPw 0ljKqBo8mCenzgBeK7VL05/qC+jrg5v/3kioE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921519; x=1725526319; 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=+qPNG8Y3Tb15rLUaBWAZZ/ecrzt8HqGuiaoxCHg7qJs=; b=JtKnLWAAh5playqZSC1e3kV/dbadYiEbH2+O5Rn31p/tKIdABrk1oRqwQlcq764dR2 au9vfvgLpc3ESRoYjroRzHiIeKwsn4fHTwjDPcYBznS7bfeepz3IdV2RacZ1oaXFH1zM ycSmlgbjmws+bSYjr5m7H5cmGF7cI4uLLL7cVc5vtfmNY+eG4m4Nfys9k2rIjsDJUbZL rIBt1q37o3fPbeJhZeMmGVVuxuzUFeZsMGMpI7eQtMFxsF7ldeAqY4N9dUNf4BBmoz1H scg3836Wq1rvYm805r4hes3PK6hxrR4okpiHwR6NUZf0gDoaqUb67XCu859PFx8W8NFh xFXg== X-Forwarded-Encrypted: i=1; AJvYcCX4OL4+I46YOtA0zufjvdBGIoNqK7gPQMuRzMjkvZ47rPlH2KAlx/yaoRYP7FrYy1nZGbaYaBCRvur8hl8=@vger.kernel.org X-Gm-Message-State: AOJu0YzD6NtNRXD1POTcKaVNXgR5R3iCqyXYxitaCxncPJL85bDXjIJ+ o4Yp9aFznP/LsCjxvkFYDblN4AaI/vjI8NjBaGdP2M8fslgeRJUD+8nklH/qvw== X-Google-Smtp-Source: AGHT+IHniIg70zN8Mcbn6SOTtRLOmATPMt3xZKk81frTkXYpYHX5zq7/IMrglokTZFmgklGCVG2ZMA== X-Received: by 2002:a17:902:c402:b0:1fd:6ca4:f987 with SMTP id d9443c01a7336-2051675f88amr16164665ad.15.1724921519210; Thu, 29 Aug 2024 01:51:59 -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.51.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:51:58 -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 05/10] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections Date: Thu, 29 Aug 2024 16:51:25 +0800 Message-ID: <20240829085131.1361701-6-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains about missing "Return" section for many documented functions in the regulator OF-specific code. These all have descriptions about the return values, just not in the format kernel-doc wants. Convert these to use the proper "Return:" section header. The existing descriptions have been reworded and moved around to fit the grammar and formatting. Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Capitalized first word of first sentence in "Return" section - Added articles ("the", "a") to the description based on surrounding and function implementation context - s/alloc/allocation/ - s/error code/error number/ --- drivers/regulator/of_regulator.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regula= tor.c index d557f7b1ec7c..dfa9f42d4629 100644 --- a/drivers/regulator/of_regulator.c +++ b/drivers/regulator/of_regulator.c @@ -338,8 +338,10 @@ static int of_get_regulation_constraints(struct device= *dev, * @desc: regulator description * * Populates regulator_init_data structure by extracting data from device - * tree node, returns a pointer to the populated structure or NULL if memo= ry - * alloc fails. + * tree node. + * + * Return: Pointer to a populated &struct regulator_init_data or NULL if + * memory allocation fails. */ struct regulator_init_data *of_get_regulator_init_data(struct device *dev, struct device_node *node, @@ -391,7 +393,7 @@ static void devm_of_regulator_put_matches(struct device= *dev, void *res) * in place and an additional of_node reference is taken for each matched * regulator. * - * Returns the number of matches found or a negative error code on failure. + * Return: The number of matches found or a negative error number on failu= re. */ int of_regulator_match(struct device *dev, struct device_node *node, struct of_regulator_match *matches, @@ -619,7 +621,7 @@ static bool of_coupling_find_node(struct device_node *s= rc, * - all coupled regulators have the same number of regulator_dev phandles * - all regulators are linked to each other * - * Returns true if all conditions are met. + * Return: True if all conditions are met; false otherwise. */ bool of_check_coupling_data(struct regulator_dev *rdev) { @@ -690,8 +692,8 @@ bool of_check_coupling_data(struct regulator_dev *rdev) * "regulator-coupled-with" property * @index: Index in phandles array * - * Returns the regulator_dev pointer parsed from DTS. If it has not been y= et - * registered, returns NULL + * Return: Pointer to the &struct regulator_dev parsed from DTS, or %NULL = if + * it has not yet been registered. */ struct regulator_dev *of_parse_coupled_regulator(struct regulator_dev *rde= v, int index) --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f177.google.com (mail-pl1-f177.google.com [209.85.214.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A270018DF61 for ; Thu, 29 Aug 2024 08:52:01 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.177 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921523; cv=none; b=rYELlCBRkGqXjW9aG5Dym47GsoWZb8AP628oSgR8EpVkw9TWtUch5WkXsndHhZpn+sbPwKZQI9cbQt18VfEIJHeUqdk/7u4SeLqcC33mC3dfA+FqAHi5OkqCjEfyzQmgOdFZLigUaWZhF0ptfAVOTtSk/Cw8aRJiywKgFfV2X4s= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921523; c=relaxed/simple; bh=Ys1aolYt/lRZW5Vi+ayqWyuwyr8HYv3CS6ogA9snSlE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=uOgo1GQgl461i7fDtoonvM7igE1qNIJA70qA2IHsMMPcaJ0MRHlqgD4hFPIThq1Uk0tQ6Xxpkae7aJLlefyrMcTquq7nkX8eM/bzhu2wRGcYEedsH/3VNWOdGYY9Ae8YFRzt7T4NDa6PC4nK1eF9cUHuVPoKdw/DAnwkqgxS3YU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=Bg8mwNou; arc=none smtp.client-ip=209.85.214.177 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="Bg8mwNou" Received: by mail-pl1-f177.google.com with SMTP id d9443c01a7336-202146e93f6so4030415ad.3 for ; Thu, 29 Aug 2024 01:52:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921521; x=1725526321; darn=vger.kernel.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=sgPHavE7K4ClGYJgJpC5pW6t6qCTjxay4H8VAVIO8qM=; b=Bg8mwNouhDF9cgTRMOhyAeugDG4VMvpQ/awtMEiHV1S6R8nUEiqxvwiuoSz4nw/6LP O28qK1t3cXnvSP4gDRDibJDkQqhArhVjH3cSh2cfRGiVqcoeeCgtSEfGDkIB1/30bq5a z+LOIrNL/GDc6GAoWfQolg8Ov0QxVm7O1iirA= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921521; x=1725526321; 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=sgPHavE7K4ClGYJgJpC5pW6t6qCTjxay4H8VAVIO8qM=; b=gpiqrlPlmlm35Jx7z7tD9hbA7YNXvE6DEnvKuasGJQIw8TIxYDkSI4ykGvu0IZqbfs 55X9VCnbNypX4/GB7ctS9mSX1n78iVv2BhcVU9a7FahOzOg+fPXhlhuWMmUscV/P7N9h egcC9ElE2VwgqpBwTDeRrjYTgDjViH+P1Mn5Q1ubCprxJRKY8xFUiDBS4KKZY8rQR1ly 1bb3kZcijrKSrP66DsvS12LmdacZkhBKC2IAmKQwtvfMJqj1TY3JAGsJ1faM4ywEs/US 8w7yPPqJAJiRLkdYTxeETCkDK+hX/bKjGAqd6fPPIlGMy3vpE4fv+Oi1khubkGz1zKgD 0/Sw== X-Forwarded-Encrypted: i=1; AJvYcCWVkdCksqYrpZ4hWDxd7sss70m1RWX+bL2m00wG0VtOXIesrf90WYh2foB5uWRk3xn8XrVq9ok+hKJjufs=@vger.kernel.org X-Gm-Message-State: AOJu0Yxp2+yUruOJfJk2NlCa0iG/vJgI27s0bA6v/BSHl3MIFN9UIkye /fSQUzcHImqSBvm5Py6Img6tY1Nnq4oxtJM7bSYbwHkRrAnudmNoiC4HweHMvA== X-Google-Smtp-Source: AGHT+IHNUXOidI2Jf1faocA3YuPGFcSZUSZSENW9FgWaOxjFlPiWIkyXqvj6UuCHYbxvh0ZYtCh0GA== X-Received: by 2002:a17:902:d4c2:b0:1fd:a0b9:2be7 with SMTP id d9443c01a7336-2050c33e3eamr25630315ad.13.1724921520981; Thu, 29 Aug 2024 01:52:00 -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.51.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:00 -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 06/10] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section Date: Thu, 29 Aug 2024 16:51:26 +0800 Message-ID: <20240829085131.1361701-7-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains about missing "Return" section for kerneldoc of of_get_fixed_voltage_config(). The kerneldoc has a description about the return values, just not in the format kernel-doc wants. Convert it to use the proper "Return:" section header. The existing description have been reworded and moved around to fit the grammar and formatting. Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Capitalized first word of first sentence in "Return" section - Added articles ("the", "a") to the description based on surrounding and function implementation context - s/alloc/allocation/ --- drivers/regulator/fixed.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/drivers/regulator/fixed.c b/drivers/regulator/fixed.c index cb93e5cdcfa9..c3de9c783d26 100644 --- a/drivers/regulator/fixed.c +++ b/drivers/regulator/fixed.c @@ -158,8 +158,10 @@ static int reg_fixed_get_irqs(struct device *dev, * @desc: regulator description * * Populates fixed_voltage_config structure by extracting data from device - * tree node, returns a pointer to the populated structure of NULL if memo= ry - * alloc fails. + * tree node. + * + * Return: Pointer to a populated &struct fixed_voltage_config or %NULL if + * memory allocation fails. */ static struct fixed_voltage_config * of_get_fixed_voltage_config(struct device *dev, --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f181.google.com (mail-pl1-f181.google.com [209.85.214.181]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 617CF18E025 for ; Thu, 29 Aug 2024 08:52:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.181 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921525; cv=none; b=ArsbWTvSAUkAi4LFzIxAcOL157UYNm6k+oAJKIBFls902ZMTvP25k6M4JG6zebdNYIRhSSjAUfDd5b6GjddZrAQQ/EHOBIQshY81tZdlbVw/Wqk51VKtMpFGC6tylRDPtnjGwECH3pVyiS7yyHZggWM/pQLyEyEvKIsR+HKembU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921525; c=relaxed/simple; bh=7hkrUe/KGPGY6RW/seN1kpeFhXk11ehgjMIbRWCvfcc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=tW+MPSNEWqz7k5Rqsg/WhTQRr6sSvZPNRjnO/jdjet/u6N8Uu1AKVP05T9mcvv9k0swAbyb16lOv/Vi8NtdwQECu3D/T0APRqpvK89YAeHcQMaOXbAL9VtwomjkkYqtBUj2sWBEyVMRbaupr2h4Xdmg7U6gA+kPOeWzWTb6zCBg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=A6lqAPiE; arc=none smtp.client-ip=209.85.214.181 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="A6lqAPiE" Received: by mail-pl1-f181.google.com with SMTP id d9443c01a7336-202508cb8ebso2627145ad.3 for ; Thu, 29 Aug 2024 01:52:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921523; x=1725526323; darn=vger.kernel.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=SH5i9APy7hcIZsD71Cy0fPlXqstfyKV2jYdTC5JW2L8=; b=A6lqAPiEBu1qpqVZXXAZeVByAOfXopD900Y3ccQJZqdVcZfG1HMUDFKD5AZsurJMkC pKzvSVhwzxeLMPHuWbQGy/G7HZ4UAZciS+nJR98Y8MxnWUp0fchKsJOm+hqJALDi+eoD IwMcnbUQo54xIgXt69YUTNNi+X7JncLBcQjQg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921523; x=1725526323; 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=SH5i9APy7hcIZsD71Cy0fPlXqstfyKV2jYdTC5JW2L8=; b=jjsC1MbLcl3K6dzIg2RQhQSQUNgReSUK+Xqg2q7BEBOnBQHdBdsB4X6+z+FhV5eJQ/ HCM64SfgTy+5idkI1BnT5TpOZIsj5G+N3iTKW29UEp2cSe3VgMH0I03prS17gw2/qblK LGFDyAkLWBI7E0g9XBUNRt3O9C7LH/5JzCvf0XNq3eVRKihymneNU9GP4prEfI+Ynpkc GATOOGgmIQ8TpqQSR382ZImWhtTLTkNdojKnnLbY25zXBzxYEy98/pI9H06fDfBnlJX0 it2Qy2pn0zOVLy3jdZh8UfRrRny9PZ+jWYetplchouXdYWqaY3A4ynLt1K5ADNudxVh4 GO7A== X-Forwarded-Encrypted: i=1; AJvYcCWOpHVusVwv1LT2+/+zJF7XvHYSvX/b44jb0l9vcA87S4JTp9m4RvMYrkx7z7RD1cKXm1NUmDDYlAp5+bw=@vger.kernel.org X-Gm-Message-State: AOJu0YxVm66HLrUWYiTIixDLcpTU23VR3gCOFvsP+KBdFyVBzZM3yY1p uuGaaunYr8i9iI7MzDQMolCTL6STi6T/Nw7jnulOjzTt+95vMJGjm2Oqrnuy8Q== X-Google-Smtp-Source: AGHT+IGvMUAJLJKTXy1U/I9Oz2SRJocUKAPqs8ZLqPE3NaF6A1+zA4ieje9ST+i37tUB7r8buTiUFA== X-Received: by 2002:a17:902:f648:b0:1fb:4f8f:f212 with SMTP id d9443c01a7336-2050c4e89a1mr24399925ad.60.1724921523557; Thu, 29 Aug 2024 01:52:03 -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.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:03 -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 07/10] regulator: fixed-helper: Add missing "Return" kerneldoc section Date: Thu, 29 Aug 2024 16:51:27 +0800 Message-ID: <20240829085131.1361701-8-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains about missing "Return" section for the function regulator_register_always_on(). Add a "Return" section for it based on its behavior. Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Capitalized first word of first sentence in "Return" section - Added articles ("the", "a") to the description based on surrounding and function implementation context - s/alloc/allocation/ --- drivers/regulator/fixed-helper.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/drivers/regulator/fixed-helper.c b/drivers/regulator/fixed-hel= per.c index 2d5a42b2b3d8..b6cb0aaac3b1 100644 --- a/drivers/regulator/fixed-helper.c +++ b/drivers/regulator/fixed-helper.c @@ -26,6 +26,8 @@ static void regulator_fixed_release(struct device *dev) * @supplies: consumers for this regulator * @num_supplies: number of consumers * @uv: voltage in microvolts + * + * Return: Pointer to registered platform device, or %NULL if memory alloc= ation fails. */ struct platform_device *regulator_register_always_on(int id, const char *n= ame, struct regulator_consumer_supply *supplies, int num_supplies, int uv) --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f181.google.com (mail-pl1-f181.google.com [209.85.214.181]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DCB4C18E054 for ; Thu, 29 Aug 2024 08:52:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.181 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921528; cv=none; b=O0jXYlGB/h2ehTXwETDHHFa3FkqSXFJMJARUcB+AD8ebltE/cl7ArCz+ySQiGGaYwGigb0d2aAKz47v8Hse6tEI9Qodj95Yfioih+79qm4PbY63xghb5D/pYduFJsuD41DT5QYtOla5y0Z0PEhFr/UN7Vzw3RBUVRKNsZrbM/0U= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921528; c=relaxed/simple; bh=sBM9ARh7eDRymdf4FtcaEhoRTmZZ184Uz1y3Zn5KRB4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=C4zJHSCk1uPxMl+okh6f5sryMke7xZ8v2nadzye4XJ43d3ML2Zm+ckM9/OUULikQoqCtFEGTgfzuNheAUNkjoozKJBprN09YLmJKdc4p0w94ir7buV5aniZCQrxVF0a65dAQil0IWkA+v+ImlHzRVh5i7TbMik1vyX7KX3zzIX4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=TkEUns7r; arc=none smtp.client-ip=209.85.214.181 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="TkEUns7r" Received: by mail-pl1-f181.google.com with SMTP id d9443c01a7336-201d5af11a4so3456745ad.3 for ; Thu, 29 Aug 2024 01:52:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921526; x=1725526326; darn=vger.kernel.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=7f9k7PpUQjpljatpt98ZEbTrZ2XDZjx22JMjFJskajY=; b=TkEUns7rsPTsVlSqcBill7lJpxxSZTMFdklj7k34wLoix/sQdgeMOhroCYxhEXrLnZ IHo72IHDGdRiF9jsa+s/8N1lQiV3ohSjIwdKFnc5NwRmyF1WcR0X7fSWguElove6wOQl +q450CFXmqXzjcouQZsM3AlJMmCJKbcdO7Jeg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921526; x=1725526326; 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=7f9k7PpUQjpljatpt98ZEbTrZ2XDZjx22JMjFJskajY=; b=nL9F9We4f/YvbukcGyk3p6wQjEaKpSJxFD0zEMkbPLynFpBlV9eNwfCrmRcpENUc0K IqT9GoJSZerRiai41G12j96OiOCsEbPoL+YC/JMz+K+fXAH4ojDLpmRVB3ElGG8FNR1A D94PdYCmwHfBcw3yZ5YBHJy9s2k+Woiryz+1MfI1Vg8udAOMWq/sYCR0uI3+sBSzbl1p xBD3KpjQ0kzFkhPkERQPkk4g95OCYMq+fI4Z6Dm9vHToElowiTqbc6J6IZ3bZypNjtDy GI3iXLlXmu3U+idyAAjdJ7GOpOa1tZTcNt1zfty+V7Gu2izkf7l4OdRQYhvoxjTPpKUr BLYw== X-Forwarded-Encrypted: i=1; AJvYcCXpjqJCzK6cTRNBWfwsZqoKp3zNgL0r1IBh2FMDQ8sAxH1ee1hHmzmsmD4Rh9Md3irCRjLhm5j8wKXPLqk=@vger.kernel.org X-Gm-Message-State: AOJu0YxveMzLQhvYwBKuM1V8aRUUmjpUye/i6j7YJMlJ3VMdhOtCH/1v xUzFmLTwgiGr4g9ku3ll5aKlwoB62XsQQpnLgx2rYi2JecfrB91T/tBq0Snt/A== X-Google-Smtp-Source: AGHT+IGhKkcGNXI0K2CzplNu1hl3pLJjO1nnoCWwWYcUIQxyGIW+1Pl1x1rPn6MjaWMLeftQHomqJg== X-Received: by 2002:a17:902:ec84:b0:203:a0c7:3156 with SMTP id d9443c01a7336-2050c23699amr22267205ad.5.1724921526443; Thu, 29 Aug 2024 01:52:06 -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.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:05 -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 , Matti Vaittinen Subject: [PATCH v2 08/10] regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc Date: Thu, 29 Aug 2024 16:51:28 +0800 Message-ID: <20240829085131.1361701-9-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" kernel-doc complains about missing "Return" section for the function regulator_irq_map_event_simple(). Add a "Return" section for it based on its behavior. The function actually always returns 0, but fills in fields in its @rid parameter as needed. Expand the description of the parameter to cover this. While at it fix a typo found in the description of the same function. Reported-by: Matti Vaittinen Closes: https://lore.kernel.org/all/e341240e-1c1f-49a2-91cd-440888fdbda0@gm= ail.com/ Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - Update commit subject to reflect changes - Was 'regulator: irq_helpers: Add missing "Return" kerneldoc section' - Add period ('.') to the end of the "Return" section sentence - Fix typo in function description spotted by Marti - Describe output fields in @rid clearly --- drivers/regulator/irq_helpers.c | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helper= s.c index 5ab1a0befe12..2de7b907c81d 100644 --- a/drivers/regulator/irq_helpers.c +++ b/drivers/regulator/irq_helpers.c @@ -404,16 +404,21 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel); /** * regulator_irq_map_event_simple - regulator IRQ notification for trivial= IRQs * - * @irq: Number of IRQ that occurred - * @rid: Information about the event IRQ indicates - * @dev_mask: mask indicating the regulator originating the IRQ + * @irq: Number of IRQ that occurred. + * @rid: Information about the event IRQ indicates. + * The function fills in the ®ulator_err_state->notifs + * and ®ulator_err_state->errors fields of + * ®ulator_irq_data->states as output. + * @dev_mask: mask indicating the regulator originating the IRQ. * * Regulators whose IRQ has single, well defined purpose (always indicate * exactly one event, and are relevant to exactly one regulator device) can - * use this function as their map_event callbac for their regulator IRQ - * notification helperk. Exactly one rdev and exactly one error (in + * use this function as their map_event callback for their regulator IRQ + * notification helper. Exactly one rdev and exactly one error (in * "common_errs"-field) can be given at IRQ helper registration for * regulator_irq_map_event_simple() to be viable. + * + * Return: 0. */ int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid, unsigned long *dev_mask) --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f171.google.com (mail-pl1-f171.google.com [209.85.214.171]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E123518E355 for ; Thu, 29 Aug 2024 08:52:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921530; cv=none; b=RUQT7ZtlsPNyxlhOWV9ri4goNOd7B0HBbQ4H2P9rQcMPbJxxuF0nbVSl1KSmR6dx59rwqSU+Dq1PVGZRZ3soxLAK+AFy9uspoU9sb69PmnPKXR8S8flOSM3ED9n/IPQn0e3OlmCl3ugfTVU3043BCwR7U52igRGNfAZ6hjJClCw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921530; c=relaxed/simple; bh=U8Wxx2A86/hM9uHvSu4wzKX5x6eclhbGxoahVqz/w7U=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=TnH2aM7TZ6/lVgBheH1wX6Se1OtGCPPEMU94eVJUoPnfeDIv6z1X/UhbydQnMDAZu72q2VbIxNCaU0YoIFn0RB+8JIoxzUNInJAr5Ip7HOXTeRldeW9klc6L1qF9PZEsrERsMIcE+NNI2GpgESfvjE/746tt1Do1ZfEu8j3lOpU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=D16GhPuY; arc=none smtp.client-ip=209.85.214.171 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="D16GhPuY" Received: by mail-pl1-f171.google.com with SMTP id d9443c01a7336-2020e83eca1so4476875ad.2 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=vger.kernel.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=D16GhPuYRgvW+Vzl0urbWS8vwB7j8yCcyf+lSv7A582XzMd93A5JyoBppYO/QDrbEX zMlWh35PaCjyLuZNj7dtv218r103yVRjSK2RetRg5Wdy/1HiFgqHpKSXVHohL1FM1UKq NieD4GBiy/C+DQqKOo/s564PCSzUBTzVctCvw= 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=YZnlXsc+r6gHZ32Ityn4Jh3lhUEG6+MwmzEqPf9W2KzLD2c2GG4M101bOwAP/DYlJw ER0y/fFHQUbqZ3/11RidAFCWoF2tI9dE5hGFdLBHyb8BsT/fsTuBC5Lmvn5ESHt3CAZY upoIUFjIfGEk3h3ZsOfO+cP0greTDHHF2/CNVJGVC5uvLW9TSDa3A/EGHMoCJR2htsSu 3jDwdiZn/WBq8XlWh7mFk9suLn1UtzjMyJ4IVVRPFlTJqo5ER7dGt10TF8zweoYmxbAs OAETVcb+aZK7woK5680t5QeKKYmxTpp3ywiio3ZSAc3l5J3xwLLuHg2atkJC5TgX1Mg6 trbg== X-Forwarded-Encrypted: i=1; AJvYcCUNmJQrUSA3UGtjkDWtDaSlHBVfcN9dIwCdHVtpB5cOlklzkdzYYBbNAqMfw/lBinIEuXN2D7NdsCsPTaY=@vger.kernel.org X-Gm-Message-State: AOJu0Yzp26BRzPJ+YSfIj+SHdMEzi6h6oUUjjDl764yyf1AIdeFdmU2h x+Nr1vZ2UolibvoNvgnkFjsTDeBBTF3ov6stDhfszbWcoCixX53+dUXe/eTSzg== 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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- 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_regula= tor.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; } =20 -/* +/** * 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) --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Thu Dec 18 23:37:35 2025 Received: from mail-pl1-f171.google.com (mail-pl1-f171.google.com [209.85.214.171]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E481218E364 for ; Thu, 29 Aug 2024 08:52:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921532; cv=none; b=J26qQnJ+9yvVtcLlkuGxeOULEqz2LG+2vijy66I5LGKYnLWHNwYVlE8a3zWU1YPLRvXQiDBCeYn/kFHFPFf9pV5WSgff2zuPEQIxfrI4w7nXK1GPmQb9dDkH0jNMRFxguq8JZ7H1fEgDRkMVLOiZKTvhUiklsIJ68bClL2sO3rg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724921532; c=relaxed/simple; bh=kNIE9BNf8Zv75I/FZ7NOqQGoA6g4YLu7tMFeythIcfc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kBNHPT97MfSYD3xZB/bOrYZpvhL8Htu7sYnfG43Y7EreyF+ZsFLHRfgLDnEEb5nDqBzxo7GvyiD6IcSdSs16VVJttN+zRABq6dIQu9XBFzee2p9jleQRbFbB8gBw1E4ERNszu/6gpzfUFMI4EgeEONvQr9CLJXeZPVgBbFiAQ90= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=HNLduTVS; arc=none smtp.client-ip=209.85.214.171 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="HNLduTVS" Received: by mail-pl1-f171.google.com with SMTP id d9443c01a7336-2021c03c13aso3323085ad.1 for ; Thu, 29 Aug 2024 01:52:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921530; x=1725526330; darn=vger.kernel.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=iWRchbsiI/jit0CfCKj74uSu6ttu4ROq7KriKtjM8cE=; b=HNLduTVS+NiusJfaTa1ZilLuHUGB4fa5G+TghDaL+Dnlt4i3FdhmkFdf4znX7IFH3B u0tTxjWHtsCJCN1mRz08Ki4BDgTH8IGpHWBj7FgFoE1wsvMFuKqb3244VirxtU0hZfnN rZxk5acMvM1kbklMARJLDoEa2959nUsuPP8S0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921530; x=1725526330; 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=iWRchbsiI/jit0CfCKj74uSu6ttu4ROq7KriKtjM8cE=; b=RGyrarZmrWDIdPACT089kBSJnnqoQcGVq+iFpoHWTah6rB8zjz1wiX+Prvdr42L3bi Z8G0N+kRFzKtyaZxfJsrq+Fgx625uIfJ6RmdQBPe+1Z8E/EYFUZob47s6RZEK6JijnhS 4u4g//ZhacSfgMlb139gA0SavIEOKDeLgMcKg9u0dD1436IzScUPP6Xb55ZHXe+YqLrs MHjV9bgoJRw0jsQDnPnFHBocmC/na9JtDfOTWfsOsA1As7zpIMAkSKPypM4CD74P2oJd x4Wdf3fffnjSZ7t8IPnfRAUL4L6JhyE2DkYsuO3orVr0umixV+LVxdyKZbEJAEbBtX1O Uq3Q== X-Forwarded-Encrypted: i=1; AJvYcCX50qE1OvPaIcd2rpLhr0OTE20PTK7dmvR/scuz23SiU67kQtMwNET8QYtlB8Bfk77s9+L/y6kosheQwIE=@vger.kernel.org X-Gm-Message-State: AOJu0Yzw85vf9Lpva83RbuMwXSMxzhQafnqcGK5Od6Qs24G+4A3gvZ3x 1ok/0llYVOyDlrRuRwF02LtKm2B4kNX0dWyfc9tElIGR5c2akIjyDYE4sP10jw== X-Google-Smtp-Source: AGHT+IGOtUweXCQpV0LrosRSEGtTwTNe13Qf96/F2cMlyFpBImeyvt9uH0ZmoT0phJz7470I5C5maQ== X-Received: by 2002:a17:902:da84:b0:202:60e:76f6 with SMTP id d9443c01a7336-2050ea4ce5emr31435735ad.29.1724921529985; Thu, 29 Aug 2024 01:52:09 -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.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:09 -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 10/10] regulator: Unify "negative error number" terminology in comments Date: Thu, 29 Aug 2024 16:51:30 +0800 Message-ID: <20240829085131.1361701-11-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> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Previous commits cleaning up kerneldoc used the term "negative error number" to refer to error condition return values. Update remaining instances of other terminology such as "error code" or "errno" as well so the whole regulator subsystem is unified. Signed-off-by: Chen-Yu Tsai Reported-by: Andy Shevchenko Reviewed-by: Andy Shevchenko --- Changes since v1: - New patch --- drivers/regulator/core.c | 2 +- drivers/regulator/devres.c | 18 +++++++++--------- drivers/regulator/fixed.c | 2 +- drivers/regulator/irq_helpers.c | 2 +- drivers/regulator/max77802-regulator.c | 4 ++-- drivers/regulator/qcom-rpmh-regulator.c | 6 +++--- drivers/regulator/qcom_smd-regulator.c | 2 +- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 0b929ab71188..c1d11924d892 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c @@ -3388,7 +3388,7 @@ EXPORT_SYMBOL_GPL(regulator_get_regmap); * voltage selectors. * * On success, the output parameters @vsel_reg and @vsel_mask are filled in - * and 0 is returned, otherwise a negative errno is returned. + * and 0 is returned, otherwise a negative error number is returned. */ int regulator_get_hardware_vsel_register(struct regulator *regulator, unsigned *vsel_reg, diff --git a/drivers/regulator/devres.c b/drivers/regulator/devres.c index 7111c46e9de1..1b893cdd1aad 100644 --- a/drivers/regulator/devres.c +++ b/drivers/regulator/devres.c @@ -163,7 +163,7 @@ EXPORT_SYMBOL_GPL(devm_regulator_get_optional); * In cases where the supply is not strictly required, callers can check f= or * -ENODEV error and handle it accordingly. * - * Returns: voltage in microvolts on success, or an error code on failure. + * Returns: voltage in microvolts on success, or an negative error number = on failure. */ int devm_regulator_get_enable_read_voltage(struct device *dev, const char = *id) { @@ -174,8 +174,8 @@ int devm_regulator_get_enable_read_voltage(struct devic= e *dev, const char *id) * Since we need a real voltage, we use devm_regulator_get_optional() * rather than getting a dummy regulator with devm_regulator_get() and * then letting regulator_get_voltage() fail with -EINVAL. This way, the - * caller can handle the -ENODEV error code if needed instead of the - * ambiguous -EINVAL. + * caller can handle the -ENODEV negative error number if needed instead + * of the ambiguous -EINVAL. */ r =3D devm_regulator_get_optional(dev, id); if (IS_ERR(r)) @@ -276,7 +276,7 @@ static int _devm_regulator_bulk_get(struct device *dev,= int num_consumers, * @num_consumers: number of consumers to register * @consumers: configuration of consumers; clients are stored here. * - * @return 0 on success, an errno on failure. + * @return 0 on success, a negative error number on failure. * * This helper function allows drivers to get several regulator * consumers in one operation with management, the regulators will @@ -299,7 +299,7 @@ EXPORT_SYMBOL_GPL(devm_regulator_bulk_get); * @num_consumers: number of consumers to register * @consumers: configuration of consumers; clients are stored here. * - * @return 0 on success, an errno on failure. + * @return 0 on success, a negative error number on failure. * * This helper function allows drivers to exclusively get several * regulator consumers in one operation with management, the regulators @@ -326,7 +326,7 @@ EXPORT_SYMBOL_GPL(devm_regulator_bulk_get_exclusive); * This is a convenience function to allow bulk regulator configuration * to be stored "static const" in files. * - * Return: 0 on success, an errno on failure. + * Return: 0 on success, a negative error number on failure. */ int devm_regulator_bulk_get_const(struct device *dev, int num_consumers, const struct regulator_bulk_data *in_consumers, @@ -393,7 +393,7 @@ static void devm_regulator_bulk_disable(void *res) * @num_consumers: number of consumers to register * @id: list of supply names or regulator IDs * - * @return 0 on success, an errno on failure. + * @return 0 on success, a negative error number on failure. * * This helper function allows drivers to get several regulator * consumers in one operation with management, the regulators will @@ -574,7 +574,7 @@ static void devm_regulator_unregister_supply_alias(stru= ct device *dev, * lookup the supply * @num_id: number of aliases to register * - * @return 0 on success, an errno on failure. + * @return 0 on success, a negative error number on failure. * * This helper function allows drivers to register several supply * aliases in one operation, the aliases will be automatically @@ -726,7 +726,7 @@ static void regulator_irq_helper_drop(void *res) * IRQ. * @rdev_amount: Amount of regulators associated with this IRQ. * - * Return: handle to irq_helper or an ERR_PTR() encoded error code. + * Return: handle to irq_helper or an ERR_PTR() encoded negative error num= ber. */ void *devm_regulator_irq_helper(struct device *dev, const struct regulator_irq_desc *d, int irq, diff --git a/drivers/regulator/fixed.c b/drivers/regulator/fixed.c index c3de9c783d26..1cb647ed70c6 100644 --- a/drivers/regulator/fixed.c +++ b/drivers/regulator/fixed.c @@ -129,7 +129,7 @@ static irqreturn_t reg_fixed_under_voltage_irq_handler(= int irq, void *data) * If it's an optional IRQ and not found, it returns 0. * Otherwise, it attempts to request the threaded IRQ. * - * Return: 0 on success, or error code on failure. + * Return: 0 on success, or a negative error number on failure. */ static int reg_fixed_get_irqs(struct device *dev, struct fixed_voltage_data *priv) diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helper= s.c index 2de7b907c81d..0aa188b2bbb2 100644 --- a/drivers/regulator/irq_helpers.c +++ b/drivers/regulator/irq_helpers.c @@ -333,7 +333,7 @@ static void init_rdev_errors(struct regulator_irq *h) * IRQ. * @rdev_amount: Amount of regulators associated with this IRQ. * - * Return: handle to irq_helper or an ERR_PTR() encoded error code. + * Return: handle to irq_helper or an ERR_PTR() encoded negative error num= ber. */ void *regulator_irq_helper(struct device *dev, const struct regulator_irq_desc *d, int irq, diff --git a/drivers/regulator/max77802-regulator.c b/drivers/regulator/max= 77802-regulator.c index 69eb6abd2551..b2e87642bec4 100644 --- a/drivers/regulator/max77802-regulator.c +++ b/drivers/regulator/max77802-regulator.c @@ -160,8 +160,8 @@ static unsigned max77802_get_mode(struct regulator_dev = *rdev) * Enable Control Logic3 by PWRREQ (LDO 3) * * If setting the regulator mode fails, the function only warns but does - * not return an error code to avoid the regulator core to stop setting - * the operating mode for the remaining regulators. + * not return a negative error number to avoid the regulator core to stop + * setting the operating mode for the remaining regulators. */ static int max77802_set_suspend_mode(struct regulator_dev *rdev, unsigned int mode) diff --git a/drivers/regulator/qcom-rpmh-regulator.c b/drivers/regulator/qc= om-rpmh-regulator.c index 6b4cb7ba49c7..6c343b4b9d15 100644 --- a/drivers/regulator/qcom-rpmh-regulator.c +++ b/drivers/regulator/qcom-rpmh-regulator.c @@ -158,7 +158,7 @@ struct rpmh_vreg_init_data { * @wait_for_ack: Boolean indicating if execution must wait until the * request has been acknowledged as complete * - * Return: 0 on success, errno on failure + * Return: 0 on success, or a negative error number on failure */ static int rpmh_regulator_send_request(struct rpmh_vreg *vreg, struct tcs_cmd *cmd, bool wait_for_ack) @@ -317,7 +317,7 @@ static unsigned int rpmh_regulator_vrm_get_mode(struct = regulator_dev *rdev) * This function is used in the regulator_ops for VRM type RPMh regulator * devices. * - * Return: 0 on success, errno on failure + * Return: 0 on success, or a negative error number on failure */ static unsigned int rpmh_regulator_vrm_get_optimum_mode( struct regulator_dev *rdev, int input_uV, int output_uV, int load_uA) @@ -409,7 +409,7 @@ static const struct regulator_ops rpmh_regulator_xob_op= s =3D { * @pmic_rpmh_data: Pointer to a null-terminated array of rpmh-regulator * resources defined for the top level PMIC device * - * Return: 0 on success, errno on failure + * Return: 0 on success, or a negative error number on failure */ static int rpmh_regulator_init_vreg(struct rpmh_vreg *vreg, struct device = *dev, struct device_node *node, const char *pmic_id, diff --git a/drivers/regulator/qcom_smd-regulator.c b/drivers/regulator/qco= m_smd-regulator.c index 6761ada0cf7d..28e7ce60cb61 100644 --- a/drivers/regulator/qcom_smd-regulator.c +++ b/drivers/regulator/qcom_smd-regulator.c @@ -1386,7 +1386,7 @@ MODULE_DEVICE_TABLE(of, rpm_of_match); * @pmic_rpm_data: Pointer to a null-terminated array of qcom_smd-regulator * resources defined for the top level PMIC device * - * Return: 0 on success, errno on failure + * Return: 0 on success, or a negative error number on failure */ static int rpm_regulator_init_vreg(struct qcom_rpm_reg *vreg, struct devic= e *dev, struct device_node *node, --=20 2.46.0.295.g3b9ea8a38a-goog