From patchwork Fri Jun 26 06:57:31 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11627189 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 8D10D90 for ; Fri, 26 Jun 2020 11:12:30 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 5DC1120724 for ; Fri, 26 Jun 2020 11:12:30 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="jNKHnPBk"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="cU3REmEx" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5DC1120724 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=eG0IMLbymOqxzjru7RopD36fj3IuahTVPefIZLJqPrI=; b=jNKHnPBkzJn2kEX4X66qYaule u1s48483CGl1qC46Id7Dt7WeEIYf8UrpEkqLCkVj/s5qeb9jFownuYvTwgXmT23dBSQLexR+0Y+/V pXVOu2AJV9YefHzgaj8R9x6EixYhiO4H5GssLLQ1QfUVzxsI/EGCc5PakHs1ZfqE4OR4YC3Dm6CVv HTD9DmHbCnBKECO8u5PT1nJR1Yr9SkreXk3JdYx63AIK3G1DU0wPDlfqcF5Av1643fURTDM5PnF1Y eNHAU5j7MMe6s8jzMrx//Bme8IcRhnkZiWz0Fd5yaHt0LgF8cNhT73ahHXKfXT4YY3E8BOznJjvqn fP/8JY2kw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jomFZ-0004R3-Ql; Fri, 26 Jun 2020 11:10:30 +0000 Received: from mail-ej1-x642.google.com ([2a00:1450:4864:20::642]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jomCI-0002xY-Mi for linux-arm-kernel@lists.infradead.org; Fri, 26 Jun 2020 11:07:15 +0000 Received: by mail-ej1-x642.google.com with SMTP id w16so8964581ejj.5 for ; Fri, 26 Jun 2020 04:07:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=EQdtlCq0FayiIxw9Rs+gOrZ/5VZqnIsgjAQgaobsp4s=; b=cU3REmExdXZnTF1HXY2PtQ30RmVx7lx6+g3J32TSut/xk7G7p7XuOcEJLmRCbZ1oAr yxV9KPJUZZxSbh1LCZe2jrxDJ+MPWPlh0BioUJLmX/EUALUyyccsVlG1MH1dkpOLRMbg F1qIyO8QOKmF/5DVafM5L6c29Kmb/zbFn7/mZAHvQwjiHO04zXvrQrvjofjw6jUuyN1n mP/+VZDB0onc+Z+oo783ZaFEVi8BQHwkpLhTxi8/2m/2B8ctw2r2H/OwnpQMJBAjCEAO SGmQdBYITEgfwziCb87ej+7xh0NjA/L6OCgXbTy+b95YSxVc84h4L5vpK1eAZH5R/Qp9 gajw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=EQdtlCq0FayiIxw9Rs+gOrZ/5VZqnIsgjAQgaobsp4s=; b=V25XD0vcIEFFLCehBlslzaYoS1MB3d+/zjyJIdL00YuWwEfFD2qhjvYtwT9s7IezrF aDd0LHTAPlusWbtB5WVrcFHsEcbwljYzjFOhI+WEOcy99QUPCv2RN3+Fbd2Xln9CeDsG SbSmC/I1fSytBf9JC8402MZ0D6ekMf18YxHrpFDPOB9LCM5u0DyyWogfT4uPOrd+sFuO ithY6uu2kvwAi7++5QKzqjFwpINUE4irGnt3OslF82j+btizOHQvCbyBpZoEH7lWfbAY WU7m60TKMWDi72mMB9HcKoPs386N7zYWNWSYeoQCXJSmM85CsUl7ilXCXf3q3dO3laRd 9CHw== X-Gm-Message-State: AOAM531nEDED3bV8fSyXTEWRDTppTX7TyQtxRPc1MI9WSbmFb8CapUgU eyutv4DRbaBt1UqBiXCjoJuOFNGBNs4= X-Google-Smtp-Source: ABdhPJwZ+URFbBBN0AhuwE/y6WRRpqaFyX55X7XIOPgwaR11LJdWPX+JuV9C2QRf7yGvIuLUOuZ4Yg== X-Received: by 2002:adf:fa81:: with SMTP id h1mr2187942wrr.288.1593154664379; Thu, 25 Jun 2020 23:57:44 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id x18sm15355269wmi.35.2020.06.25.23.57.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 23:57:43 -0700 (PDT) From: Lee Jones To: broonie@kernel.org, lgirdwood@gmail.com Subject: [PATCH 2/9] regulator: qcom-rpmh-regulator: Repair dodgy kerneldoc header formatting Date: Fri, 26 Jun 2020 07:57:31 +0100 Message-Id: <20200626065738.93412-3-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200626065738.93412-1-lee.jones@linaro.org> References: <20200626065738.93412-1-lee.jones@linaro.org> MIME-Version: 1.0 X-Spam-Note: CRM114 invocation failed X-Spam-Score: -0.2 (/) X-Spam-Report: SpamAssassin version 3.4.4 on merlin.infradead.org summary: Content analysis details: (-0.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:642 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-arm-msm@vger.kernel.org, linux-kernel@vger.kernel.org, Bjorn Andersson , Andy Gross , Lee Jones , linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org W=1 kernel builds report a lack of descriptions for various enum properties and function arguments. In reality they are documented, but the formatting was not as expected '@.*:'. Instead, some weird arg identifiers were used or none at all. This change fixes the following warnings: drivers/regulator/qcom-rpmh-regulator.c:33: warning: Enum value 'VRM' not described in enum 'rpmh_regulator_type' drivers/regulator/qcom-rpmh-regulator.c:33: warning: Enum value 'XOB' not described in enum 'rpmh_regulator_type' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'vreg' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'dev' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'node' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'pmic_id' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'pmic_rpmh_data' not described in 'rpmh_regulator_init_vreg' Cc: Andy Gross Cc: Bjorn Andersson Cc: linux-arm-msm@vger.kernel.org Signed-off-by: Lee Jones Reviewed-by: Bjorn Andersson --- drivers/regulator/qcom-rpmh-regulator.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/drivers/regulator/qcom-rpmh-regulator.c b/drivers/regulator/qcom-rpmh-regulator.c index 79bdc129cb504..08dcc614efa7f 100644 --- a/drivers/regulator/qcom-rpmh-regulator.c +++ b/drivers/regulator/qcom-rpmh-regulator.c @@ -22,9 +22,9 @@ /** * enum rpmh_regulator_type - supported RPMh accelerator types - * %VRM: RPMh VRM accelerator which supports voting on enable, voltage, + * @VRM: RPMh VRM accelerator which supports voting on enable, voltage, * and mode of LDO, SMPS, and BOB type PMIC regulators. - * %XOB: RPMh XOB accelerator which supports voting on the enable state + * @XOB: RPMh XOB accelerator which supports voting on the enable state * of PMIC regulators. */ enum rpmh_regulator_type { @@ -399,13 +399,13 @@ static const struct regulator_ops rpmh_regulator_xob_ops = { /** * rpmh_regulator_init_vreg() - initialize all attributes of an rpmh-regulator - * vreg: Pointer to the individual rpmh-regulator resource - * dev: Pointer to the top level rpmh-regulator PMIC device - * node: Pointer to the individual rpmh-regulator resource + * @vreg: Pointer to the individual rpmh-regulator resource + * @dev: Pointer to the top level rpmh-regulator PMIC device + * @node: Pointer to the individual rpmh-regulator resource * device node - * pmic_id: String used to identify the top level rpmh-regulator + * @pmic_id: String used to identify the top level rpmh-regulator * PMIC device on the board - * pmic_rpmh_data: Pointer to a null-terminated array of rpmh-regulator + * @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