1FF-A manifests binding to device tree 2===================================== 3 4This document defines the nodes and properties used to define a partition, 5according to the FF-A specification, and the SPMC manifest. 6 7FF-A Partition Manifest Properties 8---------------------------------- 9 10The FF-A partition manifest is consumed by the SPMC to configure the state 11associated with the related Secure Partition. 12 13- compatible [mandatory] 14 - value type: <string> 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 18 backwards compatible manner. 19 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. 22 23- ffa-version [mandatory] 24 - value type: <u32> 25 - Must be two 16 bits values (X, Y), concatenated as 31:16 -> X, 26 15:0 -> Y, where: 27 28 - X is the major version of FF-A expected by the partition at the FFA 29 instance it will execute. 30 - Y is the minor version of FF-A expected by the partition at the FFA 31 instance it will execute. 32 33- uuid [mandatory] 34 - value type: <prop-encoded-array> 35 - An array of comma separated tuples each consisting of 4 <u32> values, 36 identifying the UUID of the services implemented by this partition. 37 The UUID format is described in RFC 4122. 38 - These 4 <u32> values are packed similar to the UUID register mapping 39 specified in section '5.3 Unique Identification format', SMC Calling 40 Convention, DEN0028, v1.6 G BET0 41 (https://developer.arm.com/documentation/den0028/latest/). 42 43- id 44 - value type: <u32> 45 - Pre-allocated partition ID. 46 47- auxiliary-id 48 - value type: <u32> 49 - Pre-allocated ID that could be used in memory management transactions. 50 51- description 52 - value type: <string> 53 - Name of the partition e.g. for debugging purposes. 54 55- execution-ctx-count [mandatory] 56 - value type: <u32> 57 - Number of vCPUs that a VM or SP wants to instantiate. 58 59 - In the absence of virtualization, this is the number of execution 60 contexts that a partition implements. 61 - If value of this field = 1 and number of PEs > 1 then the partition is 62 treated as UP & migrate capable. 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. 65 66- exception-level [mandatory] 67 - value type: <u32> 68 - The target exception level for the partition: 69 70 - 0x0: EL1 71 - 0x1: S_EL0 72 - 0x2: S_EL1 73 74- execution-state [mandatory] 75 - value type: <u32> 76 - The target execution state of the partition: 77 78 - 0: AArch64 79 - 1: AArch32 80 81- load-address 82 - value type: <u64> 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 85 any address chosen at boot time. 86 87- entrypoint-offset 88 - value type: <u64> 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. 92 93- xlat-granule 94 - value type: <u32> 95 - Translation granule used with the partition: 96 97 - 0x0: 4k 98 - 0x1: 16k 99 - 0x2: 64k 100 101- boot-order 102 - value type: <u32> 103 - A unique number amongst all partitions that specifies if this partition 104 must be booted before others. The partition with the smaller number will be 105 booted first. Highest vlue allowed for this field is 0xFFFF. 106 107- rx-tx-buffer 108 - value type: "memory-regions" node 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". 112 113- messaging-method [mandatory] 114 - value type: <u32> 115 - Specifies which messaging methods are supported by the partition, set bit 116 means the feature is supported, clear bit - not supported: 117 118 - Bit[0]: partition can receive direct requests via FFA_MSG_SEND_DIRECT_REQ ABI if set 119 - Bit[1]: partition can send direct requests via FFA_MSG_SEND_DIRECT_REQ ABI if set 120 - Bit[2]: partition can send and receive indirect messages 121 - Bit[9]: partition can receive direct requests via FFA_MSG_SEND_DIRECT_REQ2 ABI if set 122 - Bit[10]: partition can send direct requests via FFA_MSG_SEND_DIRECT_REQ2 ABI if set 123 124- managed-exit 125 - value type: <empty> 126 - Specifies if managed exit is supported. 127 - This field is deprecated in favor of ns-interrupts-action field in the FF-A 128 v1.1 EAC0 spec. 129 130- managed-exit-virq 131 - value type: <empty> 132 - Indicates if the partition needs managed exit, if supported, to be signaled 133 through vIRQ signal. 134 135- ns-interrupts-action [mandatory] 136 - value type: <u32> 137 - Specifies the action that the SPMC must take in response to a Non-secure 138 physical interrupt. 139 140 - 0x0: Non-secure interrupt is queued 141 - 0x1: Non-secure interrupt is signaled after a managed exit 142 - 0x2: Non-secure interrupt is signaled 143 144 - This field supersedes the managed-exit field in the FF-A v1.0 spec. 145 146- other-s-interrupts-action 147 - value type: <u32> 148 - Specifies the action that the SPMC must take in response to a Other-Secure 149 physical interrupt. 150 151 - 0x0: Other-Secure interrupt is queued 152 - 0x1: Other-Secure interrupt is signaled 153 154- has-primary-scheduler 155 - value type: <empty> 156 - Presence of this field indicates that the partition implements the primary 157 scheduler. If so, run-time EL must be EL1. 158 159- time-slice-mem 160 - value type: <empty> 161 - Presence of this field indicates that the partition doesn't expect the 162 partition manager to time slice long running memory management functions. 163 164- gp-register-num 165 - value type: <u32> 166 - The field specifies the general purpose register number but not its width. 167 The width is derived from the partition's execution state, as specified in 168 the partition properties. For example, if the number value is 1 then the 169 general-purpose register used will be x1 in AArch64 state and w1 in AArch32 170 state. 171 Presence of this field indicates that the partition expects the address of 172 the FF-A boot information blob to be passed in the specified general purpose 173 register. 174 175- power-management-messages 176 - value type: <u32> 177 - Specifies which power management messages a partition subscribes to. 178 A set bit means the partition should be informed of the power event, clear 179 bit - should not be informed of event: 180 181 - Bit[0]: CPU_OFF 182 - Bit[1]: CPU_SUSPEND 183 - Bit[2]: CPU_SUSPEND_RESUME 184 185- vm-availability-messages 186 - value type: <u32> 187 - Specifies which VM availability messages a partition subscribes to. A set 188 bit means the partition should be informed of the event, clear bit - should 189 not be informed of event: 190 191 - Bit[0]: VM created 192 - Bit[1]: VM destroyed 193 194- lifecycle-support 195 - value type: <empty> 196 - Presence of this field indicates support for all partition lifecycle states 197 defined in the FF-A v1.3 ALP2 spec. 198 199- abort-action 200 - value type: <u32> 201 - Specifies the action that the SPMC takes when a partition encounters a fatal 202 error. 203 204 - 0x0: STOP 205 - 0x1: DESTROY 206 - 0x2: RESTART 207 - 0x3: PROPAGATE 208 209 - All other values are unsupported. If a partition does not specify this 210 field in the manifest, the SPMC takes implementation defined action. 211 212.. _memory_region_node: 213 214Memory Regions 215~~~~~~~~~~~~~~ 216 217- compatible [mandatory] 218 - value type: <string> 219 - Must be the string "arm,ffa-manifest-memory-regions". 220 221- description 222 - value type: <string> 223 - Name of the memory region e.g. for debugging purposes. 224 225- pages-count [mandatory] 226 - value type: <u32> 227 - Count of pages of memory region as a multiple of the translation granule 228 size 229 230- attributes [mandatory] 231 - value type: <u32> 232 - Mapping modes: ORed to get required permission 233 234 - 0x1: Read 235 - 0x2: Write 236 - 0x4: Execute 237 - 0x8: Security state 238 239- base-address 240 - value type: <u64> 241 - Base address of the region. The address must be aligned to the translation 242 granule size. 243 The address given may be a Physical Address (PA), Virtual Address (VA), or 244 Intermediate Physical Address (IPA). Refer to the FF-A specification for 245 more information on the restrictions around the address type. 246 If the base address is omitted then the partition manager must map a memory 247 region of the specified size into the partition's translation regime and 248 then communicate the region properties (including the base address chosen 249 by the partition manager) to the partition. 250 251- load-address-relative-offset 252 - value type: <u64> 253 - Offset relative to the load address of the partition. 254 When this is provided in the partition manifest, it should be added to the 255 load address to get the base address of the region. The secure partition 256 manifest can have either "base-address" or "load-address-relative-offset". 257 It cannot have both. 258 259- stream-ids 260 - value type: <prop-encoded-array> 261 - List of IDs belonging to a DMA capable peripheral device that has access to 262 the memory region represented by current node. 263 - Each ID must have been declared in exactly one device region node. 264 265- smmu-id 266 - value type: <u32> 267 - Identifies the SMMU IP that enforces the access control for the DMA device 268 that owns the above stream-ids. 269 270- stream-ids-access-permissions 271 - value type: <prop-encoded-array> 272 - List of attributes representing the instruction and data access permissions 273 used by the DMA device streams to access the memory region represented by 274 current node. 275 276.. _device_region_node: 277 278Device Regions 279~~~~~~~~~~~~~~ 280 281- compatible [mandatory] 282 - value type: <string> 283 - Must be the string "arm,ffa-manifest-device-regions". 284 285- description 286 - value type: <string> 287 - Name of the device region e.g. for debugging purposes. 288 289- pages-count [mandatory] 290 - value type: <u32> 291 - Count of pages of memory region as a multiple of the translation granule 292 size 293 294- attributes [mandatory] 295 - value type: <u32> 296 - Mapping modes: ORed to get required permission 297 298 - 0x1: Read 299 - 0x2: Write 300 - 0x4: Execute 301 - 0x8: Security state 302 303- base-address [mandatory] 304 - value type: <u64> 305 - Base address of the region. The address must be aligned to the translation 306 granule size. 307 The address given may be a Physical Address (PA), Virtual Address (VA), or 308 Intermediate Physical Address (IPA). Refer to the FF-A specification for 309 more information on the restrictions around the address type. 310 311- smmu-id 312 - value type: <u32> 313 - On systems with multiple System Memory Management Units (SMMUs) this 314 identifier is used to inform the partition manager which SMMU the device is 315 upstream of. If the field is omitted then it is assumed that the device is 316 not upstream of any SMMU. 317 318- stream-ids 319 - value type: <prop-encoded-array> 320 - List of IDs where an ID is a unique <u32> value amongst all devices assigned 321 to the partition. 322 323- interrupts 324 - value type: <prop-encoded-array> 325 - A list of (id, attributes) pair describing the device interrupts, where: 326 327 - id: The <u32> interrupt IDs. 328 - attributes: A <u32> value, containing attributes for each interrupt ID: 329 330 +----------------------+----------+ 331 |Field | Bit(s) | 332 +----------------------+----------+ 333 | Priority | 7:0 | 334 +----------------------+----------+ 335 | Security state | 8 | 336 +----------------------+----------+ 337 | Config(Edge/Level) | 9 | 338 +----------------------+----------+ 339 | Type(SPI/PPI/SGI) | 11:10 | 340 +----------------------+----------+ 341 342 Security state: 343 - Secure: 1 344 - Non-secure: 0 345 346 Configuration: 347 - Edge triggered: 0 348 - Level triggered: 1 349 350 Type: 351 - SPI: 0b10 352 - PPI: 0b01 353 - SGI: 0b00 354 355- interrupts-target 356 - value type: <prop-encoded-array> 357 - A list of (id, mpdir upper bits, mpidr lower bits) tuples describing which 358 mpidr the interrupt is routed to, where: 359 360 - id: The <u32> interrupt ID. Must be one of those specified in the 361 "interrupts" field. 362 - mpidr upper bits: The <u32> describing the upper bits of the 64 bits 363 mpidr 364 - mpidr lower bits: The <u32> describing the lower bits of the 64 bits 365 mpidr 366 367- exclusive-access 368 - value type: <empty> 369 - Presence of this field implies that this endpoint must be granted exclusive 370 access and ownership of this device's MMIO region. 371 372SPMC Manifest Properties 373------------------------ 374 375This manifest contains the SPMC *attribute* node consumed by the SPMD at 376boot time. 377 378attribute 379~~~~~~~~~ 380 381- spmc_id 382 - value type: <u32> 383 - Defines the endpoint ID value that SPMC can query through ``FFA_ID_GET``. 384- maj_ver 385 - value type: <u32> 386 - Major of the FF-A version implemented by the SPMC. SPMD checks against its own 387 version. 388- min_ver 389 - value type>: <u32> 390 - Minor of the FF-A version implemented by the SPMC. SPMD checks against its own 391 version. 392- exec_state 393 - value type: <u32> 394 - Defines the SPMC execution state (AArch64 or AArch32). 395- load_address 396 - value type: <u64> 397 - Base physical address in which the SPMC binary is placed. Should be page aligned. 398- entrypoint: 399 - value type: <u64> 400 - Defines the physical address for the cold boot primary core entrypoint used by the SPMD 401 (currently matches ``BL32_BASE``) to enter the SPMC. 402- binary_size 403 - value type: <u32> 404 - Defines the maximum size of the SPMC binary. It is used with load_address to sanitize the 405 specified entrypoint. 406 407-------------- 408 409*Copyright (c) 2019-2025, Arm Limited and Contributors. All rights reserved.* 410