reset: sti: Document sti-picophyreset controllers bindings.
authorPeter Griffin <peter.griffin@linaro.org>
Wed, 2 Jul 2014 14:08:47 +0000 (15:08 +0100)
committerMaxime Coquelin <maxime.coquelin@st.com>
Fri, 31 Oct 2014 12:00:38 +0000 (13:00 +0100)
Add DT bindings documentation for sti-picophyreset controller.

Signed-off-by: Peter Griffin <peter.griffin@linaro.org>
Acked-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Maxime Coquelin <maxime.coquelin@st.com>
Documentation/devicetree/bindings/reset/st,sti-picophyreset.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/reset/st,sti-picophyreset.txt b/Documentation/devicetree/bindings/reset/st,sti-picophyreset.txt
new file mode 100644 (file)
index 0000000..54ae9f7
--- /dev/null
@@ -0,0 +1,42 @@
+STMicroelectronics STi family Sysconfig Picophy SoftReset Controller
+=============================================================================
+
+This binding describes a reset controller device that is used to enable and
+disable on-chip PicoPHY USB2 phy(s) using "softreset" control bits found in
+the STi family SoC system configuration registers.
+
+The actual action taken when softreset is asserted is hardware dependent.
+However, when asserted it may not be possible to access the hardware's
+registers and after an assert/deassert sequence the hardware's previous state
+may no longer be valid.
+
+Please refer to Documentation/devicetree/bindings/reset/reset.txt
+for common reset controller binding usage.
+
+Required properties:
+- compatible: Should be "st,stih407-picophyreset"
+- #reset-cells: 1, see below
+
+Example:
+
+       picophyreset: picophyreset-controller {
+               compatible = "st,stih407-picophyreset";
+               #reset-cells = <1>;
+       };
+
+Specifying picophyreset control of devices
+=======================================
+
+Device nodes should specify the reset channel required in their "resets"
+property, containing a phandle to the picophyreset device node and an
+index specifying which channel to use, as described in
+Documentation/devicetree/bindings/reset/reset.txt.
+
+Example:
+
+       usb2_picophy0: usbpicophy@0 {
+               resets = <&picophyreset STIH407_PICOPHY0_RESET>;
+       };
+
+Macro definitions for the supported reset channels can be found in:
+include/dt-bindings/reset-controller/stih407-resets.h