diff mbox series

[v7] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema

Message ID 20200306085513.76024-1-ikjn@chromium.org (mailing list archive)
State Mainlined
Commit 46b5780688c0d825b6b8d49b267b13102bea512d
Headers show
Series [v7] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema | expand

Commit Message

Ikjoon Jang March 6, 2020, 8:55 a.m. UTC
Convert the ChromeOS EC bindings to json-schema.

Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
---
 .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
 .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
 2 files changed, 129 insertions(+), 76 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
 create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml

Comments

Rob Herring March 12, 2020, 7:20 p.m. UTC | #1
On Fri,  6 Mar 2020 16:55:13 +0800, Ikjoon Jang wrote:
> Convert the ChromeOS EC bindings to json-schema.
> 
> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> ---
>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
>  2 files changed, 129 insertions(+), 76 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Ikjoon Jang April 8, 2020, 9:58 a.m. UTC | #2
On Fri, Mar 13, 2020 at 3:20 AM Rob Herring <robh@kernel.org> wrote:
>
> On Fri,  6 Mar 2020 16:55:13 +0800, Ikjoon Jang wrote:
> > Convert the ChromeOS EC bindings to json-schema.
> >
> > Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> > Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> > ---
> >  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
> >  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
> >  2 files changed, 129 insertions(+), 76 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
> >  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> >
>
> Reviewed-by: Rob Herring <robh@kernel.org>

This patch should go through Lee Jones tree?
Lee Jones April 14, 2020, 8:10 a.m. UTC | #3
On Wed, 08 Apr 2020, Ikjoon Jang wrote:

> On Fri, Mar 13, 2020 at 3:20 AM Rob Herring <robh@kernel.org> wrote:
> >
> > On Fri,  6 Mar 2020 16:55:13 +0800, Ikjoon Jang wrote:
> > > Convert the ChromeOS EC bindings to json-schema.
> > >
> > > Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> > > Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> > > ---
> > >  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
> > >  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
> > >  2 files changed, 129 insertions(+), 76 deletions(-)
> > >  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
> > >  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> > >
> >
> > Reviewed-by: Rob Herring <robh@kernel.org>
> 
> This patch should go through Lee Jones tree?

The way we are operating at the moment, it's a coin flip (50/50)!

Happy either way at the moment to be honest.
Lee Jones April 17, 2020, 10:13 a.m. UTC | #4
On Fri, 06 Mar 2020, Ikjoon Jang wrote:

> Convert the ChromeOS EC bindings to json-schema.
> 
> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> ---
>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
>  2 files changed, 129 insertions(+), 76 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml

Applied, thanks.
Enric Balletbo i Serra June 25, 2020, 10:46 a.m. UTC | #5
Hi Lee,

On 17/4/20 12:13, Lee Jones wrote:
> On Fri, 06 Mar 2020, Ikjoon Jang wrote:
> 
>> Convert the ChromeOS EC bindings to json-schema.
>>
>> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
>> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
>> ---
>>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
>>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
>>  2 files changed, 129 insertions(+), 76 deletions(-)
>>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
>>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> 
> Applied, thanks.
> 

I don't see this patch applied, I am missing something?

Thanks,
 Enric
Lee Jones June 25, 2020, 1:46 p.m. UTC | #6
On Thu, 25 Jun 2020, Enric Balletbo i Serra wrote:

> Hi Lee,
> 
> On 17/4/20 12:13, Lee Jones wrote:
> > On Fri, 06 Mar 2020, Ikjoon Jang wrote:
> > 
> >> Convert the ChromeOS EC bindings to json-schema.
> >>
> >> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> >> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> >> ---
> >>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
> >>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
> >>  2 files changed, 129 insertions(+), 76 deletions(-)
> >>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
> >>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> > 
> > Applied, thanks.
> 
> I don't see this patch applied, I am missing something?

It should be there.  Not sure when the MFD repo was last pushed.

I'll try pushing it again (there are a couple of new patches from
today).  Maybe that will spur a fetch from -next.  If it's still not
there tomorrow, let me know and I'll investigate further.
Enric Balletbo i Serra June 26, 2020, 7:56 a.m. UTC | #7
Hi Lee,

On 25/6/20 15:46, Lee Jones wrote:
> On Thu, 25 Jun 2020, Enric Balletbo i Serra wrote:
> 
>> Hi Lee,
>>
>> On 17/4/20 12:13, Lee Jones wrote:
>>> On Fri, 06 Mar 2020, Ikjoon Jang wrote:
>>>
>>>> Convert the ChromeOS EC bindings to json-schema.
>>>>
>>>> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
>>>> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
>>>> ---
>>>>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
>>>>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
>>>>  2 files changed, 129 insertions(+), 76 deletions(-)
>>>>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
>>>>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
>>>
>>> Applied, thanks.
>>
>> I don't see this patch applied, I am missing something?
> 
> It should be there.  Not sure when the MFD repo was last pushed.
> 
> I'll try pushing it again (there are a couple of new patches from
> today).  Maybe that will spur a fetch from -next.  If it's still not
> there tomorrow, let me know and I'll investigate further.
> 

Still not there, just to make sure I am looking at the right branch, I am checking

https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git/log/?h=for-mfd-next

Thanks,
 Enric
Lee Jones June 26, 2020, 9:40 a.m. UTC | #8
On Fri, 26 Jun 2020, Enric Balletbo i Serra wrote:

