| Message ID | 20210416063721.20538-5-nm@ti.com (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
| Series | dt-bindings: soc/arm: Convert pending ti,sci* bindings to json format | expand |
On Fri, Apr 16, 2021 at 01:37:21AM -0500, Nishanth Menon wrote: > Convert the ti,sci to json schema for better checks and documentation. > > NOTE: This change does introduce a stricter naming convention for > TI-SCI controller nodes. > > NOTE: we do have false positive checkpatch warning with this patch: > "DT binding docs and includes should be a separate patch" > > Signed-off-by: Nishanth Menon <nm@ti.com> > --- > .../bindings/arm/keystone/ti,sci.txt | 86 ------------ > .../bindings/arm/keystone/ti,sci.yaml | 129 ++++++++++++++++++ > 2 files changed, 129 insertions(+), 86 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/arm/keystone/ti,sci.txt > create mode 100644 Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml > > diff --git a/Documentation/devicetree/bindings/arm/keystone/ti,sci.txt b/Documentation/devicetree/bindings/arm/keystone/ti,sci.txt > deleted file mode 100644 > index 6f0cd31c1520..000000000000 > --- a/Documentation/devicetree/bindings/arm/keystone/ti,sci.txt > +++ /dev/null > @@ -1,86 +0,0 @@ > -Texas Instruments System Control Interface (TI-SCI) Message Protocol > --------------------------------------------------------------------- > - > -Texas Instrument's processors including those belonging to Keystone generation > -of processors have separate hardware entity which is now responsible for the > -management of the System on Chip (SoC) system. These include various system > -level functions as well. > - > -An example of such an SoC is K2G, which contains the system control hardware > -block called Power Management Micro Controller (PMMC). This hardware block is > -initialized early into boot process and provides services to Operating Systems > -on multiple processors including ones running Linux. > - > -See http://processors.wiki.ti.com/index.php/TISCI for protocol definition. > - > -TI-SCI controller Device Node: > -============================= > - > -The TI-SCI node describes the Texas Instrument's System Controller entity node. > -This parent node may optionally have additional children nodes which describe > -specific functionality such as clocks, power domain, reset or additional > -functionality as may be required for the SoC. This hierarchy also describes the > -relationship between the TI-SCI parent node to the child node. > - > -Required properties: > -------------------- > -- compatible: should be "ti,k2g-sci" for TI 66AK2G SoC > - should be "ti,am654-sci" for for TI AM654 SoC > -- mbox-names: > - "rx" - Mailbox corresponding to receive path > - "tx" - Mailbox corresponding to transmit path > - > -- mboxes: Mailboxes corresponding to the mbox-names. Each value of the mboxes > - property should contain a phandle to the mailbox controller device > - node and an args specifier that will be the phandle to the intended > - sub-mailbox child node to be used for communication. > - > -See Documentation/devicetree/bindings/mailbox/mailbox.txt for more details > -about the generic mailbox controller and client driver bindings. Also see > -Documentation/devicetree/bindings/mailbox/ti,message-manager.txt for typical > -controller that is used to communicate with this System controllers. > - > -Optional Properties: > -------------------- > -- reg-names: > - debug_messages - Map the Debug message region > -- reg: register space corresponding to the debug_messages > -- ti,system-reboot-controller: If system reboot can be triggered by SoC reboot > -- ti,host-id: Integer value corresponding to the host ID assigned by Firmware > - for identification of host processing entities such as virtual > - machines > - > -Example (K2G): > -------------- > - pmmc: pmmc { > - compatible = "ti,k2g-sci"; > - ti,host-id = <2>; > - mbox-names = "rx", "tx"; > - mboxes= <&msgmgr &msgmgr_proxy_pmmc_rx>, > - <&msgmgr &msgmgr_proxy_pmmc_tx>; > - reg-names = "debug_messages"; > - reg = <0x02921800 0x800>; > - }; > - > - > -TI-SCI Client Device Node: > -========================= > - > -Client nodes are maintained as children of the relevant TI-SCI device node. > - > -Example (K2G): > -------------- > - pmmc: pmmc { > - compatible = "ti,k2g-sci"; > - ... > - > - my_clk_node: clk_node { > - ... > - ... > - }; > - > - my_pd_node: pd_node { > - ... > - ... > - }; > - }; > diff --git a/Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml b/Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml > new file mode 100644 > index 000000000000..3e835ad84dc2 > --- /dev/null > +++ b/Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml > @@ -0,0 +1,129 @@ > +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/arm/keystone/ti,sci.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: TI-SCI controller device node bindings > + > +maintainers: > + - Nishanth Menon <nm@ti.com> > + > +allOf: > + - $ref: /schemas/mbox/mbox-consumer.yaml# Drop. > + > +description: | > + Texas Instrument's processors including those belonging to Keystone generation > + of processors have separate hardware entity which is now responsible for the > + management of the System on Chip (SoC) system. These include various system > + level functions as well. > + > + An example of such an SoC is K2G, which contains the system control hardware > + block called Power Management Micro Controller (PMMC). This hardware block is > + initialized early into boot process and provides services to Operating Systems > + on multiple processors including ones running Linux. > + > + See http://processors.wiki.ti.com/index.php/TISCI for protocol definition. > + > + The TI-SCI node describes the Texas Instrument's System Controller entity node. > + This parent node may optionally have additional children nodes which describe > + specific functionality such as clocks, power domain, reset or additional > + functionality as may be required for the SoC. This hierarchy also describes the > + relationship between the TI-SCI parent node to the child node. > + > +properties: > + $nodename: > + pattern: "^system-controller@[0-9a-f]+$" > + > + compatible: > + oneOf: > + - description: System controller on TI 66AK2G SoC and other K3 SoCs > + items: > + - const: ti,k2g-sci > + - description: System controller on TI AM654 SoC > + items: > + - const: ti,am654-sci > + > + reg-names: > + description: | > + Specifies the debug messages memory mapped region that is optionally > + made available from TI-SCI controller. > + - const: debug_messages Drop the '-' and fix the indent so it's an actual schema. > + > + reg: > + minItems: 1 > + > + mbox-names: > + description: | > + Specifies the mailboxes used to communicate with TI-SCI Controller > + made available from TI-SCI controller. > + items: > + - const: rx > + - const: tx > + > + mboxes: > + minItems: 2 > + > + ti,system-reboot-controller: > + description: Determines If system reboot can be triggered by SoC reboot > + type: boolean > + > + ti,host-id: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: | > + Value corresponding to the host ID assigned by Firmware > + for identification of host processing entities such as virtual machines. > + > +required: > + - compatible > + - mbox-names > + - mboxes > + > +additionalProperties: false > + > +patternProperties: > + # All other properties should be a power, clock or reset controller > + "^(power-controller|clock-controller|reset-controller)$": > + type: object > + oneOf: > + - $ref: /schemas/soc/ti/sci-pm-domain.yaml# > + - $ref: /schemas/clock/ti,sci-clk.yaml# > + - $ref: /schemas/reset/ti,sci-reset.yaml# I'd prefer you separate these with a property for each node. > + > +examples: > + - | > + pmmc: system-controller@2921800 { > + compatible = "ti,k2g-sci"; > + ti,system-reboot-controller; > + mbox-names = "rx", "tx"; > + mboxes= <&msgmgr 5 2>, > + <&msgmgr 0 0>; > + reg-names = "debug_messages"; > + reg = <0x02921800 0x800>; > + }; > + > + - | > + dmsc: system-controller@44083000 { > + compatible = "ti,k2g-sci"; > + ti,host-id = <12>; > + mbox-names = "rx", "tx"; > + mboxes= <&secure_proxy_main 11>, > + <&secure_proxy_main 13>; > + reg-names = "debug_messages"; > + reg = <0x44083000 0x1000>; > + > + k3_pds: power-controller { > + compatible = "ti,sci-pm-domain"; > + #power-domain-cells = <2>; > + }; > + > + k3_clks: clock-controller { > + compatible = "ti,k2g-sci-clk"; > + #clock-cells = <2>; > + }; > + > + k3_reset: reset-controller { > + compatible = "ti,sci-reset"; > + #reset-cells = <2>; > + }; > + }; > -- > 2.31.0 >
On 17:40-20210421, Rob Herring wrote: [..] > > +allOf: > > + - $ref: /schemas/mbox/mbox-consumer.yaml# > > Drop. > OK. > > + reg-names: > > + description: | > > + Specifies the debug messages memory mapped region that is optionally > > + made available from TI-SCI controller. > > + - const: debug_messages > > Drop the '-' and fix the indent so it's an actual schema. OK. [..] > > +patternProperties: > > + # All other properties should be a power, clock or reset controller > > + "^(power-controller|clock-controller|reset-controller)$": > > + type: object > > + oneOf: > > + - $ref: /schemas/soc/ti/sci-pm-domain.yaml# > > + - $ref: /schemas/clock/ti,sci-clk.yaml# > > + - $ref: /schemas/reset/ti,sci-reset.yaml# > > I'd prefer you separate these with a property for each node. Hmm... I am not sure I completely understand your comment here. I assume we dont want to duplicate each of those node yamls, so, did you mean something like: ti,sci-clk as a bool property in the tisci node and if present, then expect the node ti,sci-clk node? Can you give me a hint of similar yaml usage elsewhere that I can refer to?
On Thu, Apr 22, 2021 at 9:17 AM Nishanth Menon <nm@ti.com> wrote: > > On 17:40-20210421, Rob Herring wrote: > > [..] > > > > +allOf: > > > + - $ref: /schemas/mbox/mbox-consumer.yaml# > > > > Drop. > > > > OK. > > > > + reg-names: > > > + description: | > > > + Specifies the debug messages memory mapped region that is optionally > > > + made available from TI-SCI controller. > > > + - const: debug_messages > > > > Drop the '-' and fix the indent so it's an actual schema. > > OK. > > [..] > > > +patternProperties: > > > + # All other properties should be a power, clock or reset controller > > > + "^(power-controller|clock-controller|reset-controller)$": > > > + type: object > > > + oneOf: > > > + - $ref: /schemas/soc/ti/sci-pm-domain.yaml# > > > + - $ref: /schemas/clock/ti,sci-clk.yaml# > > > + - $ref: /schemas/reset/ti,sci-reset.yaml# > > > > I'd prefer you separate these with a property for each node. > > Hmm... I am not sure I completely understand your comment here. > I assume we dont want to duplicate each of those node yamls, so, > did you mean something like: > > ti,sci-clk as a bool property in the tisci node and if present, then > expect the node ti,sci-clk node? > > Can you give me a hint of similar yaml usage elsewhere that I can refer > to? Just do: properties: power-controller: type: object $ref: /schemas/soc/ti/sci-pm-domain.yaml# And so on for clock-controller and reset-controller. Rob
diff --git a/Documentation/devicetree/bindings/arm/keystone/ti,sci.txt b/Documentation/devicetree/bindings/arm/keystone/ti,sci.txt deleted file mode 100644 index 6f0cd31c1520..000000000000 --- a/Documentation/devicetree/bindings/arm/keystone/ti,sci.txt +++ /dev/null @@ -1,86 +0,0 @@ -Texas Instruments System Control Interface (TI-SCI) Message Protocol --------------------------------------------------------------------- - -Texas Instrument's processors including those belonging to Keystone generation -of processors have separate hardware entity which is now responsible for the -management of the System on Chip (SoC) system. These include various system -level functions as well. - -An example of such an SoC is K2G, which contains the system control hardware -block called Power Management Micro Controller (PMMC). This hardware block is -initialized early into boot process and provides services to Operating Systems -on multiple processors including ones running Linux. - -See http://processors.wiki.ti.com/index.php/TISCI for protocol definition. - -TI-SCI controller Device Node: -============================= - -The TI-SCI node describes the Texas Instrument's System Controller entity node. -This parent node may optionally have additional children nodes which describe -specific functionality such as clocks, power domain, reset or additional -functionality as may be required for the SoC. This hierarchy also describes the -relationship between the TI-SCI parent node to the child node. - -Required properties: -------------------- -- compatible: should be "ti,k2g-sci" for TI 66AK2G SoC - should be "ti,am654-sci" for for TI AM654 SoC -- mbox-names: - "rx" - Mailbox corresponding to receive path - "tx" - Mailbox corresponding to transmit path - -- mboxes: Mailboxes corresponding to the mbox-names. Each value of the mboxes - property should contain a phandle to the mailbox controller device - node and an args specifier that will be the phandle to the intended - sub-mailbox child node to be used for communication. - -See Documentation/devicetree/bindings/mailbox/mailbox.txt for more details -about the generic mailbox controller and client driver bindings. Also see -Documentation/devicetree/bindings/mailbox/ti,message-manager.txt for typical -controller that is used to communicate with this System controllers. - -Optional Properties: -------------------- -- reg-names: - debug_messages - Map the Debug message region -- reg: register space corresponding to the debug_messages -- ti,system-reboot-controller: If system reboot can be triggered by SoC reboot -- ti,host-id: Integer value corresponding to the host ID assigned by Firmware - for identification of host processing entities such as virtual - machines - -Example (K2G): -------------- - pmmc: pmmc { - compatible = "ti,k2g-sci"; - ti,host-id = <2>; - mbox-names = "rx", "tx"; - mboxes= <&msgmgr &msgmgr_proxy_pmmc_rx>, - <&msgmgr &msgmgr_proxy_pmmc_tx>; - reg-names = "debug_messages"; - reg = <0x02921800 0x800>; - }; - - -TI-SCI Client Device Node: -========================= - -Client nodes are maintained as children of the relevant TI-SCI device node. - -Example (K2G): -------------- - pmmc: pmmc { - compatible = "ti,k2g-sci"; - ... - - my_clk_node: clk_node { - ... - ... - }; - - my_pd_node: pd_node { - ... - ... - }; - }; diff --git a/Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml b/Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml new file mode 100644 index 000000000000..3e835ad84dc2 --- /dev/null +++ b/Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml @@ -0,0 +1,129 @@ +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/arm/keystone/ti,sci.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: TI-SCI controller device node bindings + +maintainers: + - Nishanth Menon <nm@ti.com> + +allOf: + - $ref: /schemas/mbox/mbox-consumer.yaml# + +description: | + Texas Instrument's processors including those belonging to Keystone generation + of processors have separate hardware entity which is now responsible for the + management of the System on Chip (SoC) system. These include various system + level functions as well. + + An example of such an SoC is K2G, which contains the system control hardware + block called Power Management Micro Controller (PMMC). This hardware block is + initialized early into boot process and provides services to Operating Systems + on multiple processors including ones running Linux. + + See http://processors.wiki.ti.com/index.php/TISCI for protocol definition. + + The TI-SCI node describes the Texas Instrument's System Controller entity node. + This parent node may optionally have additional children nodes which describe + specific functionality such as clocks, power domain, reset or additional + functionality as may be required for the SoC. This hierarchy also describes the + relationship between the TI-SCI parent node to the child node. + +properties: + $nodename: + pattern: "^system-controller@[0-9a-f]+$" + + compatible: + oneOf: + - description: System controller on TI 66AK2G SoC and other K3 SoCs + items: + - const: ti,k2g-sci + - description: System controller on TI AM654 SoC + items: + - const: ti,am654-sci + + reg-names: + description: | + Specifies the debug messages memory mapped region that is optionally + made available from TI-SCI controller. + - const: debug_messages + + reg: + minItems: 1 + + mbox-names: + description: | + Specifies the mailboxes used to communicate with TI-SCI Controller + made available from TI-SCI controller. + items: + - const: rx + - const: tx + + mboxes: + minItems: 2 + + ti,system-reboot-controller: + description: Determines If system reboot can be triggered by SoC reboot + type: boolean + + ti,host-id: + $ref: /schemas/types.yaml#/definitions/uint32 + description: | + Value corresponding to the host ID assigned by Firmware + for identification of host processing entities such as virtual machines. + +required: + - compatible + - mbox-names + - mboxes + +additionalProperties: false + +patternProperties: + # All other properties should be a power, clock or reset controller + "^(power-controller|clock-controller|reset-controller)$": + type: object + oneOf: + - $ref: /schemas/soc/ti/sci-pm-domain.yaml# + - $ref: /schemas/clock/ti,sci-clk.yaml# + - $ref: /schemas/reset/ti,sci-reset.yaml# + +examples: + - | + pmmc: system-controller@2921800 { + compatible = "ti,k2g-sci"; + ti,system-reboot-controller; + mbox-names = "rx", "tx"; + mboxes= <&msgmgr 5 2>, + <&msgmgr 0 0>; + reg-names = "debug_messages"; + reg = <0x02921800 0x800>; + }; + + - | + dmsc: system-controller@44083000 { + compatible = "ti,k2g-sci"; + ti,host-id = <12>; + mbox-names = "rx", "tx"; + mboxes= <&secure_proxy_main 11>, + <&secure_proxy_main 13>; + reg-names = "debug_messages"; + reg = <0x44083000 0x1000>; + + k3_pds: power-controller { + compatible = "ti,sci-pm-domain"; + #power-domain-cells = <2>; + }; + + k3_clks: clock-controller { + compatible = "ti,k2g-sci-clk"; + #clock-cells = <2>; + }; + + k3_reset: reset-controller { + compatible = "ti,sci-reset"; + #reset-cells = <2>; + }; + };
Convert the ti,sci to json schema for better checks and documentation. NOTE: This change does introduce a stricter naming convention for TI-SCI controller nodes. NOTE: we do have false positive checkpatch warning with this patch: "DT binding docs and includes should be a separate patch" Signed-off-by: Nishanth Menon <nm@ti.com> --- .../bindings/arm/keystone/ti,sci.txt | 86 ------------ .../bindings/arm/keystone/ti,sci.yaml | 129 ++++++++++++++++++ 2 files changed, 129 insertions(+), 86 deletions(-) delete mode 100644 Documentation/devicetree/bindings/arm/keystone/ti,sci.txt create mode 100644 Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml