| Message ID | 20200221123214.26341-1-dafna.hirschfeld@collabora.com |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | [v4,1/2] dt-bindings: i2c: cros-ec-tunnel: convert i2c-cros-ec-tunnel.txt to yaml | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | warning | "total: 0 errors, 3 warnings, 63 lines checked" |
| robh/dt-meta-schema | success |
Hi Dafna, On 21/2/20 13:32, Dafna Hirschfeld wrote: > Convert the binding file i2c-cros-ec-tunnel.txt to yaml format. > > This was tested and verified on ARM and ARM64 with: > > make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > > Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com> > --- > Changes since v1: > - changing the subject to start with "dt-bindings: i2c: cros-ec-tunnel:" > - changing the license to (GPL-2.0-only OR BSD-2-Clause) > - removing "Guenter Roeck <groeck@chromium.org>" from the maintainers list > - adding ref: /schemas/i2c/i2c-controller.yaml > > Changes since v2: > - adding another patch that fixes a warning found by this patch > > Changes since v3: > - In the example, change sbs-battery@b to battery@b > > > .../bindings/i2c/i2c-cros-ec-tunnel.txt | 39 ------------ > .../bindings/i2c/i2c-cros-ec-tunnel.yaml | 63 +++++++++++++++++++ > 2 files changed, 63 insertions(+), 39 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt > create mode 100644 Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > According to the feedback I received on another patch from Rob, seems that you should name the file with the full compatible string "google,i2c-cros-ec-tunnel.yaml" I know we didn't do this with the extcon-usbc-cros-ec.yaml but seems this is the right way to do it. Just take this in consideration for future patches. > diff --git a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt > deleted file mode 100644 > index 898f030eba62..000000000000 > --- a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt > +++ /dev/null > @@ -1,39 +0,0 @@ > -I2C bus that tunnels through the ChromeOS EC (cros-ec) > -====================================================== > -On some ChromeOS board designs we've got a connection to the EC (embedded > -controller) but no direct connection to some devices on the other side of > -the EC (like a battery and PMIC). To get access to those devices we need > -to tunnel our i2c commands through the EC. > - > -The node for this device should be under a cros-ec node like google,cros-ec-spi > -or google,cros-ec-i2c. > - > - > -Required properties: > -- compatible: google,cros-ec-i2c-tunnel > -- google,remote-bus: The EC bus we'd like to talk to. > - > -Optional child nodes: > -- One node per I2C device connected to the tunnelled I2C bus. > - > - > -Example: > - cros-ec@0 { > - compatible = "google,cros-ec-spi"; > - > - ... > - > - i2c-tunnel { > - compatible = "google,cros-ec-i2c-tunnel"; > - #address-cells = <1>; > - #size-cells = <0>; > - > - google,remote-bus = <0>; > - > - battery: sbs-battery@b { > - compatible = "sbs,sbs-battery"; > - reg = <0xb>; > - sbs,poll-retry-count = <1>; > - }; > - }; > - } > diff --git a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > new file mode 100644 > index 000000000000..cfe4f0aeb46f > --- /dev/null > +++ b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > @@ -0,0 +1,63 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/i2c/i2c-cros-ec-tunnel.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: I2C bus that tunnels through the ChromeOS EC (cros-ec) > + > +maintainers: > + - Benson Leung <bleung@chromium.org> > + - Enric Balletbo i Serra <enric.balletbo@collabora.com> > + > +description: | > + On some ChromeOS board designs we've got a connection to the EC (embedded > + controller) but no direct connection to some devices on the other side of > + the EC (like a battery and PMIC). To get access to those devices we need > + to tunnel our i2c commands through the EC. > + The node for this device should be under a cros-ec node like google,cros-ec-spi > + or google,cros-ec-i2c. > + > +allOf: > + - $ref: /schemas/i2c/i2c-controller.yaml# > + > +properties: > + compatible: > + const: > + google,cros-ec-i2c-tunnel > + > + google,remote-bus: > + $ref: "/schemas/types.yaml#/definitions/uint32" > + description: The EC bus we'd like to talk to. > + > + "#address-cells": true > + "#size-cells": true > + > +patternProperties: > + "^.*@[0-9a-f]+$": > + type: object > + description: One node per I2C device connected to the tunnelled I2C bus. > + > +additionalProperties: false > + > +required: > + - compatible > + - google,remote-bus > + > +examples: > + - | > + cros-ec@0 { > + compatible = "google,cros-ec-spi"; Like we did with the extcon-usbc-cros-ec.yaml I think would be nice have a complete example here too. + spi0 { + #address-cells = <1>; + #size-cells = <0>; + cros-ec@0 { + compatible = "google,cros-ec-spi"; + reg = <0>; > + i2c-tunnel { > + compatible = "google,cros-ec-i2c-tunnel"; > + #address-cells = <1>; > + #size-cells = <0>; > + google,remote-bus = <0>; > + > + battery: battery@b { > + compatible = "sbs,sbs-battery"; > + reg = <0xb>; > + sbs,poll-retry-count = <1>; > + }; > + }; > + }; >
On Fri, Feb 21, 2020 at 04:28:59PM +0100, Enric Balletbo i Serra wrote: > Hi Dafna, > > On 21/2/20 13:32, Dafna Hirschfeld wrote: > > Convert the binding file i2c-cros-ec-tunnel.txt to yaml format. > > > > This was tested and verified on ARM and ARM64 with: > > > > make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > > make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > > > > Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com> > > --- > > Changes since v1: > > - changing the subject to start with "dt-bindings: i2c: cros-ec-tunnel:" > > - changing the license to (GPL-2.0-only OR BSD-2-Clause) > > - removing "Guenter Roeck <groeck@chromium.org>" from the maintainers list > > - adding ref: /schemas/i2c/i2c-controller.yaml > > > > Changes since v2: > > - adding another patch that fixes a warning found by this patch > > > > Changes since v3: > > - In the example, change sbs-battery@b to battery@b > > > > > > .../bindings/i2c/i2c-cros-ec-tunnel.txt | 39 ------------ > > .../bindings/i2c/i2c-cros-ec-tunnel.yaml | 63 +++++++++++++++++++ > > 2 files changed, 63 insertions(+), 39 deletions(-) > > delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt > > create mode 100644 Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > > > > According to the feedback I received on another patch from Rob, seems that you > should name the file with the full compatible string > "google,i2c-cros-ec-tunnel.yaml" > > I know we didn't do this with the extcon-usbc-cros-ec.yaml but seems this is the > right way to do it. Just take this in consideration for future patches. > > > > diff --git a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt > > deleted file mode 100644 > > index 898f030eba62..000000000000 > > --- a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt > > +++ /dev/null > > @@ -1,39 +0,0 @@ > > -I2C bus that tunnels through the ChromeOS EC (cros-ec) > > -====================================================== > > -On some ChromeOS board designs we've got a connection to the EC (embedded > > -controller) but no direct connection to some devices on the other side of > > -the EC (like a battery and PMIC). To get access to those devices we need > > -to tunnel our i2c commands through the EC. > > - > > -The node for this device should be under a cros-ec node like google,cros-ec-spi > > -or google,cros-ec-i2c. > > - > > - > > -Required properties: > > -- compatible: google,cros-ec-i2c-tunnel > > -- google,remote-bus: The EC bus we'd like to talk to. > > - > > -Optional child nodes: > > -- One node per I2C device connected to the tunnelled I2C bus. > > - > > - > > -Example: > > - cros-ec@0 { > > - compatible = "google,cros-ec-spi"; > > - > > - ... > > - > > - i2c-tunnel { > > - compatible = "google,cros-ec-i2c-tunnel"; > > - #address-cells = <1>; > > - #size-cells = <0>; > > - > > - google,remote-bus = <0>; > > - > > - battery: sbs-battery@b { > > - compatible = "sbs,sbs-battery"; > > - reg = <0xb>; > > - sbs,poll-retry-count = <1>; > > - }; > > - }; > > - } > > diff --git a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > > new file mode 100644 > > index 000000000000..cfe4f0aeb46f > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml > > @@ -0,0 +1,63 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/i2c/i2c-cros-ec-tunnel.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: I2C bus that tunnels through the ChromeOS EC (cros-ec) > > + > > +maintainers: > > + - Benson Leung <bleung@chromium.org> > > + - Enric Balletbo i Serra <enric.balletbo@collabora.com> > > + > > +description: | > > + On some ChromeOS board designs we've got a connection to the EC (embedded > > + controller) but no direct connection to some devices on the other side of > > + the EC (like a battery and PMIC). To get access to those devices we need > > + to tunnel our i2c commands through the EC. > > + The node for this device should be under a cros-ec node like google,cros-ec-spi > > + or google,cros-ec-i2c. > > + > > +allOf: > > + - $ref: /schemas/i2c/i2c-controller.yaml# > > + > > +properties: > > + compatible: > > + const: > > + google,cros-ec-i2c-tunnel > > + > > + google,remote-bus: > > + $ref: "/schemas/types.yaml#/definitions/uint32" > > + description: The EC bus we'd like to talk to. > > + > > + "#address-cells": true > > + "#size-cells": true > > + > > +patternProperties: > > + "^.*@[0-9a-f]+$": > > + type: object > > + description: One node per I2C device connected to the tunnelled I2C bus. > > + > > +additionalProperties: false > > + > > +required: > > + - compatible > > + - google,remote-bus > > + > > +examples: > > + - | > > + cros-ec@0 { > > + compatible = "google,cros-ec-spi"; > > Like we did with the extcon-usbc-cros-ec.yaml I think would be nice have a > complete example here too. Yes, or once we have a schema for "google,cros-ec-spi" it will start failing. With these MFDs, it's going to be easier to just have 1 complete example instead of bits and pieces spread around. Rob
diff --git a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt deleted file mode 100644 index 898f030eba62..000000000000 --- a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt +++ /dev/null @@ -1,39 +0,0 @@ -I2C bus that tunnels through the ChromeOS EC (cros-ec) -====================================================== -On some ChromeOS board designs we've got a connection to the EC (embedded -controller) but no direct connection to some devices on the other side of -the EC (like a battery and PMIC). To get access to those devices we need -to tunnel our i2c commands through the EC. - -The node for this device should be under a cros-ec node like google,cros-ec-spi -or google,cros-ec-i2c. - - -Required properties: -- compatible: google,cros-ec-i2c-tunnel -- google,remote-bus: The EC bus we'd like to talk to. - -Optional child nodes: -- One node per I2C device connected to the tunnelled I2C bus. - - -Example: - cros-ec@0 { - compatible = "google,cros-ec-spi"; - - ... - - i2c-tunnel { - compatible = "google,cros-ec-i2c-tunnel"; - #address-cells = <1>; - #size-cells = <0>; - - google,remote-bus = <0>; - - battery: sbs-battery@b { - compatible = "sbs,sbs-battery"; - reg = <0xb>; - sbs,poll-retry-count = <1>; - }; - }; - } diff --git a/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml new file mode 100644 index 000000000000..cfe4f0aeb46f --- /dev/null +++ b/Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml @@ -0,0 +1,63 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/i2c/i2c-cros-ec-tunnel.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: I2C bus that tunnels through the ChromeOS EC (cros-ec) + +maintainers: + - Benson Leung <bleung@chromium.org> + - Enric Balletbo i Serra <enric.balletbo@collabora.com> + +description: | + On some ChromeOS board designs we've got a connection to the EC (embedded + controller) but no direct connection to some devices on the other side of + the EC (like a battery and PMIC). To get access to those devices we need + to tunnel our i2c commands through the EC. + The node for this device should be under a cros-ec node like google,cros-ec-spi + or google,cros-ec-i2c. + +allOf: + - $ref: /schemas/i2c/i2c-controller.yaml# + +properties: + compatible: + const: + google,cros-ec-i2c-tunnel + + google,remote-bus: + $ref: "/schemas/types.yaml#/definitions/uint32" + description: The EC bus we'd like to talk to. + + "#address-cells": true + "#size-cells": true + +patternProperties: + "^.*@[0-9a-f]+$": + type: object + description: One node per I2C device connected to the tunnelled I2C bus. + +additionalProperties: false + +required: + - compatible + - google,remote-bus + +examples: + - | + cros-ec@0 { + compatible = "google,cros-ec-spi"; + i2c-tunnel { + compatible = "google,cros-ec-i2c-tunnel"; + #address-cells = <1>; + #size-cells = <0>; + google,remote-bus = <0>; + + battery: battery@b { + compatible = "sbs,sbs-battery"; + reg = <0xb>; + sbs,poll-retry-count = <1>; + }; + }; + };
Convert the binding file i2c-cros-ec-tunnel.txt to yaml format. This was tested and verified on ARM and ARM64 with: make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com> --- Changes since v1: - changing the subject to start with "dt-bindings: i2c: cros-ec-tunnel:" - changing the license to (GPL-2.0-only OR BSD-2-Clause) - removing "Guenter Roeck <groeck@chromium.org>" from the maintainers list - adding ref: /schemas/i2c/i2c-controller.yaml Changes since v2: - adding another patch that fixes a warning found by this patch Changes since v3: - In the example, change sbs-battery@b to battery@b .../bindings/i2c/i2c-cros-ec-tunnel.txt | 39 ------------ .../bindings/i2c/i2c-cros-ec-tunnel.yaml | 63 +++++++++++++++++++ 2 files changed, 63 insertions(+), 39 deletions(-) delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.txt create mode 100644 Documentation/devicetree/bindings/i2c/i2c-cros-ec-tunnel.yaml