Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Anson Huang <anson.huang@nxp.com>
To:     Rob Herring <robh@kernel.org>
CC:     Aisheng Dong <aisheng.dong@nxp.com>,
        "shawnguo@kernel.org" <shawnguo@kernel.org>,
        "s.hauer@pengutronix.de" <s.hauer@pengutronix.de>,
        "kernel@pengutronix.de" <kernel@pengutronix.de>,
        "festevam@gmail.com" <festevam@gmail.com>,
        "linux@rempel-privat.de" <linux@rempel-privat.de>,
        "wolfram@the-dreams.de" <wolfram@the-dreams.de>,
        "linux-i2c@vger.kernel.org" <linux-i2c@vger.kernel.org>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        "linux-arm-kernel@lists.infradead.org" 
        <linux-arm-kernel@lists.infradead.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        dl-linux-imx <linux-imx@nxp.com>
Subject: RE: [PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-schema
Thread-Topic: [PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-schema
Thread-Index: AQHWOhPYQZtBSbK1pkqHXpuLzKejUKjZ+4gAgACz0mA=
Date:   Tue, 16 Jun 2020 03:58:58 +0000
Message-ID: <DB3PR0402MB39167FB45A17247C442E6930F59D0@DB3PR0402MB3916.eurprd04.prod.outlook.com>
References: <1591235358-15516-1-git-send-email-Anson.Huang@nxp.com>
 <1591235358-15516-4-git-send-email-Anson.Huang@nxp.com>
 <20200615171018.GA1961591@bogus>
In-Reply-To: <20200615171018.GA1961591@bogus>
Accept-Language: en-US
Content-Language: en-US
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: c047a33c-0fc1-4611-47fc-08d811a99945
X-MS-Exchange-CrossTenant-originalarrivaltime: 16 Jun 2020 03:58:58.9416
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: dlynECaM5LC8aFoYRWj+cBr9uUMUgXzJBUXP4+H5DQeuoKhoOp8nsNoOnSZVLiNVaud4Y63mzNKfQ6dAPIkTUA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB3PR0402MB3705
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi, Rob


> Subject: Re: [PATCH V2 3/3] dt-bindings: i2c: Convert imx i2c to json-sch=
ema
>=20
> On Thu, Jun 04, 2020 at 09:49:18AM +0800, Anson Huang wrote:
> > Convert the i.MX I2C binding to DT schema format using json-schema,
> > some improvements applied, such as update example based on latest DT
> > file, add more compatible for existing SoCs, and remove unnecessary
> > common property "pinctrl".
> >
> > Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> > ---
> > Changes since V1:
> > 	- add "additionalProperties: false".
> > ---
> >  Documentation/devicetree/bindings/i2c/i2c-imx.txt  |  49 ---------
> > Documentation/devicetree/bindings/i2c/i2c-imx.yaml | 119
> > +++++++++++++++++++++
> >  2 files changed, 119 insertions(+), 49 deletions(-)  delete mode
> > 100644 Documentation/devicetree/bindings/i2c/i2c-imx.txt
> >  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> > b/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> > deleted file mode 100644
> > index b967544..0000000
> > --- a/Documentation/devicetree/bindings/i2c/i2c-imx.txt
> > +++ /dev/null
> > @@ -1,49 +0,0 @@
> > -* Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for i.MX
> > -
> > -Required properties:
> > -- compatible :
> > -  - "fsl,imx1-i2c" for I2C compatible with the one integrated on
> > i.MX1 SoC
> > -  - "fsl,imx21-i2c" for I2C compatible with the one integrated on
> > i.MX21 SoC
> > -  - "fsl,vf610-i2c" for I2C compatible with the one integrated on
> > Vybrid vf610 SoC
> > -- reg : Should contain I2C/HS-I2C registers location and length
> > -- interrupts : Should contain I2C/HS-I2C interrupt
> > -- clocks : Should contain the I2C/HS-I2C clock specifier
> > -
> > -Optional properties:
> > -- clock-frequency : Constains desired I2C/HS-I2C bus clock frequency i=
n Hz.
> > -  The absence of the property indicates the default frequency 100 kHz.
> > -- dmas: A list of two dma specifiers, one for each entry in dma-names.
> > -- dma-names: should contain "tx" and "rx".
> > -- scl-gpios: specify the gpio related to SCL pin
> > -- sda-gpios: specify the gpio related to SDA pin
> > -- pinctrl: add extra pinctrl to configure i2c pins to gpio function
> > for i2c
> > -  bus recovery, call it "gpio" state
> > -
> > -Examples:
> > -
> > -i2c@83fc4000 { /* I2C2 on i.MX51 */
> > -	compatible =3D "fsl,imx51-i2c", "fsl,imx21-i2c";
> > -	reg =3D <0x83fc4000 0x4000>;
> > -	interrupts =3D <63>;
> > -};
> > -
> > -i2c@70038000 { /* HS-I2C on i.MX51 */
> > -	compatible =3D "fsl,imx51-i2c", "fsl,imx21-i2c";
> > -	reg =3D <0x70038000 0x4000>;
> > -	interrupts =3D <64>;
> > -	clock-frequency =3D <400000>;
> > -};
> > -
> > -i2c0: i2c@40066000 { /* i2c0 on vf610 */
> > -	compatible =3D "fsl,vf610-i2c";
> > -	reg =3D <0x40066000 0x1000>;
> > -	interrupts =3D<0 71 0x04>;
> > -	dmas =3D <&edma0 0 50>,
> > -		<&edma0 0 51>;
> > -	dma-names =3D "rx","tx";
> > -	pinctrl-names =3D "default", "gpio";
> > -	pinctrl-0 =3D <&pinctrl_i2c1>;
> > -	pinctrl-1 =3D <&pinctrl_i2c1_gpio>;
> > -	scl-gpios =3D <&gpio5 26 GPIO_ACTIVE_HIGH>;
> > -	sda-gpios =3D <&gpio5 27 GPIO_ACTIVE_HIGH>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> > b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> > new file mode 100644
> > index 0000000..63cceab
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/i2c/i2c-imx.yaml
> > @@ -0,0 +1,119 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +https://eur01.safelinks.protection.outlook.com/?url=3Dhttp%3A%2F%2Fdev=
i
> >
> +cetree.org%2Fschemas%2Fi2c%2Fi2c-imx.yaml%23&amp;data=3D02%7C01%7C
> Anson
> >
> +.Huang%40nxp.com%7C943043d1a28548a7fd3308d8114efd9d%7C686ea1d
> 3bc2b4c6
> >
> +fa92cd99c5c301635%7C0%7C0%7C637278378260012996&amp;sdata=3DVZfJ
> %2BLVtuB
> > +JOWy0e9riauncrE5UNozko4iP6tYm9y80%3D&amp;reserved=3D0
> > +$schema:
> > +https://eur01.safelinks.protection.outlook.com/?url=3Dhttp%3A%2F%2Fdev=
i
> >
> +cetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=3D02%7C01%7CAns
> on.Hua
> >
> +ng%40nxp.com%7C943043d1a28548a7fd3308d8114efd9d%7C686ea1d3bc2
> b4c6fa92
> >
> +cd99c5c301635%7C0%7C0%7C637278378260012996&amp;sdata=3DABISCsw
> dkJMA4ECe
> > +JE7wKsgzcwZYQS1dfVrxCAecLlY%3D&amp;reserved=3D0
> > +
> > +title: Freescale Inter IC (I2C) and High Speed Inter IC (HS-I2C) for
> > +i.MX
> > +
> > +maintainers:
> > +  - Wolfram Sang <wolfram@the-dreams.de>
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - const: fsl,imx1-i2c
> > +      - const: fsl,imx21-i2c
> > +      - const: fsl,vf610-i2c
> > +      - items:
> > +          - const: fsl,imx35-i2c
> > +          - const: fsl,imx1-i2c
> > +      - items:
> > +          - enum:
> > +            - fsl,imx25-i2c
> > +            - fsl,imx27-i2c
> > +            - fsl,imx31-i2c
> > +            - fsl,imx50-i2c
> > +            - fsl,imx51-i2c
> > +            - fsl,imx53-i2c
> > +            - fsl,imx6q-i2c
> > +            - fsl,imx6sl-i2c
> > +            - fsl,imx6sx-i2c
> > +            - fsl,imx6sll-i2c
> > +            - fsl,imx6ul-i2c
> > +            - fsl,imx7s-i2c
> > +            - fsl,imx8mq-i2c
> > +            - fsl,imx8mm-i2c
> > +            - fsl,imx8mn-i2c
> > +            - fsl,imx8mp-i2c
> > +          - const: fsl,imx21-i2c
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  clock-names:
> > +    const: ipg
> > +
> > +  clock-frequency:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
>=20
> Already has a type.

Will remove the type and just use enum for it, it ONLY supports 100KHz/400K=
Hz.

>=20
> > +    description: |
> > +      Constains desired I2C/HS-I2C bus clock frequency in Hz.
> > +      The absence of the property indicates the default frequency 100 =
kHz.
> > +    default: 100000
>=20
> The bus default is up to 3MHz. Is that valid here?

No, it should be either 100KHz or 400KHz, so far on i.MX I2C, ONLY 100KHz/4=
00KHz are
supported/tested.=20

>=20
> > +
> > +  dmas:
> > +    items:
> > +      - description: DMA controller phandle and request line for RX
> > +      - description: DMA controller phandle and request line for TX
> > +
> > +  dma-names:
> > +    items:
> > +      - const: rx
> > +      - const: tx
> > +
> > +  sda-gpios:
> > +    $ref: '/schemas/types.yaml#/definitions/phandle'
>=20
> *-gpios already has a type

Will remove -gpios' type/description as it is already defined in i2c-gpio.y=
aml.

>=20
> > +    description: |
> > +      gpio used for the sda signal, this should be flagged as
> > +      active high using open drain with
> (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
> > +      from <dt-bindings/gpio/gpio.h> since the signal is by definition
> > +      open drain.
> > +    maxItems: 1
> > +
> > +  scl-gpios:
> > +    $ref: '/schemas/types.yaml#/definitions/phandle'
> > +    description: |
> > +      gpio used for the scl signal, this should be flagged as
> > +      active high using open drain with
> (GPIO_ACTIVE_HIGH|GPIO_OPEN_DRAIN)
> > +      from <dt-bindings/gpio/gpio.h> since the signal is by definition
> > +      open drain.
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - clocks
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/clock/imx5-clock.h>
> > +    #include <dt-bindings/clock/vf610-clock.h>
> > +    #include <dt-bindings/gpio/gpio.h>
> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> > +
> > +    i2c@83fc4000 {
> > +        compatible =3D "fsl,imx51-i2c", "fsl,imx21-i2c";
> > +        reg =3D <0x83fc4000 0x4000>;
> > +        interrupts =3D <63>;
> > +        clocks =3D <&clks IMX5_CLK_I2C2_GATE>;
> > +    };
> > +
> > +    i2c@40066000 {
> > +        compatible =3D "fsl,vf610-i2c";
> > +        reg =3D <0x40066000 0x1000>;
> > +        interrupts =3D <71 IRQ_TYPE_LEVEL_HIGH>;
> > +        clocks =3D <&clks VF610_CLK_I2C0>;
> > +        clock-names =3D "ipg";
> > +        dmas =3D <&edma0 0 50>,
> > +               <&edma0 0 51>;
> > +        dma-names =3D "rx","tx";
>=20
> space                       ^

Will fix it in V3.

Thanks,
Anson