[PATCH] usb: gadget: s3c-hsudc.c: fix kernel-doc warnings

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Also, fix a few minor typos.

Warning(drivers/usb/gadget/s3c-hsudc.c:118): No description found for parameter 'wedge'
Warning(drivers/usb/gadget/s3c-hsudc.c:118): Excess struct/union/enum/typedef member 'desc' description in 's3c_hsudc_ep'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'pd'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'transceiver'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'supplies[ARRAY_SIZE(s3c_hsudc_supply_names)]'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'irq'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'uclk'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'ep0state'
Warning(drivers/usb/gadget/s3c-hsudc.c:157): No description found for parameter 'ep[]'
Warning(drivers/usb/gadget/s3c-hsudc.c:293): Excess function parameter 'driver' description in 's3c_hsudc_stop_activity'
Warning(drivers/usb/gadget/s3c-hsudc.c:434): No description found for parameter 'hsudc'
Warning(drivers/usb/gadget/s3c-hsudc.c:434): No description found for parameter 'ep_idx'
Warning(drivers/usb/gadget/s3c-hsudc.c:467): No description found for parameter 'hsudc'
Warning(drivers/usb/gadget/s3c-hsudc.c:467): No description found for parameter 'ep_idx'
Warning(drivers/usb/gadget/s3c-hsudc.c:803): Excess function parameter 'desc' description in 's3c_hsudc_ep_disable'
Warning(drivers/usb/gadget/s3c-hsudc.c:981): No description found for parameter 'hsudc'
Warning(drivers/usb/gadget/s3c-hsudc.c:981): No description found for parameter 'hsep'
Warning(drivers/usb/gadget/s3c-hsudc.c:981): No description found for parameter 'epnum'

Signed-off-by: Kevin Cernekee <cernekee@xxxxxxxxx>
---
 drivers/usb/gadget/s3c-hsudc.c          |   35 ++++++++++++++++---------------
 include/linux/platform_data/s3c-hsudc.h |    2 +-
 2 files changed, 19 insertions(+), 18 deletions(-)

