Commit 56480a03 authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman
Browse files

usb: cdns3: cdns3-gadget: Fix a bunch of kernel-doc related formatting issues 



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

 drivers/usb/cdns3/cdns3-gadget.c:163: warning: expecting prototype for select_ep(). Prototype was for cdns3_select_ep() instead
 drivers/usb/cdns3/cdns3-gadget.c:2025: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2224: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2247: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2264: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2399: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2489: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2589: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2656: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2677: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2722: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2768: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2877: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2923: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/cdns3/cdns3-gadget.c:2986: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Peter Chen <peter.chen@kernel.org>
Cc: Pawel Laszczak <pawell@cadence.com>
Cc: Roger Quadros <rogerq@kernel.org>
Cc: Aswath Govindraju <a-govindraju@ti.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Pawel Jez <pjez@cadence.com>
Cc: linux-usb@vger.kernel.org
Acked-by: default avatarPeter Chen <peter.chen@kernel.org>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210526130037.856068-8-lee.jones@linaro.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 6dd1efeb

drivers/usb/cdns3/cdns3-gadget.c

+17 −17
Original line number Diff line number Diff line
@@ -155,7 +155,7 @@ static struct cdns3_request *cdns3_next_priv_request(struct list_head *list) 
}



/**

 * select_ep - selects endpoint

 * cdns3_select_ep - selects endpoint

 * @priv_dev:  extended gadget object

 * @ep: endpoint address

 */
@@ -2022,7 +2022,7 @@ static void cdns3_configure_dmult(struct cdns3_device *priv_dev, 
}



/**

 * cdns3_ep_config Configure hardware endpoint

 * cdns3_ep_config - Configure hardware endpoint

 * @priv_ep: extended endpoint object

 * @enable: set EP_CFG_ENABLE bit in ep_cfg register.

 */
@@ -2223,7 +2223,7 @@ usb_ep *cdns3_gadget_match_ep(struct usb_gadget *gadget, 
}



/**

 * cdns3_gadget_ep_alloc_request Allocates request

 * cdns3_gadget_ep_alloc_request - Allocates request

 * @ep: endpoint object associated with request

 * @gfp_flags: gfp flags

 *
@@ -2246,7 +2246,7 @@ struct usb_request *cdns3_gadget_ep_alloc_request(struct usb_ep *ep, 
}



/**

 * cdns3_gadget_ep_free_request Free memory occupied by request

 * cdns3_gadget_ep_free_request - Free memory occupied by request

 * @ep: endpoint object associated with request

 * @request: request to free memory

 */
@@ -2263,7 +2263,7 @@ void cdns3_gadget_ep_free_request(struct usb_ep *ep, 
}



/**

 * cdns3_gadget_ep_enable Enable endpoint

 * cdns3_gadget_ep_enable - Enable endpoint

 * @ep: endpoint object

 * @desc: endpoint descriptor

 *
@@ -2398,7 +2398,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, 
}



/**

 * cdns3_gadget_ep_disable Disable endpoint

 * cdns3_gadget_ep_disable - Disable endpoint

 * @ep: endpoint object

 *

 * Returns 0 on success, error code elsewhere
@@ -2488,7 +2488,7 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep) 
}



/**

 * cdns3_gadget_ep_queue Transfer data on endpoint

 * cdns3_gadget_ep_queue - Transfer data on endpoint

 * @ep: endpoint object

 * @request: request object

 * @gfp_flags: gfp flags
@@ -2588,7 +2588,7 @@ static int cdns3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request, 
}



/**

 * cdns3_gadget_ep_dequeue Remove request from transfer queue

 * cdns3_gadget_ep_dequeue - Remove request from transfer queue

 * @ep: endpoint object associated with request

 * @request: request object

 *
@@ -2655,7 +2655,7 @@ int cdns3_gadget_ep_dequeue(struct usb_ep *ep, 
}



/**

 * __cdns3_gadget_ep_set_halt Sets stall on selected endpoint

 * __cdns3_gadget_ep_set_halt - Sets stall on selected endpoint

 * Should be called after acquiring spin_lock and selecting ep

 * @priv_ep: endpoint object to set stall on.

 */
@@ -2676,7 +2676,7 @@ void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep) 
}



/**

 * __cdns3_gadget_ep_clear_halt Clears stall on selected endpoint

 * __cdns3_gadget_ep_clear_halt - Clears stall on selected endpoint

 * Should be called after acquiring spin_lock and selecting ep

 * @priv_ep: endpoint object to clear stall on

 */
@@ -2721,7 +2721,7 @@ int __cdns3_gadget_ep_clear_halt(struct cdns3_endpoint *priv_ep) 
}



/**

 * cdns3_gadget_ep_set_halt Sets/clears stall on selected endpoint

 * cdns3_gadget_ep_set_halt - Sets/clears stall on selected endpoint

 * @ep: endpoint object to set/clear stall on

 * @value: 1 for set stall, 0 for clear stall

 *
@@ -2767,7 +2767,7 @@ static const struct usb_ep_ops cdns3_gadget_ep_ops = { 
};



/**

 * cdns3_gadget_get_frame Returns number of actual ITP frame

 * cdns3_gadget_get_frame - Returns number of actual ITP frame

 * @gadget: gadget object

 *

 * Returns number of actual ITP frame
@@ -2876,7 +2876,7 @@ static void cdns3_gadget_config(struct cdns3_device *priv_dev) 
}



/**

 * cdns3_gadget_udc_start Gadget start

 * cdns3_gadget_udc_start - Gadget start

 * @gadget: gadget object

 * @driver: driver which operates on this gadget

 *
@@ -2922,7 +2922,7 @@ static int cdns3_gadget_udc_start(struct usb_gadget *gadget, 
}



/**

 * cdns3_gadget_udc_stop Stops gadget

 * cdns3_gadget_udc_stop - Stops gadget

 * @gadget: gadget object

 *

 * Returns 0
@@ -2985,7 +2985,7 @@ static void cdns3_free_all_eps(struct cdns3_device *priv_dev) 
}



/**

 * cdns3_init_eps Initializes software endpoints of gadget

 * cdns3_init_eps - Initializes software endpoints of gadget

 * @priv_dev: extended gadget object

 *

 * Returns 0 on success, error code elsewhere