1 * Xen hypervisor device tree bindings 1 * Xen hypervisor device tree bindings
2 2
3 Xen ARM virtual platforms shall have a top-lev 3 Xen ARM virtual platforms shall have a top-level "hypervisor" node with
4 the following properties: 4 the following properties:
5 5
6 - compatible: 6 - compatible:
7 compatible = "xen,xen-<version>", "xen 7 compatible = "xen,xen-<version>", "xen,xen";
8 where <version> is the version of the Xen AB 8 where <version> is the version of the Xen ABI of the platform.
9 9
10 - reg: specifies the base physical address and !! 10 - reg: specifies the base physical address and size of a region in
11 where the special resources should be mapped !! 11 memory where the grant table should be mapped to, using an
12 hypercall. !! 12 HYPERVISOR_memory_op hypercall. The memory region is large enough to map
13 Region 0 is reserved for mapping grant table !! 13 the whole grant table (it is larger or equal to gnttab_max_grant_frames()).
14 The memory region is large enough to map the !! 14 This property is unnecessary when booting Dom0 using ACPI.
15 or equal to gnttab_max_grant_frames()). <<
16 Regions 1...N are extended regions (unused a <<
17 GFNs and grants, they might be absent if the <<
18 15
19 - interrupts: the interrupt used by Xen to inj 16 - interrupts: the interrupt used by Xen to inject event notifications.
20 A GIC node is also required. 17 A GIC node is also required.
>> 18 This property is unnecessary when booting Dom0 using ACPI.
21 19
22 To support UEFI on Xen ARM virtual platforms, 20 To support UEFI on Xen ARM virtual platforms, Xen populates the FDT "uefi" node
23 under /hypervisor with following parameters: 21 under /hypervisor with following parameters:
24 22
25 ______________________________________________ 23 ________________________________________________________________________________
26 Name | Size | Descripti 24 Name | Size | Description
27 ============================================== 25 ================================================================================
28 xen,uefi-system-table | 64-bit | Guest phy 26 xen,uefi-system-table | 64-bit | Guest physical address of the UEFI System
29 | | Table. 27 | | Table.
30 ---------------------------------------------- 28 --------------------------------------------------------------------------------
31 xen,uefi-mmap-start | 64-bit | Guest phy 29 xen,uefi-mmap-start | 64-bit | Guest physical address of the UEFI memory
32 | | map. 30 | | map.
33 ---------------------------------------------- 31 --------------------------------------------------------------------------------
34 xen,uefi-mmap-size | 32-bit | Size in b 32 xen,uefi-mmap-size | 32-bit | Size in bytes of the UEFI memory map
35 | | pointed t 33 | | pointed to in previous entry.
36 ---------------------------------------------- 34 --------------------------------------------------------------------------------
37 xen,uefi-mmap-desc-size | 32-bit | Size in b 35 xen,uefi-mmap-desc-size | 32-bit | Size in bytes of each entry in the UEFI
38 | | memory ma 36 | | memory map.
39 ---------------------------------------------- 37 --------------------------------------------------------------------------------
40 xen,uefi-mmap-desc-ver | 32-bit | Version o 38 xen,uefi-mmap-desc-ver | 32-bit | Version of the mmap descriptor format.
41 ---------------------------------------------- 39 --------------------------------------------------------------------------------
42 40
43 Example (assuming #address-cells = <2> and #si 41 Example (assuming #address-cells = <2> and #size-cells = <2>):
44 42
45 hypervisor { 43 hypervisor {
46 compatible = "xen,xen-4.3", "xen,xen"; 44 compatible = "xen,xen-4.3", "xen,xen";
47 reg = <0 0xb0000000 0 0x20000>; 45 reg = <0 0xb0000000 0 0x20000>;
48 interrupts = <1 15 0xf08>; 46 interrupts = <1 15 0xf08>;
49 uefi { 47 uefi {
50 xen,uefi-system-table = <0xXXX 48 xen,uefi-system-table = <0xXXXXXXXX>;
51 xen,uefi-mmap-start = <0xXXXXX 49 xen,uefi-mmap-start = <0xXXXXXXXX>;
52 xen,uefi-mmap-size = <0xXXXXXX 50 xen,uefi-mmap-size = <0xXXXXXXXX>;
53 xen,uefi-mmap-desc-size = <0xX 51 xen,uefi-mmap-desc-size = <0xXXXXXXXX>;
54 xen,uefi-mmap-desc-ver = <0xXX 52 xen,uefi-mmap-desc-ver = <0xXXXXXXXX>;
55 }; 53 };
56 }; 54 };
57 55
58 The format and meaning of the "xen,uefi-*" par 56 The format and meaning of the "xen,uefi-*" parameters are similar to those in
59 Documentation/arch/arm/uefi.rst, which are pro !! 57 Documentation/arm/uefi.txt, which are provided by the regular UEFI stub. However
60 they differ because they are provided by the X 58 they differ because they are provided by the Xen hypervisor, together with a set
61 of UEFI runtime services implemented via hyper 59 of UEFI runtime services implemented via hypercalls, see
62 http://xenbits.xen.org/docs/unstable/hypercall 60 http://xenbits.xen.org/docs/unstable/hypercall/x86_64/include,public,platform.h.html.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.