Patrick Rudolph has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/32340
Change subject: Documentation: Small fixes ......................................................................
Documentation: 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 --- M Documentation/index.md R Documentation/lib/abi-data-consumption.md M Documentation/lib/index.md R Documentation/lib/timestamp.md D Documentation/security.md 5 files changed, 11 insertions(+), 39 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/40/32340/1
diff --git a/Documentation/index.md b/Documentation/index.md index 6eb2e69..6dbbf4d 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -167,13 +167,10 @@ * [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 @@ * [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 similarity index 86% rename from Documentation/abi-data-consumption.md rename to Documentation/lib/abi-data-consumption.md index 962f33e..d162199 100644 --- a/Documentation/abi-data-consumption.md +++ b/Documentation/lib/abi-data-consumption.md @@ -8,8 +8,9 @@ ## 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 85e0460..99b8061 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 similarity index 90% rename from Documentation/timestamp.md rename to Documentation/lib/timestamp.md index 9233ed9..d5dc8fa 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 @@
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 @@ 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 @@ 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 @@ 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 73b167f..0000000 --- a/Documentation/security.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -## Google VBoot2 Measured boot extension - -- [Measured Boot](vboot/measured_boot.md)
Paul Menzel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/32340 )
Change subject: Documentation: Small fixes ......................................................................
Patch Set 1: Code-Review+1
(1 comment)
https://review.coreboot.org/#/c/32340/1//COMMIT_MSG Commit Message:
https://review.coreboot.org/#/c/32340/1//COMMIT_MSG@7 PS1, Line 7: Documentation: Small fixes
Add small fixes
or
Clean up and improve structure
Hung-Te Lin has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/32340 )
Change subject: Documentation: Small fixes ......................................................................
Patch Set 1: Code-Review+1
I'm fine with the lib/index changes.
Martin Roth has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/32340 )
Change subject: Documentation: Small fixes ......................................................................
Patch Set 1: Code-Review+2
I guess you can add the security file back in when you merge your other patch: "security: Add memory subfolder". It'll make more sense at that point anyway.
Hello Paul Menzel, Hung-Te Lin, Philipp Deppenwiese, build bot (Jenkins), Martin Roth, Patrick Georgi,
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/32340
to look at the new patch set (#2).
Change subject: Documentation: Add small fixes ......................................................................
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 --- M Documentation/index.md R Documentation/lib/abi-data-consumption.md M Documentation/lib/index.md R Documentation/lib/timestamp.md D Documentation/security.md 5 files changed, 11 insertions(+), 39 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/40/32340/2
Patrick Rudolph has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/32340 )
Change subject: Documentation: Add small fixes ......................................................................
Patch Set 2:
(1 comment)
https://review.coreboot.org/#/c/32340/1//COMMIT_MSG Commit Message:
https://review.coreboot.org/#/c/32340/1//COMMIT_MSG@7 PS1, Line 7: Documentation: Small fixes
Add small fixes […]
Done
Patrick Rudolph has submitted this change and it was merged. ( https://review.coreboot.org/c/coreboot/+/32340 )
Change subject: Documentation: Add small fixes ......................................................................
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 --- M Documentation/index.md R Documentation/lib/abi-data-consumption.md M Documentation/lib/index.md R Documentation/lib/timestamp.md D Documentation/security.md 5 files changed, 11 insertions(+), 39 deletions(-)
Approvals: build bot (Jenkins): Verified Martin Roth: Looks good to me, approved Paul Menzel: Looks good to me, but someone else must approve Hung-Te Lin: Looks good to me, but someone else must approve
diff --git a/Documentation/index.md b/Documentation/index.md index 6eb2e69..6dbbf4d 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -167,13 +167,10 @@ * [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 @@ * [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 similarity index 86% rename from Documentation/abi-data-consumption.md rename to Documentation/lib/abi-data-consumption.md index 962f33e..d162199 100644 --- a/Documentation/abi-data-consumption.md +++ b/Documentation/lib/abi-data-consumption.md @@ -8,8 +8,9 @@ ## 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 85e0460..99b8061 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 similarity index 90% rename from Documentation/timestamp.md rename to Documentation/lib/timestamp.md index 9233ed9..d5dc8fa 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 @@
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 @@ 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 @@ 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 @@ 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 73b167f..0000000 --- a/Documentation/security.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -## Google VBoot2 Measured boot extension - -- [Measured Boot](vboot/measured_boot.md)
-
Hung-Te Lin (Code Review) -
Martin Roth (Code Review)
-
Patrick Rudolph (Code Review)
-
Paul Menzel (Code Review)