doc: Move device tree bindings documentation to doc/device-tree-bindings
authorBreno Lima <breno.lima@nxp.com>
Sat, 21 Jul 2018 00:48:10 +0000 (21:48 -0300)
committerTom Rini <trini@konsulko.com>
Tue, 24 Jul 2018 13:25:23 +0000 (09:25 -0400)
Currently the U-Boot project contains 2 documentation directories:

- doc/
- Documentation/

The Documentation directory only contains device tree bindings related
content, so move the 3 files to doc/device-tree-bindings/.

Signed-off-by: Breno Lima <breno.lima@nxp.com>
Documentation/devicetree/bindings/phy/no-op.txt [deleted file]
Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.txt [deleted file]
Documentation/devicetree/bindings/rtc/brcm,brcmstb-waketimer.txt [deleted file]
doc/device-tree-bindings/phy/no-op.txt [new file with mode: 0644]
doc/device-tree-bindings/phy/phy-stm32-usbphyc.txt [new file with mode: 0644]
doc/device-tree-bindings/rtc/brcm,brcmstb-waketimer.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/phy/no-op.txt b/Documentation/devicetree/bindings/phy/no-op.txt
deleted file mode 100644 (file)
index a338112..0000000
+++ /dev/null
@@ -1,16 +0,0 @@
-NOP PHY driver
-
-This driver is used to stub PHY operations in a driver (USB, SATA).
-This is useful when the 'client' driver (USB, SATA, ...) uses the PHY framework
-and there is no actual PHY harwdare to drive.
-
-Required properties:
-- compatible     : must contain "nop-phy"
-- #phy-cells     : must contain <0>
-
-Example:
-
-nop_phy {
-       compatible = "nop-phy";
-       #phy-cells = <0>;
-};
diff --git a/Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.txt b/Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.txt
deleted file mode 100644 (file)
index 725ae71..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-STMicroelectronics STM32 USB HS PHY controller
-
-The STM32 USBPHYC block contains a dual port High Speed UTMI+ PHY and a UTMI
-switch. It controls PHY configuration and status, and the UTMI+ switch that
-selects either OTG or HOST controller for the second PHY port. It also sets
-PLL configuration.
-
-USBPHYC
-      |_ PLL
-      |
-      |_ PHY port#1 _________________ HOST controller
-      |                    _                 |
-      |                  / 1|________________|
-      |_ PHY port#2 ----|   |________________
-      |                  \_0|                |
-      |_ UTMI switch_______|          OTG controller
-
-
-Phy provider node
-=================
-
-Required properties:
-- compatible: must be "st,stm32mp1-usbphyc"
-- reg: address and length of the usb phy control register set
-- clocks: phandle + clock specifier for the PLL phy clock
-- #address-cells: number of address cells for phys sub-nodes, must be <1>
-- #size-cells: number of size cells for phys sub-nodes, must be <0>
-
-Optional properties:
-- assigned-clocks: phandle + clock specifier for the PLL phy clock
-- assigned-clock-parents: the PLL phy clock parent
-- resets: phandle + reset specifier
-
-Required nodes: one sub-node per port the controller provides.
-
-Phy sub-nodes
-==============
-
-Required properties:
-- reg: phy port index
-- phy-supply: phandle to the regulator providing 3V3 power to the PHY,
-             see phy-bindings.txt in the same directory.
-- vdda1v1-supply: phandle to the regulator providing 1V1 power to the PHY
-- vdda1v8-supply: phandle to the regulator providing 1V8 power to the PHY
-- #phy-cells: see phy-bindings.txt in the same directory, must be <0> for PHY
-  port#1 and must be <1> for PHY port#2, to select USB controller
-
-
-Example:
-               usbphyc: usb-phy@5a006000 {
-                       compatible = "st,stm32mp1-usbphyc";
-                       reg = <0x5a006000 0x1000>;
-                       clocks = <&rcc_clk USBPHY_K>;
-                       resets = <&rcc_rst USBPHY_R>;
-                       #address-cells = <1>;
-                       #size-cells = <0>;
-
-                       usbphyc_port0: usb-phy@0 {
-                               reg = <0>;
-                               phy-supply = <&vdd_usb>;
-                               vdda1v1-supply = <&reg11>;
-                               vdda1v8-supply = <&reg18>
-                               #phy-cells = <0>;
-                       };
-
-                       usbphyc_port1: usb-phy@1 {
-                               reg = <1>;
-                               phy-supply = <&vdd_usb>;
-                               vdda1v1-supply = <&reg11>;
-                               vdda1v8-supply = <&reg18>
-                               #phy-cells = <1>;
-                       };
-               };
diff --git a/Documentation/devicetree/bindings/rtc/brcm,brcmstb-waketimer.txt b/Documentation/devicetree/bindings/rtc/brcm,brcmstb-waketimer.txt
deleted file mode 100644 (file)
index 1d990bc..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-Broadcom STB wake-up Timer
-
-The Broadcom STB wake-up timer provides a 27Mhz resolution timer, with the
-ability to wake up the system from low-power suspend/standby modes.
-
-Required properties:
-- compatible     : should contain "brcm,brcmstb-waketimer"
-- reg            : the register start and length for the WKTMR block
-- interrupts     : The TIMER interrupt
-- interrupt-parent: The phandle to the Always-On (AON) Power Management (PM) L2
-                    interrupt controller node
-- clocks        : The phandle to the UPG fixed clock (27Mhz domain)
-
-Example:
-
-waketimer@f0411580 {
-       compatible = "brcm,brcmstb-waketimer";
-       reg = <0xf0411580 0x14>;
-       interrupts = <0x3>;
-       interrupt-parent = <&aon_pm_l2_intc>;
-       clocks = <&upg_fixed>;
-};
diff --git a/doc/device-tree-bindings/phy/no-op.txt b/doc/device-tree-bindings/phy/no-op.txt
new file mode 100644 (file)
index 0000000..a338112
--- /dev/null
@@ -0,0 +1,16 @@
+NOP PHY driver
+
+This driver is used to stub PHY operations in a driver (USB, SATA).
+This is useful when the 'client' driver (USB, SATA, ...) uses the PHY framework
+and there is no actual PHY harwdare to drive.
+
+Required properties:
+- compatible     : must contain "nop-phy"
+- #phy-cells     : must contain <0>
+
+Example:
+
+nop_phy {
+       compatible = "nop-phy";
+       #phy-cells = <0>;
+};
diff --git a/doc/device-tree-bindings/phy/phy-stm32-usbphyc.txt b/doc/device-tree-bindings/phy/phy-stm32-usbphyc.txt
new file mode 100644 (file)
index 0000000..725ae71
--- /dev/null
@@ -0,0 +1,73 @@
+STMicroelectronics STM32 USB HS PHY controller
+
+The STM32 USBPHYC block contains a dual port High Speed UTMI+ PHY and a UTMI
+switch. It controls PHY configuration and status, and the UTMI+ switch that
+selects either OTG or HOST controller for the second PHY port. It also sets
+PLL configuration.
+
+USBPHYC
+      |_ PLL
+      |
+      |_ PHY port#1 _________________ HOST controller
+      |                    _                 |
+      |                  / 1|________________|
+      |_ PHY port#2 ----|   |________________
+      |                  \_0|                |
+      |_ UTMI switch_______|          OTG controller
+
+
+Phy provider node
+=================
+
+Required properties:
+- compatible: must be "st,stm32mp1-usbphyc"
+- reg: address and length of the usb phy control register set
+- clocks: phandle + clock specifier for the PLL phy clock
+- #address-cells: number of address cells for phys sub-nodes, must be <1>
+- #size-cells: number of size cells for phys sub-nodes, must be <0>
+
+Optional properties:
+- assigned-clocks: phandle + clock specifier for the PLL phy clock
+- assigned-clock-parents: the PLL phy clock parent
+- resets: phandle + reset specifier
+
+Required nodes: one sub-node per port the controller provides.
+
+Phy sub-nodes
+==============
+
+Required properties:
+- reg: phy port index
+- phy-supply: phandle to the regulator providing 3V3 power to the PHY,
+             see phy-bindings.txt in the same directory.
+- vdda1v1-supply: phandle to the regulator providing 1V1 power to the PHY
+- vdda1v8-supply: phandle to the regulator providing 1V8 power to the PHY
+- #phy-cells: see phy-bindings.txt in the same directory, must be <0> for PHY
+  port#1 and must be <1> for PHY port#2, to select USB controller
+
+
+Example:
+               usbphyc: usb-phy@5a006000 {
+                       compatible = "st,stm32mp1-usbphyc";
+                       reg = <0x5a006000 0x1000>;
+                       clocks = <&rcc_clk USBPHY_K>;
+                       resets = <&rcc_rst USBPHY_R>;
+                       #address-cells = <1>;
+                       #size-cells = <0>;
+
+                       usbphyc_port0: usb-phy@0 {
+                               reg = <0>;
+                               phy-supply = <&vdd_usb>;
+                               vdda1v1-supply = <&reg11>;
+                               vdda1v8-supply = <&reg18>
+                               #phy-cells = <0>;
+                       };
+
+                       usbphyc_port1: usb-phy@1 {
+                               reg = <1>;
+                               phy-supply = <&vdd_usb>;
+                               vdda1v1-supply = <&reg11>;
+                               vdda1v8-supply = <&reg18>
+                               #phy-cells = <1>;
+                       };
+               };
diff --git a/doc/device-tree-bindings/rtc/brcm,brcmstb-waketimer.txt b/doc/device-tree-bindings/rtc/brcm,brcmstb-waketimer.txt
new file mode 100644 (file)
index 0000000..1d990bc
--- /dev/null
@@ -0,0 +1,22 @@
+Broadcom STB wake-up Timer
+
+The Broadcom STB wake-up timer provides a 27Mhz resolution timer, with the
+ability to wake up the system from low-power suspend/standby modes.
+
+Required properties:
+- compatible     : should contain "brcm,brcmstb-waketimer"
+- reg            : the register start and length for the WKTMR block
+- interrupts     : The TIMER interrupt
+- interrupt-parent: The phandle to the Always-On (AON) Power Management (PM) L2
+                    interrupt controller node
+- clocks        : The phandle to the UPG fixed clock (27Mhz domain)
+
+Example:
+
+waketimer@f0411580 {
+       compatible = "brcm,brcmstb-waketimer";
+       reg = <0xf0411580 0x14>;
+       interrupts = <0x3>;
+       interrupt-parent = <&aon_pm_l2_intc>;
+       clocks = <&upg_fixed>;
+};