| Message ID | 1589813260-20036-2-git-send-email-Anson.Huang@nxp.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Covert i.MX GPT/TPM/SYSCTR timer binding to json-schema | expand |
> From: Anson Huang <Anson.Huang@nxp.com> > Sent: Monday, May 18, 2020 10:48 PM > > Convert the i.MX GPT binding to DT schema format using json-schema. > > Signed-off-by: Anson Huang <Anson.Huang@nxp.com> > --- > .../devicetree/bindings/timer/fsl,imxgpt.txt | 45 --------- > .../devicetree/bindings/timer/fsl,imxgpt.yaml | 109 > +++++++++++++++++++++ > 2 files changed, 109 insertions(+), 45 deletions(-) delete mode 100644 > Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > create mode 100644 > Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > > diff --git a/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > b/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > deleted file mode 100644 > index 5d8fd5b..0000000 > --- a/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > +++ /dev/null > @@ -1,45 +0,0 @@ > -Freescale i.MX General Purpose Timer (GPT) > - > -Required properties: > - > -- compatible : should be one of following: > - for i.MX1: > - - "fsl,imx1-gpt"; > - for i.MX21: > - - "fsl,imx21-gpt"; > - for i.MX27: > - - "fsl,imx27-gpt", "fsl,imx21-gpt"; > - for i.MX31: > - - "fsl,imx31-gpt"; > - for i.MX25: > - - "fsl,imx25-gpt", "fsl,imx31-gpt"; > - for i.MX50: > - - "fsl,imx50-gpt", "fsl,imx31-gpt"; > - for i.MX51: > - - "fsl,imx51-gpt", "fsl,imx31-gpt"; > - for i.MX53: > - - "fsl,imx53-gpt", "fsl,imx31-gpt"; > - for i.MX6Q: > - - "fsl,imx6q-gpt", "fsl,imx31-gpt"; > - for i.MX6DL: > - - "fsl,imx6dl-gpt"; > - for i.MX6SL: > - - "fsl,imx6sl-gpt", "fsl,imx6dl-gpt"; > - for i.MX6SX: > - - "fsl,imx6sx-gpt", "fsl,imx6dl-gpt"; > -- reg : specifies base physical address and size of the registers. > -- interrupts : should be the gpt interrupt. > -- clocks : the clocks provided by the SoC to drive the timer, must contain > - an entry for each entry in clock-names. > -- clock-names : must include "ipg" entry first, then "per" entry. > - > -Example: > - > -gpt1: timer@10003000 { > - compatible = "fsl,imx27-gpt", "fsl,imx21-gpt"; > - reg = <0x10003000 0x1000>; > - interrupts = <26>; > - clocks = <&clks IMX27_CLK_GPT1_IPG_GATE>, > - <&clks IMX27_CLK_PER1_GATE>; > - clock-names = "ipg", "per"; > -}; > diff --git a/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > b/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > new file mode 100644 > index 0000000..5c7186b > --- /dev/null > +++ b/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > @@ -0,0 +1,109 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2 > +--- > + > +title: Freescale i.MX General Purpose Timer (GPT) > + > +maintainers: > + - Sascha Hauer <s.hauer@pengutronix.de> > + > +properties: > + compatible: > + oneOf: > + - description: on i.MX1 the following compatible must be specified Such a description seems not necessary in order to make the doc more clean > + items: > + - const: "fsl,imx1-gpt" > + > + - description: on i.MX21 the following compatible must be specified > + items: > + - const: "fsl,imx21-gpt" > + > + - description: on i.MX27 the following compatibles must be specified > + items: > + - const: "fsl,imx27-gpt" > + - const: "fsl,imx21-gpt" > + > + - description: on i.MX31 the following compatible must be specified > + items: > + - const: "fsl,imx31-gpt" > + > + - description: on i.MX25 the following compatibles must be specified > + items: > + - const: "fsl,imx25-gpt" > + - const: "fsl,imx31-gpt" > + > + - description: on i.MX50 the following compatibles must be specified > + items: > + - const: "fsl,imx50-gpt" > + - const: "fsl,imx31-gpt" > + > + - description: on i.MX51 the following compatibles must be specified > + items: > + - const: "fsl,imx51-gpt" > + - const: "fsl,imx31-gpt" > + > + - description: on i.MX53 the following compatibles must be specified > + items: > + - const: "fsl,imx53-gpt" > + - const: "fsl,imx31-gpt" > + > + - description: on i.MX6Q the following compatibles must be specified > + items: > + - const: "fsl,imx6q-gpt" > + - const: "fsl,imx31-gpt" > + > + - description: on i.MX6DL the following compatible must be specified > + items: > + - const: "fsl,imx6dl-gpt" > + > + - description: on i.MX6SL the following compatibles must be specified > + items: > + - const: "fsl,imx6sl-gpt" > + - const: "fsl,imx6dl-gpt" > + > + - description: on i.MX6SX the following compatibles must be specified > + items: > + - const: "fsl,imx6sx-gpt" > + - const: "fsl,imx6dl-gpt" > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + clocks: > + items: > + - description: SoC GPT ipg clock > + - description: SoC GPT per clock > + maxItems: 2 maxItems is not needed > + > + clock-names: > + items: > + - const: ipg > + - const: per > + maxItems: 2 Ditto > + > +required: > + - compatible > + - reg > + - interrupts > + - clocks > + - clock-names > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/clock/imx27-clock.h> > + > + timer@10003000 { > + compatible = "fsl,imx27-gpt", "fsl,imx21-gpt"; > + reg = <0x10003000 0x1000>; > + interrupts = <26>; > + clocks = <&clks IMX27_CLK_GPT1_IPG_GATE>, > + <&clks IMX27_CLK_PER1_GATE>; > + clock-names = "ipg", "per"; > + }; > -- > 2.7.4
> Subject: RE: [PATCH 1/3] dt-bindings: timer: Convert i.MX GPT to json-schema > > > From: Anson Huang <Anson.Huang@nxp.com> > > Sent: Monday, May 18, 2020 10:48 PM > > > > Convert the i.MX GPT binding to DT schema format using json-schema. > > > > Signed-off-by: Anson Huang <Anson.Huang@nxp.com> > > --- > > .../devicetree/bindings/timer/fsl,imxgpt.txt | 45 --------- > > .../devicetree/bindings/timer/fsl,imxgpt.yaml | 109 > > +++++++++++++++++++++ > > 2 files changed, 109 insertions(+), 45 deletions(-) delete mode > > 100644 Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > > create mode 100644 > > Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > > > > diff --git a/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > > b/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > > deleted file mode 100644 > > index 5d8fd5b..0000000 > > --- a/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt > > +++ /dev/null > > @@ -1,45 +0,0 @@ > > -Freescale i.MX General Purpose Timer (GPT) > > - > > -Required properties: > > - > > -- compatible : should be one of following: > > - for i.MX1: > > - - "fsl,imx1-gpt"; > > - for i.MX21: > > - - "fsl,imx21-gpt"; > > - for i.MX27: > > - - "fsl,imx27-gpt", "fsl,imx21-gpt"; > > - for i.MX31: > > - - "fsl,imx31-gpt"; > > - for i.MX25: > > - - "fsl,imx25-gpt", "fsl,imx31-gpt"; > > - for i.MX50: > > - - "fsl,imx50-gpt", "fsl,imx31-gpt"; > > - for i.MX51: > > - - "fsl,imx51-gpt", "fsl,imx31-gpt"; > > - for i.MX53: > > - - "fsl,imx53-gpt", "fsl,imx31-gpt"; > > - for i.MX6Q: > > - - "fsl,imx6q-gpt", "fsl,imx31-gpt"; > > - for i.MX6DL: > > - - "fsl,imx6dl-gpt"; > > - for i.MX6SL: > > - - "fsl,imx6sl-gpt", "fsl,imx6dl-gpt"; > > - for i.MX6SX: > > - - "fsl,imx6sx-gpt", "fsl,imx6dl-gpt"; > > -- reg : specifies base physical address and size of the registers. > > -- interrupts : should be the gpt interrupt. > > -- clocks : the clocks provided by the SoC to drive the timer, must contain > > - an entry for each entry in clock-names. > > -- clock-names : must include "ipg" entry first, then "per" entry. > > - > > -Example: > > - > > -gpt1: timer@10003000 { > > - compatible = "fsl,imx27-gpt", "fsl,imx21-gpt"; > > - reg = <0x10003000 0x1000>; > > - interrupts = <26>; > > - clocks = <&clks IMX27_CLK_GPT1_IPG_GATE>, > > - <&clks IMX27_CLK_PER1_GATE>; > > - clock-names = "ipg", "per"; > > -}; > > diff --git a/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > > b/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > > new file mode 100644 > > index 0000000..5c7186b > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml > > @@ -0,0 +1,109 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2 > > +--- > > + > > +title: Freescale i.MX General Purpose Timer (GPT) > > + > > +maintainers: > > + - Sascha Hauer <s.hauer@pengutronix.de> > > + > > +properties: > > + compatible: > > + oneOf: > > + - description: on i.MX1 the following compatible must be > > +specified > > Such a description seems not necessary in order to make the doc more clean You meant the description is NOT necessary for those simple compatible string platforms or for all platforms, I feel like having the description is more clear for users. Anson
diff --git a/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt b/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt deleted file mode 100644 index 5d8fd5b..0000000 --- a/Documentation/devicetree/bindings/timer/fsl,imxgpt.txt +++ /dev/null @@ -1,45 +0,0 @@ -Freescale i.MX General Purpose Timer (GPT) - -Required properties: - -- compatible : should be one of following: - for i.MX1: - - "fsl,imx1-gpt"; - for i.MX21: - - "fsl,imx21-gpt"; - for i.MX27: - - "fsl,imx27-gpt", "fsl,imx21-gpt"; - for i.MX31: - - "fsl,imx31-gpt"; - for i.MX25: - - "fsl,imx25-gpt", "fsl,imx31-gpt"; - for i.MX50: - - "fsl,imx50-gpt", "fsl,imx31-gpt"; - for i.MX51: - - "fsl,imx51-gpt", "fsl,imx31-gpt"; - for i.MX53: - - "fsl,imx53-gpt", "fsl,imx31-gpt"; - for i.MX6Q: - - "fsl,imx6q-gpt", "fsl,imx31-gpt"; - for i.MX6DL: - - "fsl,imx6dl-gpt"; - for i.MX6SL: - - "fsl,imx6sl-gpt", "fsl,imx6dl-gpt"; - for i.MX6SX: - - "fsl,imx6sx-gpt", "fsl,imx6dl-gpt"; -- reg : specifies base physical address and size of the registers. -- interrupts : should be the gpt interrupt. -- clocks : the clocks provided by the SoC to drive the timer, must contain - an entry for each entry in clock-names. -- clock-names : must include "ipg" entry first, then "per" entry. - -Example: - -gpt1: timer@10003000 { - compatible = "fsl,imx27-gpt", "fsl,imx21-gpt"; - reg = <0x10003000 0x1000>; - interrupts = <26>; - clocks = <&clks IMX27_CLK_GPT1_IPG_GATE>, - <&clks IMX27_CLK_PER1_GATE>; - clock-names = "ipg", "per"; -}; diff --git a/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml b/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml new file mode 100644 index 0000000..5c7186b --- /dev/null +++ b/Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml @@ -0,0 +1,109 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/timer/fsl,imxgpt.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Freescale i.MX General Purpose Timer (GPT) + +maintainers: + - Sascha Hauer <s.hauer@pengutronix.de> + +properties: + compatible: + oneOf: + - description: on i.MX1 the following compatible must be specified + items: + - const: "fsl,imx1-gpt" + + - description: on i.MX21 the following compatible must be specified + items: + - const: "fsl,imx21-gpt" + + - description: on i.MX27 the following compatibles must be specified + items: + - const: "fsl,imx27-gpt" + - const: "fsl,imx21-gpt" + + - description: on i.MX31 the following compatible must be specified + items: + - const: "fsl,imx31-gpt" + + - description: on i.MX25 the following compatibles must be specified + items: + - const: "fsl,imx25-gpt" + - const: "fsl,imx31-gpt" + + - description: on i.MX50 the following compatibles must be specified + items: + - const: "fsl,imx50-gpt" + - const: "fsl,imx31-gpt" + + - description: on i.MX51 the following compatibles must be specified + items: + - const: "fsl,imx51-gpt" + - const: "fsl,imx31-gpt" + + - description: on i.MX53 the following compatibles must be specified + items: + - const: "fsl,imx53-gpt" + - const: "fsl,imx31-gpt" + + - description: on i.MX6Q the following compatibles must be specified + items: + - const: "fsl,imx6q-gpt" + - const: "fsl,imx31-gpt" + + - description: on i.MX6DL the following compatible must be specified + items: + - const: "fsl,imx6dl-gpt" + + - description: on i.MX6SL the following compatibles must be specified + items: + - const: "fsl,imx6sl-gpt" + - const: "fsl,imx6dl-gpt" + + - description: on i.MX6SX the following compatibles must be specified + items: + - const: "fsl,imx6sx-gpt" + - const: "fsl,imx6dl-gpt" + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + items: + - description: SoC GPT ipg clock + - description: SoC GPT per clock + maxItems: 2 + + clock-names: + items: + - const: ipg + - const: per + maxItems: 2 + +required: + - compatible + - reg + - interrupts + - clocks + - clock-names + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/imx27-clock.h> + + timer@10003000 { + compatible = "fsl,imx27-gpt", "fsl,imx21-gpt"; + reg = <0x10003000 0x1000>; + interrupts = <26>; + clocks = <&clks IMX27_CLK_GPT1_IPG_GATE>, + <&clks IMX27_CLK_PER1_GATE>; + clock-names = "ipg", "per"; + };
Convert the i.MX GPT binding to DT schema format using json-schema. Signed-off-by: Anson Huang <Anson.Huang@nxp.com> --- .../devicetree/bindings/timer/fsl,imxgpt.txt | 45 --------- .../devicetree/bindings/timer/fsl,imxgpt.yaml | 109 +++++++++++++++++++++ 2 files changed, 109 insertions(+), 45 deletions(-) delete mode 100644 Documentation/devicetree/bindings/timer/fsl,imxgpt.txt create mode 100644 Documentation/devicetree/bindings/timer/fsl,imxgpt.yaml