| Message ID | 1589954560-10810-1-git-send-email-Anson.Huang@nxp.com (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | [V2] dt-bindings: thermal: Convert i.MX to json-schema | expand |
> From: Anson Huang <Anson.Huang@nxp.com> > Sent: Wednesday, May 20, 2020 2:03 PM > > Convert the i.MX thermal binding to DT schema format using json-schema > > Signed-off-by: Anson Huang <Anson.Huang@nxp.com> > --- > Changes since V1: > - move tempmon node into its parent node anatop in example; > - improve "fsl,tempmon" description. > --- > .../devicetree/bindings/thermal/imx-thermal.txt | 61 ------------- > .../devicetree/bindings/thermal/imx-thermal.yaml | 100 [...] > +title: NXP i.MX Thermal Binding > + > +maintainers: > + - Shawn Guo <shawn.guo@linaro.org> > + - Anson Huang <Anson.Huang@nxp.com> > + > +properties: > + compatible: > + oneOf: > + - items: Drop Unnecessary properties > + - enum: > + - fsl,imx6q-tempmon > + - fsl,imx6sx-tempmon > + - fsl,imx7d-tempmon > + > + interrupts: > + description: | > + The interrupt output of the controller, the IRQ will be triggered > + when temperature is higher than high threshold. > + maxItems: 1 You'd better explain why interrupts number is changed in the new binding compared to the original one. Probably add in commit message if really needed. > + > + nvmem-cells: > + description: | > + Phandle to the calibration cells provided by ocotp for calibration > + data and temperature grade. Better describe for each of them as you did for clocks > + maxItems: 2 > + > + nvmem-cell-names: > + maxItems: 2 > + items: > + - const: calib > + - const: temp_grade > + > + fsl,tempmon: > + $ref: '/schemas/types.yaml#/definitions/phandle' > + description: Phandle to the register map node. What register map? A bit ambiguous.. Regards Aisheng > + > + fsl,tempmon-data: > + $ref: '/schemas/types.yaml#/definitions/phandle' > + description: | > + Deprecated property, phandle pointer to fuse controller that contains > + TEMPMON calibration data, e.g. OCOTP on imx6q. The details about > + calibration data can be found in SoC Reference Manual. > + deprecated: true > + > + clocks: > + maxItems: 1 > + > +required: > + - compatible > + - interrupts > + - fsl,tempmon > + - nvmem-cells > + - nvmem-cell-names > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/clock/imx6sx-clock.h> > + #include <dt-bindings/interrupt-controller/arm-gic.h> > + > + efuse@21bc000 { > + #address-cells = <1>; > + #size-cells = <1>; > + compatible = "fsl,imx6sx-ocotp", "syscon"; > + reg = <0x021bc000 0x4000>; > + clocks = <&clks IMX6SX_CLK_OCOTP>; > + > + tempmon_calib: calib@38 { > + reg = <0x38 4>; > + }; > + > + tempmon_temp_grade: temp-grade@20 { > + reg = <0x20 4>; > + }; > + }; > + > + anatop@20c8000 { > + compatible = "fsl,imx6q-anatop", "syscon", "simple-mfd"; > + reg = <0x020c8000 0x1000>; > + interrupts = <0 49 IRQ_TYPE_LEVEL_HIGH>, > + <0 54 IRQ_TYPE_LEVEL_HIGH>, > + <0 127 IRQ_TYPE_LEVEL_HIGH>; > + > + tempmon { > + compatible = "fsl,imx6sx-tempmon"; > + interrupts = <GIC_SPI 49 IRQ_TYPE_LEVEL_HIGH>; > + fsl,tempmon = <&anatop>; > + nvmem-cells = <&tempmon_calib>, > <&tempmon_temp_grade>; > + nvmem-cell-names = "calib", "temp_grade"; > + clocks = <&clks IMX6SX_CLK_PLL3_USB_OTG>; > + }; > + }; > -- > 2.7.4
> Subject: RE: [PATCH V2] dt-bindings: thermal: Convert i.MX to json-schema > > > From: Anson Huang <Anson.Huang@nxp.com> > > Sent: Wednesday, May 20, 2020 2:03 PM > > > > Convert the i.MX thermal binding to DT schema format using json-schema > > > > Signed-off-by: Anson Huang <Anson.Huang@nxp.com> > > --- > > Changes since V1: > > - move tempmon node into its parent node anatop in example; > > - improve "fsl,tempmon" description. > > --- > > .../devicetree/bindings/thermal/imx-thermal.txt | 61 ------------- > > .../devicetree/bindings/thermal/imx-thermal.yaml | 100 > > [...] > > > +title: NXP i.MX Thermal Binding > > + > > +maintainers: > > + - Shawn Guo <shawn.guo@linaro.org> > > + - Anson Huang <Anson.Huang@nxp.com> > > + > > +properties: > > + compatible: > > + oneOf: > > + - items: > > Drop Unnecessary properties Will use enum directly. > > > + - enum: > > + - fsl,imx6q-tempmon > > + - fsl,imx6sx-tempmon > > + - fsl,imx7d-tempmon > > + > > + interrupts: > > + description: | > > + The interrupt output of the controller, the IRQ will be triggered > > + when temperature is higher than high threshold. > > + maxItems: 1 > > You'd better explain why interrupts number is changed in the new binding > compared to the original one. Probably add in commit message if really > needed. There is ONLY 1 interrupt output from temperature to GIC, some platforms like i.MX6SX/i.MX7D has 2 more secondary interrupts inside anatop which shares same output interrupt to GIC, these 2 interrupts are NOT used for now, so from the high level description of the interrupt, should be ONLY 1 interrupt item I think. > > > + > > + nvmem-cells: > > + description: | > > + Phandle to the calibration cells provided by ocotp for calibration > > + data and temperature grade. > > Better describe for each of them as you did for clocks Will do in V3. > > > + maxItems: 2 > > + > > + nvmem-cell-names: > > + maxItems: 2 > > + items: > > + - const: calib > > + - const: temp_grade > > + > > + fsl,tempmon: > > + $ref: '/schemas/types.yaml#/definitions/phandle' > > + description: Phandle to the register map node. > > What register map? A bit ambiguous.. Temperature sensor registers, will add more detail in V3. Anson
diff --git a/Documentation/devicetree/bindings/thermal/imx-thermal.txt b/Documentation/devicetree/bindings/thermal/imx-thermal.txt deleted file mode 100644 index 823e417..0000000 --- a/Documentation/devicetree/bindings/thermal/imx-thermal.txt +++ /dev/null @@ -1,61 +0,0 @@ -* Temperature Monitor (TEMPMON) on Freescale i.MX SoCs - -Required properties: -- compatible : must be one of following: - - "fsl,imx6q-tempmon" for i.MX6Q, - - "fsl,imx6sx-tempmon" for i.MX6SX, - - "fsl,imx7d-tempmon" for i.MX7S/D. -- interrupts : the interrupt output of the controller: - i.MX6Q has one IRQ which will be triggered when temperature is higher than high threshold, - i.MX6SX and i.MX7S/D have two more IRQs than i.MX6Q, one is IRQ_LOW and the other is IRQ_PANIC, - when temperature is below than low threshold, IRQ_LOW will be triggered, when temperature - is higher than panic threshold, system will auto reboot by SRC module. -- fsl,tempmon : phandle pointer to system controller that contains TEMPMON - control registers, e.g. ANATOP on imx6q. -- nvmem-cells: A phandle to the calibration cells provided by ocotp. -- nvmem-cell-names: Should be "calib", "temp_grade". - -Deprecated properties: -- fsl,tempmon-data : phandle pointer to fuse controller that contains TEMPMON - calibration data, e.g. OCOTP on imx6q. The details about calibration data - can be found in SoC Reference Manual. - -Direct access to OCOTP via fsl,tempmon-data is incorrect on some newer chips -because it does not handle OCOTP clock requirements. - -Optional properties: -- clocks : thermal sensor's clock source. - -Example: -ocotp: ocotp@21bc000 { - #address-cells = <1>; - #size-cells = <1>; - compatible = "fsl,imx6sx-ocotp", "syscon"; - reg = <0x021bc000 0x4000>; - clocks = <&clks IMX6SX_CLK_OCOTP>; - - tempmon_calib: calib@38 { - reg = <0x38 4>; - }; - - tempmon_temp_grade: temp-grade@20 { - reg = <0x20 4>; - }; -}; - -tempmon: tempmon { - compatible = "fsl,imx6sx-tempmon", "fsl,imx6q-tempmon"; - interrupts = <GIC_SPI 49 IRQ_TYPE_LEVEL_HIGH>; - fsl,tempmon = <&anatop>; - nvmem-cells = <&tempmon_calib>, <&tempmon_temp_grade>; - nvmem-cell-names = "calib", "temp_grade"; - clocks = <&clks IMX6SX_CLK_PLL3_USB_OTG>; -}; - -Legacy method (Deprecated): -tempmon { - compatible = "fsl,imx6q-tempmon"; - fsl,tempmon = <&anatop>; - fsl,tempmon-data = <&ocotp>; - clocks = <&clks 172>; -}; diff --git a/Documentation/devicetree/bindings/thermal/imx-thermal.yaml b/Documentation/devicetree/bindings/thermal/imx-thermal.yaml new file mode 100644 index 0000000..894465e --- /dev/null +++ b/Documentation/devicetree/bindings/thermal/imx-thermal.yaml @@ -0,0 +1,100 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/thermal/imx-thermal.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NXP i.MX Thermal Binding + +maintainers: + - Shawn Guo <shawn.guo@linaro.org> + - Anson Huang <Anson.Huang@nxp.com> + +properties: + compatible: + oneOf: + - items: + - enum: + - fsl,imx6q-tempmon + - fsl,imx6sx-tempmon + - fsl,imx7d-tempmon + + interrupts: + description: | + The interrupt output of the controller, the IRQ will be triggered + when temperature is higher than high threshold. + maxItems: 1 + + nvmem-cells: + description: | + Phandle to the calibration cells provided by ocotp for calibration + data and temperature grade. + maxItems: 2 + + nvmem-cell-names: + maxItems: 2 + items: + - const: calib + - const: temp_grade + + fsl,tempmon: + $ref: '/schemas/types.yaml#/definitions/phandle' + description: Phandle to the register map node. + + fsl,tempmon-data: + $ref: '/schemas/types.yaml#/definitions/phandle' + description: | + Deprecated property, phandle pointer to fuse controller that contains + TEMPMON calibration data, e.g. OCOTP on imx6q. The details about + calibration data can be found in SoC Reference Manual. + deprecated: true + + clocks: + maxItems: 1 + +required: + - compatible + - interrupts + - fsl,tempmon + - nvmem-cells + - nvmem-cell-names + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/imx6sx-clock.h> + #include <dt-bindings/interrupt-controller/arm-gic.h> + + efuse@21bc000 { + #address-cells = <1>; + #size-cells = <1>; + compatible = "fsl,imx6sx-ocotp", "syscon"; + reg = <0x021bc000 0x4000>; + clocks = <&clks IMX6SX_CLK_OCOTP>; + + tempmon_calib: calib@38 { + reg = <0x38 4>; + }; + + tempmon_temp_grade: temp-grade@20 { + reg = <0x20 4>; + }; + }; + + anatop@20c8000 { + compatible = "fsl,imx6q-anatop", "syscon", "simple-mfd"; + reg = <0x020c8000 0x1000>; + interrupts = <0 49 IRQ_TYPE_LEVEL_HIGH>, + <0 54 IRQ_TYPE_LEVEL_HIGH>, + <0 127 IRQ_TYPE_LEVEL_HIGH>; + + tempmon { + compatible = "fsl,imx6sx-tempmon"; + interrupts = <GIC_SPI 49 IRQ_TYPE_LEVEL_HIGH>; + fsl,tempmon = <&anatop>; + nvmem-cells = <&tempmon_calib>, <&tempmon_temp_grade>; + nvmem-cell-names = "calib", "temp_grade"; + clocks = <&clks IMX6SX_CLK_PLL3_USB_OTG>; + }; + };
Convert the i.MX thermal binding to DT schema format using json-schema Signed-off-by: Anson Huang <Anson.Huang@nxp.com> --- Changes since V1: - move tempmon node into its parent node anatop in example; - improve "fsl,tempmon" description. --- .../devicetree/bindings/thermal/imx-thermal.txt | 61 ------------- .../devicetree/bindings/thermal/imx-thermal.yaml | 100 +++++++++++++++++++++ 2 files changed, 100 insertions(+), 61 deletions(-) delete mode 100644 Documentation/devicetree/bindings/thermal/imx-thermal.txt create mode 100644 Documentation/devicetree/bindings/thermal/imx-thermal.yaml