Re: [RFC PATCH 5/5] Documentation: dt-bindings: phy: add YAML TI PHY binding

2015-09-08 Thread Matt Porter
On Tue, Sep 01, 2015 at 10:42:25AM -0700, Tim Bird wrote:
> On Thu, Aug 27, 2015 at 10:23 PM, Matt Porter  wrote:
> > Convert the ti-phy.txt binding to standard YAML DT binding
> > format. This binding references the YAML generic PHY binding.
> >
> > Signed-off-by: Matt Porter 
> > ---
> >  Documentation/devicetree/bindings/phy/ti-phy.yaml | 166 
> > ++
> >  1 file changed, 166 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/phy/ti-phy.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/phy/ti-phy.yaml 
> > b/Documentation/devicetree/bindings/phy/ti-phy.yaml
> > new file mode 100644
> > index 000..ec93501
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/phy/ti-phy.yaml
> > @@ -0,0 +1,166 @@
> > +%YAML 1.2
> > +---
> > +id: omap-control-phy
> > +
> > +title: OMAP Control PHY
> > +
> > +compatible:
> > +  - name: "ti,control-phy-otghs"
> > +description: if it has otghs_control mailbox register as on OMAP4.
> > +  - name: "ti,control-phy-usb2"
> > +description: if it has Power down bit in control_dev_conf register
> > + e.g. USB2_PHY on OMAP5.
> > +  - name: "ti,control-phy-pipe3"
> > +description: if it has DPLL and individual Rx & Tx power control
> > + e.g. USB3 PHY and SATA PHY on OMAP5.
> > +  - name: "ti,control-phy-pcie"
> > +description: for pcie to support external clock for pcie and to
> > + set PCS delay value. e.g. PCIE PHY in DRA7x
> > +  - name: "ti,control-phy-usb2-dra7"
> > +description: if it has power down register like USB2 PHY on DRA7
> > + DRA7 platform.
> > +  - name: "ti,control-phy-usb2-am437"
> > +description: if it has power down register like USB2 PHY on AM437
> > + platform.
> 
> I'm confused.  If these descriptions are multi-line, don't they need the '>'
> syntax?

Consider that a bug ;) Yes, they should have '>'. Since I'm just using
the default core yaml schema validator this is perfectly legal when I
run it through yaml. It would mess up formating when output to a
document.


> Also, I'm still confused by the "name:" field in this section.  These are
> possible *values* for the compatible property, not the name of the field,
> as all other property descriptions are.

Ok, so that's a legacy artifact of several incarnations of these tags
before I posted initially. I agree, it should be "string" or "value",
probably the latter as you suggest.

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


Re: [RFC PATCH 5/5] Documentation: dt-bindings: phy: add YAML TI PHY binding

2015-09-01 Thread Tim Bird
On Thu, Aug 27, 2015 at 10:23 PM, Matt Porter  wrote:
> Convert the ti-phy.txt binding to standard YAML DT binding
> format. This binding references the YAML generic PHY binding.
>
> Signed-off-by: Matt Porter 
> ---
>  Documentation/devicetree/bindings/phy/ti-phy.yaml | 166 
> ++
>  1 file changed, 166 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/ti-phy.yaml
>
> diff --git a/Documentation/devicetree/bindings/phy/ti-phy.yaml 
> b/Documentation/devicetree/bindings/phy/ti-phy.yaml
> new file mode 100644
> index 000..ec93501
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/ti-phy.yaml
> @@ -0,0 +1,166 @@
> +%YAML 1.2
> +---
> +id: omap-control-phy
> +
> +title: OMAP Control PHY
> +
> +compatible:
> +  - name: "ti,control-phy-otghs"
> +description: if it has otghs_control mailbox register as on OMAP4.
> +  - name: "ti,control-phy-usb2"
> +description: if it has Power down bit in control_dev_conf register
> + e.g. USB2_PHY on OMAP5.
> +  - name: "ti,control-phy-pipe3"
> +description: if it has DPLL and individual Rx & Tx power control
> + e.g. USB3 PHY and SATA PHY on OMAP5.
> +  - name: "ti,control-phy-pcie"
> +description: for pcie to support external clock for pcie and to
> + set PCS delay value. e.g. PCIE PHY in DRA7x
> +  - name: "ti,control-phy-usb2-dra7"
> +description: if it has power down register like USB2 PHY on DRA7
> + DRA7 platform.
> +  - name: "ti,control-phy-usb2-am437"
> +description: if it has power down register like USB2 PHY on AM437
> + platform.

I'm confused.  If these descriptions are multi-line, don't they need the '>'
syntax?

Also, I'm still confused by the "name:" field in this section.  These are
possible *values* for the compatible property, not the name of the field,
as all other property descriptions are.

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


[RFC PATCH 5/5] Documentation: dt-bindings: phy: add YAML TI PHY binding

2015-08-27 Thread Matt Porter
Convert the ti-phy.txt binding to standard YAML DT binding
format. This binding references the YAML generic PHY binding.

Signed-off-by: Matt Porter 
---
 Documentation/devicetree/bindings/phy/ti-phy.yaml | 166 ++
 1 file changed, 166 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/ti-phy.yaml

diff --git a/Documentation/devicetree/bindings/phy/ti-phy.yaml 
b/Documentation/devicetree/bindings/phy/ti-phy.yaml
new file mode 100644
index 000..ec93501
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/ti-phy.yaml
@@ -0,0 +1,166 @@
+%YAML 1.2
+---
+id: omap-control-phy
+
+title: OMAP Control PHY
+
+compatible:
+  - name: "ti,control-phy-otghs"
+description: if it has otghs_control mailbox register as on OMAP4.
+  - name: "ti,control-phy-usb2"
+description: if it has Power down bit in control_dev_conf register
+ e.g. USB2_PHY on OMAP5.
+  - name: "ti,control-phy-pipe3"
+description: if it has DPLL and individual Rx & Tx power control
+ e.g. USB3 PHY and SATA PHY on OMAP5.
+  - name: "ti,control-phy-pcie"
+description: for pcie to support external clock for pcie and to
+ set PCS delay value. e.g. PCIE PHY in DRA7x
+  - name: "ti,control-phy-usb2-dra7"
+description: if it has power down register like USB2 PHY on DRA7
+ DRA7 platform.
+  - name: "ti,control-phy-usb2-am437"
+description: if it has power down register like USB2 PHY on AM437
+ platform.
+required:
+  - name: "reg"
+description: register ranges as listed in the reg-names property
+  - name: "reg-names"
+description: >
+ "otghs_control" for control-phy-otghs "power",
+ "pcie_pcs" and "control_sma" for control-phy-pcie
+ "power" for all other types
+
+example:
+  - dts: |
+  omap_control_usb: omap-control-usb@4a002300 {
+  compatible = "ti,control-phy-otghs";
+  reg = <0x4a00233c 0x4>;
+  reg-names = "otghs_control";
+  };
+...
+
+---
+id: omap-usb2-phy
+
+title: OMAP USB2 PHY
+
+compatible:
+  - name: "ti,omap-usb2"
+
+required:
+  - name: "reg"
+description: >
+ Address and length of the register set for the device.
+  - name: "#phy-cells"
+description: >
+ determine the number of cells that should be given in
+ the phandle while referencing this phy.
+reference: phy-device
+  - name: "clocks"
+description: >
+ a list of phandles and clock-specifier pairs, one for
+ each entry in clock-names.
+reference: clock-consumer
+  - name: "clock-names"
+description: >
+ should include:
+ * "wkupclk" - wakeup clock.
+ * "refclk" - reference clock (optional).
+reference: clock-consumer
+
+optional:
+  - name: "ctrl-module"
+description: >
+ phandle of the control module used by PHY driver to
+ power on the PHY.
+
+example:
+  - dts: |
+  usb2phy@4a0ad080 {
+compatible = "ti,omap-usb2";
+reg = <0x4a0ad080 0x58>;
+ctrl-module = <&omap_control_usb>;
+#phy-cells = <0>;
+clocks = <&usb_phy_cm_clk32k>, <&usb_otg_ss_refclk960m>;
+clock-names = "wkupclk", "refclk";
+  };
+description: >
+ This is usually a subnode of ocp2scp to which it is
+ connected.
+...
+
+---
+id: ti-pipe3-phy
+
+title: TI Pipe3 PHY
+
+compatible:
+  - name: "ti,phy-usb3"
+  - name: "ti,phy-pipe3-sata"
+  - name: "ti,phy-pipe3-pcie"
+  - deprecated: "ti,omap-usb3"
+
+required:
+  - name: "reg"
+description: >
+ Address and length of the register set for the device.
+  - name: "reg-names"
+description: >
+ The names of the register addresses corresponding to
+ the registers filled in "reg".
+  - name: "#phy-cells"
+description: >
+ determine the number of cells that should be given in
+ the phandle while referencing this phy.
+reference: phy-device
+  - name: "clocks"
+description: >
+ a list of phandles and clock-specifier pairs, one for
+ each entry in clock-names.
+reference: clock-consumer
+  - name: "clock-names"
+description: >
+ should include:
+ * "wkupclk" - wakeup clock.
+ * "sysclk" - system clock.
+ * "refclk" - reference clock.
+ * "dpll_ref" - external dpll ref clk
+ * "dpll_ref_m2" - external dpll ref clk
+ * "phy-div" - divider for apll
+ * "div-clk" - apll clock
+reference: clock-consumer
+
+optional:
+  - name: "ctrl-module"
+description: >
+ phandle of the control module used by PHY driver to
+ power