> Hi Lee,
> 
> On 25/6/20 15:46, Lee Jones wrote:
> > On Thu, 25 Jun 2020, Enric Balletbo i Serra wrote:
> > 
> >> Hi Lee,
> >>
> >> On 17/4/20 12:13, Lee Jones wrote:
> >>> On Fri, 06 Mar 2020, Ikjoon Jang wrote:
> >>>
> >>>> Convert the ChromeOS EC bindings to json-schema.
> >>>>
> >>>> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> >>>> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> >>>> ---
> >>>>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
> >>>>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
> >>>>  2 files changed, 129 insertions(+), 76 deletions(-)
> >>>>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
> >>>>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> >>>
> >>> Applied, thanks.
> >>
> >> I don't see this patch applied, I am missing something?
> > 
> > It should be there.  Not sure when the MFD repo was last pushed.
> > 
> > I'll try pushing it again (there are a couple of new patches from
> > today).  Maybe that will spur a fetch from -next.  If it's still not
> > there tomorrow, let me know and I'll investigate further.
> > 
> 
> Still not there, just to make sure I am looking at the right branch, I am checking
> 
> https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git/log/?h=for-mfd-next

Oh, I see what's happened.

Looks like this patch wasn't sent to LKML, so my apply script failed.

Any reason not to send it to LKML?
Enric Balletbo i Serra June 26, 2020, 9:47 a.m. UTC | #9
Hi Lee,

On 26/6/20 11:40, Lee Jones wrote:
> On Fri, 26 Jun 2020, Enric Balletbo i Serra wrote:
> 
>> Hi Lee,
>>
>> On 25/6/20 15:46, Lee Jones wrote:
>>> On Thu, 25 Jun 2020, Enric Balletbo i Serra wrote:
>>>
>>>> Hi Lee,
>>>>
>>>> On 17/4/20 12:13, Lee Jones wrote:
>>>>> On Fri, 06 Mar 2020, Ikjoon Jang wrote:
>>>>>
>>>>>> Convert the ChromeOS EC bindings to json-schema.
>>>>>>
>>>>>> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
>>>>>> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
>>>>>> ---
>>>>>>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
>>>>>>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
>>>>>>  2 files changed, 129 insertions(+), 76 deletions(-)
>>>>>>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
>>>>>>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
>>>>>
>>>>> Applied, thanks.
>>>>
>>>> I don't see this patch applied, I am missing something?
>>>
>>> It should be there.  Not sure when the MFD repo was last pushed.
>>>
>>> I'll try pushing it again (there are a couple of new patches from
>>> today).  Maybe that will spur a fetch from -next.  If it's still not
>>> there tomorrow, let me know and I'll investigate further.
>>>
>>
>> Still not there, just to make sure I am looking at the right branch, I am checking
>>
>> https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git/log/?h=for-mfd-next
> 
> Oh, I see what's happened.
> 
> Looks like this patch wasn't sent to LKML, so my apply script failed.
> 
> Any reason not to send it to LKML?
> 

Ikjoon? I agree that is a good practice cc always the LKML, also I didn't know
you had a script looking at it to pick the patches, that's useful to know :-)

Do you want we resend the patch? In such case, Ikjoon, can you resend it?

Thanks,
 Enric
Lee Jones June 26, 2020, 3:34 p.m. UTC | #10
On Fri, 26 Jun 2020, Enric Balletbo i Serra wrote:

> Hi Lee,
> 
> On 26/6/20 11:40, Lee Jones wrote:
> > On Fri, 26 Jun 2020, Enric Balletbo i Serra wrote:
> > 
> >> Hi Lee,
> >>
> >> On 25/6/20 15:46, Lee Jones wrote:
> >>> On Thu, 25 Jun 2020, Enric Balletbo i Serra wrote:
> >>>
> >>>> Hi Lee,
> >>>>
> >>>> On 17/4/20 12:13, Lee Jones wrote:
> >>>>> On Fri, 06 Mar 2020, Ikjoon Jang wrote:
> >>>>>
> >>>>>> Convert the ChromeOS EC bindings to json-schema.
> >>>>>>
> >>>>>> Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> >>>>>> Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> >>>>>> ---
> >>>>>>  .../devicetree/bindings/mfd/cros-ec.txt       |  76 -----------
> >>>>>>  .../bindings/mfd/google,cros-ec.yaml          | 129 ++++++++++++++++++
> >>>>>>  2 files changed, 129 insertions(+), 76 deletions(-)
> >>>>>>  delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt
> >>>>>>  create mode 100644 Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
> >>>>>
> >>>>> Applied, thanks.
> >>>>
> >>>> I don't see this patch applied, I am missing something?
> >>>
> >>> It should be there.  Not sure when the MFD repo was last pushed.
> >>>
> >>> I'll try pushing it again (there are a couple of new patches from
> >>> today).  Maybe that will spur a fetch from -next.  If it's still not
> >>> there tomorrow, let me know and I'll investigate further.
> >>>
> >>
> >> Still not there, just to make sure I am looking at the right branch, I am checking
> >>
> >> https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git/log/?h=for-mfd-next
> > 
> > Oh, I see what's happened.
> > 
> > Looks like this patch wasn't sent to LKML, so my apply script failed.
> > 
> > Any reason not to send it to LKML?
> > 
> 
> Ikjoon? I agree that is a good practice cc always the LKML, also I didn't know
> you had a script looking at it to pick the patches, that's useful to know :-)
> 
> Do you want we resend the patch? In such case, Ikjoon, can you resend it?

No it's okay.  I will apply it manually (probably on Monday).
diff mbox series

Patch

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/google,cros-ec.yaml b/Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
new file mode 100644
index 000000000000..6a7279a85ec1
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/google,cros-ec.yaml
@@ -0,0 +1,129 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/google,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
+
+  spi-max-frequency:
+    description: Maximum SPI frequency of the device in Hz.
+
+  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
+    spi-max-frequency: 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 {
+            compatible = "google,cros-ec-rpmsg";
+        };
+    };
+...