blob: 7483c9002012a0af9db6a644523d67461e51a689 [file] [log] [blame]
Olivier Deprez9938c132021-04-21 11:22:23 +02001FF-A manifest binding to device tree
J-Alves2672cde2020-05-07 18:42:25 +01002========================================
Louis Mayencourt5f0fc152019-11-29 15:05:14 +00003
4This document defines the nodes and properties used to define a partition,
Olivier Deprez9938c132021-04-21 11:22:23 +02005according to the FF-A specification.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +00006
Louis Mayencourt31030e52020-04-08 13:04:33 +01007Partition Properties
Olivier Deprez7a632c52022-05-12 18:17:05 +02008--------------------
Louis Mayencourt5f0fc152019-11-29 15:05:14 +00009
10- compatible [mandatory]
11 - value type: <string>
J-Alves2672cde2020-05-07 18:42:25 +010012 - Must be the string "arm,ffa-manifest-X.Y" which specifies the major and
David Horstmann051fd6d2020-11-12 15:19:04 +000013 minor versions of the device tree binding for the FFA manifest represented
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000014 by this node. The minor number is incremented if the binding changes in a
15 backwards compatible manner.
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000016
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000017 - 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
J-Alves2672cde2020-05-07 18:42:25 +010020- ffa-version [mandatory]
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000021 - value type: <u32>
22 - Must be two 16 bits values (X, Y), concatenated as 31:16 -> X,
23 15:0 -> Y, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000024
Olivier Deprez9938c132021-04-21 11:22:23 +020025 - X is the major version of FF-A expected by the partition at the FFA
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000026 instance it will execute.
Olivier Deprez9938c132021-04-21 11:22:23 +020027 - Y is the minor version of FF-A expected by the partition at the FFA
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000028 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.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000034
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.
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000050
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000051 - 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:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000061
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000062 - 0x0: EL1
63 - 0x1: S_EL0
64 - 0x2: S_EL1
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000065
66- execution-state [mandatory]
67 - value type: <u32>
68 - The target execution state of the partition:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000069
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000070 - 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 [mandatory]
86 - value type: <u32>
87 - Translation granule used with the partition:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000088
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000089 - 0x0: 4k
90 - 0x1: 16k
Louis Mayencourt31030e52020-04-08 13:04:33 +010091 - 0x2: 64k
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000092
93- boot-order
94 - value type: <u32>
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.
J-Alves2672cde2020-05-07 18:42:25 +0100103 The "compatible" must be the string "arm,ffa-manifest-rx_tx-buffer".
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000104
105- messaging-method [mandatory]
Maksims Svecovsdfdec7c2021-05-06 14:17:00 +0100106 - value type: <u8>
107 - Specifies which messaging methods are supported by the partition, set bit
108 means the feature is supported, clear bit - not supported:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000109
Maksims Svecovs14713202021-05-06 19:03:48 +0100110 - Bit[0]: partition can receive direct requests if set
111 - Bit[1]: partition can send direct requests if set
112 - Bit[2]: partition can send and receive indirect messages
113
114- managed-exit
115 - value type: <empty>
116 - Specifies if managed exit is supported.
Madhukar Pappireddybfc7aa82022-09-01 10:57:21 -0500117 - This field is deprecated in favor of ns-interrupts-action field in the FF-A
118 v1.1 EAC0 spec.
119
120- ns-interrupts-action [mandatory]
121 - value type: <u32>
122 - Specifies the action that the SPMC must take in response to a Non-secure
123 physical interrupt.
124
125 - 0x0: Non-secure interrupt is queued
126 - 0x1: Non-secure interrupt is signaled after a managed exit
127 - 0x2: Non-secure interrupt is signaled
128
129 - This field supersedes the managed-exit field in the FF-A v1.0 spec.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000130
131- has-primary-scheduler
132 - value type: <empty>
133 - Presence of this field indicates that the partition implements the primary
134 scheduler. If so, run-time EL must be EL1.
135
136- run-time-model
137 - value type: <u32>
138 - Run time model that the SPM must enforce for this SP:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000139
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000140 - 0x0: Run to completion
141 - 0x1: Preemptible
142
143- time-slice-mem
144 - value type: <empty>
145 - Presence of this field indicates that the partition doesn't expect the
146 partition manager to time slice long running memory management functions.
147
148- gp-register-num
149 - value type: <u32>
J-Alvescfc6e232022-05-24 12:13:08 +0100150 - The field specifies the general purpose register number but not its width.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000151 The width is derived from the partition's execution state, as specified in
152 the partition properties. For example, if the number value is 1 then the
153 general-purpose register used will be x1 in AArch64 state and w1 in AArch32
154 state.
J-Alvescfc6e232022-05-24 12:13:08 +0100155 Presence of this field indicates that the partition expects the address of
156 the FF-A boot information blob to be passed in the specified general purpose
157 register.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000158
159- stream-endpoint-ids
160 - value type: <prop-encoded-array>
161 - List of <u32> tuples, identifying the IDs this partition is acting as
162 proxy for.
163
Marc Bonnici25f4b542022-04-12 17:18:13 +0100164- power-management-messages
165 - value type: <u32>
166 - Specifies which power management messages a partition subscribes to.
167 A set bit means the partition should be informed of the power event, clear
168 bit - should not be informed of event:
169
170 - Bit[0]: CPU_OFF
171 - Bit[1]: CPU_SUSPEND
172 - Bit[2]: CPU_SUSPEND_RESUME
173
Louis Mayencourt31030e52020-04-08 13:04:33 +0100174Memory Regions
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000175--------------
176
177- compatible [mandatory]
178 - value type: <string>
J-Alves2672cde2020-05-07 18:42:25 +0100179 - Must be the string "arm,ffa-manifest-memory-regions".
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000180
181- description
182 - value type: <string>
183 - Name of the memory region e.g. for debugging purposes.
184
185- pages-count [mandatory]
186 - value type: <u32>
187 - Count of pages of memory region as a multiple of the translation granule
188 size
189
190- attributes [mandatory]
191 - value type: <u32>
Louis Mayencourt31030e52020-04-08 13:04:33 +0100192 - Mapping modes: ORed to get required permission
193
194 - 0x1: Read
195 - 0x2: Write
196 - 0x4: Execute
Olivier Deprez7a632c52022-05-12 18:17:05 +0200197 - 0x8: Security state
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000198
199- base-address
200 - value type: <u64>
201 - Base address of the region. The address must be aligned to the translation
202 granule size.
203 The address given may be a Physical Address (PA), Virtual Address (VA), or
Olivier Deprez7a632c52022-05-12 18:17:05 +0200204 Intermediate Physical Address (IPA). Refer to the FF-A specification for
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000205 more information on the restrictions around the address type.
206 If the base address is omitted then the partition manager must map a memory
207 region of the specified size into the partition's translation regime and
208 then communicate the region properties (including the base address chosen
209 by the partition manager) to the partition.
210
Louis Mayencourt31030e52020-04-08 13:04:33 +0100211Device Regions
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000212--------------
213
214- compatible [mandatory]
215 - value type: <string>
J-Alves2672cde2020-05-07 18:42:25 +0100216 - Must be the string "arm,ffa-manifest-device-regions".
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000217
218- description
219 - value type: <string>
220 - Name of the device region e.g. for debugging purposes.
221
Olivier Deprez7a632c52022-05-12 18:17:05 +0200222- pages-count [mandatory]
223 - value type: <u32>
224 - Count of pages of memory region as a multiple of the translation granule
225 size
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000226
227- attributes [mandatory]
228 - value type: <u32>
Louis Mayencourt31030e52020-04-08 13:04:33 +0100229 - Mapping modes: ORed to get required permission
230
231 - 0x1: Read
232 - 0x2: Write
233 - 0x4: Execute
Olivier Deprez7a632c52022-05-12 18:17:05 +0200234 - 0x8: Security state
235
236- base-address [mandatory]
237 - value type: <u64>
238 - Base address of the region. The address must be aligned to the translation
239 granule size.
240 The address given may be a Physical Address (PA), Virtual Address (VA), or
241 Intermediate Physical Address (IPA). Refer to the FF-A specification for
242 more information on the restrictions around the address type.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000243
244- smmu-id
245 - value type: <u32>
246 - On systems with multiple System Memory Management Units (SMMUs) this
247 identifier is used to inform the partition manager which SMMU the device is
248 upstream of. If the field is omitted then it is assumed that the device is
249 not upstream of any SMMU.
250
Louis Mayencourt31030e52020-04-08 13:04:33 +0100251- stream-ids
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000252 - value type: <prop-encoded-array>
253 - A list of (id, mem-manage) pair, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000254
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000255 - id: A unique <u32> value amongst all devices assigned to the partition.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000256
257- interrupts [mandatory]
258 - value type: <prop-encoded-array>
259 - A list of (id, attributes) pair describing the device interrupts, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000260
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000261 - id: The <u32> interrupt IDs.
Olivier Deprez7a632c52022-05-12 18:17:05 +0200262 - attributes: A <u32> value, containing attributes for each interrupt ID:
263
264 +----------------------+----------+
265 |Field | Bit(s) |
266 +----------------------+----------+
267 | Priority | 7:0 |
268 +----------------------+----------+
269 | Security state | 8 |
270 +----------------------+----------+
271 | Config(Edge/Level) | 9 |
272 +----------------------+----------+
273 | Type(SPI/PPI/SGI) | 11:10 |
274 +----------------------+----------+
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000275
Olivier Deprez7a632c52022-05-12 18:17:05 +0200276 Security state:
277 - Secure: 1
278 - Non-secure: 0
279
280 Configuration:
281 - Edge triggered: 0
282 - Level triggered: 1
283
284 Type:
285 - SPI: 0b10
286 - PPI: 0b01
287 - SGI: 0b00
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000288
289- exclusive-access
290 - value type: <empty>
291 - Presence of this field implies that this endpoint must be granted exclusive
David Horstmann051fd6d2020-11-12 15:19:04 +0000292 access and ownership of this device's MMIO region.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000293
294--------------
295
Olivier Deprez7a632c52022-05-12 18:17:05 +0200296*Copyright (c) 2019-2022, Arm Limited and Contributors. All rights reserved.*