blob: 59996cc27b5ddc09103a04af59dad05d721f154b [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
7Version 1.0
8-----------
9
Louis Mayencourt31030e52020-04-08 13:04:33 +010010Partition Properties
11^^^^^^^^^^^^^^^^^^^^
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000012
13- compatible [mandatory]
14 - value type: <string>
J-Alves2672cde2020-05-07 18:42:25 +010015 - Must be the string "arm,ffa-manifest-X.Y" which specifies the major and
David Horstmann051fd6d2020-11-12 15:19:04 +000016 minor versions of the device tree binding for the FFA manifest represented
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000017 by this node. The minor number is incremented if the binding changes in a
18 backwards compatible manner.
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000019
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000020 - 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
J-Alves2672cde2020-05-07 18:42:25 +010023- ffa-version [mandatory]
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000024 - value type: <u32>
25 - Must be two 16 bits values (X, Y), concatenated as 31:16 -> X,
26 15:0 -> Y, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000027
Olivier Deprez9938c132021-04-21 11:22:23 +020028 - X is the major version of FF-A expected by the partition at the FFA
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000029 instance it will execute.
Olivier Deprez9938c132021-04-21 11:22:23 +020030 - Y is the minor version of FF-A expected by the partition at the FFA
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000031 instance it will execute.
32
33- uuid [mandatory]
34 - value type: <prop-encoded-array>
35 - An array consisting of 4 <u32> values, identifying the UUID of the service
36 implemented by this partition. The UUID format is described in RFC 4122.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000037
38- id
39 - value type: <u32>
40 - Pre-allocated partition ID.
41
42- auxiliary-id
43 - value type: <u32>
44 - Pre-allocated ID that could be used in memory management transactions.
45
46- description
47 - value type: <string>
48 - Name of the partition e.g. for debugging purposes.
49
50- execution-ctx-count [mandatory]
51 - value type: <u32>
52 - Number of vCPUs that a VM or SP wants to instantiate.
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000053
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000054 - In the absence of virtualization, this is the number of execution
55 contexts that a partition implements.
56 - If value of this field = 1 and number of PEs > 1 then the partition is
57 treated as UP & migrate capable.
58 - If the value of this field > 1 then the partition is treated as a MP
59 capable partition irrespective of the number of PEs.
60
61- exception-level [mandatory]
62 - value type: <u32>
63 - The target exception level for the partition:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000064
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000065 - 0x0: EL1
66 - 0x1: S_EL0
67 - 0x2: S_EL1
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000068
69- execution-state [mandatory]
70 - value type: <u32>
71 - The target execution state of the partition:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000072
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000073 - 0: AArch64
74 - 1: AArch32
75
76- load-address
77 - value type: <u64>
78 - Physical base address of the partition in memory. Absence of this field
79 indicates that the partition is position independent and can be loaded at
80 any address chosen at boot time.
81
82- entrypoint-offset
83 - value type: <u64>
84 - Offset from the base of the partition's binary image to the entry point of
85 the partition. Absence of this field indicates that the entry point is at
86 offset 0x0 from the base of the partition's binary.
87
88- xlat-granule [mandatory]
89 - value type: <u32>
90 - Translation granule used with the partition:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +000091
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000092 - 0x0: 4k
93 - 0x1: 16k
Louis Mayencourt31030e52020-04-08 13:04:33 +010094 - 0x2: 64k
Louis Mayencourt5f0fc152019-11-29 15:05:14 +000095
96- boot-order
97 - value type: <u32>
98 - A unique number amongst all partitions that specifies if this partition
99 must be booted before others. The partition with the smaller number will be
100 booted first.
101
102- rx-tx-buffer
103 - value type: "memory-regions" node
104 - Specific "memory-regions" nodes that describe the RX/TX buffers expected
105 by the partition.
J-Alves2672cde2020-05-07 18:42:25 +0100106 The "compatible" must be the string "arm,ffa-manifest-rx_tx-buffer".
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000107
108- messaging-method [mandatory]
Maksims Svecovsdfdec7c2021-05-06 14:17:00 +0100109 - value type: <u8>
110 - Specifies which messaging methods are supported by the partition, set bit
111 means the feature is supported, clear bit - not supported:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000112
Maksims Svecovs14713202021-05-06 19:03:48 +0100113 - Bit[0]: partition can receive direct requests if set
114 - Bit[1]: partition can send direct requests if set
115 - Bit[2]: partition can send and receive indirect messages
116
117- managed-exit
118 - value type: <empty>
119 - Specifies if managed exit is supported.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000120
121- has-primary-scheduler
122 - value type: <empty>
123 - Presence of this field indicates that the partition implements the primary
124 scheduler. If so, run-time EL must be EL1.
125
126- run-time-model
127 - value type: <u32>
128 - Run time model that the SPM must enforce for this SP:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000129
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000130 - 0x0: Run to completion
131 - 0x1: Preemptible
132
133- time-slice-mem
134 - value type: <empty>
135 - Presence of this field indicates that the partition doesn't expect the
136 partition manager to time slice long running memory management functions.
137
138- gp-register-num
139 - value type: <u32>
140 - Presence of this field indicates that the partition expects the
J-Alves2672cde2020-05-07 18:42:25 +0100141 ffa_init_info structure to be passed in via the specified general purpose
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000142 register.
143 The field specifies the general purpose register number but not its width.
144 The width is derived from the partition's execution state, as specified in
145 the partition properties. For example, if the number value is 1 then the
146 general-purpose register used will be x1 in AArch64 state and w1 in AArch32
147 state.
148
149- stream-endpoint-ids
150 - value type: <prop-encoded-array>
151 - List of <u32> tuples, identifying the IDs this partition is acting as
152 proxy for.
153
Marc Bonnici25f4b542022-04-12 17:18:13 +0100154- power-management-messages
155 - value type: <u32>
156 - Specifies which power management messages a partition subscribes to.
157 A set bit means the partition should be informed of the power event, clear
158 bit - should not be informed of event:
159
160 - Bit[0]: CPU_OFF
161 - Bit[1]: CPU_SUSPEND
162 - Bit[2]: CPU_SUSPEND_RESUME
163
Louis Mayencourt31030e52020-04-08 13:04:33 +0100164Memory Regions
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000165--------------
166
167- compatible [mandatory]
168 - value type: <string>
J-Alves2672cde2020-05-07 18:42:25 +0100169 - Must be the string "arm,ffa-manifest-memory-regions".
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000170
171- description
172 - value type: <string>
173 - Name of the memory region e.g. for debugging purposes.
174
175- pages-count [mandatory]
176 - value type: <u32>
177 - Count of pages of memory region as a multiple of the translation granule
178 size
179
180- attributes [mandatory]
181 - value type: <u32>
Louis Mayencourt31030e52020-04-08 13:04:33 +0100182 - Mapping modes: ORed to get required permission
183
184 - 0x1: Read
185 - 0x2: Write
186 - 0x4: Execute
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000187
188- base-address
189 - value type: <u64>
190 - Base address of the region. The address must be aligned to the translation
191 granule size.
192 The address given may be a Physical Address (PA), Virtual Address (VA), or
J-Alves2672cde2020-05-07 18:42:25 +0100193 Intermediate Physical Address (IPA). Refer to the FFA specification for
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000194 more information on the restrictions around the address type.
195 If the base address is omitted then the partition manager must map a memory
196 region of the specified size into the partition's translation regime and
197 then communicate the region properties (including the base address chosen
198 by the partition manager) to the partition.
199
Louis Mayencourt31030e52020-04-08 13:04:33 +0100200Device Regions
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000201--------------
202
203- compatible [mandatory]
204 - value type: <string>
J-Alves2672cde2020-05-07 18:42:25 +0100205 - Must be the string "arm,ffa-manifest-device-regions".
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000206
207- description
208 - value type: <string>
209 - Name of the device region e.g. for debugging purposes.
210
211- reg [mandatory]
212 - value type: <prop-encoded-array>
213 - A (address, num-pages) pair describing the device, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000214
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000215 - address: The physical base address <u64> value of the device MMIO
216 region.
217 - num-pages: The <u32> number of pages of the region. The total size of
218 the region is this value multiplied by the translation granule size.
219
220- attributes [mandatory]
221 - value type: <u32>
Louis Mayencourt31030e52020-04-08 13:04:33 +0100222 - Mapping modes: ORed to get required permission
223
224 - 0x1: Read
225 - 0x2: Write
226 - 0x4: Execute
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000227
228- smmu-id
229 - value type: <u32>
230 - On systems with multiple System Memory Management Units (SMMUs) this
231 identifier is used to inform the partition manager which SMMU the device is
232 upstream of. If the field is omitted then it is assumed that the device is
233 not upstream of any SMMU.
234
Louis Mayencourt31030e52020-04-08 13:04:33 +0100235- stream-ids
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000236 - value type: <prop-encoded-array>
237 - A list of (id, mem-manage) pair, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000238
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000239 - id: A unique <u32> value amongst all devices assigned to the partition.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000240
241- interrupts [mandatory]
242 - value type: <prop-encoded-array>
243 - A list of (id, attributes) pair describing the device interrupts, where:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000244
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000245 - id: The <u32> interrupt IDs.
Louis Mayencourt31030e52020-04-08 13:04:33 +0100246 - attributes: A <u32> value,
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000247 containing the attributes for each interrupt ID:
Louis Mayencourt950ef2f2020-03-27 11:49:20 +0000248
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000249 - Interrupt type: SPI, PPI, SGI
250 - Interrupt configuration: Edge triggered, Level triggered
251 - Interrupt security state: Secure, Non-secure
252 - Interrupt priority value
253 - Target execution context/vCPU for each SPI
254
255- exclusive-access
256 - value type: <empty>
257 - Presence of this field implies that this endpoint must be granted exclusive
David Horstmann051fd6d2020-11-12 15:19:04 +0000258 access and ownership of this device's MMIO region.
Louis Mayencourt5f0fc152019-11-29 15:05:14 +0000259
260--------------
261
Manish Pandeyd3dc3a02020-09-25 09:50:31 +0100262*Copyright (c) 2019-2021, Arm Limited and Contributors. All rights reserved.*