From patchwork Thu Jul 2 14:46:08 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11639183 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 3B6D813B4 for ; Thu, 2 Jul 2020 14:51:06 +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 139C720780 for ; Thu, 2 Jul 2020 14:51:06 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="SxJe9cWh"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="MnIF3NKM" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 139C720780 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=Dtd/fHZ3T7JN3c5RuEK/asZcqkXO4G372PLxTs4L37c=; b=SxJe9cWhsSj6nqUnuLnR5k2w1 fErf6tC5eCdGOyo31QZNjMPWC1tOtxiuB78zwTc9TKQNpDxmGRxS377VgT/PqMxdptBTSkjoyeGDT tDssuxtIH9GuflR9P0u+V9OJCb6I8pAn2wOkl5Yq5sovUG9KFDaA/z2+sI5SSOTQSwamuk3WQpoHl /aR9wZx8pc+u6HTi1rIDy8AX1CQ9PnFZu0davw3vEl+2Hvtk4EVzNe+M7ZDcX4SWdF8tKSNa1j5wJ wzsnLh4gi7AUjPbiLAiyCZZni1E4dAaPUnovoUMNVX1Yj3GwUqfr6ogUAnRbOGPjw+ms2rV8S7uIZ 12OArNFSg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jr0WD-0006S3-NA; Thu, 02 Jul 2020 14:48:53 +0000 Received: from mail-wm1-x342.google.com ([2a00:1450:4864:20::342]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jr0UD-0005J8-G9 for linux-arm-kernel@lists.infradead.org; Thu, 02 Jul 2020 14:46:50 +0000 Received: by mail-wm1-x342.google.com with SMTP id j18so27093940wmi.3 for ; Thu, 02 Jul 2020 07:46:49 -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=A68m/4vXtRoEt+tCUl/deoA+S6NQ0dzD0za0e2IsKFc=; b=MnIF3NKMeHllD9bTiFG/UBWre8WcWJwn5Gs+iOqWaPWWVSs3Fmue2tnex/eI8nRqPE XQauSD7JfNVMRzo5iKgnr8oq0f8dcrGaXVQgT+wgmvxBBPLfRQpEcxBSpsifs7sxW9TI y7LrKuy/z5fGS7KaetA8KIHoBZ1xNWSKfbioR04TI5jOLFjaaMAUV6foseYp2OYdkRM4 1Z0jBQW5Nt733Tztd5Mv871YZPC7G+E2gk7GlaK964bTvoaRTTMT0v5Op/LxtOUhhyPI eeWnTopVRGYVBugAlMM1Yaopc5tKTEPkusEWAxPsCNUFafsAbuPDdUnPwlEpVSXqMaMZ sQYA== 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=A68m/4vXtRoEt+tCUl/deoA+S6NQ0dzD0za0e2IsKFc=; b=iJ1Mf+O9fztlz9BhyjEzfD8Mv86UwwziTQ7jXy8JmcijuR1UXvNmsxKQxdenSVVOvc xYYZYinmOFFl363iftMhyfXJ722HVMZ3ynDC5p9uOAozxBn/3tgjh4m1YEfn6dSwq60D yL3rmnA2T0h5xvuTP5TGpF89cI3wFxaPK+b3dS3fLi7z0MFoVJq/JlIlG5drKWd2nM9H 5/zbqDspnNGF7zDuXz9GR3UDk7WMWL6OafLDQWQG90/pE1nrR479b5EoWjyBm+iSPpdq pqRZJJTQu7PiOOWo8DS5nvR3eG4JuvKTPWN/5UgUIukYcKfNNziYLWUtr+pcY65pqKlI XRvA== X-Gm-Message-State: AOAM530OQsS372hfqffArwIXrrdU+MsD09b13IGEQxzkucJlHDhQcT7I U131Xw7U32cbSeb3GdIKO3M0Wg== X-Google-Smtp-Source: ABdhPJw/XS4Q1S0GGevj+ph6k6w1go7mzC+xGwxs/OouigSO7U4rDiQ8fCZ+aBU/5fV4s1OKUk6Idg== X-Received: by 2002:a7b:c5c7:: with SMTP id n7mr32283737wmk.77.1593701208260; Thu, 02 Jul 2020 07:46:48 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id g14sm7002737wrw.83.2020.07.02.07.46.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 02 Jul 2020 07:46:47 -0700 (PDT) From: Lee Jones To: gregkh@linuxfoundation.org Subject: [PATCH 13/30] usb: cdns3: core: Fix incorrect formatting and misspelled function arg docs Date: Thu, 2 Jul 2020 15:46:08 +0100 Message-Id: <20200702144625.2533530-14-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_104649_632751_9E1150BB X-CRM114-Status: GOOD ( 11.42 ) 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:342 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 , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, Lee Jones , linux-arm-kernel@lists.infradead.org, Roger Quadros Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org There are 3 misspellings and 1 incorrect format used in this file's kerneldoc function headers. Fixing them squashes the following W=1 kernel 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: Peter Chen Cc: Roger Quadros Signed-off-by: Lee Jones --- drivers/usb/cdns3/core.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/drivers/usb/cdns3/core.c b/drivers/usb/cdns3/core.c index 19bbb5b7e6b6c..59e5e213a99bb 100644 --- a/drivers/usb/cdns3/core.c +++ b/drivers/usb/cdns3/core.c @@ -282,7 +282,7 @@ static int cdns3_idle_init(struct cdns3 *cdns) /** * cdns3_hw_role_switch - switch roles based on HW state - * @cdns3: controller + * @cdns: controller */ int cdns3_hw_role_switch(struct cdns3 *cdns) { @@ -320,7 +320,7 @@ int cdns3_hw_role_switch(struct cdns3 *cdns) /** * cdsn3_role_get - get current role of controller. * - * @dev: Pointer to device structure + * @sw: pointer to USB role switch structure * * Returns role */ @@ -334,8 +334,8 @@ static enum usb_role cdns3_role_get(struct usb_role_switch *sw) /** * cdns3_role_set - set current role of controller. * - * @dev: pointer to device object - * @role - the previous role + * @sw: pointer to USB role switch structure + * @role: the previous role * Handles below events: * - Role switch for dual-role devices * - USB_ROLE_GADGET <--> USB_ROLE_NONE for peripheral-only devices