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: 231491 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp2595713ilg; Fri, 3 Jul 2020 10:43:47 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxLoPgwCmlyG9YmhuIib7yPJVbtCsulsdD7kTmNyCGHcxph/1lhE2hZlVXCjFTdWSochVUf X-Received: by 2002:a50:cf09:: with SMTP id c9mr64940edk.90.1593798227319; Fri, 03 Jul 2020 10:43:47 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593798227; cv=none; d=google.com; s=arc-20160816; b=T3lQiQP+R7+P/Rn6PmLUVtDEGRuhHK15Nmp8kjg1M7u3vcW9881BwgToO47phRGWi5 dieCTm9zOFbMkhwFFQrvtrypJBRNveSKRykog6qA03m4OPJVdzlkOr41lyDzWdUFu/VV xD3CaG+kofdOWE/pQr2mUGogH+XeOO3C6Oy/mT6TjCa/XXf+CSrZRj1N+AnWUD/PV6By XAp4CNRCUmoLwOCTfD9WxXAjpFgxD63BO/xQRAFCNX2DLmUY9E8KZ/8uIwWl2ziVSq4w xqL9vlJ1yJBAoBfVjDc2AedQCJobeBUshk9Zmltfv1nHhQz2ap8DUJZ/01HScAfVAxll eEDA== 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=ObQbMmeWDMLVhtsXWDC1B0aBD5PkI/uWeU7dXCk6FlM=; b=bBNsyUMnf4xKhCS4WKELQPLs7uXocbb+jjCdgr1FNemH9t9ySUz10hZ5HDyOuTt1cn 00Etjt6z7YCpOvs8Nha3gqLRjQpDUbvadXFyooZONjl9lHjDT+b0JrfAhmZgxjflI4sz zxGAqx6V4ta1L0im68JGIrAQSqVUKyfeEy5rKavG6UaPMBshO1cK1sVflOsZIpEDJjhO +SVKo74ciRojkZN5e3ySohvP1sxnQNzFKD6dBE9BJW2LIyJ5+escIQnYWdHmjSF2E7FS Xc+DQxECHsloA/fYCRplphtRrxVC88vn6hffpv4EoMeEG4cHReO3wAWcSCEQLh4KHRdy sItA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=jn2FpAOU; spf=pass (google.com: domain of linux-usb-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-usb-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 e20si8186762edy.5.2020.07.03.10.43.47; Fri, 03 Jul 2020 10:43:47 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-usb-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=jn2FpAOU; spf=pass (google.com: domain of linux-usb-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-usb-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 S1726953AbgGCRmq (ORCPT + 5 others); Fri, 3 Jul 2020 13:42:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44554 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726942AbgGCRmn (ORCPT ); Fri, 3 Jul 2020 13:42:43 -0400 Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5E901C061794 for ; Fri, 3 Jul 2020 10:42:43 -0700 (PDT) Received: by mail-wm1-x341.google.com with SMTP id o8so32745955wmh.4 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=tKqyMJ19nxYBk2Mue9k/Rqua0atBvldyvQTFtmucGmE5uA4hPhGDTyuIJ73iMvKoC0 PXF/vl3NNc4yQ0e1VQPeYnL3xO82oTQog4MctlCbi1f04pfnldZVAcA73WNAjm+ZU8/3 5TDZ2kgiQiJCg8v1wR0aOEksE6nz/0J5Al5IBDikuItrSLBC7GEA1JkVLCykuYYUkQMM l0Hka0tCQncUB9suvBm0961CNNX6BC75f+YdSXKWxTnNmM4go5t7JEJsyXluoCsVyVNi aZIQ/LhI6o2takbSG8CnhO7sbolWUD2OL4USGO7PtW/XIDsPiFI6rwdTk7ahj0F3Xoz1 Mm+g== X-Gm-Message-State: AOAM530Av895/U9esKhE5LSnWWOnErOc5Hc2oRxYdIJ2kInPgTD25Lcc j+K0rJWkhO+eRjcHrIcET6JSNg== 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 Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Lee Jones , Peter Chen 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 Sender: linux-usb-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-usb@vger.kernel.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(-) -- 2.25.1 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