From 438b463a8f5f739eb02422a3d00b8dfcbeefc2e9 Mon Sep 17 00:00:00 2001 From: Philipp Deppenwiese Date: Sun, 13 May 2018 15:47:18 +0200 Subject: [PATCH] Documentation: Update index.md and move files * Add more subdirectories and index.mds. * Move "getting started" and "lessons" into sub-directories. * Move "NativeRaminit" into northbridge/intel/sandybridge folder. * Move "MultiProcessorInit" into soc/intel/icelake folder. * Reference new files Change-Id: I78c3ec0e8bcc342686277ae141a88d0486680978 Signed-off-by: Philipp Deppenwiese Signed-off-by: Patrick Rudolph Reviewed-on: https://review.coreboot.org/26262 Reviewed-by: Patrick Georgi Reviewed-by: Philipp Deppenwiese Tested-by: build bot (Jenkins) --- .../{ => getting_started}/build_system.md | 0 .../gerrit_guidelines.md | 0 Documentation/getting_started/index.md | 6 ++++ .../Kconfig.md => getting_started/kconfig.md} | 0 .../{ => getting_started}/submodules.md | 0 Documentation/index.md | 13 ++++----- Documentation/lessons/index.md | 4 +++ .../{Lesson1.md => lessons/lesson1.md} | 0 .../{Lesson2.md => lessons/lesson2.md} | 0 Documentation/mainboard/hp/compaq_8200_sff.md | 26 +++++++++--------- Documentation/northbridge/index.md | 7 +++++ Documentation/northbridge/intel/index.md | 7 +++++ .../northbridge/intel/sandybridge/index.md | 7 +++++ .../intel/sandybridge/nri.md} | 6 ++-- .../intel/sandybridge/nri_freq.md} | 0 .../intel/sandybridge/nri_read.md} | 0 .../intel/sandybridge/nri_registers.md} | 0 .../sandybridge}/timA_lane0-3_adjust_fine.png | Bin .../timA_lane0-3_discover_420x.png | Bin .../intel/sandybridge}/timA_lane0-3_rt53.png | Bin .../intel/sandybridge}/timA_lane0-3_rt54.png | Bin .../intel/sandybridge}/timA_lane0-3_rt55.png | Bin Documentation/soc/index.md | 7 +++++ .../intel/icelake}/MultiProcessorInit.md | 0 .../coreboot_publish_mp_service_api.png | Bin Documentation/soc/intel/icelake/index.md | 7 +++++ Documentation/soc/intel/index.md | 7 +++++ 27 files changed, 73 insertions(+), 24 deletions(-) rename Documentation/{ => getting_started}/build_system.md (100%) rename Documentation/{ => getting_started}/gerrit_guidelines.md (100%) create mode 100644 Documentation/getting_started/index.md rename Documentation/{core/Kconfig.md => getting_started/kconfig.md} (100%) rename Documentation/{ => getting_started}/submodules.md (100%) create mode 100644 Documentation/lessons/index.md rename Documentation/{Lesson1.md => lessons/lesson1.md} (100%) rename Documentation/{Lesson2.md => lessons/lesson2.md} (100%) create mode 100644 Documentation/northbridge/index.md create mode 100644 Documentation/northbridge/intel/index.md create mode 100644 Documentation/northbridge/intel/sandybridge/index.md rename Documentation/{Intel/NativeRaminit/Sandybridge.md => northbridge/intel/sandybridge/nri.md} (97%) rename Documentation/{Intel/NativeRaminit/Sandybridge_freq.md => northbridge/intel/sandybridge/nri_freq.md} (100%) rename Documentation/{Intel/NativeRaminit/Sandybridge_read.md => northbridge/intel/sandybridge/nri_read.md} (100%) rename Documentation/{Intel/NativeRaminit/SandyBridge_registers.md => northbridge/intel/sandybridge/nri_registers.md} (100%) rename Documentation/{Intel/NativeRaminit => northbridge/intel/sandybridge}/timA_lane0-3_adjust_fine.png (100%) rename Documentation/{Intel/NativeRaminit => northbridge/intel/sandybridge}/timA_lane0-3_discover_420x.png (100%) rename Documentation/{Intel/NativeRaminit => northbridge/intel/sandybridge}/timA_lane0-3_rt53.png (100%) rename Documentation/{Intel/NativeRaminit => northbridge/intel/sandybridge}/timA_lane0-3_rt54.png (100%) rename Documentation/{Intel/NativeRaminit => northbridge/intel/sandybridge}/timA_lane0-3_rt55.png (100%) create mode 100644 Documentation/soc/index.md rename Documentation/{Intel/MultiProcessorInit => soc/intel/icelake}/MultiProcessorInit.md (100%) rename Documentation/{Intel/MultiProcessorInit => soc/intel/icelake}/coreboot_publish_mp_service_api.png (100%) create mode 100644 Documentation/soc/intel/icelake/index.md create mode 100644 Documentation/soc/intel/index.md diff --git a/Documentation/build_system.md b/Documentation/getting_started/build_system.md similarity index 100% rename from Documentation/build_system.md rename to Documentation/getting_started/build_system.md diff --git a/Documentation/gerrit_guidelines.md b/Documentation/getting_started/gerrit_guidelines.md similarity index 100% rename from Documentation/gerrit_guidelines.md rename to Documentation/getting_started/gerrit_guidelines.md diff --git a/Documentation/getting_started/index.md b/Documentation/getting_started/index.md new file mode 100644 index 0000000000..b23e89d701 --- /dev/null +++ b/Documentation/getting_started/index.md @@ -0,0 +1,6 @@ +# Getting Started + +* [Build System](build_system.md) +* [Submodules](submodules.md) +* [Kconfig](kconfig.md) +* [Gerrit Guidelines](gerrit_guidelines.md) diff --git a/Documentation/core/Kconfig.md b/Documentation/getting_started/kconfig.md similarity index 100% rename from Documentation/core/Kconfig.md rename to Documentation/getting_started/kconfig.md diff --git a/Documentation/submodules.md b/Documentation/getting_started/submodules.md similarity index 100% rename from Documentation/submodules.md rename to Documentation/getting_started/submodules.md diff --git a/Documentation/index.md b/Documentation/index.md index a3cda52550..afe892da6a 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -1,5 +1,4 @@ -Welcome to coreboot's documentation! -==================================== +# Welcome to the coreboot documentation This is the developer documentation for [coreboot](https://coreboot.org). It is built from Markdown files in the @@ -8,16 +7,14 @@ directory in the source code. Contents: -* [Lesson 2: Submitting a patch to coreboot.org](Lesson2.md) -* [Gerrit Etiquette and Guidelines](gerrit_guidelines.md) -* [coreboot's build system](build_system.md) -* [Kconfig in coreboot](core/Kconfig.md) -* [Use of git submodules in coreboot](submodules.md) +* [Getting Started](getting_started/index.md) +* [Rookie Guide](lessons/index.md) * [Timestamps](timestamp.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) -* [Sandy Bridge Raminit](Intel/NativeRaminit/Sandybridge.md) +* [Northbridge-specific documentation](northbridge/index.md) +* [System on Chip-specific documentation](soc/index.md) * [Mainboard-specific documentation](mainboard/index.md) * [SuperIO-specific documentation](superio/index.md) diff --git a/Documentation/lessons/index.md b/Documentation/lessons/index.md new file mode 100644 index 0000000000..6540e8c4fa --- /dev/null +++ b/Documentation/lessons/index.md @@ -0,0 +1,4 @@ +# Rookie Guide + +* [Lesson 1: Starting from scratch](lesson1.md) +* [Lesson 2: Submitting a patch to coreboot.org](lesson2.md) diff --git a/Documentation/Lesson1.md b/Documentation/lessons/lesson1.md similarity index 100% rename from Documentation/Lesson1.md rename to Documentation/lessons/lesson1.md diff --git a/Documentation/Lesson2.md b/Documentation/lessons/lesson2.md similarity index 100% rename from Documentation/Lesson2.md rename to Documentation/lessons/lesson2.md diff --git a/Documentation/mainboard/hp/compaq_8200_sff.md b/Documentation/mainboard/hp/compaq_8200_sff.md index 9d6a0e7f50..3e83e25060 100644 --- a/Documentation/mainboard/hp/compaq_8200_sff.md +++ b/Documentation/mainboard/hp/compaq_8200_sff.md @@ -60,19 +60,19 @@ as otherwise there's not enough space near the flash. ## Technology ```eval_rst -+------------------+--------------------------------------+ -| Northbridge | Sandy Bridge | -+------------------+--------------------------------------+ -| Southbridge | bd82x6x | -+------------------+--------------------------------------+ -| CPU | model_206ax | -+------------------+--------------------------------------+ -| SuperIO | :doc:`../../superio/nuvoton/npcd378` | -+------------------+--------------------------------------+ -| EC | | -+------------------+--------------------------------------+ -| Coprocessor | Intel ME | -+------------------+--------------------------------------+ ++------------------+--------------------------------------------------+ +| Northbridge | :doc:`../../northbridge/intel/sandybridge/index` | ++------------------+--------------------------------------------------+ +| Southbridge | bd82x6x | ++------------------+--------------------------------------------------+ +| CPU | model_206ax | ++------------------+--------------------------------------------------+ +| SuperIO | :doc:`../../superio/nuvoton/npcd378` | ++------------------+--------------------------------------------------+ +| EC | | ++------------------+--------------------------------------------------+ +| Coprocessor | Intel ME | ++------------------+--------------------------------------------------+ ``` [Compaq 8200 Elite SFF]: https://support.hp.com/us-en/document/c03414707 diff --git a/Documentation/northbridge/index.md b/Documentation/northbridge/index.md new file mode 100644 index 0000000000..79700785af --- /dev/null +++ b/Documentation/northbridge/index.md @@ -0,0 +1,7 @@ +# Northbridge-specific documentation + +This section contains documentation about coreboot on specific northbridges. + +## Vendor + +- [Intel](intel/index.md) diff --git a/Documentation/northbridge/intel/index.md b/Documentation/northbridge/intel/index.md new file mode 100644 index 0000000000..6cca1daf7a --- /dev/null +++ b/Documentation/northbridge/intel/index.md @@ -0,0 +1,7 @@ +# Intel Northbridge-specific documentation + +This section contains documentation about coreboot on specific Intel Northbridges. + +## Platforms + +- [Sandy Bridge](sandybridge/index.md) diff --git a/Documentation/northbridge/intel/sandybridge/index.md b/Documentation/northbridge/intel/sandybridge/index.md new file mode 100644 index 0000000000..815abcefb5 --- /dev/null +++ b/Documentation/northbridge/intel/sandybridge/index.md @@ -0,0 +1,7 @@ +# Intel Sandy Bridge-specific documentation + +This section contains documentation about coreboot on specific Intel "Sandy Bridge" northbridge. + +## Topics + +- [Native Ram Initialization](nri.md) diff --git a/Documentation/Intel/NativeRaminit/Sandybridge.md b/Documentation/northbridge/intel/sandybridge/nri.md similarity index 97% rename from Documentation/Intel/NativeRaminit/Sandybridge.md rename to Documentation/northbridge/intel/sandybridge/nri.md index 5c83a0dad2..1b07ba48eb 100644 --- a/Documentation/Intel/NativeRaminit/Sandybridge.md +++ b/Documentation/northbridge/intel/sandybridge/nri.md @@ -41,13 +41,13 @@ The memory initialization code has to take care of lots of duties: ``` ## (Inoffical) register documentation -- [Sandy Bride - Register documentation](SandyBridge_registers.md) +- [Sandy Bride - Register documentation](nri_registers.md) ## Frequency selection -- [Sandy Bride - Frequency selection](Sandybridge_freq.md) +- [Sandy Bride - Frequency selection](nri_freq.md) ## Read training -- [Sandy Bride - Read training](Sandybridge_read.md) +- [Sandy Bride - Read training](nri_read.md) ### SMBIOS type 17 The SMBIOS specification allows to report the memory configuration in use. diff --git a/Documentation/Intel/NativeRaminit/Sandybridge_freq.md b/Documentation/northbridge/intel/sandybridge/nri_freq.md similarity index 100% rename from Documentation/Intel/NativeRaminit/Sandybridge_freq.md rename to Documentation/northbridge/intel/sandybridge/nri_freq.md diff --git a/Documentation/Intel/NativeRaminit/Sandybridge_read.md b/Documentation/northbridge/intel/sandybridge/nri_read.md similarity index 100% rename from Documentation/Intel/NativeRaminit/Sandybridge_read.md rename to Documentation/northbridge/intel/sandybridge/nri_read.md diff --git a/Documentation/Intel/NativeRaminit/SandyBridge_registers.md b/Documentation/northbridge/intel/sandybridge/nri_registers.md similarity index 100% rename from Documentation/Intel/NativeRaminit/SandyBridge_registers.md rename to Documentation/northbridge/intel/sandybridge/nri_registers.md diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_adjust_fine.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_adjust_fine.png similarity index 100% rename from Documentation/Intel/NativeRaminit/timA_lane0-3_adjust_fine.png rename to Documentation/northbridge/intel/sandybridge/timA_lane0-3_adjust_fine.png diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_discover_420x.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_discover_420x.png similarity index 100% rename from Documentation/Intel/NativeRaminit/timA_lane0-3_discover_420x.png rename to Documentation/northbridge/intel/sandybridge/timA_lane0-3_discover_420x.png diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt53.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt53.png similarity index 100% rename from Documentation/Intel/NativeRaminit/timA_lane0-3_rt53.png rename to Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt53.png diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt54.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt54.png similarity index 100% rename from Documentation/Intel/NativeRaminit/timA_lane0-3_rt54.png rename to Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt54.png diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt55.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt55.png similarity index 100% rename from Documentation/Intel/NativeRaminit/timA_lane0-3_rt55.png rename to Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt55.png diff --git a/Documentation/soc/index.md b/Documentation/soc/index.md new file mode 100644 index 0000000000..ca50dc85fb --- /dev/null +++ b/Documentation/soc/index.md @@ -0,0 +1,7 @@ +# SOC-specific documentation + +This section contains documentation about coreboot on specific SOCs. + +## Vendor + +- [Intel](intel/index.md) diff --git a/Documentation/Intel/MultiProcessorInit/MultiProcessorInit.md b/Documentation/soc/intel/icelake/MultiProcessorInit.md similarity index 100% rename from Documentation/Intel/MultiProcessorInit/MultiProcessorInit.md rename to Documentation/soc/intel/icelake/MultiProcessorInit.md diff --git a/Documentation/Intel/MultiProcessorInit/coreboot_publish_mp_service_api.png b/Documentation/soc/intel/icelake/coreboot_publish_mp_service_api.png similarity index 100% rename from Documentation/Intel/MultiProcessorInit/coreboot_publish_mp_service_api.png rename to Documentation/soc/intel/icelake/coreboot_publish_mp_service_api.png diff --git a/Documentation/soc/intel/icelake/index.md b/Documentation/soc/intel/icelake/index.md new file mode 100644 index 0000000000..b4f512ca05 --- /dev/null +++ b/Documentation/soc/intel/icelake/index.md @@ -0,0 +1,7 @@ +# Intel Ice Lake SOC-specific documentation + +This section contains documentation about coreboot on specific Intel "Ice Lake" SOCs. + +## Multiprocessor Init + +- [Multiprocessor Init](MultiProcessorInit.md) diff --git a/Documentation/soc/intel/index.md b/Documentation/soc/intel/index.md new file mode 100644 index 0000000000..5ac5125cfc --- /dev/null +++ b/Documentation/soc/intel/index.md @@ -0,0 +1,7 @@ +# Intel SOC-specific documentation + +This section contains documentation about coreboot on specific Intel SOCs. + +## Platforms + +- [Ice Lake/9th Gen Core-i series](icelake/index.md)