From patchwork Tue Jun 30 13:33:41 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 192085 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp3822387ilg; Tue, 30 Jun 2020 06:34:03 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwm7hAECtp9R35Bvru8NdkMdwrk82evyG2QqaDiF347UdosnWnvHEJ3ZaL0aP5JXCiifkJQ X-Received: by 2002:a17:906:856:: with SMTP id f22mr17484156ejd.245.1593524043629; Tue, 30 Jun 2020 06:34:03 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593524043; cv=none; d=google.com; s=arc-20160816; b=R7zr8No6OhJHyQ7f/dmN2hIf9Mw/wc3URlT6eQtscNSdGVshVJ4m28aEk6MEgPGyay H9q3kLzFVJTyKX0qDQGTN77HFh0zk6qMGiz+FYMCMZXxhZjxsvnbdC6qiAyufY8e1WV1 z/dJNTLkUPHJVQtX2kW3u3Gi2nKykLSBaED5/+np4cTdjl6cRZXf22ty9CkLqC2HTYtq 0kvMhdUTypweOP2nHI0VgZNtMPNoOhKR47Hiytu5RHreq9E94CPc6rqPi47zc57Jb+Ja IdUUGPlolndDG99fxp+cyzZ7zx+0OqW/51yieECbffRFK2V5tQzR6qRCS/9JrJizRyKK QB7Q== 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=ed8H2szCHThwNArdetIOxqgfOUbWnaN816hTwHMkdbs=; b=nU5pdEFDmwasgISj1o+FnDEYWrVfbvDPpBokG41TXW/UPlM3L5WQFPlBA1Jm8KRcce I6/3dqD5pSXzG8SIY5CKQLYA7EkOJYGnkg2BKsQb/ucjB4hOdO6Yw0fEl/nQzYg9UNOn El8MgpjbhNy/2RfSr0+Ry6AnlKcR4Kn2F+O6MKvYzc74SqvKM/BG3YcQeJM6r8TTiaaG 41kHfPe7p1vSPEkMjRCeEUqr3U+/0eT3pH6pniNNnH9sjAGFvXUt/k/93r5IMHhSEhfJ rjLvX6vOU2x01jjWxzRFJ3qVrTNjqJYX4CZ7bZ7qUX7q2nGG3h68sn1v8AGdYvYjivk5 hUVA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=LDOoBlOc; 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 j18si1886545eja.217.2020.06.30.06.34.03; Tue, 30 Jun 2020 06:34:03 -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=LDOoBlOc; 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 S2388193AbgF3NeB (ORCPT + 5 others); Tue, 30 Jun 2020 09:34:01 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44984 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2388172AbgF3Nd4 (ORCPT ); Tue, 30 Jun 2020 09:33:56 -0400 Received: from mail-wr1-x444.google.com (mail-wr1-x444.google.com [IPv6:2a00:1450:4864:20::444]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6FA7DC08C5DF for ; Tue, 30 Jun 2020 06:33:56 -0700 (PDT) Received: by mail-wr1-x444.google.com with SMTP id r12so20129717wrj.13 for ; Tue, 30 Jun 2020 06:33:56 -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=ed8H2szCHThwNArdetIOxqgfOUbWnaN816hTwHMkdbs=; b=LDOoBlOcdm5PNPBUjDlyXJMjFJoTSFbyLvEFfk2MSUYrchcD9tFEd0BZXO9SrTscoH eA/vQ6GAXtpXOUjef9fBRpi0CJvg8ckXzJXuEz09kLvdNWWqgqE1w+ordm7P5ftaJrHD a0mfbn07kQRfTm7ePl7W2Q76YlUgaNcjabzztkrqEVWKBpwBuKDZpQ0ySSp7J3V99l2j FbzF3FM16U5AgKguFp3o6KOWA4WGAskO5BV+OW1Ott1uuGymscZa01d/Fo66kvqK+Cnd 3apKWuCiSlV53s2VaJ5tXUiP4AQaF9MKFHjnCVFdG0y9wiripankDZXkPRCESZJ47G42 r9QQ== 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=ed8H2szCHThwNArdetIOxqgfOUbWnaN816hTwHMkdbs=; b=n2msv9OjbtVD0SVZrxtjLwzhSWOhQOn3ljmojgsFopGv9eCTmn3vua1SWlC1XPMpnz ra4TmvzSJQd7QXQZgRyeMORwQ028FDPNYw3fps95lXHvXwHn1ddUumItLvyHre/9p7Ys ShrutsI3gXmM0XxgZs4jXY6JZkgpSJvhfENAOGTeSt3ApbZturnC9wjiicIgXZDat/1x O20jQjqAlH5ZIXIv875X9/sdCbMDN0zvGV0fgTHVoHkSD9nepVCmuEUK5mMsG3k3Y5XG R/l7xwflmCbNMeolGGEA9au587syOYeqfepbQfflXal5rCYliutPbRT551IANmoiAATi u00A== X-Gm-Message-State: AOAM531/tFx/wkhJYo1lSLuggxpq/Wx1pRtQcJ52i4A7Pxl2Jin+RYPG hrwO8o4h5g6+fTtYuEeGe9698g== X-Received: by 2002:a05:6000:1006:: with SMTP id a6mr20905598wrx.332.1593524035124; Tue, 30 Jun 2020 06:33:55 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id z16sm3682464wrr.35.2020.06.30.06.33.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 30 Jun 2020 06:33:54 -0700 (PDT) From: Lee Jones To: linus.walleij@linaro.org, bgolaszewski@baylibre.com Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, Lee Jones , Alexander Shiyan Subject: [PATCH 06/10] gpio: gpio-syscon: Fix formatting issues which confuse kerneldoc Date: Tue, 30 Jun 2020 14:33:41 +0100 Message-Id: <20200630133345.2232932-7-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200630133345.2232932-1-lee.jones@linaro.org> References: <20200630133345.2232932-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 Kerneldoc expects struct properties to be documented using the syntax '@.*: ', but no '@' has been provided in 'struct syscon_gpio_data's header. Add them to stop confusing kerneldoc. Fixes the following W=1 warnings: drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'compatible' not described in 'syscon_gpio_data' drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'flags' not described in 'syscon_gpio_data' drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'bit_count' not described in 'syscon_gpio_data' drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'dat_bit_offset' not described in 'syscon_gpio_data' drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'dir_bit_offset' not described in 'syscon_gpio_data' drivers/gpio/gpio-syscon.c:48: warning: Function parameter or member 'set' not described in 'syscon_gpio_data' Cc: Alexander Shiyan Signed-off-by: Lee Jones --- drivers/gpio/gpio-syscon.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) -- 2.25.1 diff --git a/drivers/gpio/gpio-syscon.c b/drivers/gpio/gpio-syscon.c index 31f332074d7d5..fdd3d497b5350 100644 --- a/drivers/gpio/gpio-syscon.c +++ b/drivers/gpio/gpio-syscon.c @@ -24,16 +24,16 @@ /** * struct syscon_gpio_data - Configuration for the device. - * compatible: SYSCON driver compatible string. - * flags: Set of GPIO_SYSCON_FEAT_ flags: + * @compatible: SYSCON driver compatible string. + * @flags: Set of GPIO_SYSCON_FEAT_ flags: * GPIO_SYSCON_FEAT_IN: GPIOs supports input, * GPIO_SYSCON_FEAT_OUT: GPIOs supports output, * GPIO_SYSCON_FEAT_DIR: GPIOs supports switch direction. - * bit_count: Number of bits used as GPIOs. - * dat_bit_offset: Offset (in bits) to the first GPIO bit. - * dir_bit_offset: Optional offset (in bits) to the first bit to switch + * @bit_count: Number of bits used as GPIOs. + * @dat_bit_offset: Offset (in bits) to the first GPIO bit. + * @dir_bit_offset: Optional offset (in bits) to the first bit to switch * GPIO direction (Used with GPIO_SYSCON_FEAT_DIR flag). - * set: HW specific callback to assigns output value + * @set: HW specific callback to assigns output value * for signal "offset" */