From 4d8b843d3740cc90c98f181d49f0d4a67cb0a1b7 Mon Sep 17 00:00:00 2001 From: Stefan Reinauer Date: Tue, 5 May 2015 13:10:04 -0700 Subject: Rename documentation -> Documentation In order to be closer to the Linux kernel source tree structure, rename documentation to Documentation. Change-Id: I8690f666638ef352d201bd3c3dc1923b0d24cb12 Signed-off-by: Stefan Reinauer Reviewed-on: http://review.coreboot.org/10110 Tested-by: build bot (Jenkins) Reviewed-by: Patrick Georgi --- Documentation/abi-data-consumption.txt | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Documentation/abi-data-consumption.txt (limited to 'Documentation/abi-data-consumption.txt') diff --git a/Documentation/abi-data-consumption.txt b/Documentation/abi-data-consumption.txt new file mode 100644 index 0000000000..81442e7170 --- /dev/null +++ b/Documentation/abi-data-consumption.txt @@ -0,0 +1,22 @@ +This text describes the ABI coreboot presents to downstream users. Such +users are payloads and/or operating systems. Therefore, this text serves +at what can be relied on for downstream consumption. Anything not explicitly +listed as consumable is subject to change without notice. + +Background and Usage + +coreboot passes information to downstream users using coreboot tables. These +table definitions can be found in src/include/boot/coreboot_tables.h and +payloads/libpayload/include/coreboot_tables.h respectively within coreboot +and libpayload. One of the most vital and important pieces of information +found within these tables is the memory map of the system indicating +available and reserved memory. + +In 2009 cbmem was added to coreboot. The "CBMEM high table memory manager" +serves a way for coreboot to bookkeep its own internal data. While some +of this data may be exposed through the coreboot tables the data structures +used to manage the data within the cbmem area is subject to change. + +Provided the above, if one needs a piece of data exposed to the OS +or payload it should reside within the coreboot tables. If it isn't there +then a code change will be required to add it to the coreboot tables. -- cgit v1.2.3