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

devicetree: update documentation for fw_cfg ARM bindings

Remove fw_cfg hardware interface details from
Documentation/devicetree/bindings/arm/fw-cfg.txt,
and replace them with a pointer to the authoritative
documentation in the QEMU source tree.

Signed-off-by: Gabriel Somlo <somlo@cmu.edu>
Cc: Laszlo Ersek <lersek@redhat.com>
Acked-by: Rob Herring <robh@kernel.org>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Gabriel Somlo and committed by
Greg Kroah-Hartman
92aed5d6 246c46eb

+2 -36
+2 -36
Documentation/devicetree/bindings/arm/fw-cfg.txt
··· 11 11 registers; their location is communicated to the guest's UEFI firmware in the 12 12 DTB that QEMU places at the bottom of the guest's DRAM. 13 13 14 - The guest writes a selector value (a key) to the selector register, and then 15 - can read the corresponding data (produced by QEMU) via the data register. If 16 - the selected entry is writable, the guest can rewrite it through the data 17 - register. 14 + The authoritative guest-side hardware interface documentation to the fw_cfg 15 + device can be found in "docs/specs/fw_cfg.txt" in the QEMU source tree. 18 16 19 - The selector register takes keys in big endian byte order. 20 - 21 - The data register allows accesses with 8, 16, 32 and 64-bit width (only at 22 - offset 0 of the register). Accesses larger than a byte are interpreted as 23 - arrays, bundled together only for better performance. The bytes constituting 24 - such a word, in increasing address order, correspond to the bytes that would 25 - have been transferred by byte-wide accesses in chronological order. 26 - 27 - The interface allows guest firmware to download various parameters and blobs 28 - that affect how the firmware works and what tables it installs for the guest 29 - OS. For example, boot order of devices, ACPI tables, SMBIOS tables, kernel and 30 - initrd images for direct kernel booting, virtual machine UUID, SMP information, 31 - virtual NUMA topology, and so on. 32 - 33 - The authoritative registry of the valid selector values and their meanings is 34 - the QEMU source code; the structure of the data blobs corresponding to the 35 - individual key values is also defined in the QEMU source code. 36 - 37 - The presence of the registers can be verified by selecting the "signature" blob 38 - with key 0x0000, and reading four bytes from the data register. The returned 39 - signature is "QEMU". 40 - 41 - The outermost protocol (involving the write / read sequences of the control and 42 - data registers) is expected to be versioned, and/or described by feature bits. 43 - The interface revision / feature bitmap can be retrieved with key 0x0001. The 44 - blob to be read from the data register has size 4, and it is to be interpreted 45 - as a uint32_t value in little endian byte order. The current value 46 - (corresponding to the above outer protocol) is zero. 47 - 48 - The guest kernel is not expected to use these registers (although it is 49 - certainly allowed to); the device tree bindings are documented here because 50 - this is where device tree bindings reside in general. 51 17 52 18 Required properties: 53 19