diff options
author | Peter Chen <peter.chen@freescale.com> | 2014-09-22 08:14:17 +0800 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2014-09-23 21:32:31 -0700 |
commit | 19353881b4afc9e2351fa8987b8fa2921587e0d6 (patch) | |
tree | 1883a8fc5b504f5a4d8ec1a42438127fb67e37cd /drivers/usb | |
parent | 27c62c2da177178771517744acaced08767214e2 (diff) | |
download | linux-19353881b4afc9e2351fa8987b8fa2921587e0d6.tar.bz2 |
usb: chipidea: enhance kernel-doc format
Some kernel-doc style comment are not satisfied for format, fix them.
Signed-off-by: Peter Chen <peter.chen@freescale.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/usb')
-rw-r--r-- | drivers/usb/chipidea/ci.h | 14 | ||||
-rw-r--r-- | drivers/usb/chipidea/core.c | 8 |
2 files changed, 17 insertions, 5 deletions
diff --git a/drivers/usb/chipidea/ci.h b/drivers/usb/chipidea/ci.h index 9563cb56d564..ea40626e0246 100644 --- a/drivers/usb/chipidea/ci.h +++ b/drivers/usb/chipidea/ci.h @@ -99,10 +99,10 @@ enum ci_role { /** * struct ci_role_driver - host/gadget role driver - * start: start this role - * stop: stop this role - * irq: irq handler for this role - * name: role name string (host/gadget) + * @start: start this role + * @stop: stop this role + * @irq: irq handler for this role + * @name: role name string (host/gadget) */ struct ci_role_driver { int (*start)(struct ci_hdrc *); @@ -245,6 +245,7 @@ static inline void ci_role_stop(struct ci_hdrc *ci) /** * hw_read: reads from a hw register + * @ci: the controller * @reg: register index * @mask: bitfield mask * @@ -277,6 +278,7 @@ static inline void __hw_write(struct ci_hdrc *ci, u32 val, /** * hw_write: writes to a hw register + * @ci: the controller * @reg: register index * @mask: bitfield mask * @data: new value @@ -293,6 +295,7 @@ static inline void hw_write(struct ci_hdrc *ci, enum ci_hw_regs reg, /** * hw_test_and_clear: tests & clears a hw register + * @ci: the controller * @reg: register index * @mask: bitfield mask * @@ -309,6 +312,7 @@ static inline u32 hw_test_and_clear(struct ci_hdrc *ci, enum ci_hw_regs reg, /** * hw_test_and_write: tests & writes a hw register + * @ci: the controller * @reg: register index * @mask: bitfield mask * @data: new value @@ -327,6 +331,8 @@ static inline u32 hw_test_and_write(struct ci_hdrc *ci, enum ci_hw_regs reg, /** * ci_otg_is_fsm_mode: runtime check if otg controller * is in otg fsm mode. + * + * @ci: chipidea device */ static inline bool ci_otg_is_fsm_mode(struct ci_hdrc *ci) { diff --git a/drivers/usb/chipidea/core.c b/drivers/usb/chipidea/core.c index 7cb74c4f0e92..3df5005c554d 100644 --- a/drivers/usb/chipidea/core.c +++ b/drivers/usb/chipidea/core.c @@ -139,6 +139,8 @@ static int hw_alloc_regmap(struct ci_hdrc *ci, bool is_lpm) /** * hw_read_intr_enable: returns interrupt enable register * + * @ci: the controller + * * This function returns register data */ u32 hw_read_intr_enable(struct ci_hdrc *ci) @@ -149,6 +151,8 @@ u32 hw_read_intr_enable(struct ci_hdrc *ci) /** * hw_read_intr_status: returns interrupt status register * + * @ci: the controller + * * This function returns register data */ u32 hw_read_intr_status(struct ci_hdrc *ci) @@ -176,6 +180,8 @@ int hw_port_test_set(struct ci_hdrc *ci, u8 mode) /** * hw_port_test_get: reads port test mode value * + * @ci: the controller + * * This function returns port test mode value */ u8 hw_port_test_get(struct ci_hdrc *ci) @@ -295,7 +301,7 @@ static void hw_phymode_configure(struct ci_hdrc *ci) /** * ci_usb_phy_init: initialize phy according to different phy type * @ci: the controller - * + * * This function returns an error code if usb_phy_init has failed */ static int ci_usb_phy_init(struct ci_hdrc *ci) |