Convert the ChromeOS EC bindings to json-schema.
Signed-off-by: Ikjoon Jang <ikjn@xxxxxxxxxxxx>
---
.../devicetree/bindings/mfd/cros-ec.txt | 76 ----------
.../devicetree/bindings/mfd/cros-ec.yaml | 138 ++++++++++++++++++
2 files changed, 138 insertions(+), 76 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
create mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.yaml
diff --git a/Documentation/devicetree/bindings/mfd/cros-ec.txt b/Documentation/devicetree/bindings/mfd/cros-ec.txt
deleted file mode 100644
index 4860eabd0f72..000000000000
--- a/Documentation/devicetree/bindings/mfd/cros-ec.txt
+++ /dev/null
@@ -1,76 +0,0 @@
-ChromeOS Embedded Controller
-
-Google's ChromeOS EC is a Cortex-M device which talks to the AP and
-implements various function such as keyboard and battery charging.
-
-The EC can be connect through various means (I2C, SPI, LPC, RPMSG) and the
-compatible string used depends on the interface. Each connection method has
-its own driver which connects to the top level interface-agnostic EC driver.
-Other Linux driver (such as cros-ec-keyb for the matrix keyboard) connect to
-the top-level driver.
-
-Required properties (I2C):
-- compatible: "google,cros-ec-i2c"
-- reg: I2C slave address
-
-Required properties (SPI):
-- compatible: "google,cros-ec-spi"
-- reg: SPI chip select
-
-Required properties (RPMSG):
-- compatible: "google,cros-ec-rpmsg"
-
-Optional properties (SPI):
-- google,cros-ec-spi-pre-delay: Some implementations of the EC need a little
- time to wake up from sleep before they can receive SPI transfers at a high
- clock rate. This property specifies the delay, in usecs, between the
- assertion of the CS to the start of the first clock pulse.
-- google,cros-ec-spi-msg-delay: Some implementations of the EC require some
- additional processing time in order to accept new transactions. If the delay
- between transactions is not long enough the EC may not be able to respond
- properly to subsequent transactions and cause them to hang. This property
- specifies the delay, in usecs, introduced between transactions to account
- for the time required by the EC to get back into a state in which new data
- can be accepted.
-
-Required properties (LPC):
-- compatible: "google,cros-ec-lpc"
-- reg: List of (IO address, size) pairs defining the interface uses
-
-Optional properties (all):
-- google,has-vbc-nvram: Some implementations of the EC include a small
- nvram space used to store verified boot context data. This boolean flag
- is used to specify whether this nvram is present or not.
-
-Example for I2C:
-
-i2c@12ca0000 {
- cros-ec@1e {
- reg = <0x1e>;
- compatible = "google,cros-ec-i2c";
- interrupts = <14 0>;
- interrupt-parent = <&wakeup_eint>;
- wakeup-source;
- };
-
-
-Example for SPI:
-
-spi@131b0000 {
- ec@0 {
- compatible = "google,cros-ec-spi";
- reg = <0x0>;
- interrupts = <14 0>;
- interrupt-parent = <&wakeup_eint>;
- wakeup-source;
- spi-max-frequency = <5000000>;
- controller-data {
- cs-gpio = <&gpf0 3 4 3 0>;
- samsung,spi-cs;
- samsung,spi-feedback-delay = <2>;
- };
- };
-};
-
-
-Example for LPC is not supplied as it is not yet implemented.
diff --git a/Documentation/devicetree/bindings/mfd/cros-ec.yaml b/Documentation/devicetree/bindings/mfd/cros-ec.yaml
new file mode 100644
index 000000000000..ea430f0a553b
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/cros-ec.yaml
@@ -0,0 +1,138 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/cros-ec.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ChromeOS Embedded Controller
+
+maintainers:
+ - Benson Leung <bleung@xxxxxxxxxxxx>
+ - Enric Balletbo i Serra <enric.balletbo@xxxxxxxxxxxxx>
+ - Guenter Roeck <groeck@xxxxxxxxxxxx>
+
+description: |
+ Google's ChromeOS EC is a Cortex-M device which talks to the AP and
+ implements various function such as keyboard and battery charging.
+ The EC can be connect through various means (I2C, SPI, LPC, RPMSG)
+ and the compatible string used depends on the interface.
+ Each connection method has its own driver which connects to the
+ top level interface-agnostic EC driver. Other Linux driver
+ (such as cros-ec-keyb for the matrix keyboard) connect to the
+ top-level driver.
+
+properties:
+ compatible:
+ oneOf:
+ - description:
+ For implementations of the EC is connected through I2C.
+ const: google,cros-ec-i2c
+ - description:
+ For implementations of the EC is connected through SPI.
+ const: google,cros-ec-spi
+ - description:
+ For implementations of the EC is connected through LPC.
+ const: google,cros-ec-lpc
+ - description:
+ For implementations of the EC is connected through RPMSG.
+ const: google,cros-ec-rpmsg
+
+ google,has-vbc-nvram:
+ description: |
+ Some implementations of the EC include a small
+ nvram space used to store verified boot context data.
+ This boolean flag is used to specify whether this nvram is present or not.
+ type: boolean
+
+required:
+ - compatible
+
+allOf:
+ - if:
+ properties:
+ compatible:
+ const: google,cros-ec-i2c
+ then:
+ properties:
+ reg:
+ description: I2C slave address
+ maxItems: 1
+ required:
+ - reg
+ - if:
+ properties:
+ compatible:
+ const: google,cros-ec-spi
+ then:
+ properties:
+ reg:
+ description: SPI chip select
+ maxItems: 1
+ google,cros-ec-spi-pre-delay:
+ description: |
+ Some implementations of the EC need a little time to wake up
+ from sleep before they can receive SPI transfers
+ at a high clock rate. This property specifies the delay,
+ in usecs, between the assertion of the CS to the start of
+ the first clock pulse.
+ google,cros-ec-spi-msg-delay:
+ description: |
+ Some implementations of the EC require some additional
+ processing time in order to accept new transactions.
+ If the delay between transactions is not long enough
+ the EC may not be able to respond properly to
+ subsequent transactions and cause them to hang.
+ This property specifies the delay, in usecs,
+ introduced between transactions to account for the
+ time required by the EC to get back into a state
+ in which new data can be accepted.
+ required:
+ - reg
+
+ - if:
+ properties:
+ compatible:
+ const: google,cros-ec-lpc
+ then:
+ properties:
+ reg:
+ description: |
+ List of (IO address, size) pairs defining the interface uses
+ required:
+ - reg
+
+examples:
+ - |+
+ // Example for I2C
+ i2c@12ca0000 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ cros-ec@1e {
+ reg = <0x1e>;
+ compatible = "google,cros-ec-i2c";
+ interrupts = <14 0>;
+ interrupt-parent = <&wakeup_eint>;
+ wakeup-source;
+ };
+ };
+ - |+
+ // Example for SPI
+ spi@131b0000 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ ec@0 {
+ compatible = "google,cros-ec-spi";
+ reg = <0x0>;
+ interrupts = <14 0>;
+ interrupt-parent = <&wakeup_eint>;
+ wakeup-source;
+ spi-max-frequency = <5000000>;
+ controller-data {
+ cs-gpio = <&gpf0 3 4 3 0>;
+ samsung,spi-cs;
+ samsung,spi-feedback-delay = <2>;
+ };
+ };
+ };
+
+...
--
2.25.0.rc1.283.g88dfdc4193-goog
