From patchwork Mon Jul 13 14:49:07 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 235452 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp2907299ilg; Mon, 13 Jul 2020 07:51:22 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwRmBqGiGIxLsCS4pbxCazZ3SealtPdkyzAbXCNdt8SNPPfqCc0j2qxv6qSFCLnGdUBsMMV X-Received: by 2002:a17:906:b24d:: with SMTP id ce13mr146461ejb.546.1594651882542; Mon, 13 Jul 2020 07:51:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594651882; cv=none; d=google.com; s=arc-20160816; b=ibZzgpwposZBxctHKXCf7oRd5srey0JG4kZMTB1+H5CUi0auSbf2ph5w21MQl3Utt0 HNVdQP+WX28djzK4tq5wgt750kDCEmQ0B+kV/RnsYD/30wKaowgWJFjXACRPsRA6Gpvr XPhu4hH0L4MpTjrxJ/uM8Pb04D0Fp7MpxLnd46bltqHXFAA15lUS6l+ra+EFk5s4KuFw u6vb2Sn6WbqA8uCvwFTvIYXeeboREIVitAETrv/wY9RKkMFNpKVhE/GyOUiHVGWLB7gC yyLuAK9ZfADzoPRYJ9/Fc9utB8XDOEXrpBq4sOa23ODJGhjy4S1+hlLPTV1sbNqTZril g5hQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=BDQo0AmW/wRqsDL2beQj5GgZo90S5+xYNYVa82ZvelY=; b=M5NxgZ/FcjpcxcOO+WUY2PA6tqhtq/2VChQBkn5+YFUStpoDp2+MY+YuiDEd8ouwEY Q9Us4vl4puE5vEYBBtnDqpzIxvnCnocU7/fTH/8A0XgNWcYOmcip0hEj6F26tFke2xeK rMRhSey1W8+EiIwePwYxqyFa1V/2/ZG5F4lLlMoDdI20tM2R/fm4v59WiVXqAfVOTVmc PPMmEa0Lv+pJslPHvbEc6T5t5evyKHWA5xSitKf6rvbCB82fnU7k3Ymw8Lo6qFUMzFK/ F5UeitmnmYyzqJKOeJEUHABuJ4ndBDPKF4x638tEWUseu1cANm/+M2ShtzDh+YJ45dcE uM3g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=GoRSkBxS; spf=pass (google.com: domain of linux-gpio-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-gpio-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id du14si10880948ejc.721.2020.07.13.07.51.22; Mon, 13 Jul 2020 07:51:22 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-gpio-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=GoRSkBxS; spf=pass (google.com: domain of linux-gpio-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-gpio-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730029AbgGMOth (ORCPT + 5 others); Mon, 13 Jul 2020 10:49:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60918 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729993AbgGMOtg (ORCPT ); Mon, 13 Jul 2020 10:49:36 -0400 Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6BBD8C061794 for ; Mon, 13 Jul 2020 07:49:36 -0700 (PDT) Received: by mail-wm1-x344.google.com with SMTP id j18so13588110wmi.3 for ; Mon, 13 Jul 2020 07:49:36 -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=BDQo0AmW/wRqsDL2beQj5GgZo90S5+xYNYVa82ZvelY=; b=GoRSkBxS/tnbpEU8KW8mepOxP/TVgSZbKxeDQfb1oEnG4csHx4qgPKtw1Dpch1UzMu 6g6z3ry4DE6sORZjwGWlJ1wuPVGeu0GlPBSTfXy2Ikx2dr3U54PkfYnhJnY8jAi1ZE1N j+Oeczc9kTqHziWxpVqMo6x/pdMF9PFXB/K6zJh9dQ5CmyyPITOmzo+win3AbA2SmG/A rKbhrZ1lpGQwKRiKrKyxkIJmluCboFzEbi02fEDhmuaZQWcQ67BOwHPpTljpSLqQTeq7 si2L97FkbLl1Q10+xLOD2nS+7mOQeM/04ztAslVRuYKXnSSaoTpulqjXSZhXR4/L93j0 ZDeA== 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=BDQo0AmW/wRqsDL2beQj5GgZo90S5+xYNYVa82ZvelY=; b=ok9Gbs/YEY1lLt4NrfedACwtkBdTsFoyrGm4Mzv/dZyDgQsUHCYoHTF8f4tVbB2hVt Oqwzswq2mzHofKLu3xk+CfA5P8yAU807eWbFb7KNT8rC8lXGbbK4gy878jkwzyYgAU4B j2sz/uTvc4b8KLVE4Q27ecHUU3tRfV8Euu+U3aEpSQ5AFLXGNJQasSTqj08LkLsTd9A7 D3kr7C60IuubqXv4XhWDZfA8ksPIp33LVv+GKcKIubRvMljBJLtE81/BSUjp1CCECtSy huQF9OspzDl1fTc1rnDi7fwvtHvQaOXhuxVdg9z7FQPm4prOTaNGf/Mn5EXYRtylPV6m VMSA== X-Gm-Message-State: AOAM532PszpIQhf999j5WwsLNTvCCE5JcpF6VHlO8A41CrrsJ2X5WKLg ZhiEIFlqRaSuyR0glRo5ctB3tA== X-Received: by 2002:a1c:3546:: with SMTP id c67mr329431wma.102.1594651775115; Mon, 13 Jul 2020 07:49:35 -0700 (PDT) Received: from localhost.localdomain ([2.31.163.6]) by smtp.gmail.com with ESMTPSA id o29sm26207756wra.5.2020.07.13.07.49.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Jul 2020 07:49:34 -0700 (PDT) From: Lee Jones To: linus.walleij@linaro.org Cc: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Lee Jones , Barry Song Subject: [PATCH 02/25] pinctrl: sirf: pinctrl-atlas7: Fix a bunch of documentation misdemeanours Date: Mon, 13 Jul 2020 15:49:07 +0100 Message-Id: <20200713144930.1034632-3-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200713144930.1034632-1-lee.jones@linaro.org> References: <20200713144930.1034632-1-lee.jones@linaro.org> MIME-Version: 1.0 Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org >From ill formatted kerneldoc, to incomplete *and* incorrect struct headers, through to formatting issues and missing attribute descriptions. Fixes the following W=1 kernel build warning(s): drivers/pinctrl/sirf/pinctrl-atlas7.c:197: warning: Function parameter or member 'id' not described in 'atlas7_pad_config' drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'func' not described in 'atlas7_pad_status' drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'pull' not described in 'atlas7_pad_status' drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'dstr' not described in 'atlas7_pad_status' drivers/pinctrl/sirf/pinctrl-atlas7.c:221: warning: Function parameter or member 'reserved' not described in 'atlas7_pad_status' drivers/pinctrl/sirf/pinctrl-atlas7.c:359: warning: Cannot understand * @dev: a pointer back to containing device on line 359 - I thought it was a doc line drivers/pinctrl/sirf/pinctrl-atlas7.c:4794: warning: Function parameter or member 'pad_type' not described in 'atlas7_pull_info' drivers/pinctrl/sirf/pinctrl-atlas7.c:4917: warning: Function parameter or member 'reserved' not described in 'atlas7_ds_info' drivers/pinctrl/sirf/pinctrl-atlas7.c:5617: warning: Function parameter or member 'a7gc' not described in 'atlas7_gpio_to_bank' drivers/pinctrl/sirf/pinctrl-atlas7.c:5617: warning: Function parameter or member 'gpio' not described in 'atlas7_gpio_to_bank' Cc: Barry Song Signed-off-by: Lee Jones --- drivers/pinctrl/sirf/pinctrl-atlas7.c | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) -- 2.25.1 diff --git a/drivers/pinctrl/sirf/pinctrl-atlas7.c b/drivers/pinctrl/sirf/pinctrl-atlas7.c index 50df9e0844142..e54a6e3cafd23 100644 --- a/drivers/pinctrl/sirf/pinctrl-atlas7.c +++ b/drivers/pinctrl/sirf/pinctrl-atlas7.c @@ -169,7 +169,7 @@ struct dt_params { /** * struct atlas7_pad_conf - Atlas7 Pad Configuration - * @id The ID of this Pad. + * @id: The ID of this Pad. * @type: The type of this Pad. * @mux_reg: The mux register offset. * This register contains the mux. @@ -210,7 +210,7 @@ struct atlas7_pad_config { .ad_ctrl_bit = adb, \ } -/** +/* * struct atlas7_pad_status - Atlas7 Pad status */ struct atlas7_pad_status { @@ -355,10 +355,6 @@ struct atlas7_gpio_chip { struct atlas7_gpio_bank banks[]; }; -/** - * @dev: a pointer back to containing device - * @virtbase: the offset to the controller in virtual memory - */ struct atlas7_pmx { struct device *dev; struct pinctrl_dev *pctl; @@ -376,7 +372,7 @@ struct atlas7_pmx { * refer to A7DA IO Summary - CS-314158-DD-4E.xls */ -/*Pads in IOC RTC & TOP */ +/* Pads in IOC RTC & TOP */ static const struct pinctrl_pin_desc atlas7_ioc_pads[] = { /* RTC PADs */ PINCTRL_PIN(0, "rtc_gpio_0"), @@ -4781,10 +4777,10 @@ struct map_data { /** * struct atlas7_pull_info - Atlas7 Pad pull info - * @type:The type of this Pad. - * @mask:The mas value of this pin's pull bits. - * @v2s: The map of pull register value to pull status. - * @s2v: The map of pull status to pull register value. + * @pad_type: The type of this Pad. + * @mask: The mas value of this pin's pull bits. + * @v2s: The map of pull register value to pull status. + * @s2v: The map of pull status to pull register value. */ struct atlas7_pull_info { u8 pad_type; @@ -4908,6 +4904,7 @@ static const struct atlas7_ds_ma_info atlas7_ma2ds_map[] = { * @type: The type of this Pad. * @mask: The mask value of this pin's pull bits. * @imval: The immediate value of drives trength register. + * @reserved: Reserved space */ struct atlas7_ds_info { u8 type; @@ -5609,7 +5606,7 @@ static int __init atlas7_pinmux_init(void) arch_initcall(atlas7_pinmux_init); -/** +/* * The Following is GPIO Code */ static inline struct