diff mbox

[v3,3/4] usb: gadget: pxa27x_udc device-tree documentation

Message ID 1404050473-19669-3-git-send-email-robert.jarzmik@free.fr
State Superseded, archived
Headers show

Commit Message

Robert Jarzmik June 29, 2014, 2:01 p.m. UTC
Add documentation for device-tree binding of arm PXA 27x udc (usb
device) driver.

Signed-off-by: Robert Jarzmik <robert.jarzmik@free.fr>
Cc: devicetree@vger.kernel.org

---
Since V1: change OF id mrvl,pxa27x_udc -> marvell,pxa27x-udc
          This is a consequence of other DT reviews on the marvell
          namings.
Since V2: Mark's review
          - described standard properties
          - use standard gpio bindings for pullup gpio
---
 Documentation/devicetree/bindings/usb/pxa-usb.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Comments

Arnd Bergmann June 30, 2014, 6:58 a.m. UTC | #1
On Sunday 29 June 2014 16:01:12 Robert Jarzmik wrote:
> +Required properties:
> + - compatible: Should be "marvell,pxa270-udc" for USB controllers
> +   used in device mode.
> + - reg: usb device MMIO address space
> + - interrupts: single interrupt generated by the UDC IP
> + - clocks: input clock of the UDC IP (see clock-bindings.txt)
> +
> +Optional properties:
> + - gpios:
> +   - gpio activated to control the USB D+ pullup (see gpio.txt)
> +
> +Example:
> +
> +               pxa27x_udc: udc@40600000 {
> +                       compatible = "marvell,pxa270-udc";
> +                       reg = <0x40600000 0x10000>;
> +                       interrupts = <11>;
> +                       clocks = <&pxa2xx_clks 11>;
> +                       clock-names = "udc";
> +                       gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
> +               };
> 

If you use a clock-names property, you have to list the required
clock names in the documentation above. Alternatively, just make
it an anonymous clock in the driver and change the example
to remove the clock-names.

IIRC there is a some confusion in the pxa/mmp USB drivers regarding
the clock names, and this has to be cleaned up in order to have proper
bindings.

	Arnd
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Robert Jarzmik July 5, 2014, 8:20 a.m. UTC | #2
OK, I have 2 remaining comments to integrate, one from Sergei/Felipe on the
includes, one from Mark/Arnd on the clock-names property removal.

Are there any comments left you want before I post the v4. I'd like it to be the
last round of this serie.

Cheers.

--
Robert
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/usb/pxa-usb.txt b/Documentation/devicetree/bindings/usb/pxa-usb.txt
index 79729a9..028d988 100644
--- a/Documentation/devicetree/bindings/usb/pxa-usb.txt
+++ b/Documentation/devicetree/bindings/usb/pxa-usb.txt
@@ -29,3 +29,26 @@  Example:
 		marvell,port-mode = <2>; /* PMM_GLOBAL_MODE */
 	};
 
+UDC
+
+Required properties:
+ - compatible: Should be "marvell,pxa270-udc" for USB controllers
+   used in device mode.
+ - reg: usb device MMIO address space
+ - interrupts: single interrupt generated by the UDC IP
+ - clocks: input clock of the UDC IP (see clock-bindings.txt)
+
+Optional properties:
+ - gpios:
+   - gpio activated to control the USB D+ pullup (see gpio.txt)
+
+Example:
+
+		pxa27x_udc: udc@40600000 {
+			compatible = "marvell,pxa270-udc";
+			reg = <0x40600000 0x10000>;
+			interrupts = <11>;
+			clocks = <&pxa2xx_clks 11>;
+			clock-names = "udc";
+			gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
+		};