Commit 6e29619f authored Jul 02, 2020 by Lee Jones Committed by Greg Kroah-Hartman Jul 03, 2020

usb: cdns3: core: Fix incorrect formatting and misspelled function arg docs

There are 3 misspellings and 1 incorrect format used in this file's
kerneldoc function headers. Fixing them squashes the following W=1
kernel 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: Peter Chen <peter.chen@nxp.com>
Cc: Roger Quadros <rogerq@ti.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200702144625.2533530-14-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent ede175a5

drivers/usb/cdns3/core.c

+4 −4

Original line number	Diff line number	Diff line
		@@ -282,7 +282,7 @@ static int cdns3_idle_init(struct cdns3 *cdns)

		/**
		* cdns3_hw_role_switch - switch roles based on HW state
		* @cdns3: controller
		* @cdns: controller
		*/
		int cdns3_hw_role_switch(struct cdns3 *cdns)
		{
		@@ -320,7 +320,7 @@ int cdns3_hw_role_switch(struct cdns3 *cdns)
		/**
		* cdsn3_role_get - get current role of controller.
		*
		* @dev: Pointer to device structure
		* @sw: pointer to USB role switch structure
		*
		* Returns role
		*/
		@@ -334,8 +334,8 @@ static enum usb_role cdns3_role_get(struct usb_role_switch *sw)
		/**
		* cdns3_role_set - set current role of controller.
		*
		* @dev: pointer to device object
		* @role - the previous role
		* @sw: pointer to USB role switch structure
		* @role: the previous role
		* Handles below events:
		* - Role switch for dual-role devices
		* - USB_ROLE_GADGET <--> USB_ROLE_NONE for peripheral-only devices