| # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) |
| %YAML 1.2 |
| --- |
| $id: http://devicetree.org/schemas/remoteproc/ti,k3-r5f-rproc.yaml# |
| $schema: http://devicetree.org/meta-schemas/core.yaml# |
| |
| title: TI K3 R5F processor subsystems |
| |
| maintainers: |
| - Suman Anna <s-anna@ti.com> |
| |
| description: | |
| The TI K3 family of SoCs usually have one or more dual-core Arm Cortex R5F |
| processor subsystems/clusters (R5FSS). The dual core cluster can be used |
| either in a LockStep mode providing safety/fault tolerance features or in a |
| Split mode providing two individual compute cores for doubling the compute |
| capacity on most SoCs. These are used together with other processors present |
| on the SoC to achieve various system level goals. |
| |
| AM64x SoCs do not support LockStep mode, but rather a new non-safety mode |
| called "Single-CPU" mode, where only Core0 is used, but with ability to use |
| Core1's TCMs as well. |
| |
| AM62 SoC family support a single R5F core only which runs Device Manager |
| firmware and can also be used as a remote processor with IPC communication. |
| |
| Each Dual-Core R5F sub-system is represented as a single DTS node |
| representing the cluster, with a pair of child DT nodes representing |
| the individual R5F cores. Each node has a number of required or optional |
| properties that enable the OS running on the host processor to perform |
| the device management of the remote processor and to communicate with the |
| remote processor. |
| |
| properties: |
| $nodename: |
| pattern: "^r5fss(@.*)?" |
| |
| compatible: |
| enum: |
| - ti,am62-r5fss |
| - ti,am64-r5fss |
| - ti,am654-r5fss |
| - ti,j7200-r5fss |
| - ti,j721e-r5fss |
| - ti,j721s2-r5fss |
| |
| power-domains: |
| description: | |
| Should contain a phandle to a PM domain provider node and an args |
| specifier containing the R5FSS device id value. |
| maxItems: 1 |
| |
| "#address-cells": |
| const: 1 |
| |
| "#size-cells": |
| const: 1 |
| |
| ranges: |
| description: | |
| Standard ranges definition providing address translations for |
| local R5F TCM address spaces to bus addresses. |
| |
| # Optional properties: |
| # -------------------- |
| |
| ti,cluster-mode: |
| $ref: /schemas/types.yaml#/definitions/uint32 |
| description: | |
| Configuration Mode for the Dual R5F cores within the R5F cluster. |
| For most SoCs (AM65x, J721E, J7200, J721s2), |
| It should be either a value of 1 (LockStep mode) or 0 (Split mode) on |
| most SoCs (AM65x, J721E, J7200, J721s2), default is LockStep mode if |
| omitted. |
| For AM64x SoCs, |
| It should be either a value of 0 (Split mode) or 2 (Single-CPU mode) and |
| default is Split mode if omitted. |
| For AM62x SoCs, |
| It should be set as 3 (Single-Core mode) which is also the default if |
| omitted. |
| |
| |
| # R5F Processor Child Nodes: |
| # ========================== |
| |
| patternProperties: |
| "^r5f@[a-f0-9]+$": |
| type: object |
| description: | |
| The R5F Sub-System device node should define two R5F child nodes, each |
| node representing a TI instantiation of the Arm Cortex R5F core. There |
| are some specific integration differences for the IP like the usage of |
| a Region Address Translator (RAT) for translating the larger SoC bus |
| addresses into a 32-bit address space for the processor. For AM62x, |
| the R5F Sub-System device node should only define one R5F child node |
| as it has only one core available. |
| |
| Each R5F core has an associated 64 KB of Tightly-Coupled Memory (TCM) |
| internal memories split between two banks - TCMA and TCMB (further |
| interleaved into two banks TCMB0 and TCMB1). These memories (also called |
| ATCM and BTCM) provide read/write performance on par with the core's L1 |
| caches. Each of the TCMs can be enabled or disabled independently and |
| either of them can be configured to appear at that R5F's address 0x0. |
| |
| The cores do not use an MMU, but has a Region Address Translator |
| (RAT) module that is accessible only from the R5Fs for providing |
| translations between 32-bit CPU addresses into larger system bus |
| addresses. Cache and memory access settings are provided through a |
| Memory Protection Unit (MPU), programmable only from the R5Fs. |
| |
| $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml# |
| |
| properties: |
| compatible: |
| enum: |
| - ti,am62-r5f |
| - ti,am64-r5f |
| - ti,am654-r5f |
| - ti,j7200-r5f |
| - ti,j721e-r5f |
| - ti,j721s2-r5f |
| |
| reg: |
| items: |
| - description: Address and Size of the ATCM internal memory region |
| - description: Address and Size of the BTCM internal memory region |
| |
| reg-names: |
| items: |
| - const: atcm |
| - const: btcm |
| |
| resets: |
| description: | |
| Should contain the phandle to the reset controller node managing the |
| local resets for this device, and a reset specifier. |
| maxItems: 1 |
| |
| firmware-name: |
| description: | |
| Should contain the name of the default firmware image |
| file located on the firmware search path |
| |
| # The following properties are mandatory for R5F Core0 in both LockStep and Split |
| # modes, and are mandatory for R5F Core1 _only_ in Split mode. They are unused for |
| # R5F Core1 in LockStep mode: |
| |
| mboxes: |
| description: | |
| OMAP Mailbox specifier denoting the sub-mailbox, to be used for |
| communication with the remote processor. This property should match |
| with the sub-mailbox node used in the firmware image. |
| maxItems: 1 |
| |
| memory-region: |
| description: | |
| phandle to the reserved memory nodes to be associated with the |
| remoteproc device. There should be at least two reserved memory nodes |
| defined. The reserved memory nodes should be carveout nodes, and |
| should be defined with a "no-map" property as per the bindings in |
| Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt |
| minItems: 2 |
| maxItems: 8 |
| items: |
| - description: region used for dynamic DMA allocations like vrings and |
| vring buffers |
| - description: region reserved for firmware image sections |
| additionalItems: true |
| |
| |
| # Optional properties: |
| # -------------------- |
| # The following properties are optional properties for each of the R5F cores: |
| |
| ti,atcm-enable: |
| $ref: /schemas/types.yaml#/definitions/uint32 |
| enum: [0, 1] |
| description: | |
| R5F core configuration mode dictating if ATCM should be enabled. The |
| R5F address of ATCM is dictated by ti,loczrama property. Should be |
| either a value of 1 (enabled) or 0 (disabled), default is disabled |
| if omitted. Recommended to enable it for maximizing TCMs. |
| |
| ti,btcm-enable: |
| $ref: /schemas/types.yaml#/definitions/uint32 |
| enum: [0, 1] |
| description: | |
| R5F core configuration mode dictating if BTCM should be enabled. The |
| R5F address of BTCM is dictated by ti,loczrama property. Should be |
| either a value of 1 (enabled) or 0 (disabled), default is enabled if |
| omitted. |
| |
| ti,loczrama: |
| $ref: /schemas/types.yaml#/definitions/uint32 |
| enum: [0, 1] |
| description: | |
| R5F core configuration mode dictating which TCM should appear at |
| address 0 (from core's view). Should be either a value of 1 (ATCM |
| at 0x0) or 0 (BTCM at 0x0), default value is 1 if omitted. |
| |
| sram: |
| $ref: /schemas/types.yaml#/definitions/phandle-array |
| minItems: 1 |
| maxItems: 4 |
| items: |
| maxItems: 1 |
| description: | |
| phandles to one or more reserved on-chip SRAM regions. The regions |
| should be defined as child nodes of the respective SRAM node, and |
| should be defined as per the generic bindings in, |
| Documentation/devicetree/bindings/sram/sram.yaml |
| |
| required: |
| - compatible |
| - reg |
| - reg-names |
| - ti,sci |
| - ti,sci-dev-id |
| - ti,sci-proc-ids |
| - resets |
| - firmware-name |
| |
| unevaluatedProperties: false |
| |
| allOf: |
| - if: |
| properties: |
| compatible: |
| enum: |
| - ti,am64-r5fss |
| then: |
| properties: |
| ti,cluster-mode: |
| enum: [0, 2] |
| |
| - if: |
| properties: |
| compatible: |
| enum: |
| - ti,am654-r5fss |
| - ti,j7200-r5fss |
| - ti,j721e-r5fss |
| - ti,j721s2-r5fss |
| then: |
| properties: |
| ti,cluster-mode: |
| enum: [0, 1] |
| |
| - if: |
| properties: |
| compatible: |
| enum: |
| - ti,am62-r5fss |
| then: |
| properties: |
| ti,cluster-mode: |
| enum: [3] |
| |
| required: |
| - compatible |
| - power-domains |
| - "#address-cells" |
| - "#size-cells" |
| - ranges |
| |
| additionalProperties: false |
| |
| examples: |
| - | |
| soc { |
| #address-cells = <2>; |
| #size-cells = <2>; |
| |
| mailbox0: mailbox-0 { |
| #mbox-cells = <1>; |
| }; |
| |
| mailbox1: mailbox-1 { |
| #mbox-cells = <1>; |
| }; |
| |
| bus@100000 { |
| compatible = "simple-bus"; |
| #address-cells = <2>; |
| #size-cells = <2>; |
| ranges = <0x00 0x00100000 0x00 0x00100000 0x00 0x00020000>, /* ctrl mmr */ |
| <0x00 0x41000000 0x00 0x41000000 0x00 0x00020000>, |
| <0x00 0x41400000 0x00 0x41400000 0x00 0x00020000>, |
| <0x00 0x41c00000 0x00 0x41c00000 0x00 0x00080000>; |
| |
| bus@28380000 { |
| compatible = "simple-bus"; |
| #address-cells = <2>; |
| #size-cells = <2>; |
| ranges = <0x00 0x28380000 0x00 0x28380000 0x00 0x03880000>, /* MCU NAVSS */ |
| <0x00 0x41000000 0x00 0x41000000 0x00 0x00020000>, /* MCU R5F Core0 */ |
| <0x00 0x41400000 0x00 0x41400000 0x00 0x00020000>, /* MCU R5F Core1 */ |
| <0x00 0x41c00000 0x00 0x41c00000 0x00 0x00080000>; /* MCU SRAM */ |
| |
| /* AM65x MCU R5FSS node */ |
| mcu_r5fss0: r5fss@41000000 { |
| compatible = "ti,am654-r5fss"; |
| power-domains = <&k3_pds 129>; |
| ti,cluster-mode = <1>; |
| #address-cells = <1>; |
| #size-cells = <1>; |
| ranges = <0x41000000 0x00 0x41000000 0x20000>, |
| <0x41400000 0x00 0x41400000 0x20000>; |
| |
| mcu_r5f0: r5f@41000000 { |
| compatible = "ti,am654-r5f"; |
| reg = <0x41000000 0x00008000>, |
| <0x41010000 0x00008000>; |
| reg-names = "atcm", "btcm"; |
| ti,sci = <&dmsc>; |
| ti,sci-dev-id = <159>; |
| ti,sci-proc-ids = <0x01 0xFF>; |
| resets = <&k3_reset 159 1>; |
| firmware-name = "am65x-mcu-r5f0_0-fw"; |
| ti,atcm-enable = <1>; |
| ti,btcm-enable = <1>; |
| ti,loczrama = <1>; |
| mboxes = <&mailbox0 &mbox_mcu_r5fss0_core0>; |
| memory-region = <&mcu_r5fss0_core0_dma_memory_region>, |
| <&mcu_r5fss0_core0_memory_region>; |
| sram = <&mcu_r5fss0_core0_sram>; |
| }; |
| |
| mcu_r5f1: r5f@41400000 { |
| compatible = "ti,am654-r5f"; |
| reg = <0x41400000 0x00008000>, |
| <0x41410000 0x00008000>; |
| reg-names = "atcm", "btcm"; |
| ti,sci = <&dmsc>; |
| ti,sci-dev-id = <245>; |
| ti,sci-proc-ids = <0x02 0xFF>; |
| resets = <&k3_reset 245 1>; |
| firmware-name = "am65x-mcu-r5f0_1-fw"; |
| ti,atcm-enable = <1>; |
| ti,btcm-enable = <1>; |
| ti,loczrama = <1>; |
| mboxes = <&mailbox1 &mbox_mcu_r5fss0_core1>; |
| }; |
| }; |
| }; |
| }; |
| }; |
