From patchwork Fri Jul 3 17:41:35 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11642547 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 6482560D for ; Fri, 3 Jul 2020 17:47:32 +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 04D912084C for ; Fri, 3 Jul 2020 17:47:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="SZC2xb7o"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="jn2FpAOU" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 04D912084C 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=lfPeVvLZwG8lSljkl7gZPmfC+4UrSUJosabRhrOqcJc=; b=SZC2xb7ou6C+tDQVJe3Xd4lI2 WiSZSzKv5eLUQDDj099RnzWWC6OWeRfnEfqFZR0OUu37Jcfa+gvSwAan8bNKk/O1S4/p5o5L9+k7F ZViD+trWWL/wsV5WLJHejt1wAZ7CRx5l3JXRMjkjfoHNnpI010L7RpN+xObh+FVwZ54z1JiDiQ9aE eGswyybvc+1zrNzdm3T0iuopp3bkVDNAZjHWEJRCG9sGu+Vh0S9Se7p5bkefc8JTKDGeHTD4IY+sF Qcb3cYvJpvg98x15ypaFDyXoaLy4RF5fCq6z9yRxhdw2A32c7C1OcsDR+CkmWNildE4EWnzla22q8 /ocwO3mKw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jrPkc-0003xv-CQ; Fri, 03 Jul 2020 17:45:26 +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 1jrPi0-0002Ck-5I for linux-arm-kernel@lists.infradead.org; Fri, 03 Jul 2020 17:42:47 +0000 Received: by mail-wm1-x341.google.com with SMTP id q15so32756687wmj.2 for ; Fri, 03 Jul 2020 10:42:43 -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=ObQbMmeWDMLVhtsXWDC1B0aBD5PkI/uWeU7dXCk6FlM=; b=jn2FpAOUPnZM069KYrVVfbxt1St8s7u9aejs2316lLyFC8QicNEuaQpIqyiqJJoy6C O4vsFZ6bk3aach7toVLh8omoClMF7OLDlCzPYK4eWBpCVKSUQlWr5i1G/rLt2i8/VweZ sSg80UU1XpFSFVcxfOxDpnl/9ztoRoZmbt6zAOJ2u3FhcuWqSgpehMIFMtWHfBUA0xXX ikyr40G5+YBJtgJcJXPwZzwN9sk6THJMUK1RommOcPasQY+6xFoT5k9uRBU1A0uAVrAg g7qf2oq6gxZeeX09UgLWhVJ/wmtYGjB6Qg8WuTAh9AXezXcLDgyH62NaLTcw/cIpj1yF 1MrQ== 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=ObQbMmeWDMLVhtsXWDC1B0aBD5PkI/uWeU7dXCk6FlM=; b=WBRqLzBXi0dLCiaothZBx/KT21Yge6/AZRxbFCJNozEo+3HFzNFRYBYVbI4FedCbzG RKZ++nXW6kt4gCT+3pjG6uOZFOVtcFcf7E0aTd0Gs+O167nmSUABKFuIR4VtRytaoIA4 fH8O30gx8lTO3Yo0xUhA0L4zCgAnNj+XfJLH3rxPBN9n4brI/dJJbN47iEJlmdJQkgvt AAFl//g2FcsebMIkl17/KRL5Qmmpsd1GCtOF4nWYEB1sVsvjCkmXxptZH/2UAOTOhph4 JPj5dC1WqTPsB4SPeBLPUcpQcMIVjasYltTMZHifL2ao8yNlPhsFwFJJxMp6GzV3TLai yldg== X-Gm-Message-State: AOAM531Zl63RoFn5YdLCMHKvFWjp/UhJhBP+MvcPgS+Wa/B6GgSnrmCa zVX3vH8oO4eHIzF8siBijQZNCg== X-Google-Smtp-Source: ABdhPJztrlr52atDjF3/+UOTLHYOF7+PmOGAz6sBBDjCc2z9cg29j3l9cqY7+6NiEdsJROG6JiGr7w== X-Received: by 2002:a1c:9a02:: with SMTP id c2mr8729231wme.16.1593798162149; Fri, 03 Jul 2020 10:42:42 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id x11sm13625799wmc.26.2020.07.03.10.42.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Jul 2020 10:42:41 -0700 (PDT) From: Lee Jones To: gregkh@linuxfoundation.org, linux-usb@vger.kernel.org Subject: [PATCH 17/30] usb: chipidea: udc: Fix a few kerneldoc issues Date: Fri, 3 Jul 2020 18:41:35 +0100 Message-Id: <20200703174148.2749969-18-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_134244_469888_169895B3 X-CRM114-Status: GOOD ( 12.82 ) 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 Descriptions were missing for 'ci' almost throughout. There was one instance of over-documenting. Finally one function argument was incorrectly documented (probably down to bitrot). Fixes the following W=1 kernel build warning(s): drivers/usb/chipidea/udc.c:245: warning: Function parameter or member 'ci' not described in 'hw_port_is_high_speed' drivers/usb/chipidea/udc.c:271: warning: Function parameter or member 'ci' not described in 'hw_test_and_clear_intr_active' drivers/usb/chipidea/udc.c:285: warning: Function parameter or member 'ci' not described in 'hw_test_and_clear_setup_guard' drivers/usb/chipidea/udc.c:296: warning: Function parameter or member 'ci' not described in 'hw_test_and_set_setup_guard' drivers/usb/chipidea/udc.c:321: warning: Function parameter or member 'ci' not described in 'hw_usb_reset' drivers/usb/chipidea/udc.c:628: warning: Excess function parameter 'ci' description in 'free_pending_td' drivers/usb/chipidea/udc.c:655: warning: Function parameter or member 'hwep' not described in '_hardware_dequeue' drivers/usb/chipidea/udc.c:655: warning: Excess function parameter 'gadget' description in '_hardware_dequeue' Cc: Peter Chen Signed-off-by: Lee Jones --- drivers/usb/chipidea/udc.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/drivers/usb/chipidea/udc.c b/drivers/usb/chipidea/udc.c index 0dfbc31843fc8..6a20ef396543b 100644 --- a/drivers/usb/chipidea/udc.c +++ b/drivers/usb/chipidea/udc.c @@ -238,6 +238,7 @@ static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value) /** * hw_is_port_high_speed: test if port is high speed + * @ci: the controller * * This function returns true if high speed port */ @@ -264,6 +265,7 @@ static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n) /** * hw_test_and_clear_intr_active: test & clear active interrupts (execute * without interruption) + * @ci: the controller * * This function returns active interrutps */ @@ -278,6 +280,7 @@ static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci) /** * hw_test_and_clear_setup_guard: test & clear setup guard (execute without * interruption) + * @ci: the controller * * This function returns guard value */ @@ -289,6 +292,7 @@ static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci) /** * hw_test_and_set_setup_guard: test & set setup guard (execute without * interruption) + * @ci: the controller * * This function returns guard value */ @@ -314,6 +318,7 @@ static void hw_usb_set_address(struct ci_hdrc *ci, u8 value) /** * hw_usb_reset: restart device after a bus reset (execute without * interruption) + * @ci: the controller * * This function returns an error code */ @@ -621,7 +626,6 @@ static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq) /** * free_pending_td: remove a pending request for the endpoint - * @ci: the controller * @hwep: endpoint */ static void free_pending_td(struct ci_hw_ep *hwep) @@ -646,7 +650,7 @@ static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep, /** * _hardware_dequeue: handles a request at hardware level - * @gadget: gadget + * @hwep: endpoint * @hwreq: request * * This function returns an error code