Re: [PATCH v1 1/2] dt/bindings/usb: Add bindings for PIC32 MUSB driver.

[Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>]

Hello.

On 4/7/2016 2:16 PM, Purna Chandra Mandal wrote:

> Document devicetree binding for the USB controller

    Device tree.

> and USB Phy found on Microchip PIC32 class devices.

    PHY.

> Signed-off-by: Purna Chandra Mandal <purna.mandal@microchip.com>
>
> ---
>
>   .../bindings/usb/microchip,pic32-musb.txt          | 67 ++++++++++++++++++++++
>   1 file changed, 67 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/usb/microchip,pic32-musb.txt
>
> diff --git a/Documentation/devicetree/bindings/usb/microchip,pic32-musb.txt b/Documentation/devicetree/bindings/usb/microchip,pic32-musb.txt
> new file mode 100644
> index 0000000..e1cec9d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/microchip,pic32-musb.txt
> @@ -0,0 +1,67 @@
> +Microchip PIC32 MUSB DRC/OTG controller
> +-------------------------------------------
> +
> +Required properties:
> + - compatible       : should be "microchip,pic32mzda-usb".
> + - reg              : offset and length of "MUSB Core Registers" and
> +                      "USB Clock & Reset Registers".
> + - reg-names        : should be "mc", and "usbcr" in order
> + - clocks           : clock specifier for the musb controller clock
> + - clock-names      : should be "usb_clk"
> + - interrupts       : interrupt number for MUSB Core General interrupt
> +                      and DMA interrupt
> + - interrupt-names  : must be "mc" and "dma" in order.
> + - phys             : phy specifier for the otg phy.
> + - dr_mode          : should be one of "host", "peripheral" or "otg".
> + - mentor,multipoint: Should be "1" indicating the musb controller supports
> +                      multipoint. This is MUSB configuration-specific setting.
> + - mentor,num-eps   : Specifies the number of endpoints. This is also a
> +                      MUSB configuration-specific setting. Should be set to "8".
> + - mentor,ram-bits  : Specifies the ram address size. Should be set to "11".
> + - mentor,power     : Should be "500". This signifies the controller can supply
> +                      up to 500mA when operating in host mode.

    No, these "nentor" prefixed parameters must be determined from the 
"compatible" prop.

> + - phys             : phandle of the USB phy.
> + - usb_overcurrent  : phandle to MUSB over-current note. It should have

    s/note/node/? Also,
    Also, hyphens are preferred to underscores in the device trees.

> +                      interrupt number for over-current detection logic.
> +
> +Optional properties:
> + - microchip,fifo-mode: Specifies layout of internal SRAM for end-point fifos.
> +                        Should be 0 (default) or 1.
> +
> +Example:
> +	aliases {
> +		usb1 = &usb1;
> +		phy1 = &usb1_phy;
> +	};
> +
> +	usb1: hsusb1_core@1f8e3000 {

    The ePAPR standard tells us to use the generic names, not chip specific, 
the name standardized in this case is "usb@...".

> +		compatible = "microchip,pic32mzda-usb";
> +		reg = <0x1f8e3000 0x1000>,
> +		      <0x1f884000 0x1000>;
> +		reg-names = "mc", "usbcr";
> +		interrupts = <132 IRQ_TYPE_EDGE_RISING>,
> +			     <133 IRQ_TYPE_LEVEL_HIGH>;
> +		interrupt-names = "mc", "dma";
> +		dr_mode = "host";
> +		mentor,multipoint = <1>;
> +		mentor,num-eps = <8>;
> +		mentor,ram-bits = <11>;
> +		mentor,power = <500>;
> +		phys = <&usb1_phy>;
> +		clocks = <&rootclk PB5CLK>;
> +		clock-names = "usb_clk";
> +		usb_overcurrent = <&usb1_overcurrent>;
> +	};
> +
> +	usb1_phy: hsusb1_phy@1f8e4000 {

    "usb-phy@..."

> +		compatible = "usb-nop-xceiv";
> +		reg = <0x1f8e4000 0x1000>;
> +		clocks = <&rootclk UPLLCLK>;
> +		clock-names = "main_clk";
> +		clock-frequency = <24000000>;
> +	};
> +
> +	usb1_overcurrent: hsusb1_oc@0 {

    "usb-overcurrent@...", perhaps?

> +		interrupt-parent = <&gpio1>;
> +		interrupts = <11 IRQ_TYPE_EDGE_FALLING>;
> +	};

MBR, Sergei