From: Ikjoon Jang <ikjn@chromium.org>
To: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Cc: devicetree@vger.kernel.org, Rob Herring <robh+dt@kernel.org>,
Dmitry Torokhov <dmitry.torokhov@gmail.com>,
Lee Jones <lee.jones@linaro.org>,
Mark Rutland <mark.rutland@arm.com>,
Benson Leung <bleung@chromium.org>,
Guenter Roeck <groeck@chromium.org>,
Jiri Kosina <jikos@kernel.org>,
Benjamin Tissoires <benjamin.tissoires@redhat.com>,
Nicolas Boitchat <drinkcat@chromium.org>,
linux-input@vger.kernel.org,
Gwendal Grignou <gwendal@chromium.org>
Subject: Re: [PATCH] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema
Date: Wed, 15 Jan 2020 17:56:51 +0800 [thread overview]
Message-ID: <CAATdQgDNqPtYRsStvbQsy7M7S_TMShGELwuKg8AjARDi_KN6Pg@mail.gmail.com> (raw)
In-Reply-To: <ad5b6728-2435-9f97-870a-7107f5cc805b@collabora.com>
Hi,
<snip>
> > Signed-off-by: Ikjoon Jang <ikjn@chromium.org>
> > ---
> > .../devicetree/bindings/mfd/cros-ec.txt | 76 ----------
> > .../devicetree/bindings/mfd/cros-ec.yaml | 138 ++++++++++++++++++
>
> This is not an mfd binding anymore, the old binding is in the wrong place,
> please move to devicetree/bindings/chrome/google,cros-ec.yaml
>
I think creating a new 'chrome' subdirectory should involve more
discussions as there are
other chrome related things in dt-binding.
I'd like to convert the format first before moving forward.
<snip>
> > +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.
>
> I am not English native but I guess there are some typos. Lets take this
> opportunity to rewrite fix some parts, please feel free to ignore them if I am
> wrong.
>
yeah, I'm not too. Honestly, there was nothing strange for me before
you point out. :-)
anyway I'm trying my best to fix those things mentioned (typos,
removing LPC, rpmsg examples)
and do some generalizations (e.g. Cortex --> microcontroller). send v2
patch soon.
Thanks!
> typo: functions?
>
> > + The EC can be connect through various means (I2C, SPI, LPC, RPMSG)
>
> typo: 'connected' or 'is connected'
>
>
> I'd add '(I2C, SPI and others)' where other is RPMSG, ISHP, and future transport
> layers.
>
> > + and the compatible string used depends on the interface.
>
> on the communication 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.
>
> Not sure this part is clear an accurate to the reality, I'd just remove it.
ACK
>
> > +
> > +properties:
> > + compatible:
> > + oneOf:
> > + - description:
> > + For implementations of the EC is connected through I2C.
>
> s/is/are connected/?
>
> And the same change applies below.
>
> > + 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
>
> This does not exist in mainline so remove it.
ACK
<snip>
> + 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.
I will remove some details here ('some implementations need something' parts).
<snip>
> > + - if:
> > + properties:
> > + compatible:
> > + const: google,cros-ec-lpc
> > + then:
> > + properties:
> > + reg:
> > + description: |
> > + List of (IO address, size) pairs defining the interface uses
> > + required:
> > + - reg
> > +
>
> Remove the LPC part.
ACK
>
> > +examples:
> > + - |+
> > + // Example for I2C
>
> Use c style comments I guess
Okay, I will use '#' outside of example context in v2.
>
> > + i2c@12ca0000 {
>
> i2c0 {
>
> > + #address-cells = <1>;
> > + #size-cells = <0>;
>
> nit: Add an empty line here
ACK
>
> > + cros-ec@1e {
> > + reg = <0x1e>;
> > + compatible = "google,cros-ec-i2c";
>
> The compatible on top
>
> > + interrupts = <14 0>;
> > + interrupt-parent = <&wakeup_eint>;
> > + wakeup-source;
> > + };
>
> Just let's use an upstream example, i.e the snow one:
>
> cros-ec@1e {
> compatible = "google,cros-ec-i2c";
> reg = <0x1e>;
> interrupts = <6 IRQ_TYPE_NONE>;
> interrupt-parent = <&gpx1>;
> };
>
> > + };
> > + - |+
> > + // Example for SPI
> > + spi@131b0000 {
>
> spi0 {
>
> > + #address-cells = <1>;
> > + #size-cells = <0>;
>
> nit: Add an empty line here
ACK
>
> > + ec@0 {
>
> Use cros-ec@0, same name as before to be coherent
>
> > + compatible = "google,cros-ec-spi";
> > + reg = <0x0>;
> > + interrupts = <14 0>;
> > + interrupt-parent = <&wakeup_eint>;
>
> What about selecting a more simple example, without the controller-data to not
> confuse the reader.
>
> > + wakeup-source;
> > + spi-max-frequency = <5000000>;
> > + controller-data {
> > + cs-gpio = <&gpf0 3 4 3 0>;
> > + samsung,spi-cs;
> > + samsung,spi-feedback-delay = <2>;
> > + };
> > + };
> > + };
> > +
>
> I propose the veyron one.
>
> cros-ec@0 {
>
> compatible = "google,cros-ec-spi";
> reg = <0>;
> google,cros-ec-spi-pre-delay = <30>;
> interrupt-parent = <&gpio7>;
> interrupts = <RK_PA7 IRQ_TYPE_LEVEL_LOW>;
> spi-max-frequency = <3000000>;
> };
>
> > +...
> >
>
Okay, but I will use interrupts = <99 0> instead of <RK_XXX IRQ_XXX>
in here. :-)
> Could we have a RPMSG example too?
Okay
>
> Thanks,
> Enric
next prev parent reply other threads:[~2020-01-15 9:57 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-14 2:19 [PATCH] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema Ikjoon Jang
2020-01-14 12:58 ` Enric Balletbo i Serra
2020-01-15 9:56 ` Ikjoon Jang [this message]
2020-01-16 10:13 ` Ikjoon Jang
2020-01-16 12:29 ` Enric Balletbo i Serra
2020-01-21 7:47 ` [PATCH v3] " Ikjoon Jang
2020-01-27 15:57 ` Enric Balletbo i Serra
2020-01-27 16:12 ` Rob Herring
2020-01-27 16:25 ` Enric Balletbo i Serra
2020-02-04 7:44 ` Ikjoon Jang
2020-01-27 16:05 ` Rob Herring
2020-02-04 8:39 ` Ikjoon Jang
2020-02-14 6:26 ` [PATCH v4] " Ikjoon Jang
2020-02-14 15:39 ` Enric Balletbo i Serra
2020-02-18 20:20 ` Rob Herring
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAATdQgDNqPtYRsStvbQsy7M7S_TMShGELwuKg8AjARDi_KN6Pg@mail.gmail.com \
--to=ikjn@chromium.org \
--cc=benjamin.tissoires@redhat.com \
--cc=bleung@chromium.org \
--cc=devicetree@vger.kernel.org \
--cc=dmitry.torokhov@gmail.com \
--cc=drinkcat@chromium.org \
--cc=enric.balletbo@collabora.com \
--cc=groeck@chromium.org \
--cc=gwendal@chromium.org \
--cc=jikos@kernel.org \
--cc=lee.jones@linaro.org \
--cc=linux-input@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).