Commit 4ee383c7 authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman

usb: gadget: udc: pxa27x_udc: Fix a bunch of kerneldoc issues

Mostly bitrotted argument descriptions/names.  Also the removal
of a blank line in the middle of a kerneldoc header, which is
not allowed.

Fixes the following W=1 kernel build warning(s):

 drivers/usb/gadget/udc/pxa27x_udc.c:398: warning: Function parameter or member 'ep' not described in 'ep_write_UDCCSR'
 drivers/usb/gadget/udc/pxa27x_udc.c:398: warning: Excess function parameter 'udc' description in 'ep_write_UDCCSR'
 drivers/usb/gadget/udc/pxa27x_udc.c:479: warning: Function parameter or member 'udc' not described in 'set_ep0state'
 drivers/usb/gadget/udc/pxa27x_udc.c:479: warning: Excess function parameter 'dev' description in 'set_ep0state'
 drivers/usb/gadget/udc/pxa27x_udc.c:506: warning: Excess function parameter 'req' description in 'inc_ep_stats_reqs'
 drivers/usb/gadget/udc/pxa27x_udc.c:1476: warning: bad line:
 drivers/usb/gadget/udc/pxa27x_udc.c:1697: warning: Function parameter or member 'udc' not described in 'udc_enable'
 drivers/usb/gadget/udc/pxa27x_udc.c:1697: warning: Excess function parameter 'dev' description in 'udc_enable'
 drivers/usb/gadget/udc/pxa27x_udc.c:1750: warning: Function parameter or member 'g' not described in 'pxa27x_udc_start'
 drivers/usb/gadget/udc/pxa27x_udc.c:1750: warning: Excess function parameter 'bind' description in 'pxa27x_udc_start'
 drivers/usb/gadget/udc/pxa27x_udc.c:1784: warning: Excess function parameter 'driver' description in 'stop_activity'
 drivers/usb/gadget/udc/pxa27x_udc.c:1800: warning: Function parameter or member 'g' not described in 'pxa27x_udc_stop'
 drivers/usb/gadget/udc/pxa27x_udc.c:1800: warning: Excess function parameter 'driver' description in 'pxa27x_udc_stop'
 drivers/usb/gadget/udc/pxa27x_udc.c:2358: warning: Function parameter or member 'pdev' not described in 'pxa_udc_probe'
 drivers/usb/gadget/udc/pxa27x_udc.c:2358: warning: Excess function parameter '_dev' description in 'pxa_udc_probe'

