Commit 4a35aa6d authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman
Browse files

usb: cdns3: gadget: Fix a bunch of kernel doc issues 



Mainline misspelled function argument descriptions.  Also one
formatting issue with a missing '@' identifier.

Fixes the following W=1 build warnings:

 drivers/usb/cdns3/gadget.c:653: warning: Function parameter or member 'priv_ep' not described in 'cdns3_wa2_descmissing_packet'
 drivers/usb/cdns3/gadget.c:653: warning: Excess function parameter 'priv_dev' description in 'cdns3_wa2_descmissing_packet'
 drivers/usb/cdns3/gadget.c:1088: warning: Function parameter or member 'request' not described in 'cdns3_ep_run_transfer'
 drivers/usb/cdns3/gadget.c:2574: warning: Function parameter or member 'priv_ep' not described in '__cdns3_gadget_ep_set_halt'
 drivers/usb/cdns3/gadget.c:2574: warning: Excess function parameter 'ep' description in '__cdns3_gadget_ep_set_halt'
 drivers/usb/cdns3/gadget.c:2595: warning: Function parameter or member 'priv_ep' not described in '__cdns3_gadget_ep_clear_halt'
 drivers/usb/cdns3/gadget.c:2595: warning: Excess function parameter 'ep' description in '__cdns3_gadget_ep_clear_halt'
 drivers/usb/cdns3/gadget.c:2898: warning: Function parameter or member 'priv_dev' not described in 'cdns3_init_eps'
 drivers/usb/cdns3/gadget.c:2898: warning: Excess function parameter 'cdns3' description in 'cdns3_init_eps'
 drivers/usb/cdns3/gadget.c:3210: warning: Function parameter or member 'cdns' not described in 'cdns3_gadget_init'

Cc: Pawel Laszczak <pawell@cadence.com>
Cc: Pawel Jez <pjez@cadence.com>
Cc: Peter Chen <peter.chen@nxp.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200702144625.2533530-18-lee.jones@linaro.org


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

drivers/usb/cdns3/gadget.c

+6 −5
Original line number Diff line number Diff line
@@ -644,7 +644,7 @@ static void cdns3_wa2_remove_old_request(struct cdns3_endpoint *priv_ep) 


/**

 * cdns3_wa2_descmissing_packet - handles descriptor missing event.

 * @priv_dev: extended gadget object

 * @priv_ep: extended gadget object

 *

 * This function is used only for WA2. For more information see Work around 2

 * description.
@@ -1080,6 +1080,7 @@ static int cdns3_ep_run_stream_transfer(struct cdns3_endpoint *priv_ep, 
/**

 * cdns3_ep_run_transfer - start transfer on no-default endpoint hardware

 * @priv_ep: endpoint object

 * @request: request object

 *

 * Returns zero on success or negative value on failure

 */
@@ -2568,7 +2569,7 @@ int cdns3_gadget_ep_dequeue(struct usb_ep *ep, 
/**

 * __cdns3_gadget_ep_set_halt Sets stall on selected endpoint

 * Should be called after acquiring spin_lock and selecting ep

 * @ep: endpoint object to set stall on.

 * @priv_ep: endpoint object to set stall on.

 */

void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep)

{
@@ -2589,7 +2590,7 @@ void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep) 
/**

 * __cdns3_gadget_ep_clear_halt Clears stall on selected endpoint

 * Should be called after acquiring spin_lock and selecting ep

 * @ep: endpoint object to clear stall on

 * @priv_ep: endpoint object to clear stall on

 */

int __cdns3_gadget_ep_clear_halt(struct cdns3_endpoint *priv_ep)

{
@@ -2890,7 +2891,7 @@ static void cdns3_free_all_eps(struct cdns3_device *priv_dev) 


/**

 * cdns3_init_eps Initializes software endpoints of gadget

 * @cdns3: extended gadget object

 * @priv_dev: extended gadget object

 *

 * Returns 0 on success, error code elsewhere

 */
@@ -3202,7 +3203,7 @@ static int cdns3_gadget_resume(struct cdns3 *cdns, bool hibernated) 
/**

 * cdns3_gadget_init - initialize device structure

 *

 * cdns: cdns3 instance

 * @cdns: cdns3 instance

 *

 * This function initializes the gadget.

 */