From patchwork Fri Jul 3 17:41:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11642531 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 1273D60D for ; Fri, 3 Jul 2020 17:45:26 +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 DF0D620723 for ; Fri, 3 Jul 2020 17:45:25 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="xdMtmvFj"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="oiU0dmtO" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DF0D620723 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=58NFqXTYFAcKcOJBQL6fzmld+qUgkvqy1pLy+Y0IY10=; b=xdMtmvFjx8yskAVZUpgz3bJYp HPNr64fodBLF6SQn1+vEsHoYEip9efPG5la7K+T/o/APwtBPkuyfVNKpClJLzIAS9FUs7yllQMVKn 4LBWc2NTTwYKvBwn+OZ1YExev/M9yPOlnQ6mriOhJTGPz8RUqbohTnLzPJIbr7wFasd9aiw1shzHb V7vUMR5EqjoOg8HOJDsXeAYitSYrGW/qpi9hozMf3coIb2CUB05iOk48uVA7TK3f2FRNwR2gu5PMr RHhSPd770AFNd8/6hNGNKM1lVshsiPUqwiLepv0WmQlKdXVGdONTUl8TUJxXFOGUE49r+ig/zePz1 7rs1dgYvA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jrPiT-0002TB-0C; Fri, 03 Jul 2020 17:43:13 +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 1jrPhT-0001w2-4o for linux-arm-kernel@lists.infradead.org; Fri, 03 Jul 2020 17:42:12 +0000 Received: by mail-wm1-x344.google.com with SMTP id w3so22419892wmi.4 for ; Fri, 03 Jul 2020 10:42:11 -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=xjIIWeYNclz40pA7bk2Qh3oqQG2tAVOyN4aYQkn6OiY=; b=oiU0dmtOVMkBf6TzSeh/ny3md+5yRm4OM/IM4zkiiOFwgo/Qi47cQKLIay8N30COvv nFCgi9+MuTJUdQoM+EYjFAVSSXHFDahthwfrL2L0uG8tX9INuhlJ7/cmRhrmdxrLtuFz oJKhV9g+/B0+eQoFWwl2PcOTlD1idbOo5vbWQavXnyYORLwCMEqSIw3W8buDHcalnHaF MERyReX3fR+NEYYYVX4PHBzMSPy0uiKfTR+qpcIAq0s5oyM5UQiVkJVZ3hVqKAq+kN3d XFrtBQe2kaUyEK2PovU4zqVElnVtkGu+bfCfgt47nCsd0sAKqBjbKOLLmRrOqVDszAd0 jxjQ== 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=xjIIWeYNclz40pA7bk2Qh3oqQG2tAVOyN4aYQkn6OiY=; b=BaVioaaH25AT6XpSRZOe7OePT0WOSH4oB+MVr+eQ1/fhxdkgRPGBwq2BxUBKjbTl1W o8n1as1V9YqzzqpCmKq+BL4qQM7Qem2iboM5XhJ/DeoLkMrybmN3MpR6lImGe0RCdVlV d5PmYh5hzZmcr6LVof1NEAxrG5zRbYniP0kFG6sxGQCBVaxVXrGR8ONONwooLaiEzaDD U6kNhU/dNhsouD1YWdAuvImKuejotWLXy0h4b7XTfcDKCBZTsjJU7xAC4hVN4wdkncOs QRSFocaxT5jgz2Xv9QN1Kum2f+TvCuALntk81bvGVErVd6kIgpSVSODiMD2ORNI2fwBT 8QoA== X-Gm-Message-State: AOAM531RdEVz0f2xPeODzp27QwD53ATRvf7cOVuNnQFwd3oyEHnEAVHA cphaxU4xsRi31x0o1hWD+bKurQ== X-Google-Smtp-Source: ABdhPJw4mjZPthdniRStWHtZC5npFeRT01E/oMZEzrllITbRXHeQCaCUndaY9yDxanGEL4ylb/oaYg== X-Received: by 2002:a7b:c14a:: with SMTP id z10mr36486119wmi.19.1593798130185; Fri, 03 Jul 2020 10:42:10 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id x11sm13625799wmc.26.2020.07.03.10.42.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Jul 2020 10:42:09 -0700 (PDT) From: Lee Jones To: gregkh@linuxfoundation.org, linux-usb@vger.kernel.org Subject: [PATCH 08/30] usb: gadget: udc: core: Fix a bunch of kerneldoc misdemeanours Date: Fri, 3 Jul 2020 18:41:26 +0100 Message-Id: <20200703174148.2749969-9-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_134211_261188_CEFF529D X-CRM114-Status: GOOD ( 17.43 ) 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_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: Felipe Balbi , 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, file headers should not be in kerneldoc format. Function args should be in the format '@.*: '. We also take the time to add some descriptions for various argument which have been previously left out. Finally we remove descriptions for absent arguments. Fixes the following W=1 kernel build warning(s): drivers/usb/gadget/udc/core.c:25: warning: Incorrect use of kernel-doc format: * struct usb_udc - describes one usb device controller drivers/usb/gadget/udc/core.c:36: warning: cannot understand function prototype: 'struct usb_udc ' drivers/usb/gadget/udc/core.c:901: warning: Function parameter or member 'ep' not described in 'usb_gadget_giveback_request' drivers/usb/gadget/udc/core.c:901: warning: Function parameter or member 'req' not described in 'usb_gadget_giveback_request' drivers/usb/gadget/udc/core.c:1098: warning: Function parameter or member 'udc' not described in 'usb_gadget_udc_stop' drivers/usb/gadget/udc/core.c:1098: warning: Excess function parameter 'gadget' description in 'usb_gadget_udc_stop' drivers/usb/gadget/udc/core.c:1098: warning: Excess function parameter 'driver' description in 'usb_gadget_udc_stop' Cc: Felipe Balbi Signed-off-by: Lee Jones --- drivers/usb/gadget/udc/core.c | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/drivers/usb/gadget/udc/core.c b/drivers/usb/gadget/udc/core.c index 2e28dde8376f6..16790c02a530c 100644 --- a/drivers/usb/gadget/udc/core.c +++ b/drivers/usb/gadget/udc/core.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * udc.c - Core UDC Framework * * Copyright (C) 2010 Texas Instruments @@ -23,11 +23,11 @@ /** * struct usb_udc - describes one usb device controller - * @driver - the gadget driver pointer. For use by the class code - * @dev - the child device to the actual controller - * @gadget - the gadget. For use by the class code - * @list - for use by the udc class driver - * @vbus - for udcs who care about vbus status, this value is real vbus status; + * @driver: the gadget driver pointer. For use by the class code + * @dev: the child device to the actual controller + * @gadget: the gadget. For use by the class code + * @list: for use by the udc class driver + * @vbus: for udcs who care about vbus status, this value is real vbus status; * for udcs who do not care about vbus status, this value is always true * * This represents the internal data structure which is used by the UDC-class @@ -891,6 +891,9 @@ EXPORT_SYMBOL_GPL(usb_gadget_unmap_request); /** * usb_gadget_giveback_request - give the request back to the gadget layer + * @ep: the endpoint to be used with with the request + * @req: the request being given back + * * Context: in_interrupt() * * This is called by device controller drivers in order to return the @@ -1084,8 +1087,7 @@ static inline int usb_gadget_udc_start(struct usb_udc *udc) /** * usb_gadget_udc_stop - tells usb device controller we don't need it anymore - * @gadget: The device we want to stop activity - * @driver: The driver to unbind from @gadget + * @udc: The UDC to be stopped * * This call is issued by the UDC Class driver after calling * gadget driver's unbind() method.