diff --git a/drivers/usb/gadget/s3c-hsudc.c b/drivers/usb/gadget/s3c-hsudc.c
index 236b271..5e99819 100644
--- a/drivers/usb/gadget/s3c-hsudc.c
+++ b/drivers/usb/gadget/s3c-hsudc.c
@@ -100,9 +100,9 @@ static const char * const s3c_hsudc_supply_names[] = {
  * @ep: USB gadget layer representation of device endpoint.
  * @name: Endpoint name (as required by ep autoconfiguration).
  * @dev: Reference to the device controller to which this EP belongs.
- * @desc: Endpoint descriptor obtained from the gadget driver.
  * @queue: Transfer request queue for the endpoint.
  * @stopped: Maintains state of endpoint, set if EP is halted.
+ * @wedge: Halted, and ignoring CLEAR HALT requests from host.
  * @bEndpointAddress: EP address (including direction bit).
  * @fifo: Base address of EP FIFO.
  */
@@ -120,7 +120,7 @@ struct s3c_hsudc_ep {
 /**
  * struct s3c_hsudc_req - Driver encapsulation of USB gadget transfer request.
  * @req: Reference to USB gadget transfer request.
- * @queue: Used for inserting this request to the endpoint request queue.
+ * @queue: Used for inserting this request into the endpoint request queue.
  */
 struct s3c_hsudc_req {
 	struct usb_request req;
@@ -130,15 +130,18 @@ struct s3c_hsudc_req {
 /**
  * struct s3c_hsudc - Driver's abstraction of the device controller.
  * @gadget: Instance of usb_gadget which is referenced by gadget driver.
- * @driver: Reference to currenty active gadget driver.
+ * @driver: Reference to currently active gadget driver.
  * @dev: The device reference used by probe function.
+ * @pd: Platform-specific initialization data from the arch code.
+ * @transceiver: Shared PHY state, for OTG purposes.
+ * @supplies: List of our voltage rails: 1.2V, 1.8V, ...
  * @lock: Lock to synchronize the usage of Endpoints (EP's are indexed).
  * @regs: Remapped base address of controller's register space.
  * @mem_rsrc: Device memory resource used for remapping device register space.
- * irq: IRQ number used by the controller.
- * uclk: Reference to the controller clock.
- * ep0state: Current state of EP0.
- * ep: List of endpoints supported by the controller.
+ * @irq: IRQ number used by the controller.
+ * @uclk: Reference to the controller clock.
+ * @ep0state: Current state of EP0.
+ * @ep: List of endpoints supported by the controller.
  */
 struct s3c_hsudc {
 	struct usb_gadget gadget;
@@ -284,7 +287,6 @@ static void s3c_hsudc_nuke_ep(struct s3c_hsudc_ep *hsep, int status)
 /**
  * s3c_hsudc_stop_activity - Stop activity on all endpoints.
  * @hsudc: Device controller for which EP activity is to be stopped.
- * @driver: Reference to the gadget driver which is currently active.
  *
  * All the endpoints are stopped and any pending transfer requests if any on
  * the endpoint are terminated.
@@ -424,8 +426,8 @@ static int s3c_hsudc_read_fifo(struct s3c_hsudc_ep *hsep,
 
 /**
  * s3c_hsudc_epin_intr - Handle in-endpoint interrupt.
- * @hsudc - Device controller for which the interrupt is to be handled.
- * @ep_idx - Endpoint number on which an interrupt is pending.
+ * @hsudc: Device controller for which the interrupt is to be handled.
+ * @ep_idx: Endpoint number on which an interrupt is pending.
  *
  * Handles interrupt for a in-endpoint. The interrupts that are handled are
  * stall and data transmit complete interrupt.
@@ -457,8 +459,8 @@ static void s3c_hsudc_epin_intr(struct s3c_hsudc *hsudc, u32 ep_idx)
 
 /**
  * s3c_hsudc_epout_intr - Handle out-endpoint interrupt.
- * @hsudc - Device controller for which the interrupt is to be handled.
- * @ep_idx - Endpoint number on which an interrupt is pending.
+ * @hsudc: Device controller for which the interrupt is to be handled.
+ * @ep_idx: Endpoint number on which an interrupt is pending.
  *
  * Handles interrupt for a out-endpoint. The interrupts that are handled are
  * stall, flush and data ready interrupt.
@@ -583,7 +585,7 @@ static int s3c_hsudc_handle_reqfeat(struct s3c_hsudc *hsudc,
 
 /**
  * s3c_hsudc_process_req_status - Handle get status control request.
- * @hsudc: Device controller on which get status request has be handled.
+ * @hsudc: Device controller on which get status request will be handled.
  * @ctrl: Control request as received on the endpoint 0.
  *
  * Handle get status control request received on control endpoint.
@@ -795,7 +797,6 @@ static int s3c_hsudc_ep_enable(struct usb_ep *_ep,
 /**
  * s3c_hsudc_ep_disable - Disable a endpoint.
  * @_ep: The endpoint to be disabled.
- * @desc: Endpoint descriptor.
  *
  * Disables a endpoint when called from the gadget driver.
  */
@@ -970,9 +971,9 @@ static struct usb_ep_ops s3c_hsudc_ep_ops = {
 
 /**
  * s3c_hsudc_initep - Initialize a endpoint to default state.
- * @hsudc - Reference to the device controller.
- * @hsep - Endpoint to be initialized.
- * @epnum - Address to be assigned to the endpoint.
+ * @hsudc: Reference to the device controller.
+ * @hsep: Endpoint to be initialized.
+ * @epnum: Address to be assigned to the endpoint.
  *
  * Initialize a endpoint with default configuration.
  */
diff --git a/include/linux/platform_data/s3c-hsudc.h b/include/linux/platform_data/s3c-hsudc.h
index 6fa1093..69bd63d 100644
--- a/include/linux/platform_data/s3c-hsudc.h
+++ b/include/linux/platform_data/s3c-hsudc.h
@@ -20,7 +20,7 @@
  * s3c24xx_hsudc_platdata - Platform data for USB High-Speed gadget controller.
  * @epnum: Number of endpoints to be instantiated by the controller driver.
  * @gpio_init: Platform specific USB related GPIO initialization.
- * @gpio_uninit: Platform specific USB releted GPIO uninitialzation.
+ * @gpio_uninit: Platform specific USB related GPIO uninitialization.
  *
  * Representation of platform data for the S3C24XX USB 2.0 High Speed gadget
  * controllers.
-- 
1.7.5.2

--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Media]     [Linux Input]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]

  Powered by Linux