AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2024-12-28 11:18:45 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

usb: gadget: udc: core: Fix a bunch of kerneldoc misdemeanours

Browse Source 
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 <balbi@kernel.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200703174148.2749969-9-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Lee Jones 2020-07-03 18:41:26 +01:00 committed by Greg Kroah-Hartman
parent 8ac326ff5c
commit e21cd08f96
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
drivers/usb/gadget/udc/core.c
View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* udc.c - Core UDC Framework * udc.c - Core UDC Framework
* *
* Copyright (C) 2010 Texas Instruments * Copyright (C) 2010 Texas Instruments
@ -23,11 +23,11 @@
/** /**
* struct usb_udc - describes one usb device controller * struct usb_udc - describes one usb device controller
* @driver - the gadget driver pointer. For use by the class code * @driver: the gadget driver pointer. For use by the class code
* @dev - the child device to the actual controller * @dev: the child device to the actual controller
* @gadget - the gadget. For use by the class code * @gadget: the gadget. For use by the class code
* @list - for use by the udc class driver * @list: for use by the udc class driver
* @vbus - for udcs who care about vbus status, this value is real vbus status; * @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 * 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 * 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 * 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() * Context: in_interrupt()
* *
* This is called by device controller drivers in order to return the * 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 * usb_gadget_udc_stop - tells usb device controller we don't need it anymore
* @gadget: The device we want to stop activity * @udc: The UDC to be stopped
* @driver: The driver to unbind from @gadget
* *
* This call is issued by the UDC Class driver after calling * This call is issued by the UDC Class driver after calling
* gadget driver's unbind() method. * gadget driver's unbind() method.