| Message ID | 20250412-fslpmc-yaml-v2-1-98c0948a2921@posteo.net (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2] dt-bindings: powerpc: Convert fsl/pmc.txt to YAML | expand |
On Sat, 12 Apr 2025 14:49:38 +0200, J. Neuschäfer wrote: > This patch rewrites pmc.txt into YAML format. Descriptive texts are > expanded or shortened in a few places to better fit today's conventions. > > The list of compatible strings (and combinations of them) is based on > existing device trees in arch/powerpc as well as compatible strings > already mentioned in the plain-text version of the binding. > > One thing I didn't handle are soc-clk@... nodes as seen in > Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml. > > Signed-off-by: J. Neuschäfer <j.ne@posteo.net> > --- > Changes in v2: > - Rebase on v6.15-rc1 > - Link to v1: https://lore.kernel.org/r/20250315-fslpmc-yaml-v1-1-10ba354a85c2@posteo.net > --- > > Note: The examples include a consumer (sata@19000), to demonstrate how > sleep specifiers work. I've heard that "unrelated" nodes in examples are > generally discouraged, but I'm not sure if it's better to keep it or to > drop it in this example. > --- > .../devicetree/bindings/powerpc/fsl/pmc.txt | 63 -------- > .../devicetree/bindings/powerpc/fsl/pmc.yaml | 159 +++++++++++++++++++++ > 2 files changed, 159 insertions(+), 63 deletions(-) > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: dtschema/dtc warnings/errors: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/powerpc/fsl/pmc.example.dtb: sata@19000 (fsl,mpc8377-sata): 'sleep' does not match any of the regexes: 'pinctrl-[0-9]+' from schema $id: http://devicetree.org/schemas/ata/fsl,pq-sata.yaml# /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/powerpc/fsl/pmc.example.dtb: sata@19000 (fsl,mpc8377-sata): 'cell-index' is a required property from schema $id: http://devicetree.org/schemas/ata/fsl,pq-sata.yaml# doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250412-fslpmc-yaml-v2-1-98c0948a2921@posteo.net The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.
On Sat, Apr 12, 2025 at 02:49:38PM +0200, J. Neuschäfer wrote: > This patch rewrites pmc.txt into YAML format. Descriptive texts are > expanded or shortened in a few places to better fit today's conventions. > > The list of compatible strings (and combinations of them) is based on > existing device trees in arch/powerpc as well as compatible strings > already mentioned in the plain-text version of the binding. > > One thing I didn't handle are soc-clk@... nodes as seen in > Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml. > > Signed-off-by: J. Neuschäfer <j.ne@posteo.net> > --- > Changes in v2: > - Rebase on v6.15-rc1 > - Link to v1: https://lore.kernel.org/r/20250315-fslpmc-yaml-v1-1-10ba354a85c2@posteo.net > --- > > Note: The examples include a consumer (sata@19000), to demonstrate how > sleep specifiers work. I've heard that "unrelated" nodes in examples are > generally discouraged, but I'm not sure if it's better to keep it or to > drop it in this example. I'd drop. Unless you want to fix the error. There's nothing really unique with how 'sleep' property works. > --- > .../devicetree/bindings/powerpc/fsl/pmc.txt | 63 -------- > .../devicetree/bindings/powerpc/fsl/pmc.yaml | 159 +++++++++++++++++++++ > 2 files changed, 159 insertions(+), 63 deletions(-) > > diff --git a/Documentation/devicetree/bindings/powerpc/fsl/pmc.txt b/Documentation/devicetree/bindings/powerpc/fsl/pmc.txt > deleted file mode 100644 > index 07256b7ffcaab2ba57b33cf279df45d830ce33b3..0000000000000000000000000000000000000000 > --- a/Documentation/devicetree/bindings/powerpc/fsl/pmc.txt > +++ /dev/null > @@ -1,63 +0,0 @@ > -* Power Management Controller > - > -Properties: > -- compatible: "fsl,<chip>-pmc". > - > - "fsl,mpc8349-pmc" should be listed for any chip whose PMC is > - compatible. "fsl,mpc8313-pmc" should also be listed for any chip > - whose PMC is compatible, and implies deep-sleep capability. > - > - "fsl,mpc8548-pmc" should be listed for any chip whose PMC is > - compatible. "fsl,mpc8536-pmc" should also be listed for any chip > - whose PMC is compatible, and implies deep-sleep capability. > - > - "fsl,mpc8641d-pmc" should be listed for any chip whose PMC is > - compatible; all statements below that apply to "fsl,mpc8548-pmc" also > - apply to "fsl,mpc8641d-pmc". > - > - Compatibility does not include bit assignments in SCCR/PMCDR/DEVDISR; these > - bit assignments are indicated via the sleep specifier in each device's > - sleep property. > - > -- reg: For devices compatible with "fsl,mpc8349-pmc", the first resource > - is the PMC block, and the second resource is the Clock Configuration > - block. > - > - For devices compatible with "fsl,mpc8548-pmc", the first resource > - is a 32-byte block beginning with DEVDISR. > - > -- interrupts: For "fsl,mpc8349-pmc"-compatible devices, the first > - resource is the PMC block interrupt. > - > -- fsl,mpc8313-wakeup-timer: For "fsl,mpc8313-pmc"-compatible devices, > - this is a phandle to an "fsl,gtm" node on which timer 4 can be used as > - a wakeup source from deep sleep. > - > -Sleep specifiers: > - > - fsl,mpc8349-pmc: Sleep specifiers consist of one cell. For each bit > - that is set in the cell, the corresponding bit in SCCR will be saved > - and cleared on suspend, and restored on resume. This sleep controller > - supports disabling and resuming devices at any time. > - > - fsl,mpc8536-pmc: Sleep specifiers consist of three cells, the third of > - which will be ORed into PMCDR upon suspend, and cleared from PMCDR > - upon resume. The first two cells are as described for fsl,mpc8578-pmc. > - This sleep controller only supports disabling devices during system > - sleep, or permanently. > - > - fsl,mpc8548-pmc: Sleep specifiers consist of one or two cells, the > - first of which will be ORed into DEVDISR (and the second into > - DEVDISR2, if present -- this cell should be zero or absent if the > - hardware does not have DEVDISR2) upon a request for permanent device > - disabling. This sleep controller does not support configuring devices > - to disable during system sleep (unless supported by another compatible > - match), or dynamically. > - > -Example: > - > - power@b00 { > - compatible = "fsl,mpc8313-pmc", "fsl,mpc8349-pmc"; > - reg = <0xb00 0x100 0xa00 0x100>; > - interrupts = <80 8>; > - }; > diff --git a/Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml b/Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml > new file mode 100644 > index 0000000000000000000000000000000000000000..bb2db8adb74c54fec5d07393573f156c63a9e886 > --- /dev/null > +++ b/Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml > @@ -0,0 +1,159 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/powerpc/fsl/pmc.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Power Management Controller > + > +maintainers: > + - J. Neuschäfer <j.ne@posteo.net> > + > +description: | > + The Power Management Controller in several MPC8xxx SoCs helps save power by > + controlling chip-wide low-power states as well as peripheral clock gating. > + > + Sleep of peripheral devices is configured by the `sleep` property, for > + example `sleep = <&pmc 0x00000030>`. Any cells after the &pmc phandle are > + called a sleep specifier. > + > + For "fsl,mpc8349-pmc", sleep specifiers consist of one cell. For each bit that > + is set in the cell, the corresponding bit in SCCR will be saved and cleared > + on suspend, and restored on resume. This sleep controller supports disabling > + and resuming devices at any time. > + > + For "fsl,mpc8536-pmc", sleep specifiers consist of three cells, the third of > + which will be ORed into PMCDR upon suspend, and cleared from PMCDR upon > + resume. The first two cells are as described for fsl,mpc8548-pmc. This > + sleep controller only supports disabling devices during system sleep, or > + permanently. > + > + For "fsl,mpc8548-pmc" or "fsl,mpc8641d-pmc", Sleep specifiers consist of one > + or two cells, the first of which will be ORed into DEVDISR (and the second > + into DEVDISR2, if present -- this cell should be zero or absent if the > + hardware does not have DEVDISR2) upon a request for permanent device > + disabling. This sleep controller does not support configuring devices to > + disable during system sleep (unless supported by another compatible match), > + or dynamically. > + > +properties: > + compatible: > + oneOf: > + - items: > + - const: fsl,mpc8315-pmc > + - const: fsl,mpc8313-pmc > + - const: fsl,mpc8349-pmc > + > + - items: > + - enum: > + - fsl,mpc8313-pmc > + - fsl,mpc8323-pmc > + - fsl,mpc8360-pmc > + - fsl,mpc8377-pmc > + - fsl,mpc8378-pmc > + - fsl,mpc8379-pmc > + - const: fsl,mpc8349-pmc > + > + - items: > + - const: fsl,p1022-pmc > + - const: fsl,mpc8536-pmc > + - const: fsl,mpc8548-pmc > + > + - items: > + - enum: > + - fsl,mpc8536-pmc > + - fsl,mpc8568-pmc > + - fsl,mpc8569-pmc > + - const: fsl,mpc8548-pmc > + > + - const: fsl,mpc8548-pmc > + > + - const: fsl,mpc8641d-pmc 1 enum for these 2. Rob
On Sat, Apr 12, 2025 at 01:37:32PM -0500, Rob Herring wrote: > On Sat, Apr 12, 2025 at 02:49:38PM +0200, J. Neuschäfer wrote: > > This patch rewrites pmc.txt into YAML format. Descriptive texts are > > expanded or shortened in a few places to better fit today's conventions. > > > > The list of compatible strings (and combinations of them) is based on > > existing device trees in arch/powerpc as well as compatible strings > > already mentioned in the plain-text version of the binding. > > > > One thing I didn't handle are soc-clk@... nodes as seen in > > Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml. > > > > Signed-off-by: J. Neuschäfer <j.ne@posteo.net> > > --- > > Changes in v2: > > - Rebase on v6.15-rc1 > > - Link to v1: https://lore.kernel.org/r/20250315-fslpmc-yaml-v1-1-10ba354a85c2@posteo.net > > --- > > > > Note: The examples include a consumer (sata@19000), to demonstrate how > > sleep specifiers work. I've heard that "unrelated" nodes in examples are > > generally discouraged, but I'm not sure if it's better to keep it or to > > drop it in this example. > > I'd drop. Unless you want to fix the error. There's nothing really > unique with how 'sleep' property works. Okay. > > +properties: > > + compatible: > > + oneOf: [...] > > + - const: fsl,mpc8548-pmc > > + > > + - const: fsl,mpc8641d-pmc > > 1 enum for these 2. Will do. Thanks, J. Neuschäfer
diff --git a/Documentation/devicetree/bindings/powerpc/fsl/pmc.txt b/Documentation/devicetree/bindings/powerpc/fsl/pmc.txt deleted file mode 100644 index 07256b7ffcaab2ba57b33cf279df45d830ce33b3..0000000000000000000000000000000000000000 --- a/Documentation/devicetree/bindings/powerpc/fsl/pmc.txt +++ /dev/null @@ -1,63 +0,0 @@ -* Power Management Controller - -Properties: -- compatible: "fsl,<chip>-pmc". - - "fsl,mpc8349-pmc" should be listed for any chip whose PMC is - compatible. "fsl,mpc8313-pmc" should also be listed for any chip - whose PMC is compatible, and implies deep-sleep capability. - - "fsl,mpc8548-pmc" should be listed for any chip whose PMC is - compatible. "fsl,mpc8536-pmc" should also be listed for any chip - whose PMC is compatible, and implies deep-sleep capability. - - "fsl,mpc8641d-pmc" should be listed for any chip whose PMC is - compatible; all statements below that apply to "fsl,mpc8548-pmc" also - apply to "fsl,mpc8641d-pmc". - - Compatibility does not include bit assignments in SCCR/PMCDR/DEVDISR; these - bit assignments are indicated via the sleep specifier in each device's - sleep property. - -- reg: For devices compatible with "fsl,mpc8349-pmc", the first resource - is the PMC block, and the second resource is the Clock Configuration - block. - - For devices compatible with "fsl,mpc8548-pmc", the first resource - is a 32-byte block beginning with DEVDISR. - -- interrupts: For "fsl,mpc8349-pmc"-compatible devices, the first - resource is the PMC block interrupt. - -- fsl,mpc8313-wakeup-timer: For "fsl,mpc8313-pmc"-compatible devices, - this is a phandle to an "fsl,gtm" node on which timer 4 can be used as - a wakeup source from deep sleep. - -Sleep specifiers: - - fsl,mpc8349-pmc: Sleep specifiers consist of one cell. For each bit - that is set in the cell, the corresponding bit in SCCR will be saved - and cleared on suspend, and restored on resume. This sleep controller - supports disabling and resuming devices at any time. - - fsl,mpc8536-pmc: Sleep specifiers consist of three cells, the third of - which will be ORed into PMCDR upon suspend, and cleared from PMCDR - upon resume. The first two cells are as described for fsl,mpc8578-pmc. - This sleep controller only supports disabling devices during system - sleep, or permanently. - - fsl,mpc8548-pmc: Sleep specifiers consist of one or two cells, the - first of which will be ORed into DEVDISR (and the second into - DEVDISR2, if present -- this cell should be zero or absent if the - hardware does not have DEVDISR2) upon a request for permanent device - disabling. This sleep controller does not support configuring devices - to disable during system sleep (unless supported by another compatible - match), or dynamically. - -Example: - - power@b00 { - compatible = "fsl,mpc8313-pmc", "fsl,mpc8349-pmc"; - reg = <0xb00 0x100 0xa00 0x100>; - interrupts = <80 8>; - }; diff --git a/Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml b/Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..bb2db8adb74c54fec5d07393573f156c63a9e886 --- /dev/null +++ b/Documentation/devicetree/bindings/powerpc/fsl/pmc.yaml @@ -0,0 +1,159 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/powerpc/fsl/pmc.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Power Management Controller + +maintainers: + - J. Neuschäfer <j.ne@posteo.net> + +description: | + The Power Management Controller in several MPC8xxx SoCs helps save power by + controlling chip-wide low-power states as well as peripheral clock gating. + + Sleep of peripheral devices is configured by the `sleep` property, for + example `sleep = <&pmc 0x00000030>`. Any cells after the &pmc phandle are + called a sleep specifier. + + For "fsl,mpc8349-pmc", sleep specifiers consist of one cell. For each bit that + is set in the cell, the corresponding bit in SCCR will be saved and cleared + on suspend, and restored on resume. This sleep controller supports disabling + and resuming devices at any time. + + For "fsl,mpc8536-pmc", sleep specifiers consist of three cells, the third of + which will be ORed into PMCDR upon suspend, and cleared from PMCDR upon + resume. The first two cells are as described for fsl,mpc8548-pmc. This + sleep controller only supports disabling devices during system sleep, or + permanently. + + For "fsl,mpc8548-pmc" or "fsl,mpc8641d-pmc", Sleep specifiers consist of one + or two cells, the first of which will be ORed into DEVDISR (and the second + into DEVDISR2, if present -- this cell should be zero or absent if the + hardware does not have DEVDISR2) upon a request for permanent device + disabling. This sleep controller does not support configuring devices to + disable during system sleep (unless supported by another compatible match), + or dynamically. + +properties: + compatible: + oneOf: + - items: + - const: fsl,mpc8315-pmc + - const: fsl,mpc8313-pmc + - const: fsl,mpc8349-pmc + + - items: + - enum: + - fsl,mpc8313-pmc + - fsl,mpc8323-pmc + - fsl,mpc8360-pmc + - fsl,mpc8377-pmc + - fsl,mpc8378-pmc + - fsl,mpc8379-pmc + - const: fsl,mpc8349-pmc + + - items: + - const: fsl,p1022-pmc + - const: fsl,mpc8536-pmc + - const: fsl,mpc8548-pmc + + - items: + - enum: + - fsl,mpc8536-pmc + - fsl,mpc8568-pmc + - fsl,mpc8569-pmc + - const: fsl,mpc8548-pmc + + - const: fsl,mpc8548-pmc + + - const: fsl,mpc8641d-pmc + + description: | + "fsl,mpc8349-pmc" should be listed for any chip whose PMC is + compatible. "fsl,mpc8313-pmc" should also be listed for any chip + whose PMC is compatible, and implies deep-sleep capability. + + "fsl,mpc8548-pmc" should be listed for any chip whose PMC is + compatible. "fsl,mpc8536-pmc" should also be listed for any chip + whose PMC is compatible, and implies deep-sleep capability. + + "fsl,mpc8641d-pmc" should be listed for any chip whose PMC is + compatible; all statements below that apply to "fsl,mpc8548-pmc" also + apply to "fsl,mpc8641d-pmc". + + Compatibility does not include bit assignments in SCCR/PMCDR/DEVDISR; these + bit assignments are indicated via the sleep specifier in each device's + sleep property. + + reg: + minItems: 1 + maxItems: 2 + + interrupts: + maxItems: 1 + + fsl,mpc8313-wakeup-timer: + $ref: /schemas/types.yaml#/definitions/phandle + description: + For "fsl,mpc8313-pmc"-compatible devices, this is a phandle to an + "fsl,gtm" node on which timer 4 can be used as a wakeup source from deep + sleep. + +allOf: + - if: + properties: + compatible: + contains: + const: fsl,mpc8349-pmc + then: + properties: + reg: + items: + - description: PMC block + - description: Clock Configuration block + + - if: + properties: + compatible: + contains: + enum: + - fsl,mpc8548-pmc + - fsl,mpc8641d-pmc + then: + properties: + reg: + items: + - description: 32-byte block beginning with DEVDISR + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + + pmc: power@b00 { + compatible = "fsl,mpc8377-pmc", "fsl,mpc8349-pmc"; + reg = <0xb00 0x100>, <0xa00 0x100>; + interrupts = <80 IRQ_TYPE_LEVEL_LOW>; + }; + + sata@19000 { + compatible = "fsl,mpc8377-sata", "fsl,pq-sata"; + reg = <0x19000 0x1000>; + interrupts = <45 IRQ_TYPE_LEVEL_LOW>; + sleep = <&pmc 0x00000030>; + }; + + - | + power@e0070 { + compatible = "fsl,mpc8548-pmc"; + reg = <0xe0070 0x20>; + }; + +...