diff mbox

[U-Boot,2/3,v2] imx: usb: ehci-mx6: document board specific functions

Message ID 1438808616-25585-2-git-send-email-aalonso@freescale.com
State Changes Requested
Delegated to: Stefano Babic
Headers show

Commit Message

Adrian Alonso Aug. 5, 2015, 9:03 p.m. UTC
Document target board specific functions

board_ehci_hcd_init - override usb phy mode
board_ehci_hcd_init - set usb vbus voltage
board_ehci_power - enables/disables usb vbus voltage

Signed-off-by: Adrian Alonso <aalonso@freescale.com>
---
Changes for V2:
Split from patch imx: usb: ehci-mx6: add usb support for imx7d soc

 drivers/usb/host/ehci-mx6.c | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

Comments

Marek Vasut Aug. 5, 2015, 9:31 p.m. UTC | #1
On Wednesday, August 05, 2015 at 11:03:35 PM, Adrian Alonso wrote:
> Document target board specific functions
> 
> board_ehci_hcd_init - override usb phy mode
> board_ehci_hcd_init - set usb vbus voltage
> board_ehci_power - enables/disables usb vbus voltage
> 
> Signed-off-by: Adrian Alonso <aalonso@freescale.com>
> ---
> Changes for V2:
> Split from patch imx: usb: ehci-mx6: add usb support for imx7d soc
> 
>  drivers/usb/host/ehci-mx6.c | 31 +++++++++++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
> 
> diff --git a/drivers/usb/host/ehci-mx6.c b/drivers/usb/host/ehci-mx6.c
> index 0f94c8b..afc248b 100644
> --- a/drivers/usb/host/ehci-mx6.c
> +++ b/drivers/usb/host/ehci-mx6.c
> @@ -195,16 +195,47 @@ int usb_phy_mode(int port)
>  		return USB_INIT_HOST;
>  }
> 
> +/*

The kerneldoc starts with /** , the tool to generate the documentation
actually depends on that. Can you please fix this one thing and slap my

Acked-by: Marek Vasut <marex@denx.de>

on this patch when re-posting ?

[...]

Best regards,
Marek Vasut
diff mbox

Patch

diff --git a/drivers/usb/host/ehci-mx6.c b/drivers/usb/host/ehci-mx6.c
index 0f94c8b..afc248b 100644
--- a/drivers/usb/host/ehci-mx6.c
+++ b/drivers/usb/host/ehci-mx6.c
@@ -195,16 +195,47 @@  int usb_phy_mode(int port)
 		return USB_INIT_HOST;
 }
 
+/*
+ * board_ehci_hcd_init - override usb phy mode
+ * @port:	usb host/otg port
+ *
+ * Target board specific, override usb_phy_mode.
+ * When usb-otg is used as usb host port, iomux pad usb_otg_id can be
+ * left disconnected in this case usb_phy_mode will not be able to identify
+ * the phy mode that usb port is used.
+ * Machine file overrides board_usb_phy_mode.
+ *
+ * Return: USB_INIT_DEVICE or USB_INIT_HOST
+ */
 int __weak board_usb_phy_mode(int port)
 {
 	return usb_phy_mode(port);
 }
 
+/*
+ * board_ehci_hcd_init - set usb vbus voltage
+ * @port:      usb otg port
+ *
+ * Target board specific, setup iomux pad to setup supply vbus voltage
+ * for usb otg port. Machine board file overrides board_ehci_hcd_init
+ *
+ * Return: 0 Success
+ */
 int __weak board_ehci_hcd_init(int port)
 {
 	return 0;
 }
 
+/*
+ * board_ehci_power - enables/disables usb vbus voltage
+ * @port:      usb otg port
+ * @on:        on/off vbus voltage
+ *
+ * Enables/disables supply vbus voltage for usb otg port.
+ * Machine board file overrides board_ehci_power
+ *
+ * Return: 0 Success
+ */
 int __weak board_ehci_power(int port, int on)
 {
 	return 0;