xref: /freebsd/sys/contrib/device-tree/Bindings/reserved-memory/xen,shared-memory.txt (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1* Xen hypervisor reserved-memory binding
2
3Expose one or more memory regions as reserved-memory to the guest
4virtual machine. Typically, a region is configured at VM creation time
5to be a shared memory area across multiple virtual machines for
6communication among them.
7
8For each of these pre-shared memory regions, a range is exposed under
9the /reserved-memory node as a child node. Each range sub-node is named
10xen-shmem@<address> and has the following properties:
11
12- compatible:
13	compatible = "xen,shared-memory-v1"
14
15- reg:
16	the base guest physical address and size of the shared memory region
17
18- xen,offset: (borrower VMs only)
19	64 bit integer offset within the owner virtual machine's shared
20	memory region used for the mapping in the borrower VM.
21
22- xen,id:
23	a string that identifies the shared memory region as specified in
24	the VM config file
25