From patchwork Thu Jul 2 14:46:12 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11639191 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 A9A166C1 for ; Thu, 2 Jul 2020 14:52: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 8270A20771 for ; Thu, 2 Jul 2020 14:52: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="vq/M3fbs"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="cIkTP97L" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 8270A20771 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=MR1puET0Teos6nYRuBdCMWodemVHYjFgiwyWBaJ6Ht4=; b=vq/M3fbsh5u9Gam8/UkTH531L SapuV5kJ4Nh5OG/O2Um7Y+nzO3BTU4sDC8CI65Q1hVV8LxNRJ+81lTzKy8ml33gdPq7ssfmz7r3qA b77y4IyVZP5SBesJM2/0X5+CrlwAakXkUa1U6aQaYxdCxiO0Uyw+xV7SIuQsY2E/9fxkbYkx5W5lM CpiDfbptqgVAZGXdQrqnWnFPlCwZc1OUt3ZQEIHVTmtWwSWyjVkc7xMqv4w04En+2yFuGdXhhQx5b oBJAJ/ufiNQPohNtlanNGtMYgjvJgdnW5XBs2KXK1jx85h+oAvK2Rt0VpZHFuxuPdzsz9CQ5JWuwz WcRITUMhA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jr0XG-0007B1-4r; Thu, 02 Jul 2020 14:49:58 +0000 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jr0UI-0005MJ-7b for linux-arm-kernel@lists.infradead.org; Thu, 02 Jul 2020 14:46:55 +0000 Received: by mail-wm1-x344.google.com with SMTP id 22so27109873wmg.1 for ; Thu, 02 Jul 2020 07:46:54 -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=LuydmHRHncRiKpEKLiFPz7smS3ISdpVCQYiyoW4VCQc=; b=cIkTP97Ltc4F26LRPd0k0vH8rCSPhi/svFlkgm7iKd4rUBiebH/6UsCDSQMTEs+DqV DP49K7VEoXDEQN+3y9DARzbaESZ5W1uuHqmbciLtfPHolTD+ucYN8BVDgQfyKWGbO6HD 756KA9mM2iutxpw1ZJI7PuolhFV1232juQjtiTlEXKWJP33njo4EmHVOVLegPykn9Pat y/0yk4CPL7Cso65VaaRKexs5m2cpIXhiY2futiEY2jISvBCohLLdgn/Euz4eV2lRNfKB qHTdgXFbJnl4A+V4gHCMnLhhvAb2xZkinyaYH5F3rAEh7Tim5eHnqwp8tci0JCnaHOvh saCw== 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=LuydmHRHncRiKpEKLiFPz7smS3ISdpVCQYiyoW4VCQc=; b=E1YO6I8Bx3lSC20HDHJf9sKd4BxfeDypIXvwHMtrSCleDX4dvlN7Ix+WbYfOAbWkjO BqnYFvVbR6oc8J3EQLWSfvI0r67+cbsy/jhSkoNsc+a4nuuknUqkHKSbUsdpVqIRwauC ClZes44ypYZ27QR2beDu18DZ2v6ZsJ2Mjyd4WrkHzJL6NkVW04zgPth/f1XNzB/2NPaE 766ZuybSFO3MXBG1ICWcFEvSeFbC8XLKGhOpfhCTGogvfM16f9+VVMeUbe73BBe7PSFh 7M9YmX6tRg5aDAhuJA2ElAtePCw6uTbxe39qkzczb7qGImzeZNuaaATwdjwxv5cvNKQu z44g== X-Gm-Message-State: AOAM532BuJkY87Of+ccXQZohhxW2IXARwzVJB2uqJcOFd+e57xKcRGWr +0mHxuFmVx70r/FRpjTR1V/SPA== X-Google-Smtp-Source: ABdhPJwt4BB5QN+0+VYuAyZoPm9sDJXGV16TynQZBiUxLCJhmyDebIEU0rFkq/UKkGjxIQm03YHAJA== X-Received: by 2002:a1c:7402:: with SMTP id p2mr20867799wmc.117.1593701213215; Thu, 02 Jul 2020 07:46:53 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id g14sm7002737wrw.83.2020.07.02.07.46.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 02 Jul 2020 07:46:52 -0700 (PDT) From: Lee Jones To: gregkh@linuxfoundation.org Subject: [PATCH 17/30] usb: cdns3: gadget: Fix a bunch of kernel doc issues Date: Thu, 2 Jul 2020 15:46:12 +0100 Message-Id: <20200702144625.2533530-18-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200702144625.2533530-1-lee.jones@linaro.org> References: <20200702144625.2533530-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-20200702_104654_399478_0C66E61A X-CRM114-Status: GOOD ( 13.64 ) 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:344 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_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -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 , Pawel Laszczak , Pawel Jez , linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org, Lee Jones , 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 Mainline misspelled function argument descriptions. Also one formatting issue with a missing '@' identifier. Fixes the following W=1 build warnings: drivers/usb/cdns3/gadget.c:653: warning: Function parameter or member 'priv_ep' not described in 'cdns3_wa2_descmissing_packet' drivers/usb/cdns3/gadget.c:653: warning: Excess function parameter 'priv_dev' description in 'cdns3_wa2_descmissing_packet' drivers/usb/cdns3/gadget.c:1088: warning: Function parameter or member 'request' not described in 'cdns3_ep_run_transfer' drivers/usb/cdns3/gadget.c:2574: warning: Function parameter or member 'priv_ep' not described in '__cdns3_gadget_ep_set_halt' drivers/usb/cdns3/gadget.c:2574: warning: Excess function parameter 'ep' description in '__cdns3_gadget_ep_set_halt' drivers/usb/cdns3/gadget.c:2595: warning: Function parameter or member 'priv_ep' not described in '__cdns3_gadget_ep_clear_halt' drivers/usb/cdns3/gadget.c:2595: warning: Excess function parameter 'ep' description in '__cdns3_gadget_ep_clear_halt' drivers/usb/cdns3/gadget.c:2898: warning: Function parameter or member 'priv_dev' not described in 'cdns3_init_eps' drivers/usb/cdns3/gadget.c:2898: warning: Excess function parameter 'cdns3' description in 'cdns3_init_eps' drivers/usb/cdns3/gadget.c:3210: warning: Function parameter or member 'cdns' not described in 'cdns3_gadget_init' Cc: Pawel Laszczak Cc: Pawel Jez Cc: Peter Chen Signed-off-by: Lee Jones --- drivers/usb/cdns3/gadget.c | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c index 5e24c2e57c0d8..bfb1cbd492892 100644 --- a/drivers/usb/cdns3/gadget.c +++ b/drivers/usb/cdns3/gadget.c @@ -644,7 +644,7 @@ static void cdns3_wa2_remove_old_request(struct cdns3_endpoint *priv_ep) /** * cdns3_wa2_descmissing_packet - handles descriptor missing event. - * @priv_dev: extended gadget object + * @priv_ep: extended gadget object * * This function is used only for WA2. For more information see Work around 2 * description. @@ -1080,6 +1080,7 @@ static int cdns3_ep_run_stream_transfer(struct cdns3_endpoint *priv_ep, /** * cdns3_ep_run_transfer - start transfer on no-default endpoint hardware * @priv_ep: endpoint object + * @request: request object * * Returns zero on success or negative value on failure */ @@ -2568,7 +2569,7 @@ int cdns3_gadget_ep_dequeue(struct usb_ep *ep, /** * __cdns3_gadget_ep_set_halt Sets stall on selected endpoint * Should be called after acquiring spin_lock and selecting ep - * @ep: endpoint object to set stall on. + * @priv_ep: endpoint object to set stall on. */ void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep) { @@ -2589,7 +2590,7 @@ void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep) /** * __cdns3_gadget_ep_clear_halt Clears stall on selected endpoint * Should be called after acquiring spin_lock and selecting ep - * @ep: endpoint object to clear stall on + * @priv_ep: endpoint object to clear stall on */ int __cdns3_gadget_ep_clear_halt(struct cdns3_endpoint *priv_ep) { @@ -2890,7 +2891,7 @@ static void cdns3_free_all_eps(struct cdns3_device *priv_dev) /** * cdns3_init_eps Initializes software endpoints of gadget - * @cdns3: extended gadget object + * @priv_dev: extended gadget object * * Returns 0 on success, error code elsewhere */ @@ -3202,7 +3203,7 @@ static int cdns3_gadget_resume(struct cdns3 *cdns, bool hibernated) /** * cdns3_gadget_init - initialize device structure * - * cdns: cdns3 instance + * @cdns: cdns3 instance * * This function initializes the gadget. */