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

usb: chipidea: udc: Fix a few kerneldoc issues 



Descriptions were missing for 'ci' almost throughout.  There was
one instance of over-documenting.  Finally one function argument
was incorrectly documented (probably down to bitrot).

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

 drivers/usb/chipidea/udc.c:245: warning: Function parameter or member 'ci' not described in 'hw_port_is_high_speed'
 drivers/usb/chipidea/udc.c:271: warning: Function parameter or member 'ci' not described in 'hw_test_and_clear_intr_active'
 drivers/usb/chipidea/udc.c:285: warning: Function parameter or member 'ci' not described in 'hw_test_and_clear_setup_guard'
 drivers/usb/chipidea/udc.c:296: warning: Function parameter or member 'ci' not described in 'hw_test_and_set_setup_guard'
 drivers/usb/chipidea/udc.c:321: warning: Function parameter or member 'ci' not described in 'hw_usb_reset'
 drivers/usb/chipidea/udc.c:628: warning: Excess function parameter 'ci' description in 'free_pending_td'
 drivers/usb/chipidea/udc.c:655: warning: Function parameter or member 'hwep' not described in '_hardware_dequeue'
 drivers/usb/chipidea/udc.c:655: warning: Excess function parameter 'gadget' description in '_hardware_dequeue'

Cc: Peter Chen <Peter.Chen@nxp.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200703174148.2749969-18-lee.jones@linaro.org


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

drivers/usb/chipidea/udc.c

+6 −2
Original line number Diff line number Diff line
@@ -238,6 +238,7 @@ static int hw_ep_set_halt(struct ci_hdrc *ci, int num, int dir, int value) 


/**

 * hw_is_port_high_speed: test if port is high speed

 * @ci: the controller

 *

 * This function returns true if high speed port

 */
@@ -264,6 +265,7 @@ static int hw_test_and_clear_complete(struct ci_hdrc *ci, int n) 
/**

 * hw_test_and_clear_intr_active: test & clear active interrupts (execute

 *                                without interruption)

 * @ci: the controller

 *

 * This function returns active interrutps

 */
@@ -278,6 +280,7 @@ static u32 hw_test_and_clear_intr_active(struct ci_hdrc *ci) 
/**

 * hw_test_and_clear_setup_guard: test & clear setup guard (execute without

 *                                interruption)

 * @ci: the controller

 *

 * This function returns guard value

 */
@@ -289,6 +292,7 @@ static int hw_test_and_clear_setup_guard(struct ci_hdrc *ci) 
/**

 * hw_test_and_set_setup_guard: test & set setup guard (execute without

 *                              interruption)

 * @ci: the controller

 *

 * This function returns guard value

 */
@@ -314,6 +318,7 @@ static void hw_usb_set_address(struct ci_hdrc *ci, u8 value) 
/**

 * hw_usb_reset: restart device after a bus reset (execute without

 *               interruption)

 * @ci: the controller

 *

 * This function returns an error code

 */
@@ -621,7 +626,6 @@ static int _hardware_enqueue(struct ci_hw_ep *hwep, struct ci_hw_req *hwreq) 


/**

 * free_pending_td: remove a pending request for the endpoint

 * @ci: the controller

 * @hwep: endpoint

 */

static void free_pending_td(struct ci_hw_ep *hwep)
@@ -646,7 +650,7 @@ static int reprime_dtd(struct ci_hdrc *ci, struct ci_hw_ep *hwep, 


/**

 * _hardware_dequeue: handles a request at hardware level

 * @gadget: gadget

 * @hwep: endpoint

 * @hwreq:  request

 *

 * This function returns an error code