Documentation: Add small fixes
* Remove empty security.md * Remove second H1 header from lib/index.md * Move two documents in appropriate subfolders * Fix file path * Drop document overview Change-Id: I0e9df6203e82003c01b84967ea6bd779d7583fef Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/32340 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net> Reviewed-by: Hung-Te Lin <hungte@chromium.org> Reviewed-by: Martin Roth <martinroth@google.com>
This commit is contained in:
parent
8f70267607
commit
e8d8d9492d
|
@ -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)
|
||||
|
|
|
@ -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.
|
|
@ -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)
|
||||
|
|
|
@ -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;
|
|
@ -1,5 +0,0 @@
|
|||
# Security
|
||||
|
||||
## Google VBoot2 Measured boot extension
|
||||
|
||||
- [Measured Boot](vboot/measured_boot.md)
|
Loading…
Reference in New Issue