Commit 6a005f0f authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman

usb: chipidea: otg: Fix kerneldoc issues relating to description of 'ci'

Firstly we add some missing descriptions.  Then we fix some formatting
issues.  Kerneldoc expects arguments to be in the format '@.*: '.  If
either the '@' or ':' is omitted, kerneldoc gets confused.

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

 drivers/usb/chipidea/otg.c:29: warning: Function parameter or member 'ci' not described in 'hw_read_otgsc'
 drivers/usb/chipidea/otg.c:82: warning: Function parameter or member 'ci' not described in 'hw_write_otgsc'
 drivers/usb/chipidea/otg.c:235: warning: Function parameter or member 'ci' not described in 'ci_hdrc_otg_init'
 drivers/usb/chipidea/otg.c:254: warning: Function parameter or member 'ci' not described in 'ci_hdrc_otg_destroy'

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-10-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent e21cd08f
...@@ -23,6 +23,7 @@ ...@@ -23,6 +23,7 @@
/** /**
* hw_read_otgsc returns otgsc register bits value. * hw_read_otgsc returns otgsc register bits value.
* @ci: the controller
* @mask: bitfield mask * @mask: bitfield mask
*/ */
u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask) u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask)
...@@ -75,6 +76,7 @@ u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask) ...@@ -75,6 +76,7 @@ u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask)
/** /**
* hw_write_otgsc updates target bits of OTGSC register. * hw_write_otgsc updates target bits of OTGSC register.
* @ci: the controller
* @mask: bitfield mask * @mask: bitfield mask
* @data: to be written * @data: to be written
*/ */
...@@ -229,7 +231,7 @@ static void ci_otg_work(struct work_struct *work) ...@@ -229,7 +231,7 @@ static void ci_otg_work(struct work_struct *work)
/** /**
* ci_hdrc_otg_init - initialize otg struct * ci_hdrc_otg_init - initialize otg struct
* ci: the controller * @ci: the controller
*/ */
int ci_hdrc_otg_init(struct ci_hdrc *ci) int ci_hdrc_otg_init(struct ci_hdrc *ci)
{ {
...@@ -248,7 +250,7 @@ int ci_hdrc_otg_init(struct ci_hdrc *ci) ...@@ -248,7 +250,7 @@ int ci_hdrc_otg_init(struct ci_hdrc *ci)
/** /**
* ci_hdrc_otg_destroy - destroy otg struct * ci_hdrc_otg_destroy - destroy otg struct
* ci: the controller * @ci: the controller
*/ */
void ci_hdrc_otg_destroy(struct ci_hdrc *ci) void ci_hdrc_otg_destroy(struct ci_hdrc *ci)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment