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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




Convert the generic phy-bindings.txt binding to standard YAML
DT binding format.

Signed-off-by: Matt Porter <mporter@xxxxxxxxxxxx>
---
 .../devicetree/bindings/phy/phy-bindings.yaml      | 89 ++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/phy-bindings.yaml

diff --git a/Documentation/devicetree/bindings/phy/phy-bindings.yaml b/Documentation/devicetree/bindings/phy/phy-bindings.yaml
new file mode 100644
index 0000000..9b164d1
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/phy-bindings.yaml
@@ -0,0 +1,89 @@
+%YAML 1.2
+---
+id: phy-device
+
+title: PHY device
+
+description: >
+  This document explains only the device tree data binding.  For general
+  information about PHY subsystem refer to Documentation/phy.txt
+
+required:
+  - name: "#phy-cells"
+    description: >
+      number of cells in a PHY specifier. The meaning of all those
+      cells is defined by the binding for the phy node. The PHY
+      provider can use the values in cells to find the appropriate
+      PHY.
+
+optional:
+  - name: "phy-supply"
+    description: >
+      phandle to a regulator that provides power to the PHY. This
+      regulator will be managed during the PHY power on/off sequence.
+
+example:
+  - dts: |
+      phys: phy {
+          compatible = "xxx";
+          reg = <...>;
+          .
+          .
+          #phy-cells = <1>;
+          .
+          .
+      };
+    description: >
+      Describes an IP block (PHY provider) that implements 2 different
+      PHYs. In order to differentiate between these 2 PHYs, an
+      additional specifier should be given while trying to get a
+      reference to it.
+...
+
+---
+id: phy-user
+
+title: PHY user
+
+required:
+  - name: "phys"
+    description: >
+      the phandle for the PHY device (used by the PHY subsystem)
+  - name: "phy-names"
+    description: >
+      the names of the PHY corresponding to the PHYs present in the
+      *phys* phandle
+
+example:
+  - dts: |
+      usb1: usb_otg_ss@xxx {
+          compatible = "xxx";
+          reg = <xxx>;
+          .
+          .
+          phys = <&usb2_phy>, <&usb3_phy>;
+          phy-names = "usb2phy", "usb3phy";
+          .
+          .
+      };
+    description: >
+       Represents a controller that uses two PHYs, one for usb2 and one
+       for usb3.
+
+  - dts: |
+      usb2: usb_otg_ss@xxx {
+          compatible = "xxx";
+          reg = <xxx>;
+          .
+          .
+          phys = <&phys 1>;
+          phy-names = "usbphy";
+          .
+          .
+      };
+    description: >
+      Represents a controller that uses one of the PHYs of the PHY
+      provider device defined previously. Note that the phy handle
+      has an additional specifier "1" to differentiate between the
+      two PHYs.
+...
-- 
2.1.4

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



[Index of Archives]     [Device Tree Compilter]     [Device Tree Spec]     [Linux Driver Backports]     [Video for Linux]     [Linux USB Devel]     [Linux PCI Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Yosemite Backpacking]
  Powered by Linux