dt/bindings: Add a serial/UART attached device binding
authorRob Herring <robh@kernel.org>
Thu, 2 Feb 2017 19:48:06 +0000 (13:48 -0600)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 3 Feb 2017 09:17:02 +0000 (10:17 +0100)
Add a common binding for describing serial/UART attached devices. Common
examples are Bluetooth, WiFi, NFC and GPS devices.

Serial attached devices are represented as child nodes of a UART node.
This may need to be extended for more complex devices with multiple
interfaces, but for the simple cases a child node is sufficient.

Tested-By: Sebastian Reichel <sre@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/devicetree/bindings/serial/slave-device.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/serial/slave-device.txt b/Documentation/devicetree/bindings/serial/slave-device.txt
new file mode 100644 (file)
index 0000000..f660379
--- /dev/null
@@ -0,0 +1,36 @@
+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.
+
+Example:
+
+serial@1234 {
+       compatible = "ns16550a";
+       interrupts = <1>;
+
+       bluetooth {
+               compatible = "brcm,bcm43341-bt";
+               interrupt-parent = <&gpio>;
+               interrupts = <10>;
+       };
+};