Cc: Daniel Mack <daniel@zonque.org>
Cc: Haojian Zhuang <haojian.zhuang@gmail.com>
Cc: Robert Jarzmik <robert.jarzmik@free.fr>
Cc: Felipe Balbi <balbi@kernel.org>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200706133341.476881-7-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent b1e4d550
...@@ -386,7 +386,7 @@ static inline void udc_clear_mask_UDCCR(struct pxa_udc *udc, int mask) ...@@ -386,7 +386,7 @@ static inline void udc_clear_mask_UDCCR(struct pxa_udc *udc, int mask)
/** /**
* ep_write_UDCCSR - set bits in UDCCSR * ep_write_UDCCSR - set bits in UDCCSR
* @udc: udc device * @ep: udc endpoint
* @mask: bits to set in UDCCR * @mask: bits to set in UDCCR
* *
* Sets bits in UDCCSR (UDCCSR0 and UDCCSR*). * Sets bits in UDCCSR (UDCCSR0 and UDCCSR*).
...@@ -472,7 +472,7 @@ static int epout_has_pkt(struct pxa_ep *ep) ...@@ -472,7 +472,7 @@ static int epout_has_pkt(struct pxa_ep *ep)
/** /**
* set_ep0state - Set ep0 automata state * set_ep0state - Set ep0 automata state
* @dev: udc device * @udc: udc device
* @state: state * @state: state
*/ */
static void set_ep0state(struct pxa_udc *udc, int state) static void set_ep0state(struct pxa_udc *udc, int state)
...@@ -498,7 +498,6 @@ static void ep0_idle(struct pxa_udc *dev) ...@@ -498,7 +498,6 @@ static void ep0_idle(struct pxa_udc *dev)
/** /**
* inc_ep_stats_reqs - Update ep stats counts * inc_ep_stats_reqs - Update ep stats counts
* @ep: physical endpoint * @ep: physical endpoint
* @req: usb request
* @is_in: ep direction (USB_DIR_IN or 0) * @is_in: ep direction (USB_DIR_IN or 0)
* *
*/ */
...@@ -1473,7 +1472,6 @@ static void udc_disable(struct pxa_udc *udc); ...@@ -1473,7 +1472,6 @@ static void udc_disable(struct pxa_udc *udc);
* Context: any * Context: any
* *
* The UDC should be enabled if : * The UDC should be enabled if :
* - the pullup resistor is connected * - the pullup resistor is connected
* - and a gadget driver is bound * - and a gadget driver is bound
* - and vbus is sensed (or no vbus sense is available) * - and vbus is sensed (or no vbus sense is available)
...@@ -1688,7 +1686,7 @@ static void udc_init_data(struct pxa_udc *dev) ...@@ -1688,7 +1686,7 @@ static void udc_init_data(struct pxa_udc *dev)
/** /**
* udc_enable - Enables the udc device * udc_enable - Enables the udc device
* @dev: udc device * @udc: udc device
* *
* Enables the udc device : enables clocks, udc interrupts, control endpoint * Enables the udc device : enables clocks, udc interrupts, control endpoint
* interrupts, sets usb as UDC client and setups endpoints. * interrupts, sets usb as UDC client and setups endpoints.
...@@ -1732,8 +1730,8 @@ static void udc_enable(struct pxa_udc *udc) ...@@ -1732,8 +1730,8 @@ static void udc_enable(struct pxa_udc *udc)
/** /**
* pxa27x_start - Register gadget driver * pxa27x_start - Register gadget driver
* @g: gadget
* @driver: gadget driver * @driver: gadget driver
* @bind: bind function
* *
* When a driver is successfully registered, it will receive control requests * When a driver is successfully registered, it will receive control requests
* including set_configuration(), which enables non-control requests. Then * including set_configuration(), which enables non-control requests. Then
...@@ -1775,7 +1773,6 @@ static int pxa27x_udc_start(struct usb_gadget *g, ...@@ -1775,7 +1773,6 @@ static int pxa27x_udc_start(struct usb_gadget *g,
/** /**
* stop_activity - Stops udc endpoints * stop_activity - Stops udc endpoints
* @udc: udc device * @udc: udc device
* @driver: gadget driver
* *
* Disables all udc endpoints (even control endpoint), report disconnect to * Disables all udc endpoints (even control endpoint), report disconnect to
* the gadget user. * the gadget user.
...@@ -1792,7 +1789,7 @@ static void stop_activity(struct pxa_udc *udc) ...@@ -1792,7 +1789,7 @@ static void stop_activity(struct pxa_udc *udc)
/** /**
* pxa27x_udc_stop - Unregister the gadget driver * pxa27x_udc_stop - Unregister the gadget driver
* @driver: gadget driver * @g: gadget
* *
* Returns 0 if no error, -ENODEV, -EINVAL otherwise * Returns 0 if no error, -ENODEV, -EINVAL otherwise
*/ */
...@@ -2349,7 +2346,7 @@ MODULE_DEVICE_TABLE(of, udc_pxa_dt_ids); ...@@ -2349,7 +2346,7 @@ MODULE_DEVICE_TABLE(of, udc_pxa_dt_ids);
/** /**
* pxa_udc_probe - probes the udc device * pxa_udc_probe - probes the udc device
* @_dev: platform device * @pdev: platform device
* *
* Perform basic init : allocates udc clock, creates sysfs files, requests * Perform basic init : allocates udc clock, creates sysfs files, requests
* irq. * irq.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment