^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) * Xen hypervisor device tree bindings
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) Xen ARM virtual platforms shall have a top-level "hypervisor" node with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) the following properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) - compatible:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) compatible = "xen,xen-<version>", "xen,xen";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) where <version> is the version of the Xen ABI of the platform.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) - reg: specifies the base physical address and size of a region in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) memory where the grant table should be mapped to, using an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) HYPERVISOR_memory_op hypercall. The memory region is large enough to map
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) the whole grant table (it is larger or equal to gnttab_max_grant_frames()).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) This property is unnecessary when booting Dom0 using ACPI.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) - interrupts: the interrupt used by Xen to inject event notifications.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) A GIC node is also required.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) This property is unnecessary when booting Dom0 using ACPI.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) To support UEFI on Xen ARM virtual platforms, Xen populates the FDT "uefi" node
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) under /hypervisor with following parameters:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) ________________________________________________________________________________
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) Name | Size | Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) ================================================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) xen,uefi-system-table | 64-bit | Guest physical address of the UEFI System
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) | | Table.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) --------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) xen,uefi-mmap-start | 64-bit | Guest physical address of the UEFI memory
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) | | map.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) --------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) xen,uefi-mmap-size | 32-bit | Size in bytes of the UEFI memory map
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) | | pointed to in previous entry.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) --------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) xen,uefi-mmap-desc-size | 32-bit | Size in bytes of each entry in the UEFI
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) | | memory map.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) --------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) xen,uefi-mmap-desc-ver | 32-bit | Version of the mmap descriptor format.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) --------------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) Example (assuming #address-cells = <2> and #size-cells = <2>):
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) hypervisor {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) compatible = "xen,xen-4.3", "xen,xen";
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) reg = <0 0xb0000000 0 0x20000>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) interrupts = <1 15 0xf08>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) uefi {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) xen,uefi-system-table = <0xXXXXXXXX>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) xen,uefi-mmap-start = <0xXXXXXXXX>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) xen,uefi-mmap-size = <0xXXXXXXXX>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) xen,uefi-mmap-desc-size = <0xXXXXXXXX>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) xen,uefi-mmap-desc-ver = <0xXXXXXXXX>;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) The format and meaning of the "xen,uefi-*" parameters are similar to those in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) Documentation/arm/uefi.rst, which are provided by the regular UEFI stub. However
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) they differ because they are provided by the Xen hypervisor, together with a set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) of UEFI runtime services implemented via hypercalls, see
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) http://xenbits.xen.org/docs/unstable/hypercall/x86_64/include,public,platform.h.html.