From patchwork Fri Jul 3 17:41:27 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11642529 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 77CAF6C1 for ; Fri, 3 Jul 2020 17:45:19 +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 4D41120723 for ; Fri, 3 Jul 2020 17:45:19 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="PFwRZlVM"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="wq2eX9jG" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 4D41120723 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=kIYM2BcuvXhrHyJtKkSWVAK1b1VgWhkgSf9F3mahffY=; b=PFwRZlVMLhDzES07F5R9yZIWE GK9cl0MwHkI8hkgiE5SbHa9rZvT6jTLkzuqBczJvFgMx8fAQT4PP1gSPNl9yQyBntySEdj9OBL/BE 33mFedNc8EmfBVfoLQ9oQ8X8TJw2om0iYMrzSGEe+pA6GhmR8ArfywW1hfaaDopH/2Q2LLlBdiELW eXoCq6YvsS5hvYgW5NrLWGHxBzCMzhQU1lSr1py83E/AvxlOQTu8Bt/PrXA8LQHBuJQyv3FNy1s9F hDYb58ok+UJSmsxq3uzKeRaPYNchAqlKSIfoOhljltODgKGHGDYHskRHovj6LsLxBCZG7EaJb5aBi eKXNhX8bQ==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jrPie-0002YK-Pc; Fri, 03 Jul 2020 17:43:25 +0000 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jrPhV-0001xT-TG for linux-arm-kernel@lists.infradead.org; Fri, 03 Jul 2020 17:42:15 +0000 Received: by mail-wm1-x341.google.com with SMTP id g75so32748025wme.5 for ; Fri, 03 Jul 2020 10:42:13 -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=xrkMNgFq6kjSqpaCA+XSVAlQbJi5HEny4uddp4894Fo=; b=wq2eX9jGfiXqkmXfLTj6mEEM2DpZg01ZXm7M/28lM017rbrQHv08Hx3W5hVLkdvmFs cvQdic5dr1Kq+Q9SQvJOlJ0Um9yIR+Y5uLRgIgCiIyPKB+8SrlN67FMkH9I8POq9Tl99 +hMw+MdBOJx/zy0bvat2TNmCBkFSWbZmsToJ9vMSa5EOAXM8Car+SJkpsfivOXFgNdE/ 6OAuqi/2/eHEu3UadPeyfjssCvcTNhCKm7ljorj8hYXKdL8F5lln2bdGPwryANInysfn p6uUI7Z/tSUbPtLZ/HmaXeu93dZ6mryZK5EOYSHV/jxy8VcCQlvYpf7cgzBj9yLjwsAv LKiA== 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=xrkMNgFq6kjSqpaCA+XSVAlQbJi5HEny4uddp4894Fo=; b=nYGGSLlRYxEx9C/h70VARJz5uD8a+aWUAJ3AQEmiaIgRTwERKIrPienfZPE78d6eo+ KYl44sYiU54YZ1xLPkvmhnS9mD1/xfEjzqrxIUhxWnP3bB9Jp6fdpKn3kELpPWSq6T2F 2JgOp3BfJw6/l0NZGStoDvFoNNl22sJ/v5nU1qR/sw9z7gGA70ohfHT5ZXSQ0n2IShaZ D9S4A+3cIc3CtF1PFhfPWIPIe2BS/Hb0T22YvcbW20TFAGfzkA7vN9EPchMAjColYGO+ L+WlZYZ7047Xh9Lyzfnv0KZNl1IfmAd3xwzFMSUz7wogjF7imC2ygw+LKsyhbMqbf+hp 6FGw== X-Gm-Message-State: AOAM531FEyLd2LTiX4Bc7zbtL5LQpqxizU0mG4hRcQAxpRa+fopXALhK +rvDeAiA/708mbG3T8m4iKX/zw== X-Google-Smtp-Source: ABdhPJxF4+w/X3XbjJY6K8JuqOts4/0aCaGlb0DEvCdqQgBeAb0DrB1QpZ3cPKmGntf65MNAAWWkgQ== X-Received: by 2002:a7b:c041:: with SMTP id u1mr39858082wmc.56.1593798132797; Fri, 03 Jul 2020 10:42:12 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id x11sm13625799wmc.26.2020.07.03.10.42.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Jul 2020 10:42:12 -0700 (PDT) From: Lee Jones To: gregkh@linuxfoundation.org, linux-usb@vger.kernel.org Subject: [PATCH 09/30] usb: chipidea: otg: Fix kerneldoc issues relating to description of 'ci' Date: Fri, 3 Jul 2020 18:41:27 +0100 Message-Id: <20200703174148.2749969-10-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200703174148.2749969-1-lee.jones@linaro.org> References: <20200703174148.2749969-1-lee.jones@linaro.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200703_134214_050322_6EAB7A30 X-CRM114-Status: GOOD ( 11.48 ) 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:341 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 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 -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain 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: Peter Chen , 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 Firstly we add some missing descriptions. Then we fix some formatting issues. Kerneldoc expects arguments to be in the format '@.*: '. If either the '@' or ':' is omitted, kerneldoc gets confused. Fixes the following W=1 kernel build warning(s): drivers/usb/chipidea/otg.c:29: warning: Function parameter or member 'ci' not described in 'hw_read_otgsc' drivers/usb/chipidea/otg.c:82: warning: Function parameter or member 'ci' not described in 'hw_write_otgsc' drivers/usb/chipidea/otg.c:235: warning: Function parameter or member 'ci' not described in 'ci_hdrc_otg_init' drivers/usb/chipidea/otg.c:254: warning: Function parameter or member 'ci' not described in 'ci_hdrc_otg_destroy' Cc: Peter Chen Signed-off-by: Lee Jones --- drivers/usb/chipidea/otg.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/drivers/usb/chipidea/otg.c b/drivers/usb/chipidea/otg.c index be63924ea82ef..d3aada3ce7ec2 100644 --- a/drivers/usb/chipidea/otg.c +++ b/drivers/usb/chipidea/otg.c @@ -23,6 +23,7 @@ /** * hw_read_otgsc returns otgsc register bits value. + * @ci: the controller * @mask: bitfield mask */ u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask) @@ -75,6 +76,7 @@ u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask) /** * hw_write_otgsc updates target bits of OTGSC register. + * @ci: the controller * @mask: bitfield mask * @data: to be written */ @@ -229,7 +231,7 @@ static void ci_otg_work(struct work_struct *work) /** * ci_hdrc_otg_init - initialize otg struct - * ci: the controller + * @ci: the controller */ int ci_hdrc_otg_init(struct ci_hdrc *ci) { @@ -248,7 +250,7 @@ int ci_hdrc_otg_init(struct ci_hdrc *ci) /** * ci_hdrc_otg_destroy - destroy otg struct - * ci: the controller + * @ci: the controller */ void ci_hdrc_otg_destroy(struct ci_hdrc *ci) {