From nobody Fri Dec 19 12:01:43 2025 Received: from mail-pl1-f175.google.com (mail-pl1-f175.google.com [209.85.214.175]) (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 89D2419D067 for ; Tue, 27 Aug 2024 09:56:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752562; cv=none; b=pQTYebv2CM3mMJWuWx1zA54ynMHboCMUcMs/upiQ1CBUKtAbZDe9vTyPDkUgbH1oKP2jNvkpt5LN29dbTpB+3qe/RQzAA/merK43D6g2dORTf9PgIhYYTDHVKR+njZJWf8hoojDsq+uKyucsPkgbw+JhfwCAfKWp50KauJY2VHE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752562; c=relaxed/simple; bh=CaKmYffiLj5wjYYPSwbMvdyiljpXahIOuxC/bopPWgU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Ohj94mW+ntN4/9tjsKndD4m+3iLgNUPvan9a4LvGCriQk2TLqnBE3eLrMVLm7Xds7xLidwnkPD3DkIEQm8PEthenXvNzz/VL/0MytpuWKHoxv0Mm4oDrkqVE+zctT1fStc6NuvXIheNR6VBrdPDC2GJY+QM+MD3t6H1pqVd3B2M= 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=gsPIRQpT; arc=none smtp.client-ip=209.85.214.175 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="gsPIRQpT" Received: by mail-pl1-f175.google.com with SMTP id d9443c01a7336-201e64607a5so37481945ad.2 for ; Tue, 27 Aug 2024 02:56:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752560; x=1725357360; 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=ulSL1wDh1UXX6pfgOa+SdSJMLV52Cd+y6JQhndrl4/Y=; b=gsPIRQpTDUKLCuLP9FlANzcTzarF6Y2q7h4hgtiRECZC3IEllhG3/e33ikPJ3XpEfk 1VzUMJBbZfPfMzOhPN4XaOm1igAIjsdmwQCrNZkW9IXORE2ONtXfia30FBcx3RdcJA0x RuNaaAxNU/buQaIRcTLtPyBzJwoK0ob+CFtts= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752560; x=1725357360; 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=ulSL1wDh1UXX6pfgOa+SdSJMLV52Cd+y6JQhndrl4/Y=; b=uK4GiT6E4Dbm5lLyySamSwyyxK2/vh/LI0AGMMuGYFMTEb1xM1xn//aHxE1+ZOuOjr rhcBG2G7BxzFm00kznWNVeA0jRF6KV41333Cpiyx9n/3deZaw3yHydic9H286jQ9q7Vn lZtcPWbIrTkqj7WNDbfrK/AfBHhsIV5Drbp3QS/j3UCGBHuyjWcTvj3H0JhfFmi3weWj 1jVjB8NL3LX41kaqFpTQRnRPLQI5tOVr1yKbp5/fQnM5MpdI09Cx6XspkaHC4+BQKg1x 6mJ0JIrRb5FDWng73EQRFkFYWlQTEuLF/K74SiWxNEhu5gEN27lne3OpfIOUB8auPWg5 hzog== X-Forwarded-Encrypted: i=1; AJvYcCUJBfEOHqfhBf/TtORn7A7MsZWT1EGvPmnvUdjILG/EOCec3iHRGbPx6pJH09ankxnb+WYpaGCnaDk+CfA=@vger.kernel.org X-Gm-Message-State: AOJu0YwS/V9P03D5YuJShms6zJuL3juZlcghyVI+TWeIrpXrEWWZW14w uVeVoAoAhMJqf3wXsixHJjjMSaczN4/6rILeYOjyCxVax9aAx4PP4FC8X1izvg== X-Google-Smtp-Source: AGHT+IHG3kC3TvoiL564c2nCrzUqffudLVZMezuiycIsHxkJQk5Y8znjAyFMUcZ+3HMMg+b6baVggA== X-Received: by 2002:a17:903:41d1:b0:202:54a5:deaf with SMTP id d9443c01a7336-2039e4fbd80mr184597195ad.57.1724752559745; Tue, 27 Aug 2024 02:55:59 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.55.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:55:59 -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 1/8] regulator: core: Fix short description for _regulator_check_status_enabled() Date: Tue, 27 Aug 2024 17:55:41 +0800 Message-ID: <20240827095550.675018-2-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 --- 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 Fri Dec 19 12:01:43 2025 Received: from mail-pl1-f179.google.com (mail-pl1-f179.google.com [209.85.214.179]) (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 1E2D519DF65 for ; Tue, 27 Aug 2024 09:56:01 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752564; cv=none; b=lvFZd6WHCg8LFd7pIKgi9Q0mR8oGBifPioDXzKXyhHNLwLrAv1fDUVwnGQHKrYhXiaxTS4Trtto/2E/CY4EXwlAW3Mf8CqeXqgQSc432jSZ4ao8y84yKV3R4d2XS3C13M/gzLncMXwHppIw9u+AdCGu852UxwepbYNjRzlRC7pw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752564; c=relaxed/simple; bh=9eletfkZoOidjC/xY6StFxKzNyYPlUK7lRHiXuisd4A=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=QDYZ6xNvADJNC4ORvV43pW+/EbuJC5fWbmMOVx6CrVs4heITUSfd37VuNJZYPA4Mr1QESL1FeTvMY3nleyFKKDjxRySpJQ4dY9oeiMmPZw+aJTFPQW0xvAWAT/Rxz0oKnAbLzDZBkTnPQjB2tYUevMicnkCBBjAR2E+eSh9bOHM= 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=Dl01uO9G; arc=none smtp.client-ip=209.85.214.179 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="Dl01uO9G" Received: by mail-pl1-f179.google.com with SMTP id d9443c01a7336-201f2b7fe0dso45377765ad.1 for ; Tue, 27 Aug 2024 02:56:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752561; x=1725357361; 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=d5dITA99bOKmhMprOxuF3vZ8vny2EwMiPeFLCOo3XcY=; b=Dl01uO9GOkqchIB53dVKdofarXuUgTrXAk7cDyuODXV9EkZ0PfGsb8yEM0NfcrbX8J tRhMqU/viM6zC7EeVn47HnGCB6/g9sftCD87g5q12O//48KLKZsisDIL/g6MzQNAC4js zic9RoLMGZ/GRNE/vutRgj0HJ04AVIdmlDGf8= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752561; x=1725357361; 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=d5dITA99bOKmhMprOxuF3vZ8vny2EwMiPeFLCOo3XcY=; b=tKV2f/cfmaJzBMLevdzQRyh9/bPNMrh8nx/ucWkZ2uWyfcFw2ai97O1xDOUi7VaX+y a+O54itJjKvEd7ANiaPlX4XzQ2aeNP6YbZKmTx5ALHs4TPES7ut3sqMnKAOpcCpCnHRx bP4UHSrWS/+AS4I/BpDyv9s+str5CIspkY6cOsc72Ve7Q11/H5AjCuayQQLFb916Q7nD uljgdPP8VvJCQImU7LkL8WOlqN8ozOjxGyIVlzOrS+2O2GxcjbEbaMNWP0PimTrYQAMP jRbbzqfszbHutD7FcaF5qlJgXMVkKzgS3oqReDcG0Vv2ydtixl6Xb0dIluOmT79zfWRw Xt7w== X-Forwarded-Encrypted: i=1; AJvYcCWYAeWJVEmbrfl66ZT15PecRWWC76KskM4jMgReipvAeVvegCwHgatF774E7zHkkWi7vIz9D/tteG4zB70=@vger.kernel.org X-Gm-Message-State: AOJu0Yx8ZSm7DbRnOfkw+EFPVIe9H+M/FNmNmtCcqavKBj6KlmwiSQva corO9Fn5NUAQ0yFLoKc2o9ZHAEHApDUaBL6dUimDPeDOPv9iagWF5ZD8bc5dTw== X-Google-Smtp-Source: AGHT+IFxyh4Dh7I2pxOeTqe3BqQCexIZIRHzvyu5zz5qW6LwCSFvv6FVccQkTwPQyRBDrynayef2Cw== X-Received: by 2002:a17:902:e842:b0:1fb:90e1:c8c5 with SMTP id d9443c01a7336-2039e4b5193mr94212775ad.33.1724752561488; Tue, 27 Aug 2024 02:56:01 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:01 -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 2/8] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value Date: Tue, 27 Aug 2024 17:55:42 +0800 Message-ID: <20240827095550.675018-3-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 true, false 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 --- drivers/regulator/core.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 763048d6f1ed..3a1b6fd9780d 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c @@ -3456,7 +3456,8 @@ 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 voltage range is support, 0 if not, or error number if + * 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 Fri Dec 19 12:01:43 2025 Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com [209.85.214.174]) (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 253F919DF74 for ; Tue, 27 Aug 2024 09:56:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752566; cv=none; b=HOiFHgdvpJUSmJNXm3RstzEAAKjGf4vwHxPxIs82hEWFGcof9pXFjyWDUXOk8nsSxQtcLjBAUT6oH9SKNO8wcOmehzypve3BRYq3DVJ6eaf2bpxubyZD9WS8QKrBx0oCWmPbTMbPyA9wpbCDGCku8WLh7wloQU80JIZlQNuYgt8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752566; c=relaxed/simple; bh=hWiPvOMyFndhmj2nO6WnPJBI755Oilx522etrqUOGrA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=k7xmQviLzNntbkF5vJuFHdPTPFPlzs7cxp22ZYeM1Bm/8onDXJxOl4Icls6zPGXT+k8JNZT71FX31uaBTi2pcrkXUUiPPTUOVzhI85TkBdb+wv3ixHVzS53e6nuoqhPVoSbLMRUpvoMmfUm6vYKIsoCrKkwcMZ34C2+zJXH+Goo= 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=Ppqaf3kA; arc=none smtp.client-ip=209.85.214.174 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="Ppqaf3kA" Received: by mail-pl1-f174.google.com with SMTP id d9443c01a7336-20223b5c1c0so47220105ad.2 for ; Tue, 27 Aug 2024 02:56:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752563; x=1725357363; 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=7LLSsNj3le8TWETIDzCV0x45IW45F1GT/zaPgv3xeew=; b=Ppqaf3kAV5bvC8SwLovbZrg5Klq8wMQ91dmB5zjdYE3jp/HLFVkMwCJ+3+EaZz5eqa 2WaIEJiuZQlDfIo/oERZFKUgdiCeuz3xPHfn7U9UUcq4lIWwyhazHP+mRGLAAZ7bon2O 0YxdHCEweTNJz/7cWWa2k9QkYucSUZ/YczA9w= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752563; x=1725357363; 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=7LLSsNj3le8TWETIDzCV0x45IW45F1GT/zaPgv3xeew=; b=gJDQ6XPtAixYSQJkvtcz26lXr1AF+a2BJ/6x4trswGA6RtVpmRiiNL9y8qWhpFVXvo 8kk79jMgjeUyzE/C3ROrGU+PrA6jkS83OHRJsXDjOH/pDwk5osg7FI/otgBtEVwwjtI0 Q8qNdbp/cgD9hlqK/9ZPWGB369K6o+xNHD8s/JojRUxbvJb4st/53uzDtIz8etSs1HFq FIwjiLLoNTNRXI8NCHljNabxztxsglYGLvoFq74F4Kihsfml4Cvjdd15sHZxLYs/mjui 3EAkDhHdjmQK1/YcYQkFdNZKGE/VhVBAWc77wjV9m+/Yd9DGNu282cjT7Mo7vzMf3aiM g0zw== X-Forwarded-Encrypted: i=1; AJvYcCUjBVGf1PQtDv7m8XsgUNVUL0cP3aDud0xF+Sv4wpsVEbqRd0r0rwYiabrkylXIi/4u1J0zZsy2mYQZmYY=@vger.kernel.org X-Gm-Message-State: AOJu0YyrekNK+OupKRT7ZArpDtHX+SjWKb8WAyo8hbr5oQ6OcWcqJVjx B8N5R4iqk+19KUGdh1nuReWAsnbmuxpCnteZaQ+lgZ4u6D8V8lDOELFhRd1zYA== X-Google-Smtp-Source: AGHT+IHnP0UxGHShDudSxRf4EKVdCozcxdusgqEAENCL/YU2wzK66FdkoWkYdwQomaRjL9BY0Eb7tw== X-Received: by 2002:a17:902:c411:b0:203:a046:c676 with SMTP id d9443c01a7336-204ddfe8059mr21403475ad.0.1724752563346; Tue, 27 Aug 2024 02:56:03 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56: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 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections Date: Tue, 27 Aug 2024 17:55:43 +0800 Message-ID: <20240827095550.675018-4-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 --- 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 3a1b6fd9780d..b1950cbc046a 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 the &struct device_node corresponding to the regulator = 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 the &struct device_node corresponding to the regulator = 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 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 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 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 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 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 &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 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) { @@ -4526,7 +4532,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 negative error number on fa= ilure. * * NOTE: If the regulator is disabled it will return the voltage value. Th= is * function should not be used to determine regulator state. @@ -4610,7 +4616,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 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. @@ -4778,7 +4785,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 negative error number on failure. */ int regulator_set_load(struct regulator *regulator, int uA_load) { @@ -4963,12 +4970,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 negative error number on failure. */ int regulator_bulk_get(struct device *dev, int num_consumers, struct regulator_bulk_data *consumers) @@ -4989,12 +4996,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 negative error number on failure. */ int regulator_bulk_enable(int num_consumers, struct regulator_bulk_data *consumers) @@ -5038,12 +5046,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 negative error number on failure. */ int regulator_bulk_disable(int num_consumers, struct regulator_bulk_data *consumers) @@ -5077,7 +5086,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. @@ -5085,6 +5093,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 negative error number on failure. */ int regulator_bulk_force_disable(int num_consumers, struct regulator_bulk_data *consumers) @@ -5581,8 +5591,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 valid &struct regulator_dev on success + * or 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 Fri Dec 19 12:01:43 2025 Received: from mail-pg1-f177.google.com (mail-pg1-f177.google.com [209.85.215.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 052D119E7F9 for ; Tue, 27 Aug 2024 09:56:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.177 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752567; cv=none; b=JKGlIaqgkCAhe0oR3aSA/QcqOm0bec6rUYPLKvBe8MyA8n1mfV6hPh09FLPPIQjKZBs77cjZd5U3KsOL4Mu7wD0lFNHzuHACLpnhsJg9j/JMboSw7op9P9rpv+pSCPb2zehmbfs/3kGFotZghbTUIv6I9I3w9ykmgTfw8/OILds= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752567; c=relaxed/simple; bh=LBvhRma7fI8JVth7/NQQV6dLoRL7Em1JoE7ZYHHju0A=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=X05rREZE6O1zaFOpCI+UAqFdd0TmahSmCHGC12+7FTgssGFloOh60cq1qqdG/RUVS0ts9nSnTbcJxfXRKDiljXE8gCLen8ugXr9lkk1myfqxeTu57uZQslMON9wt1mpd8ddVHYxhuD9v9HtxWCFQoteWOcuvct5ThnszJedGXMg= 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=HG7NQBls; arc=none smtp.client-ip=209.85.215.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="HG7NQBls" Received: by mail-pg1-f177.google.com with SMTP id 41be03b00d2f7-656d8b346d2so3153561a12.2 for ; Tue, 27 Aug 2024 02:56:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752565; x=1725357365; 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=sghYcwjnzdejWIjBpN1UzeYRtefjC2IMHo4HFLUj5uA=; b=HG7NQBls/dVCUu5i137mGlKyXL+jriiR1O9eymxZsVpxRpn0Lpq1v5V9h5AZaFlQd4 QBot8I/H5vzMsIZDeYQByANozpNq4OXmONNFRqAsji70X6Zs7TDXUwn+Oo1KJ/55aAH+ uMqn7mQpnAMugvwFUlJD4Reng2QquFwGp55dc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752565; x=1725357365; 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=sghYcwjnzdejWIjBpN1UzeYRtefjC2IMHo4HFLUj5uA=; b=KSQiZXkddEaUw/po0BMpwOI/FwWkSUC4z1Gah9DwBj9CGq4gvQOKoMduTFLqVWtqY/ rJ50DOq9B+Coerdenz8AKbb9GKCbELP9kHZvxTG+eQHAbe78tS2i7dP0hXoJDc/dM02F JkC3en/SBVApEQ9b8pqg4XyLINKD0rMev7OTOcen6irgY4+mNk3wPH/T82VXuiVmZlpY wR6ssyHxKBxmufULGjmNW264xCe7k6vMS4257paGR0MuSKev8X83Cba1RsqYaf27oWl7 QICYRrx39SzkMfuRM4bUcMxYEcn9D2rEdORsvG2Kjy/X6tljZK36DF5lW14/SnlDbt6H qJBg== X-Forwarded-Encrypted: i=1; AJvYcCUbhqPH/O7kHUdmyrVYGjNumjF2tf43xYaLXDTGoiI4tJRU2Zy0orTw2F6FdL4tfjIRme3YpqrJTqV/Y3I=@vger.kernel.org X-Gm-Message-State: AOJu0Yw2GWGFBKvepQzYzlikTo5YZC4sC4hCf+rQFoPzJ0b2bm1l/gju izr7SzUSdE4xlAeUcyW3Zy4s7JBPrdmydKFW9QDmKy7YEFjwCDeGIuWsXL7wyQ== X-Google-Smtp-Source: AGHT+IFjt2qwKKVbLe4sOBHHmEf4C7vlTf8mEf3uCumq5WKVMPiLmtrco3HnyLt+ixtp3ic1ZXph6A== X-Received: by 2002:a05:6a21:1192:b0:1c2:8efc:88e9 with SMTP id adf61e73a8af0-1cc8b58f912mr11509172637.40.1724752565164; Tue, 27 Aug 2024 02:56:05 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:04 -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 4/8] regulator: core: Add missing kerneldoc Return sections Date: Tue, 27 Aug 2024 17:55:44 +0800 Message-ID: <20240827095550.675018-5-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 --- 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 b1950cbc046a..1f2303a2ba7b 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 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 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 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 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 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 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 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 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 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 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. */ @@ -4215,6 +4240,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 negative error number on failure. */ int regulator_set_voltage(struct regulator *regulator, int min_uV, int max= _uV) { @@ -4325,6 +4352,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 negative error number if calculat= ion failed. */ int regulator_set_voltage_time(struct regulator *regulator, int old_uV, int new_uV) @@ -4382,6 +4411,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 negative error number if calculat= ion failed. */ int regulator_set_voltage_time_sel(struct regulator_dev *rdev, unsigned int old_selector, @@ -4434,6 +4465,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 negative error number on failure. */ int regulator_sync_voltage(struct regulator *regulator) { @@ -4565,6 +4598,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 negative error number on failure. */ int regulator_set_current_limit(struct regulator *regulator, int min_uA, int max_uA) @@ -4638,6 +4673,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 negative error number on failure. */ int regulator_set_mode(struct regulator *regulator, unsigned int mode) { @@ -4699,6 +4736,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 negative error number on failure. */ unsigned int regulator_get_mode(struct regulator *regulator) { @@ -4745,6 +4785,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 negative error number on failure. */ int regulator_get_error_flags(struct regulator *regulator, unsigned int *flags) @@ -4817,6 +4859,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; + * negative error number on failure. */ int regulator_allow_bypass(struct regulator *regulator, bool enable) { @@ -4874,6 +4919,8 @@ EXPORT_SYMBOL_GPL(regulator_allow_bypass); * @nb: notifier block * * Register notifier block to receive regulator events. + * + * Return: 0 on success or negative error number on failure. */ int regulator_register_notifier(struct regulator *regulator, struct notifier_block *nb) @@ -4889,6 +4936,8 @@ EXPORT_SYMBOL_GPL(regulator_register_notifier); * @nb: notifier block * * Unregister regulator event notifier block. + * + * Return: 0 on success or negative error number on failure. */ int regulator_unregister_notifier(struct regulator *regulator, struct notifier_block *nb) @@ -5179,6 +5228,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) @@ -5197,6 +5248,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) { @@ -5887,6 +5940,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 negative error number on failure. */ static int regulator_suspend(struct device *dev) { @@ -5976,6 +6031,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) { @@ -5989,6 +6046,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) { @@ -6010,6 +6069,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 Fri Dec 19 12:01:43 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 A3604158D9C for ; Tue, 27 Aug 2024 09:56:07 +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=1724752569; cv=none; b=ZRysMfP80YfYfWp6KbtFwCeu1+B8YDoIbEjtM8yCjMObVj7g3+OaSLhH/QV4g0Ql/HRBlz8ZUcno3MrCU9mPMBpoZqMUsAQfqc9FP3hEkLNhXfJboTrK1w6GZmrG0wcTPG64EYSt9cfQJcxQXyHSBgldK8j3FId0H5HQEJ52UCk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752569; c=relaxed/simple; bh=JS7zaQvkWkzBMXANwpvTuIToEQVmz8bURDImoYt5Rb0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=XI2AvfBLOQSaS1Hcnn/LYqpXhkOWVjn8IPJbyvcUdteVPnLviM3gFBNUO9hxIvXBuIo0CV/Sa0kvpzQ5om3qJO4KuUOgfJNoIXmtxOIaFiwPzUtpP2VxI1NlEv8LmbqHBohz8L04OBzfDlm+DPtnQVbxMKvhZ/S6RWHvqhQoXgc= 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=nAVEUX0c; 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="nAVEUX0c" Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-201fba05363so42398715ad.3 for ; Tue, 27 Aug 2024 02:56:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752567; x=1725357367; 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=ESZ230OnhQbgGMwqd+oa/xXMpMZe5y6HmOQapIAtswk=; b=nAVEUX0cpEHoxYyG/5dilw2B6C28U0OZ3KWHNrQBrgCfJaGawYlQK0g9UxTjq8pLde KWUSe0GG00oSE19E1NO5KTm55XMjwv2BnhLe1zIamZ+AsVUbjIIyVBZSEjV1mopacpzY miZ7GwCjlwWeMQhK5qjpL8w2NFJU+cVa/I5rg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752567; x=1725357367; 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=ESZ230OnhQbgGMwqd+oa/xXMpMZe5y6HmOQapIAtswk=; b=E1gsxEVNaDyxQWkwL6p5/tv2OiMnyidTYedH31AdjjkwwPivuyMW1oo641yt6qhstt z5z6vGWbxX2TsIAXt2JDIbhhT469yLN/dTVlRd/XYinEi7gduKG5MQD+3OxLJQwT7YzW X5JBMpyFyMj4e6ILgch7EY3QICCZXDH87peMN4mIK78uL8Q0hoPHiD4oWvfAt7EUqXiD n9pQSZ0+unPcCz7iu4C9kIX8y7x6tSdIPwpN/qdYtD29gxKtrfmgkoQbiVqSJNNGdAao Lj4MoSZ6qjOG8MnCiKLom5kb+qITt2z5SL3tWSbqwUZoK5YSDhO1uH5ZCfBY52psdp5G cIrg== X-Forwarded-Encrypted: i=1; AJvYcCW67q6kIEliGJUtS0xc++vejnb5mxnIxWe86pWHLzd0nXR4BoZTASQXXQGVc3kwXvCr3zhFQnFhWYB15Vc=@vger.kernel.org X-Gm-Message-State: AOJu0Yy739FibIpLG+OhCGZaUlrCoGBLHqIfxeOgVPEsIHlg6+dvBrpH 1bWNObOGi77NAkyqEP+cMrfxFtP7ExW/cs4FI8hjOZQJ5P7DEZjXoD5zXv7oHA== X-Google-Smtp-Source: AGHT+IFFCHZgHL9RBU8dd5+9PfndpKeAF0h1nYtKjBFa8A/QGyHizQ8yJecYPHXnUGL5ASbJDHv72w== X-Received: by 2002:a17:902:ec8a:b0:202:3711:6fe9 with SMTP id d9443c01a7336-204df4d6d6dmr19210065ad.51.1724752566916; Tue, 27 Aug 2024 02:56:06 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:06 -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 5/8] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections Date: Tue, 27 Aug 2024 17:55:45 +0800 Message-ID: <20240827095550.675018-6-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 --- 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..9dab8ee74fde 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 populated &struct regulator_init_data or NULL if + * memory alloc 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 code on failure. */ 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 &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 Fri Dec 19 12:01:43 2025 Received: from mail-pf1-f170.google.com (mail-pf1-f170.google.com [209.85.210.170]) (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 E0DAC19F461 for ; Tue, 27 Aug 2024 09:56:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.170 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752572; cv=none; b=VAyHv2r2JP75ZzoYiwitJytGhNdTgWpu4wb4MGtDBOND2wTVcqBlpRphPoISzeX0NJVYoNn/HaHAvN08BCmGDX2JSBctzd5CWE1sF5CZvkuaVB7sWk0txLwx22elSPZVRiMW6czoSkmnlk6UxQ8SzYf/TpncH8CKZEDQHpeDn0U= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752572; c=relaxed/simple; bh=9nC5Pd3Zk8GhLxKe+1Y1HlO8qtSqLygWM4QVbLXpa4I=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=YH8baB4SjdF/FOr+/7DhCWqbB3qD4zkxuPYR6Tu2rLdwzyEkkcusRxvI+tAzv7LtPufN29hwheRk42sRzFaUeMutckAaZFXCwmUn1jcx8kS8yCIK1mioP/I3XkQmFNIpw3UTb10S0Hw3GnW2vBFVEN1xWQAwVxc45hBU1fhFaPw= 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=l3CuIDeR; arc=none smtp.client-ip=209.85.210.170 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="l3CuIDeR" Received: by mail-pf1-f170.google.com with SMTP id d2e1a72fcca58-7148912a1ebso1288583b3a.0 for ; Tue, 27 Aug 2024 02:56:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752569; x=1725357369; 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=/kEjsRoTrc9YEAoIm4fI2W5J5jFppY9yqOw4qUfYcYc=; b=l3CuIDeRzoMor0oevmRuhbTgDKvkOrYdZI2eBPUqvBnG0pF3hH/7CSJSogTBvB311a kADZun+/7rEl2JzeEPj6DvGwyAKfzmWLB+Hdy084b3oVXwFmc3pqcQKdkQDRxy/IVn0x DI4+amE+3Hh0MDBVLmEKtnxPJyWjogJxV9lpU= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752569; x=1725357369; 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=/kEjsRoTrc9YEAoIm4fI2W5J5jFppY9yqOw4qUfYcYc=; b=XrOgGlcjlubrnH9jAZHv7/ZdzaFaWkATb1iBY8Yzjc+9D9d0SV6SD7t8HvVBYSoy8P hPeXniF4n7XTEygFVNCN8yxdrZ2ouKBMiXlACGWcJq4t3BKkDFwBuAn5QJVNGst4/sI7 gZkjlpAl1k4AFJIjP7xjKYuNxINLSqJ5UBiSsk8dtePikBJI9wkYLc9RKOGyIjEzdezp F7uz1612pq7FyaxocbuYmlJL0bEJcY4HOjOnVLoEWBKeT029KROEDydGhplx+cIENd7M R2/M6TISdrpBuI6yltmxxocnLrQ1dJLJRZf09QYRS5xtqznsgI+LAzsngg91yIPAtkl3 wOHQ== X-Forwarded-Encrypted: i=1; AJvYcCW7yqhRDohx++hi6vws3++oNfXy5rc7YANtCqiZXwKgjCu9/gjm+dqKMwBLiZ3HwGfoHUbEDO/a+Is6jlw=@vger.kernel.org X-Gm-Message-State: AOJu0Yz1XanIQtSCVDHFmMVS84LHM7xz0XtkgSsUfgWuIPCAlXdsyBJ7 KgesVm3kzP9TfiH48NNIiYIFOGgLEMHn2Aj+MRGn+L+3efGum012G6DrW8VBzzPg4hDys30mcjA = X-Google-Smtp-Source: AGHT+IEkDjIQuJoQ6kCa98vVLTWPO/VYtGd1/XSnCdwwHvl9WI+e65ZCQr6Z5uPOx+2prdu3WCvVxQ== X-Received: by 2002:a05:6a21:33a9:b0:1cc:c2d5:f9aa with SMTP id adf61e73a8af0-1ccc2d5fa66mr1778594637.4.1724752569071; Tue, 27 Aug 2024 02:56:09 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:08 -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 6/8] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section Date: Tue, 27 Aug 2024 17:55:46 +0800 Message-ID: <20240827095550.675018-7-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 --- 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..1629aa525ef2 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 populated &struct fixed_voltage_config or %NULL if + * memory alloc fails. */ static struct fixed_voltage_config * of_get_fixed_voltage_config(struct device *dev, --=20 2.46.0.295.g3b9ea8a38a-goog From nobody Fri Dec 19 12:01:43 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 9B2DE19F475 for ; Tue, 27 Aug 2024 09:56:11 +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=1724752573; cv=none; b=UqRGxFx8bZ1GlvOniZD06d6WTM8MHElsci9lSRC86CXhcCcMXzmQ0pfzB7WzwD88WyJFCmhfhNk3JqXRhq0uVsVROubAzvbCaM6sbVeW6R6+p0EaP//hTEyZ0Ur3e5IQfCOaaw8N+UKcltgWnr19Iwo+py16Or3pS4nQqqb8hgQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752573; c=relaxed/simple; bh=NARynwCKnnv3T9J1Gl/DhTBzBUpASqlkAgDCanjFiKM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=piE/EqkwoRRYy8dGS/nADR+Q/6uyjT3IjBo7+F2xf689Qyo9z2W0ORlPRufe4+pY3ni13P2IJO/BubFVUTDNAyVR84cFK+j0KKP84PlCmd1AazY9qbvRvviBFuNRQxzhEdp4bmC4wrUc7Bsqc7lcMdJPyFO84/LkwR/h4cdIQO4= 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=OYCjXj9u; 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="OYCjXj9u" Received: by mail-pl1-f171.google.com with SMTP id d9443c01a7336-201d5af11a4so46472425ad.3 for ; Tue, 27 Aug 2024 02:56:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752571; x=1725357371; 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=QWF2y1DaAfCI+OxvAbtfW9C6juMvoH4TVoXic04e7PQ=; b=OYCjXj9uZyk0CjLZJb3BonEzUHCklOV0xtcVNzC3OblsgThA39p3dPOCUgibefXYYy CYoi09/HXPlGYejWF90WRLNTgpvl9mU0KI4OFaffuFaAfbu4baSm5BTmPUFwWGzoL4il d2jYV8HaGR9O63Z2RlTqpQ8zkD+v06M2lf+xk= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752571; x=1725357371; 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=QWF2y1DaAfCI+OxvAbtfW9C6juMvoH4TVoXic04e7PQ=; b=Q610X8yWsbJ7eG8ML0Rehpp0Pvz49QcHxX+HHwnFpHUfDXOWweDqj3fVGjyt4flR3s TJ5nD/6nDqMS2fpN+dII82fmx09maC35XR0xEOqnDU5Epz04zMLbHehrkm6Lw5C+Dk7a mQusNnKnTSiGg+yDOGnXbUHep66IXuRUfD20JwSDrcLWLdOKBdxepkkgwFOSGqgBk9bG 7DG6jKAISG62lY64byEF4Iw7ChjKKx2K3ltcml/470GVLt6fdJRprUFMApedfhcv/EIl 3sqpYxFkTPpT1Naq84xn4K8PtRJv2fh9+5xJIG1pzxrp9jOUP27kJ2i5zq1lsV0uOWeU /L9Q== X-Forwarded-Encrypted: i=1; AJvYcCXR7ZBREZGL5qHCKBuVUN7vQ0LkSSMLZqIvEEsB7gfLrB/dZvzlDgIEKQ7kQ6tUNJo9JO1MfJCgFOrhWyw=@vger.kernel.org X-Gm-Message-State: AOJu0Yyts592OIY4MO4w7dceobmN0S04IYrppfhdGWp3zAip6j50EXkK Pe3cxA5ytUvLtLhqNjXb24B8LOvfje1tTJ8gXLMPrub2qte0oxNBNjp6t5ZvkQ== X-Google-Smtp-Source: AGHT+IG1bfKL3An8XqshnrBPErEA+/k/utDPS4gPGGdrb8g9f7KtjCgE/tEqVtdEn/QXw5TVbNEMPg== X-Received: by 2002:a17:903:bcd:b0:203:a12e:faa7 with SMTP id d9443c01a7336-204df45fdafmr21313875ad.27.1724752570967; Tue, 27 Aug 2024 02:56:10 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:10 -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 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section Date: Tue, 27 Aug 2024 17:55:47 +0800 Message-ID: <20240827095550.675018-8-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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 --- 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..72807af63126 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= 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 Fri Dec 19 12:01:43 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 6E82819FA7B for ; Tue, 27 Aug 2024 09:56:13 +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=1724752574; cv=none; b=S9nx3BCZMuR6ZriOZTRpPC5KmE0tuQIJsJL1YsCqaDjc2q9KEOK1iPv6ao1Kqvz99WZFLjvi9X9SSkCCYDIXqpspVIJfx/mfBQiKda6q/gwZhRdEDTuwO+3h1XLZPLn/YEAehXRLxLSeVt4fdxHQKzncrLeQFLmIfh1ofnOfJfo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724752574; c=relaxed/simple; bh=61aWqOIzzepMknkcXPfDfYv2R9zOeeIrclywPB2sVo4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=VGUu9LgNHlYudgoVbVOW16KzabHjQm+suGAKp9mMIxBjJ1wtiHBeGLnoxyaig9gpWG9ypmqWBESwi0klRaeB0hgpaeQPI5PDmstjXq7e45ceJyL1GwYOXwGS+5xmD3HmD1i/3riE2O6ySt27AouQA0Yj9Zhgyng9Oh1roIWruTA= 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=Sjlz9zS5; 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="Sjlz9zS5" Received: by mail-pl1-f169.google.com with SMTP id d9443c01a7336-201fbd0d7c2so43047345ad.0 for ; Tue, 27 Aug 2024 02:56:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724752573; x=1725357373; 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=3/5VBNfYAsqRzbHrubk/0yjXqiOSkP3Dbb2C0/1kFpM=; b=Sjlz9zS5ZA5YBaJwgb9XuF9KPZz2YJmuLaBhLVivgf6M0eTMvMoMbPDHT1dza2yq4K jozebKbHlGroWn/3V8WyWXL7YavDy21DBmPpMD+Ektgh9zVB1xwcqajbvYoRTLHtJK4v AQVQewejI3Qi/a6riUpy7GDJs+5DV6PWYh9Vc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724752573; x=1725357373; 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=3/5VBNfYAsqRzbHrubk/0yjXqiOSkP3Dbb2C0/1kFpM=; b=P/RNUmGHJjIVRCW+jtgWOj6+1l3uFfqO6tUtxEglB1XrJOKTbrEtqR3AxrR0hJ3mGY HUaPI4nrOxI3YyA8Off+oYVR1ONtUORbZOOk0HoLau1DPjI3h5IBjotzk7Q2eBfPnAu8 2nS2H0LxGVjnN+QJEq6kgTaz6PUuDHzu9LIRqJ0E/XqWNvl+IaTlZDU1Hm8e0I3l6S10 zCtWjGHdwGI8ZdBQGbaF363pn0VNNL2Z4vQeGKNUyOAo9duIOnyxvlUye3dea0ABRPjY 4f1KCVeZxWpa321y4EKXz37j8odNGkr8e2qfujdlJBHPl3VWrY5E4gkOM+9CjQLXE9vZ fuJA== X-Forwarded-Encrypted: i=1; AJvYcCXXt3uUKU7on9Kukeuk9I+McP/3ycpeLRCBLLj8vi6GzsE6r+CXBdkAR4MWUZu285aipt0wRv441+yoWX0=@vger.kernel.org X-Gm-Message-State: AOJu0Yxi9lnYrYhdc0sXRWYisi0b/XtuahHc5PuqC4xlm/U/gF2UvoyB uGwR3TpbCtK4jtnfLYM6fvz1yUlU9uijfOAhPylUNTxC5jXqNQdUWTUTJtWkWWFmM9zzeDQpa9w = X-Google-Smtp-Source: AGHT+IGK0iObEbnV0ut5x5siCGHthaaUKI10Pjne/4Dtm0WJAt/GcXg1cPDu6YGnkB3ody3D/pB6Pg== X-Received: by 2002:a17:903:11c7:b0:202:4d05:a24a with SMTP id d9443c01a7336-204df13ee41mr24113125ad.16.1724752572692; Tue, 27 Aug 2024 02:56:12 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:3102:657e:87f4:c646]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2038560c2basm80006775ad.222.2024.08.27.02.56.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Aug 2024 02:56:12 -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 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section Date: Tue, 27 Aug 2024 17:55:48 +0800 Message-ID: <20240827095550.675018-9-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240827095550.675018-1-wenst@chromium.org> References: <20240827095550.675018-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. Signed-off-by: Chen-Yu Tsai Reviewed-by: Matti Vaittinen --- drivers/regulator/irq_helpers.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helper= s.c index 5ab1a0befe12..5803ef016b7d 100644 --- a/drivers/regulator/irq_helpers.c +++ b/drivers/regulator/irq_helpers.c @@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel); * notification helperk. 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 + * + * Actual regulator error and notification are passed back through @rid. */ int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid, unsigned long *dev_mask) --=20 2.46.0.295.g3b9ea8a38a-goog