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: 11633951 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 2DDB0174A for ; Tue, 30 Jun 2020 13:35:57 +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 06316206B6 for ; Tue, 30 Jun 2020 13:35:57 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="lJDmUBFC"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="LDOoBlOc" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 06316206B6 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=1mdlrrjdRJbeP3fy4j7Wx1D+bKN6SxVOAzIg8HFkrI4=; b=lJDmUBFC8KcFNb1QXQPEnz9Yx niQ5UUZ0EkInKatOFZvW4eM9SLQAJxXTAHc86N6K8fHNqHvij4QSOrvhUAwWrX1aESGnPVHEI6unr wjUSlrcdsTrwpxj7HV/aMYSe7rGPdpJqzMFHDPjpILZc+AKcshfba6aEVq78ar+ejv3fJJ9T/OfwQ /JRxFa5P6tQluUQEJWQ0PniI8B3GZAw32Ny5VuDv+Wc3s4TIAT1tIDe0eLA71RASnfZn5m5Qmpcs3 pBxKZg8PukrfTYCTNV7aQU90GHFep1+dTqk1Aw8de2zcrSoNjix2oVU1ocURHwqiODBapZ85RW9zV +YWMy8YTA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqGP3-0004Mx-Np; Tue, 30 Jun 2020 13:34:26 +0000 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jqGOa-0004ER-Nc for linux-arm-kernel@lists.infradead.org; Tue, 30 Jun 2020 13:33:57 +0000 Received: by mail-wr1-x442.google.com with SMTP id z15so8920185wrl.8 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=ChJxLh4NwT3BuJJev39UfIxSvB0SzoFSbyI2i5AazBSnsOrrahTrKW8vqY5+xzyqbn H30DGDatczfVrOPCE4xCta21SfLePAKxXq8B2Gzi9H0OtI2NALhJXHMz5jveHUk072QX LqNmkQXiX2MtiPuHLhkI+VnXmAwvqbvLlUnYaxKj9mW7lnJJWXzyQVvpYbMVa1lbUjxL pCftW1K99G26v8me74BEQhohT86dY2xVNEgzE8nCydgojZ/ZFtiuAbL3i4QPkfbMwBDv EwVGytvf9l7PHNJU7FtT4m2r+32cB/TXJ4N1QemcojV5o4DDjlIXkkrJtwAl7L0Q3BgY 5Ugg== X-Gm-Message-State: AOAM533F2AU7+1k87apedLmFLtzZIZnFebLqWnuRzP86vQ5Bz62x5scg jxw/wFgUUzg4y+mshbnWPepDdA== X-Google-Smtp-Source: ABdhPJyIWL/M5/vUrifTjtGsuJrzIOD9u8Z0C8MXhKYor95Ji0p/tqz8z4BB9eU13U9cbdzmuzJG4g== 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 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 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:442 listed in] [list.dnswl.org] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.0 SPF_PASS SPF: sender matches SPF record -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -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 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-gpio@vger.kernel.org, Alexander Shiyan , Lee Jones , linux-kernel@vger.kernel.org, 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 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(-) 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" */