diff options
| -rw-r--r-- | Documentation/index.md | 4 | ||||
| -rw-r--r-- | Documentation/lib/abi-data-consumption.md (renamed from Documentation/abi-data-consumption.md) | 5 | ||||
| -rw-r--r-- | Documentation/lib/index.md | 4 | ||||
| -rw-r--r-- | Documentation/lib/timestamp.md (renamed from Documentation/timestamp.md) | 32 | ||||
| -rw-r--r-- | Documentation/security.md | 5 |
5 files changed, 11 insertions, 39 deletions
diff --git a/Documentation/index.md b/Documentation/index.md index 6eb2e695c6..6dbbf4d91f 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -167,13 +167,10 @@ Contents: * [Code of Conduct](community/code_of_conduct.md) * [Community forums](community/forums.md) * [coreboot at conferences](community/conferences.md) -* [Security](security.md) * [Payloads](payloads.md) * [Distributions](distributions.md) -* [Timestamps](timestamp.md) * [Intel IFD Binary Extraction](Binary_Extraction.md) * [Dealing with Untrusted Input in SMM](technotes/2017-02-dealing-with-untrusted-input-in-smm.md) -* [ABI data consumption](abi-data-consumption.md) * [GPIO toggling in ACPI AML](acpi/gpio.md) * [Native Graphics Initialization with libgfxinit](gfx/libgfxinit.md) * [Architecture-specific documentation](arch/index.md) @@ -182,6 +179,7 @@ Contents: * [Mainboard-specific documentation](mainboard/index.md) * [Payload-specific documentation](lib/payloads/index.md) * [Library-specific documentation](lib/index.md) +* [Security](security/index.md) * [SuperIO-specific documentation](superio/index.md) * [Vendorcode-specific documentation](vendorcode/index.md) * [Utilities](util.md) diff --git a/Documentation/abi-data-consumption.md b/Documentation/lib/abi-data-consumption.md index 962f33eac5..d162199cab 100644 --- a/Documentation/abi-data-consumption.md +++ b/Documentation/lib/abi-data-consumption.md @@ -8,8 +8,9 @@ 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 +table definitions can be found in +`./src/commonlib/include/commonlib/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. diff --git a/Documentation/lib/index.md b/Documentation/lib/index.md index 85e046079d..99b8061325 100644 --- a/Documentation/lib/index.md +++ b/Documentation/lib/index.md @@ -3,5 +3,7 @@ This section contains documentation about coreboot internal technical information and libraries. -# Structure and layout +## Structure and layout - [Flashmap and Flashmap Descriptor](flashmap.md) +- [ABI data consumption](abi-data-consumption.md) +- [Timestamps](timestamp.md) diff --git a/Documentation/timestamp.md b/Documentation/lib/timestamp.md index 9233ed97cc..d5dc8facf3 100644 --- a/Documentation/timestamp.md +++ b/Documentation/lib/timestamp.md @@ -1,29 +1,5 @@ # Timestamps -## Table of Contents - -Introduction -- Transition from cache to cbmem - -Data structures used -- cache_state -- table -- entries - -Function APIs -- timestamp_init -- timestamp_add -- timestamp_add_now -- timestamp_sync - -Use / Test Cases -- Case 1: Timestamp Region Exists -- Case 2: No timestamp region, fresh boot, cbmem_initialize called after timestamp_init -- Case 3: No timestamp region, fresh boot, cbmem_initialize called before timestamp_init -- Case 4: No timestamp region, resume, cbmem_initialize called after timestamp_init -- Case 5: No timestamp region, resume, cbmem_initialize called before timestamp_init - - ## Introduction The aim of the timestamp library is to make it easier for different boards @@ -64,7 +40,7 @@ After such a transition, timestamp_init() must not be run again. The main structure that maintains information about the timestamp cache is: -``` +```c struct __packed timestamp_cache { uint16_t cache_state; struct timestamp_table table; @@ -77,7 +53,7 @@ struct __packed timestamp_cache { The state of the cache is maintained by `cache_state` attribute which can be any one of the following: -``` +```c enum { TIMESTAMP_CACHE_UNINITIALIZED = 0, TIMESTAMP_CACHE_INITIALIZED, @@ -107,7 +83,7 @@ anymore. Thus, the cache state is set to `CACHE_NOT_NEEDED`, which allows This field is represented by a structure which provides overall information about the entries in the timestamp area: -``` +```c struct timestamp_table { uint64_t base_time; uint32_t max_entries; @@ -127,7 +103,7 @@ This field holds the details of each timestamp entry, upto a maximum of `MAX_TIMESTAMP_CACHE` which is defined as 16 entries. Each entry is defined by: -``` +```c struct timestamp_entry { uint32_t entry_id; uint64_t entry_stamp; diff --git a/Documentation/security.md b/Documentation/security.md deleted file mode 100644 index 73b167fdc4..0000000000 --- a/Documentation/security.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -## Google VBoot2 Measured boot extension - -- [Measured Boot](vboot/measured_boot.md) |