docs/components/ffa-manifest-binding.rst

4 This document defines the nodes and properties used to define a partition,
5 according to the FF-A specification, and the SPMC manifest.
10 The FF-A partition manifest is consumed by the SPMC to configure the state
11 associated with the related Secure Partition.
15    - Must be the string "arm,ffa-manifest-X.Y" which specifies the major and
16      minor versions of the device tree binding for the FFA manifest represented
17      by this node. The minor number is incremented if the binding changes in a
20       - X is an integer representing the major version number of this document.
21       - Y is an integer representing the minor version number of this document.
28       - X is the major version of FF-A expected by the partition at the FFA
30       - Y is the minor version of FF-A expected by the partition at the FFA
36      identifying the UUID of the services implemented by this partition.
38    - These 4 <u32> values are packed similar to the UUID register mapping
53    - Name of the partition e.g. for debugging purposes.
59       - In the absence of virtualization, this is the number of execution
61       - If value of this field = 1 and number of PEs > 1 then the partition is
63       - If the value of this field > 1 then the partition is treated as a MP
64         capable partition irrespective of the number of PEs.
68    - The target exception level for the partition:
76    - The target execution state of the partition:
83    - Physical base address of the partition in memory. Absence of this field
84      indicates that the partition is position independent and can be loaded at
89    - Offset from the base of the partition's binary image to the entry point of
90      the partition. Absence of this field indicates that the entry point is at
91      offset 0x0 from the base of the partition's binary.
95    - Translation granule used with the partition:
104      must be booted before others. The partition with the smaller number will be
109    - Specific "memory-regions" nodes that describe the RX/TX buffers expected
110      by the partition.
111      The "compatible" must be the string "arm,ffa-manifest-rx_tx-buffer".
115    - Specifies which messaging methods are supported by the partition, set bit
116      means the feature is supported, clear bit - not supported:
127    - This field is deprecated in favor of ns-interrupts-action field in the FF-A
132    - Indicates if the partition needs managed exit, if supported, to be signaled
137    - Specifies the action that the SPMC must take in response to a Non-secure
144    - This field supersedes the managed-exit field in the FF-A v1.0 spec.
148    - Specifies the action that the SPMC must take in response to a Other-Secure
157   - Specifies how secure interrupts are handled when the SP is in a waiting
158     state and is targeted by a secure interrupt, or when the SP attempts to
162       - 0x0: Proactively inject the VI and resume SP when handling a secure
163         interrupt and SP in the waiting state.
164       - 0x1: Only when a secure interrupt is fired while target SP in the
165         waiting state, pend SRI to the NWd and rely on the scheduler to
166         explicitly donate CPU cycles to the SP.
167       - 0x2: Only when the SP attempts to go back to the waiting state while
168         having pending secure interrupts, trigger the SRI to the NWd and rely
169         on the scheduler to explicitly donate CPU cycles to the SP.
174    - Presence of this field indicates that the partition implements the primary
179    - Presence of this field indicates that the partition doesn't expect the
184    - The field specifies the general purpose register number but not its width.
185      The width is derived from the partition's execution state, as specified in
186      the partition properties. For example, if the number value is 1 then the
189      Presence of this field indicates that the partition expects the address of
190      the FF-A boot information blob to be passed in the specified general purpose
196      A set bit means the partition should be informed of the power event, clear
206      bit means the partition should be informed of the event, clear bit - should
215      defined in the FF-A v1.3 ALP2 spec.
219    - Specifies the action that the SPMC takes when a partition encounters a fatal
228      field in the manifest, the SPMC takes implementation defined action.
237    - Must be the string "arm,ffa-manifest-memory-regions".
241    - Name of the memory region e.g. for debugging purposes.
245    - Count of pages of memory region as a multiple of the translation granule
259    - Base address of the region. The address must be aligned to the translation
262      Intermediate Physical Address (IPA). Refer to the FF-A specification for
263      more information on the restrictions around the address type.
264      If the base address is omitted then the partition manager must map a memory
265      region of the specified size into the partition's translation regime and
266      then communicate the region properties (including the base address chosen
267      by the partition manager) to the partition.
271    - Offset relative to the load address of the partition.
272      When this is provided in the partition manifest, it should be added to the
273      load address to get the base address of the region. The secure partition
280      the memory region represented by current node.
285    - Identifies the SMMU IP that enforces the access control for the DMA device
286      that owns the above stream-ids.
290    - List of attributes representing the instruction and data access permissions
291      used by the DMA device streams to access the memory region represented by
301    - Must be the string "arm,ffa-manifest-device-regions".
305    - Name of the device region e.g. for debugging purposes.
309    - Count of pages of memory region as a multiple of the translation granule
323    - Base address of the region. The address must be aligned to the translation
326      Intermediate Physical Address (IPA). Refer to the FF-A specification for
327      more information on the restrictions around the address type.
332      identifier is used to inform the partition manager which SMMU the device is
333      upstream of. If the field is omitted then it is assumed that the device is
339      to the partition.
343    - A list of (id, attributes) pair describing the device interrupts, where:
376      mpidr the interrupt is routed to, where:
378       - id: The <u32> interrupt ID. Must be one of those specified in the
380       - mpidr upper bits: The <u32> describing the upper bits of the 64 bits
382       - mpidr lower bits: The <u32> describing the lower bits of the 64 bits
393 This manifest contains the SPMC *attribute* node consumed by the SPMD at
401    - Defines the endpoint ID value that SPMC can query through ``FFA_ID_GET``.
404    - Major of the FF-A version implemented by the SPMC. SPMD checks against its own
408    - Minor of the FF-A version implemented by the SPMC. SPMD checks against its own
412    - Defines the SPMC execution state (AArch64 or AArch32).
415    - Base physical address in which the SPMC binary is placed. Should be page aligned.
418    - Defines the physical address for the cold boot primary core entrypoint used by the SPMD
419      (currently matches ``BL32_BASE``) to enter the SPMC.
422    - Defines the maximum size of the SPMC binary. It is used with load_address to sanitize the