1FF-A manifest binding to device tree 2==================================== 3 4This document defines the nodes and properties used to define a partition, 5according to the FF-A specification. 6 7Partition Properties 8-------------------- 9 10- compatible [mandatory] 11 - value type: <string> 12 - Must be the string "arm,ffa-manifest-X.Y" which specifies the major and 13 minor versions of the device tree binding for the FFA manifest represented 14 by this node. The minor number is incremented if the binding changes in a 15 backwards compatible manner. 16 17 - X is an integer representing the major version number of this document. 18 - Y is an integer representing the minor version number of this document. 19 20- ffa-version [mandatory] 21 - value type: <u32> 22 - Must be two 16 bits values (X, Y), concatenated as 31:16 -> X, 23 15:0 -> Y, where: 24 25 - X is the major version of FF-A expected by the partition at the FFA 26 instance it will execute. 27 - Y is the minor version of FF-A expected by the partition at the FFA 28 instance it will execute. 29 30- uuid [mandatory] 31 - value type: <prop-encoded-array> 32 - An array consisting of 4 <u32> values, identifying the UUID of the service 33 implemented by this partition. The UUID format is described in RFC 4122. 34 35- id 36 - value type: <u32> 37 - Pre-allocated partition ID. 38 39- auxiliary-id 40 - value type: <u32> 41 - Pre-allocated ID that could be used in memory management transactions. 42 43- description 44 - value type: <string> 45 - Name of the partition e.g. for debugging purposes. 46 47- execution-ctx-count [mandatory] 48 - value type: <u32> 49 - Number of vCPUs that a VM or SP wants to instantiate. 50 51 - In the absence of virtualization, this is the number of execution 52 contexts that a partition implements. 53 - If value of this field = 1 and number of PEs > 1 then the partition is 54 treated as UP & migrate capable. 55 - If the value of this field > 1 then the partition is treated as a MP 56 capable partition irrespective of the number of PEs. 57 58- exception-level [mandatory] 59 - value type: <u32> 60 - The target exception level for the partition: 61 62 - 0x0: EL1 63 - 0x1: S_EL0 64 - 0x2: S_EL1 65 66- execution-state [mandatory] 67 - value type: <u32> 68 - The target execution state of the partition: 69 70 - 0: AArch64 71 - 1: AArch32 72 73- load-address 74 - value type: <u64> 75 - Physical base address of the partition in memory. Absence of this field 76 indicates that the partition is position independent and can be loaded at 77 any address chosen at boot time. 78 79- entrypoint-offset 80 - value type: <u64> 81 - Offset from the base of the partition's binary image to the entry point of 82 the partition. Absence of this field indicates that the entry point is at 83 offset 0x0 from the base of the partition's binary. 84 85- xlat-granule 86 - value type: <u32> 87 - Translation granule used with the partition: 88 89 - 0x0: 4k 90 - 0x1: 16k 91 - 0x2: 64k 92 93- boot-order 94 - value type: <u16> 95 - A unique number amongst all partitions that specifies if this partition 96 must be booted before others. The partition with the smaller number will be 97 booted first. 98 99- rx-tx-buffer 100 - value type: "memory-regions" node 101 - Specific "memory-regions" nodes that describe the RX/TX buffers expected 102 by the partition. 103 The "compatible" must be the string "arm,ffa-manifest-rx_tx-buffer". 104 105- messaging-method [mandatory] 106 - value type: <u16> 107 - Specifies which messaging methods are supported by the partition, set bit 108 means the feature is supported, clear bit - not supported: 109 110 - Bit[0]: partition can receive direct requests via FFA_MSG_SEND_DIRECT_REQ ABI if set 111 - Bit[1]: partition can send direct requests via FFA_MSG_SEND_DIRECT_REQ ABI if set 112 - Bit[2]: partition can send and receive indirect messages 113 - Bit[9]: partition can receive direct requests via FFA_MSG_SEND_DIRECT_REQ2 ABI if set 114 - Bit[10]: partition can send direct requests via FFA_MSG_SEND_DIRECT_REQ2 ABI if set 115 116- managed-exit 117 - value type: <empty> 118 - Specifies if managed exit is supported. 119 - This field is deprecated in favor of ns-interrupts-action field in the FF-A 120 v1.1 EAC0 spec. 121 122- managed-exit-virq 123 - value type: <empty> 124 - Indicates if the partition needs managed exit, if supported, to be signaled 125 through vFIQ signal. 126 127- ns-interrupts-action [mandatory] 128 - value type: <u32> 129 - Specifies the action that the SPMC must take in response to a Non-secure 130 physical interrupt. 131 132 - 0x0: Non-secure interrupt is queued 133 - 0x1: Non-secure interrupt is signaled after a managed exit 134 - 0x2: Non-secure interrupt is signaled 135 136 - This field supersedes the managed-exit field in the FF-A v1.0 spec. 137 138- other-s-interrupts-action 139 - value type: <u32> 140 - Specifies the action that the SPMC must take in response to a Other-Secure 141 physical interrupt. 142 143 - 0x0: Other-Secure interrupt is queued 144 - 0x1: Other-Secure interrupt is signaled 145 146- runtime-model 147 - value type: <u32> 148 - Indicates whether the SP execution can be preempted. 149 - This field is deprecated in favor of other-s-interrupts-action and 150 ns-interrupts-action fields in the FF-A v1.1 spec. 151 152- has-primary-scheduler 153 - value type: <empty> 154 - Presence of this field indicates that the partition implements the primary 155 scheduler. If so, run-time EL must be EL1. 156 157- time-slice-mem 158 - value type: <empty> 159 - Presence of this field indicates that the partition doesn't expect the 160 partition manager to time slice long running memory management functions. 161 162- gp-register-num 163 - value type: <u32> 164 - The field specifies the general purpose register number but not its width. 165 The width is derived from the partition's execution state, as specified in 166 the partition properties. For example, if the number value is 1 then the 167 general-purpose register used will be x1 in AArch64 state and w1 in AArch32 168 state. 169 Presence of this field indicates that the partition expects the address of 170 the FF-A boot information blob to be passed in the specified general purpose 171 register. 172 173- power-management-messages 174 - value type: <u32> 175 - Specifies which power management messages a partition subscribes to. 176 A set bit means the partition should be informed of the power event, clear 177 bit - should not be informed of event: 178 179 - Bit[0]: CPU_OFF 180 - Bit[1]: CPU_SUSPEND 181 - Bit[2]: CPU_SUSPEND_RESUME 182 183.. _memory_region_node: 184 185Memory Regions 186-------------- 187 188- compatible [mandatory] 189 - value type: <string> 190 - Must be the string "arm,ffa-manifest-memory-regions". 191 192- description 193 - value type: <string> 194 - Name of the memory region e.g. for debugging purposes. 195 196- pages-count [mandatory] 197 - value type: <u32> 198 - Count of pages of memory region as a multiple of the translation granule 199 size 200 201- attributes [mandatory] 202 - value type: <u32> 203 - Mapping modes: ORed to get required permission 204 205 - 0x1: Read 206 - 0x2: Write 207 - 0x4: Execute 208 - 0x8: Security state 209 210- base-address 211 - value type: <u64> 212 - Base address of the region. The address must be aligned to the translation 213 granule size. 214 The address given may be a Physical Address (PA), Virtual Address (VA), or 215 Intermediate Physical Address (IPA). Refer to the FF-A specification for 216 more information on the restrictions around the address type. 217 If the base address is omitted then the partition manager must map a memory 218 region of the specified size into the partition's translation regime and 219 then communicate the region properties (including the base address chosen 220 by the partition manager) to the partition. 221 222- stream-ids 223 - value type: <prop-encoded-array> 224 - List of IDs belonging to a DMA capable peripheral device that has access to 225 the memory region represented by current node. 226 - Each ID must have been declared in exactly one device region node. 227 228- smmu-id 229 - value type: <u32> 230 - Identifies the SMMU IP that enforces the access control for the DMA device 231 that owns the above stream-ids. 232 233- stream-ids-access-permissions 234 - value type: <prop-encoded-array> 235 - List of attributes representing the instruction and data access permissions 236 used by the DMA device streams to access the memory region represented by 237 current node. 238 239.. _device_region_node: 240 241Device Regions 242-------------- 243 244- compatible [mandatory] 245 - value type: <string> 246 - Must be the string "arm,ffa-manifest-device-regions". 247 248- description 249 - value type: <string> 250 - Name of the device region e.g. for debugging purposes. 251 252- pages-count [mandatory] 253 - value type: <u32> 254 - Count of pages of memory region as a multiple of the translation granule 255 size 256 257- attributes [mandatory] 258 - value type: <u32> 259 - Mapping modes: ORed to get required permission 260 261 - 0x1: Read 262 - 0x2: Write 263 - 0x4: Execute 264 - 0x8: Security state 265 266- base-address [mandatory] 267 - value type: <u64> 268 - Base address of the region. The address must be aligned to the translation 269 granule size. 270 The address given may be a Physical Address (PA), Virtual Address (VA), or 271 Intermediate Physical Address (IPA). Refer to the FF-A specification for 272 more information on the restrictions around the address type. 273 274- smmu-id 275 - value type: <u32> 276 - On systems with multiple System Memory Management Units (SMMUs) this 277 identifier is used to inform the partition manager which SMMU the device is 278 upstream of. If the field is omitted then it is assumed that the device is 279 not upstream of any SMMU. 280 281- stream-ids 282 - value type: <prop-encoded-array> 283 - List of IDs where an ID is a unique <u32> value amongst all devices assigned 284 to the partition. 285 286- interrupts 287 - value type: <prop-encoded-array> 288 - A list of (id, attributes) pair describing the device interrupts, where: 289 290 - id: The <u32> interrupt IDs. 291 - attributes: A <u32> value, containing attributes for each interrupt ID: 292 293 +----------------------+----------+ 294 |Field | Bit(s) | 295 +----------------------+----------+ 296 | Priority | 7:0 | 297 +----------------------+----------+ 298 | Security state | 8 | 299 +----------------------+----------+ 300 | Config(Edge/Level) | 9 | 301 +----------------------+----------+ 302 | Type(SPI/PPI/SGI) | 11:10 | 303 +----------------------+----------+ 304 305 Security state: 306 - Secure: 1 307 - Non-secure: 0 308 309 Configuration: 310 - Edge triggered: 0 311 - Level triggered: 1 312 313 Type: 314 - SPI: 0b10 315 - PPI: 0b01 316 - SGI: 0b00 317 318- interrupts-target 319 - value type: <prop-encoded-array> 320 - A list of (id, mpdir upper bits, mpidr lower bits) tuples describing which 321 mpidr the interrupt is routed to, where: 322 323 - id: The <u32> interrupt ID. Must be one of those specified in the 324 "interrupts" field. 325 - mpidr upper bits: The <u32> describing the upper bits of the 64 bits 326 mpidr 327 - mpidr lower bits: The <u32> describing the lower bits of the 64 bits 328 mpidr 329 330- exclusive-access 331 - value type: <empty> 332 - Presence of this field implies that this endpoint must be granted exclusive 333 access and ownership of this device's MMIO region. 334 335-------------- 336 337*Copyright (c) 2019-2024, Arm Limited and Contributors. All rights reserved.* 338