[2/2,v2] dt-bindings: power: reset: add yaml bindings for LinkStation power off

Message ID 2886932.VqVLtP53aq@tool
State New
Headers show
Series
  • Untitled series #38154
Related show

Commit Message

Daniel González Cabanelas June 11, 2020, 8:29 p.m.
Add Linkstation poweroff bindings documentation. 

Signed-off-by: Daniel González Cabanelas <dgcbueu@gmail.com>
---
Changes in v2:
  - Changed the required properties and description to adjust to the new
    driver now enabling the WoL feature on the device.

 .../power/reset/linkstation-poweroff.yaml     | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/reset/linkstation-poweroff.yaml

Patch

diff --git a/Documentation/devicetree/bindings/power/reset/linkstation-poweroff.yaml b/Documentation/devicetree/bindings/power/reset/linkstation-poweroff.yaml
new file mode 100644
index 0000000000..475eab8225
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/linkstation-poweroff.yaml
@@ -0,0 +1,43 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/reset/linkstation-poweroff.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Buffalo Linkstation poweroff driver
+
+maintainers:
+  - Daniel González Cabanelas <dgcbueu@gmail.com>
+
+description: |
+  This driver is used to add the power off function to some Buffalo
+  LinkStations (ARM MVEBU boards). They use an output pin at the ethernet PHY
+  (LED2/INTn) to inform the board if the power off operation must be performed
+  at restart time. This pin is ORed with the power switch and allows the WOL 
+  function to be also used.
+
+  When the power-off handler is called, the ethernet PHY INTn ouptut is set to
+  LOW state. If the restart command is executed then the PHY INTn output is 
+  forced to HIGH state.
+
+properties:
+  compatible:
+    const: linkstation,power-off
+
+  phy-handle,intn:
+    description: Phandle to a node of the ethernet PHY used for the power
+      function.
+    $ref: /schemas/types.yaml#/definitions/phandle
+
+required:
+  - compatible
+  - phy-handle,intn
+
+additionalProperties: false
+
+examples:
+  - |
+    poweroff {
+        compatible = "linkstation,power-off";
+        phy-handle,intn = <&ethphy0>;
+    };