dt-bindings: serial: Convert slave-device bindings to json-schema

Convert the serial slave-device Device Tree binding documentation to
json-schema, and incorporate it into the generic serial bindings.

Signed-off-by: Geert Uytterhoeven <[email protected]>
Reviewed-by: Matthias Brugger <[email protected]>
Signed-off-by: Rob Herring <[email protected]>

diff --git a/Documentation/devicetree/bindings/gnss/gnss.txt b/Documentation/devicetree/bindings/gnss/gnss.txt
index f547bd4549fe46552666c7bc0f6dc4152d7c4710..d6dc9c0d82499dd54da8847a8044e3407abf269c 100644 (file)
--- a/Documentation/devicetree/bindings/gnss/gnss.txt
+++ b/Documentation/devicetree/bindings/gnss/gnss.txt
@@ -8,7 +8,7 @@ bus (e.g. UART, I2C or SPI).
 
 Please refer to the following documents for generic properties:
 
-       Documentation/devicetree/bindings/serial/slave-device.txt
+       Documentation/devicetree/bindings/serial/serial.yaml
        Documentation/devicetree/bindings/spi/spi-bus.txt
 
 Required properties:

diff --git a/Documentation/devicetree/bindings/net/broadcom-bluetooth.txt b/Documentation/devicetree/bindings/net/broadcom-bluetooth.txt
index dd258674633ca84e193cbf82f49d1a3af0e8b4c7..a7d57ba5f2ac39bdc6e6676aec308036c15846c7 100644 (file)
--- a/Documentation/devicetree/bindings/net/broadcom-bluetooth.txt
+++ b/Documentation/devicetree/bindings/net/broadcom-bluetooth.txt
@@ -20,7 +20,7 @@ Required properties:
 
 Optional properties:
 
- - max-speed: see Documentation/devicetree/bindings/serial/slave-device.txt
+ - max-speed: see Documentation/devicetree/bindings/serial/serial.yaml
  - shutdown-gpios: GPIO specifier, used to enable the BT module
  - device-wakeup-gpios: GPIO specifier, used to wakeup the controller
  - host-wakeup-gpios: GPIO specifier, used to wakeup the host processor.

diff --git a/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt b/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt
index 112011c51d5e3c1ee8f928ef9bb67a982eaa3399..219bcbd0d34478ba5ceb6ffe16aa7f52e7ef1b36 100644 (file)
--- a/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt
+++ b/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt
@@ -42,7 +42,7 @@ child node of the serial node with UART.
 
 Please refer to the following documents for generic properties:
 
-       Documentation/devicetree/bindings/serial/slave-device.txt
+       Documentation/devicetree/bindings/serial/serial.yaml
 
 Required properties:
 

diff --git a/Documentation/devicetree/bindings/net/qca,qca7000.txt b/Documentation/devicetree/bindings/net/qca,qca7000.txt
index 21c36e5249936c4c25677e396a457acbe3c9202e..8f5ae0b84eec2646db8126a126058346e1b063c5 100644 (file)
--- a/Documentation/devicetree/bindings/net/qca,qca7000.txt
+++ b/Documentation/devicetree/bindings/net/qca,qca7000.txt
@@ -68,7 +68,7 @@ Required properties:
 Optional properties:
 - local-mac-address : see ./ethernet.txt
 - current-speed     : current baud rate of QCA7000 which defaults to 115200
-                     if absent, see also ../serial/slave-device.txt
+                     if absent, see also ../serial/serial.yaml
 
 UART Example:
 

diff --git a/Documentation/devicetree/bindings/net/ti-bluetooth.txt b/Documentation/devicetree/bindings/net/ti-bluetooth.txt
index 6d03ff8c7068135ed95d51dc1224266ae43b26e7..f48c17b38f5851de21d6f21f282b1bafc03c3398 100644 (file)
--- a/Documentation/devicetree/bindings/net/ti-bluetooth.txt
+++ b/Documentation/devicetree/bindings/net/ti-bluetooth.txt
@@ -15,8 +15,7 @@ standard BT HCI protocol with additional channels for the other functions.
 TI WiLink devices also have a separate WiFi interface as described in
 wireless/ti,wlcore.txt.
 
-This bindings follows the UART slave device binding in
-../serial/slave-device.txt.
+This bindings follows the UART slave device binding in ../serial/serial.yaml.
 
 Required properties:
  - compatible: should be one of the following:

diff --git a/Documentation/devicetree/bindings/serial/serial.yaml b/Documentation/devicetree/bindings/serial/serial.yaml
index ca2ae755b560141c04949e13647b89a7d5ae2b96..dd97ecd1a7fe8ddda790084effd88425b0aec583 100644 (file)
--- a/Documentation/devicetree/bindings/serial/serial.yaml
+++ b/Documentation/devicetree/bindings/serial/serial.yaml
@@ -7,6 +7,7 @@ $schema: "http://devicetree.org/meta-schemas/core.yaml#"
 title: Serial Interface Generic DT Bindings
 
 maintainers:
+  - Rob Herring <[email protected]>
   - Greg Kroah-Hartman <[email protected]>
 
 description:
@@ -69,3 +70,58 @@ then:
   properties:
     cts-gpios: false
     rts-gpios: false
+
+patternProperties:
+  ".*":
+    if:
+      type: object
+    then:
+      description:
+        Serial attached devices shall be a child node of the host UART device
+        the slave device is attached to. It is expected that the attached
+        device is the only child node of the UART device. The slave device node
+        name shall reflect the generic type of device for the node.
+
+      properties:
+        compatible:
+          description:
+            Compatible of the device connected to the serial port.
+
+        max-speed:
+          $ref: /schemas/types.yaml#/definitions/uint32
+          description:
+            The maximum baud rate the device operates at.
+            This should only be present if the maximum is less than the slave
+            device can support.  For example, a particular board has some
+            signal quality issue or the host processor can't support higher
+            baud rates.
+
+        current-speed:
+          $ref: /schemas/types.yaml#/definitions/uint32
+          description: |
+            The current baud rate the device operates at.
+            This should only be present in case a driver has no chance to know
+            the baud rate of the slave device.
+            Examples:
+              * device supports auto-baud
+              * the rate is setup by a bootloader and there is no way to reset
+                the device
+              * device baud rate is configured by its firmware but there is no
+                way to request the actual settings
+
+      required:
+        - compatible
+
+examples:
+  - |
+    serial@1234 {
+            compatible = "ns16550a";
+            reg = <0x1234 0x20>;
+            interrupts = <1>;
+
+            bluetooth {
+                    compatible = "brcm,bcm43341-bt";
+                    interrupt-parent = <&gpio>;
+                    interrupts = <10>;
+            };
+    };

diff --git a/Documentation/devicetree/bindings/serial/slave-device.txt b/Documentation/devicetree/bindings/serial/slave-device.txt
deleted file mode 100644 (file)
index 40110e0..0000000
--- a/Documentation/devicetree/bindings/serial/slave-device.txt
+++ /dev/null
@@ -1,45 +0,0 @@
-Serial Slave Device DT binding
-
-This documents the binding structure and common properties for serial
-attached devices. Common examples include Bluetooth, WiFi, NFC and GPS
-devices.
-
-Serial attached devices shall be a child node of the host UART device the
-slave device is attached to. It is expected that the attached device is
-the only child node of the UART device. The slave device node name shall
-reflect the generic type of device for the node.
-
-Required Properties:
-
-- compatible   : A string reflecting the vendor and specific device the node
-                 represents.
-
-Optional Properties:
-
-- max-speed    : The maximum baud rate the device operates at. This should
-                 only be present if the maximum is less than the slave device
-                 can support. For example, a particular board has some signal
-                 quality issue or the host processor can't support higher
-                 baud rates.
-- current-speed        : The current baud rate the device operates at. This should
-                 only be present in case a driver has no chance to know
-                 the baud rate of the slave device.
-                 Examples:
-                   * device supports auto-baud
-                   * the rate is setup by a bootloader and there is no
-                     way to reset the device
-                   * device baud rate is configured by its firmware but
-                     there is no way to request the actual settings
-
-Example:
-
-serial@1234 {
-       compatible = "ns16550a";
-       interrupts = <1>;
-
-       bluetooth {
-               compatible = "brcm,bcm43341-bt";
-               interrupt-parent = <&gpio>;
-               interrupts = <10>;
-       };
-};

diff --git a/MAINTAINERS b/MAINTAINERS
index b4cb364cd0195a1e6ee3a4f723b05cc3b39a4361..16760fc4f64bd2331096db26b7ab55cf1161f83f 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -15001,7 +15001,7 @@ SERIAL DEVICE BUS
 M:     Rob Herring <[email protected]>
 L:     [email protected]
 S:     Maintained
-F:     Documentation/devicetree/bindings/serial/slave-device.txt
+F:     Documentation/devicetree/bindings/serial/serial.yaml
 F:     drivers/tty/serdev/
 F:     include/linux/serdev.h