usb: dwc3: document usb_psy in struct dwc3

PATCH Superseded Ray Chi 2 participants 2 messages Mar 3, 2021

Subsystems (2)

USB DesignWare USB3 DRD IP driver

lore

Share & tools

lore

Ray Chi

author

2021-03-03 10:32 UTC #0 lore raw

PATCH 1/1 usb: dwc3: document usb_psy in struct dwc3

The new struct member was added to struct dwc3, but a documentation was missing:

drivers/usb/dwc3/core.h:1273: warning: Function parameter or member 'usb_psy' not described in 'dwc3'

Signed-off-by Ray Chi <[email protected]>

---
 drivers/usb/dwc3/core.h | 1 +
 1 file changed, 1 insertion(+)

drivers/usb/dwc3/core.h +1 -0

index 6708fdf358b3..ce6bd84e2b39 100644
@@ -988,6 +988,7 @@ struct dwc3_scratchpad_array {
  * @role_sw: usb_role_switch handle
  * @role_switch_default_mode: default operation mode of controller while
  *			usb role is USB_ROLE_NONE.
+ * @usb_psy: pointer to power supply interface.
  * @usb2_phy: pointer to USB2 PHY
  * @usb3_phy: pointer to USB3 PHY
  * @usb2_generic_phy: pointer to USB2 PHY

Signature · 1 line

2.30.1.766.gb4fecdf3b7-goog

Greg KH

maintainer

2021-03-03 11:02 UTC #1 lore raw

Quoted 6 lines · Ray Chi

The new struct member was added to struct dwc3, but a documentation was missing:
drivers/usb/dwc3/core.h:1273: warning: Function parameter or member 'usb_psy' not described in 'dwc3'
Signed-off-by Ray Chi <[email protected]>

You forgot the "Reported-by:" line here.

Please fix up and resend a v2.

thanks,

greg k-h