Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: Xen ARM DT bindings

Add a doc to describe the Xen ARM device tree bindings


Changes in v5:

- add a comment about the size of the grant table memory region;
- add a comment about the required presence of a GIC node;
- specify that the described properties are part of a top-level
"hypervisor" node;
- specify #address-cells and #size-cells for the example.


Changes in v4:

- "xen,xen" should be last as it is less specific;
- update reg property using 2 address-cells and 2 size-cells.


Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com>
Acked-by: Rob Herring <rob.herring@calxeda.com>
CC: devicetree-discuss@lists.ozlabs.org
CC: David Vrabel <david.vrabel@citrix.com>
CC: Rob Herring <robherring2@gmail.com>
CC: Dave Martin <dave.martin@linaro.org>

+25
+25
Documentation/devicetree/bindings/arm/xen.txt
··· 1 + * Xen hypervisor device tree bindings 2 + 3 + Xen ARM virtual platforms shall have a top-level "hypervisor" node with 4 + the following properties: 5 + 6 + - compatible: 7 + compatible = "xen,xen-<version>", "xen,xen"; 8 + where <version> is the version of the Xen ABI of the platform. 9 + 10 + - reg: specifies the base physical address and size of a region in 11 + memory where the grant table should be mapped to, using an 12 + HYPERVISOR_memory_op hypercall. The memory region is large enough to map 13 + the whole grant table (it is larger or equal to gnttab_max_grant_frames()). 14 + 15 + - interrupts: the interrupt used by Xen to inject event notifications. 16 + A GIC node is also required. 17 + 18 + 19 + Example (assuming #address-cells = <2> and #size-cells = <2>): 20 + 21 + hypervisor { 22 + compatible = "xen,xen-4.3", "xen,xen"; 23 + reg = <0 0xb0000000 0 0x20000>; 24 + interrupts = <1 15 0xf08>; 25 + };