dt-bindings: gnss: Rewrite Mediatek bindings in YAML
authorLinus Walleij <linus.walleij@linaro.org>
Mon, 25 Apr 2022 13:29:47 +0000 (15:29 +0200)
committerRob Herring <robh@kernel.org>
Mon, 25 Apr 2022 20:19:46 +0000 (15:19 -0500)
This rewrites the Mediatek GNSS bindings in YAML.

Cc: devicetree@vger.kernel.org
Cc: Krzysztof Kozlowski <krzk@kernel.org>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220425132947.1311171-1-linus.walleij@linaro.org
Documentation/devicetree/bindings/gnss/mediatek.txt [deleted file]
Documentation/devicetree/bindings/gnss/mediatek.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/gnss/mediatek.txt b/Documentation/devicetree/bindings/gnss/mediatek.txt
deleted file mode 100644 (file)
index 80cb802..0000000
+++ /dev/null
@@ -1,35 +0,0 @@
-Mediatek-based GNSS Receiver DT binding
-
-Mediatek chipsets are used in GNSS-receiver modules produced by several
-vendors and can use a UART interface.
-
-Please see Documentation/devicetree/bindings/gnss/gnss.txt for generic
-properties.
-
-Required properties:
-
-- compatible   : Must be
-
-                       "globaltop,pa6h"
-
-- vcc-supply   : Main voltage regulator (pin name: VCC)
-
-Optional properties:
-
-- current-speed                : Default UART baud rate
-- gnss-fix-gpios       : GPIO used to determine device position fix state
-                         (pin name: FIX, 3D_FIX)
-- reset-gpios          : GPIO used to reset the device (pin name: RESET, NRESET)
-- timepulse-gpios      : Time pulse GPIO (pin name: PPS1, 1PPS)
-- vbackup-supply       : Backup voltage regulator (pin name: VBAT, VBACKUP)
-
-Example:
-
-serial@1234 {
-       compatible = "ns16550a";
-
-       gnss {
-               compatible = "globaltop,pa6h";
-               vcc-supply = <&vcc_3v3>;
-       };
-};
diff --git a/Documentation/devicetree/bindings/gnss/mediatek.yaml b/Documentation/devicetree/bindings/gnss/mediatek.yaml
new file mode 100644 (file)
index 0000000..45cf01b
--- /dev/null
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/gnss/mediatek.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mediatek GNSS Receiver Device Tree Bindings
+
+maintainers:
+  - Johan Hovold <johan@kernel.org>
+
+description:
+  Mediatek chipsets are used in GNSS-receiver modules produced by several
+  vendors and can use a UART interface.
+
+allOf:
+  - $ref: gnss-common.yaml#
+
+properties:
+  compatible:
+    const: globaltop,pa6h
+
+  vcc-supply:
+    description:
+      Main voltage regulator, pin name VCC.
+
+  reset-gpios:
+    maxItems: 1
+    description: An optional reset line, with names such as RESET or NRESET.
+      If the line is active low it should be flagged with GPIO_ACTIVE_LOW.
+
+  timepulse-gpios:
+    description: Comes with pin names such as PPS1 or 1PPS.
+
+  gnss-fix-gpios:
+    maxItems: 1
+    description: GPIO used to determine device position fix state, pin names
+      FIX or 3D_FIX.
+
+  vbackup-supply:
+    description:
+      Regulator providing backup voltage, pin names such as VBAT or VBACKUP.
+
+required:
+  - compatible
+  - vcc-supply
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    serial {
+        gnss {
+            compatible = "globaltop,pa6h";
+            vcc-supply = <&vcc_3v3>;
+            reset-gpios = <&gpio 1 GPIO_ACTIVE_LOW>;
+        };
+    };