* [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema
@ 2020-03-05 7:53 Ikjoon Jang
2020-03-05 8:54 ` Enric Balletbo i Serra
2020-03-05 16:48 ` Rob Herring
0 siblings, 2 replies; 4+ messages in thread
From: Ikjoon Jang @ 2020-03-05 7:53 UTC (permalink / raw)
To: devicetree
Cc: Rob Herring, Dmitry Torokhov, Gwendal Grignou, Lee Jones,
Mark Rutland, Benson Leung, Enric Balletbo i Serra,
Guenter Roeck, Jiri Kosina, Benjamin Tissoires, Nicolas Boitchat,
linux-input, Ikjoon Jang
Convert the ChromeOS EC bindings to json-schema.
Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
---
v6: adjust property dependencies, drop duplicated definitions,
and set additionalProperties
v5: unset additionalProperties
v4: text reflows, add type references, and fix examples
v3: node name changed in rpmsg example
v2: cleanup description, fix typos, remove LPC, and add RPMSG example
---
.../devicetree/bindings/mfd/cros-ec.txt | 76 -----------
.../devicetree/bindings/mfd/cros-ec.yaml | 125 ++++++++++++++++++
2 files changed, 125 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..19add9d6bd09
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/cros-ec.yaml
@@ -0,0 +1,125 @@
+# 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@chromium.org>
+ - Enric Balletbo i Serra <enric.balletbo@collabora.com>
+ - Guenter Roeck <groeck@chromium.org>
+
+description:
+ Google's ChromeOS EC is a microcontroller which talks to the AP and
+ implements various functions such as keyboard and battery charging.
+ The EC can be connected through various interfaces (I2C, SPI, and others)
+ and the compatible string specifies which interface is being used.
+
+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 RPMSG.
+ const: google,cros-ec-rpmsg
+
+ google,cros-ec-spi-pre-delay:
+ description:
+ This property specifies the delay in usecs between the
+ assertion of the CS and the first clock pulse.
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint32
+ - default: 0
+ - minimum: 0
+
+ google,cros-ec-spi-msg-delay:
+ description:
+ This property specifies the delay in usecs between messages.
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint32
+ - default: 0
+ - minimum: 0
+
+ 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
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+
+if:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - google,cros-ec-i2c
+ - google,cros-ec-rpmsg
+then:
+ properties:
+ google,cros-ec-spi-pre-delay: false
+ google,cros-ec-spi-msg-delay: false
+
+additionalProperties: false
+
+examples:
+ # Example for I2C
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ i2c0 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ cros-ec@1e {
+ compatible = "google,cros-ec-i2c";
+ reg = <0x1e>;
+ interrupts = <6 0>;
+ interrupt-parent = <&gpio0>;
+ };
+ };
+
+ # Example for SPI
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ spi0 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ cros-ec@0 {
+ compatible = "google,cros-ec-spi";
+ reg = <0x0>;
+ google,cros-ec-spi-msg-delay = <30>;
+ google,cros-ec-spi-pre-delay = <10>;
+ interrupts = <99 0>;
+ interrupt-parent = <&gpio7>;
+ spi-max-frequency = <5000000>;
+ };
+ };
+
+ # Example for RPMSG
+ - |
+ scp0 {
+ cros-ec@0 {
+ compatible = "google,cros-ec-rpmsg";
+ };
+ };
+...
--
2.25.0.265.gbab2e86ba0-goog
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema
2020-03-05 7:53 [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema Ikjoon Jang
@ 2020-03-05 8:54 ` Enric Balletbo i Serra
2020-03-06 7:24 ` Lee Jones
2020-03-05 16:48 ` Rob Herring
1 sibling, 1 reply; 4+ messages in thread
From: Enric Balletbo i Serra @ 2020-03-05 8:54 UTC (permalink / raw)
To: Ikjoon Jang, devicetree
Cc: Rob Herring, Dmitry Torokhov, Gwendal Grignou, Lee Jones,
Mark Rutland, Benson Leung, Guenter Roeck, Jiri Kosina,
Benjamin Tissoires, Nicolas Boitchat, linux-input
Hi Ikjoon,
On 5/3/20 8:53, Ikjoon Jang wrote:
> Convert the ChromeOS EC bindings to json-schema.
>
> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> ---
> v6: adjust property dependencies, drop duplicated definitions,
> and set additionalProperties
> v5: unset additionalProperties
> v4: text reflows, add type references, and fix examples
> v3: node name changed in rpmsg example
> v2: cleanup description, fix typos, remove LPC, and add RPMSG example
> ---
> .../devicetree/bindings/mfd/cros-ec.txt | 76 -----------
> .../devicetree/bindings/mfd/cros-ec.yaml | 125 ++++++++++++++++++
According to the feedback I received on other patches from Rob, the name of the
file should include the vendor, in that case should be google,cros-ec.yaml
I already argued in previous version why I think this should go in
bindings/chrome instead of mfd, these bindings correspond to the platform/chrome
device not the mfd cros ec device (cros-ec-dev) in MFD, anyway, I don't want to
be touchy, but, as is, should go through the Lee Jones tree not our
chrome-platform tree. So if Lee is fine with it I'm fine too.
Just another minor change (see below) and looks good to me.
Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> 2 files changed, 125 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..19add9d6bd09
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/cros-ec.yaml
> @@ -0,0 +1,125 @@
> +# 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@chromium.org>
> + - Enric Balletbo i Serra <enric.balletbo@collabora.com>
> + - Guenter Roeck <groeck@chromium.org>
> +
> +description:
> + Google's ChromeOS EC is a microcontroller which talks to the AP and
> + implements various functions such as keyboard and battery charging.
> + The EC can be connected through various interfaces (I2C, SPI, and others)
> + and the compatible string specifies which interface is being used.
> +
> +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 RPMSG.
> + const: google,cros-ec-rpmsg
> +
> + google,cros-ec-spi-pre-delay:
> + description:
> + This property specifies the delay in usecs between the
> + assertion of the CS and the first clock pulse.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - default: 0
> + - minimum: 0
> +
> + google,cros-ec-spi-msg-delay:
> + description:
> + This property specifies the delay in usecs between messages.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - default: 0
> + - minimum: 0
> +
> + 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
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> +required:
> + - compatible
> +
> +if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - google,cros-ec-i2c
> + - google,cros-ec-rpmsg
> +then:
> + properties:
> + google,cros-ec-spi-pre-delay: false
> + google,cros-ec-spi-msg-delay: false
> +
> +additionalProperties: false
> +
> +examples:
> + # Example for I2C
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + i2c0 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + cros-ec@1e {
> + compatible = "google,cros-ec-i2c";
> + reg = <0x1e>;
> + interrupts = <6 0>;
> + interrupt-parent = <&gpio0>;
> + };
> + };
> +
> + # Example for SPI
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + spi0 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + cros-ec@0 {
> + compatible = "google,cros-ec-spi";
> + reg = <0x0>;
> + google,cros-ec-spi-msg-delay = <30>;
> + google,cros-ec-spi-pre-delay = <10>;
> + interrupts = <99 0>;
> + interrupt-parent = <&gpio7>;
> + spi-max-frequency = <5000000>;
> + };
> + };
> +
> + # Example for RPMSG
> + - |
> + scp0 {
> + cros-ec@0 {
There is no reg so so you should remove the unit address in this case s/@0//
> + compatible = "google,cros-ec-rpmsg";
> + };
> + };
> +...
>
Thanks,
Enric
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema
2020-03-05 7:53 [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema Ikjoon Jang
2020-03-05 8:54 ` Enric Balletbo i Serra
@ 2020-03-05 16:48 ` Rob Herring
1 sibling, 0 replies; 4+ messages in thread
From: Rob Herring @ 2020-03-05 16:48 UTC (permalink / raw)
To: Ikjoon Jang
Cc: devicetree, Benjamin Tissoires, Nicolas Boitchat, linux-input,
Ikjoon Jang
On Thu, 5 Mar 2020 15:53:02 +0800, Ikjoon Jang wrote:
> Convert the ChromeOS EC bindings to json-schema.
>
> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> ---
> v6: adjust property dependencies, drop duplicated definitions,
> and set additionalProperties
> v5: unset additionalProperties
> v4: text reflows, add type references, and fix examples
> v3: node name changed in rpmsg example
> v2: cleanup description, fix typos, remove LPC, and add RPMSG example
> ---
> .../devicetree/bindings/mfd/cros-ec.txt | 76 -----------
> .../devicetree/bindings/mfd/cros-ec.yaml | 125 ++++++++++++++++++
> 2 files changed, 125 insertions(+), 76 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
> create mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.yaml
>
My bot found errors running 'make dt_binding_check' on your patch:
Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/mfd/cros-ec.example.dt.yaml: cros-ec@0: 'spi-max-frequency' does not match any of the regexes: 'pinctrl-[0-9]+'
See https://patchwork.ozlabs.org/patch/1249450
Please check and re-submit.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema
2020-03-05 8:54 ` Enric Balletbo i Serra
@ 2020-03-06 7:24 ` Lee Jones
0 siblings, 0 replies; 4+ messages in thread
From: Lee Jones @ 2020-03-06 7:24 UTC (permalink / raw)
To: Enric Balletbo i Serra
Cc: Ikjoon Jang, devicetree, Rob Herring, Dmitry Torokhov,
Gwendal Grignou, Mark Rutland, Benson Leung, Guenter Roeck,
Jiri Kosina, Benjamin Tissoires, Nicolas Boitchat, linux-input
On Thu, 05 Mar 2020, Enric Balletbo i Serra wrote:
> Hi Ikjoon,
>
> On 5/3/20 8:53, Ikjoon Jang wrote:
> > Convert the ChromeOS EC bindings to json-schema.
> >
> > Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> > ---
> > v6: adjust property dependencies, drop duplicated definitions,
> > and set additionalProperties
> > v5: unset additionalProperties
> > v4: text reflows, add type references, and fix examples
> > v3: node name changed in rpmsg example
> > v2: cleanup description, fix typos, remove LPC, and add RPMSG example
> > ---
> > .../devicetree/bindings/mfd/cros-ec.txt | 76 -----------
> > .../devicetree/bindings/mfd/cros-ec.yaml | 125 ++++++++++++++++++
>
> According to the feedback I received on other patches from Rob, the name of the
> file should include the vendor, in that case should be google,cros-ec.yaml
>
> I already argued in previous version why I think this should go in
> bindings/chrome instead of mfd, these bindings correspond to the platform/chrome
> device not the mfd cros ec device (cros-ec-dev) in MFD, anyway, I don't want to
> be touchy, but, as is, should go through the Lee Jones tree not our
> chrome-platform tree. So if Lee is fine with it I'm fine too.
Actually these have been reviewed and taken by Rob of late.
> Just another minor change (see below) and looks good to me.
>
> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
--
Lee Jones [李琼斯]
Linaro Services Technical Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-03-06 7:24 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-03-05 7:53 [PATCH v6] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema Ikjoon Jang
2020-03-05 8:54 ` Enric Balletbo i Serra
2020-03-06 7:24 ` Lee Jones
2020-03-05 16:48 ` Rob Herring
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.