summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorPhilipp Deppenwiese <zaolin@das-labor.org>2018-05-13 15:47:18 +0200
committerPatrick Georgi <pgeorgi@google.com>2018-05-30 09:14:48 +0000
commit438b463a8f5f739eb02422a3d00b8dfcbeefc2e9 (patch)
treef281339a3f82297a8bb6df61f60331e9e5d45831 /Documentation
parente462585c9446cecb6f8cf06f62311c6ef18a4cbf (diff)
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 <zaolin@das-labor.org> Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com> Reviewed-on: https://review.coreboot.org/26262 Reviewed-by: Patrick Georgi <pgeorgi@google.com> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/getting_started/build_system.md (renamed from Documentation/build_system.md)0
-rw-r--r--Documentation/getting_started/gerrit_guidelines.md (renamed from Documentation/gerrit_guidelines.md)0
-rw-r--r--Documentation/getting_started/index.md6
-rw-r--r--Documentation/getting_started/kconfig.md (renamed from Documentation/core/Kconfig.md)0
-rw-r--r--Documentation/getting_started/submodules.md (renamed from Documentation/submodules.md)0
-rw-r--r--Documentation/index.md13
-rw-r--r--Documentation/lessons/index.md4
-rw-r--r--Documentation/lessons/lesson1.md (renamed from Documentation/Lesson1.md)0
-rw-r--r--Documentation/lessons/lesson2.md (renamed from Documentation/Lesson2.md)0
-rw-r--r--Documentation/mainboard/hp/compaq_8200_sff.md26
-rw-r--r--Documentation/northbridge/index.md7
-rw-r--r--Documentation/northbridge/intel/index.md7
-rw-r--r--Documentation/northbridge/intel/sandybridge/index.md7
-rw-r--r--Documentation/northbridge/intel/sandybridge/nri.md (renamed from Documentation/Intel/NativeRaminit/Sandybridge.md)6
-rw-r--r--Documentation/northbridge/intel/sandybridge/nri_freq.md (renamed from Documentation/Intel/NativeRaminit/Sandybridge_freq.md)0
-rw-r--r--Documentation/northbridge/intel/sandybridge/nri_read.md (renamed from Documentation/Intel/NativeRaminit/Sandybridge_read.md)0
-rw-r--r--Documentation/northbridge/intel/sandybridge/nri_registers.md (renamed from Documentation/Intel/NativeRaminit/SandyBridge_registers.md)0
-rw-r--r--Documentation/northbridge/intel/sandybridge/timA_lane0-3_adjust_fine.png (renamed from Documentation/Intel/NativeRaminit/timA_lane0-3_adjust_fine.png)bin92363 -> 92363 bytes
-rw-r--r--Documentation/northbridge/intel/sandybridge/timA_lane0-3_discover_420x.png (renamed from Documentation/Intel/NativeRaminit/timA_lane0-3_discover_420x.png)bin100726 -> 100726 bytes
-rw-r--r--Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt53.png (renamed from Documentation/Intel/NativeRaminit/timA_lane0-3_rt53.png)bin103600 -> 103600 bytes
-rw-r--r--Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt54.png (renamed from Documentation/Intel/NativeRaminit/timA_lane0-3_rt54.png)bin104571 -> 104571 bytes
-rw-r--r--Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt55.png (renamed from Documentation/Intel/NativeRaminit/timA_lane0-3_rt55.png)bin105582 -> 105582 bytes
-rw-r--r--Documentation/soc/index.md7
-rw-r--r--Documentation/soc/intel/icelake/MultiProcessorInit.md (renamed from Documentation/Intel/MultiProcessorInit/MultiProcessorInit.md)0
-rw-r--r--Documentation/soc/intel/icelake/coreboot_publish_mp_service_api.png (renamed from Documentation/Intel/MultiProcessorInit/coreboot_publish_mp_service_api.png)bin123328 -> 123328 bytes
-rw-r--r--Documentation/soc/intel/icelake/index.md7
-rw-r--r--Documentation/soc/intel/index.md7
27 files changed, 73 insertions, 24 deletions
diff --git a/Documentation/build_system.md b/Documentation/getting_started/build_system.md
index 787c833d2b..787c833d2b 100644
--- a/Documentation/build_system.md
+++ b/Documentation/getting_started/build_system.md
diff --git a/Documentation/gerrit_guidelines.md b/Documentation/getting_started/gerrit_guidelines.md
index cf7d5e8c5a..cf7d5e8c5a 100644
--- a/Documentation/gerrit_guidelines.md
+++ b/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
index 7b436ce80a..7b436ce80a 100644
--- a/Documentation/core/Kconfig.md
+++ b/Documentation/getting_started/kconfig.md
diff --git a/Documentation/submodules.md b/Documentation/getting_started/submodules.md
index 631e351303..631e351303 100644
--- a/Documentation/submodules.md
+++ b/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
index 0a10ba3723..0a10ba3723 100644
--- a/Documentation/Lesson1.md
+++ b/Documentation/lessons/lesson1.md
diff --git a/Documentation/Lesson2.md b/Documentation/lessons/lesson2.md
index ec929c8014..ec929c8014 100644
--- a/Documentation/Lesson2.md
+++ b/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
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
index d8b73b3aec..d8b73b3aec 100644
--- a/Documentation/Intel/NativeRaminit/Sandybridge_freq.md
+++ b/Documentation/northbridge/intel/sandybridge/nri_freq.md
diff --git a/Documentation/Intel/NativeRaminit/Sandybridge_read.md b/Documentation/northbridge/intel/sandybridge/nri_read.md
index 0496657b3f..0496657b3f 100644
--- a/Documentation/Intel/NativeRaminit/Sandybridge_read.md
+++ b/Documentation/northbridge/intel/sandybridge/nri_read.md
diff --git a/Documentation/Intel/NativeRaminit/SandyBridge_registers.md b/Documentation/northbridge/intel/sandybridge/nri_registers.md
index 601157c464..601157c464 100644
--- a/Documentation/Intel/NativeRaminit/SandyBridge_registers.md
+++ b/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
index d72e4c6d84..d72e4c6d84 100644
--- a/Documentation/Intel/NativeRaminit/timA_lane0-3_adjust_fine.png
+++ b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_adjust_fine.png
Binary files differ
diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_discover_420x.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_discover_420x.png
index 6f33217d1e..6f33217d1e 100644
--- a/Documentation/Intel/NativeRaminit/timA_lane0-3_discover_420x.png
+++ b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_discover_420x.png
Binary files differ
diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt53.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt53.png
index 191e792845..191e792845 100644
--- a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt53.png
+++ b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt53.png
Binary files differ
diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt54.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt54.png
index fa7f6089d0..fa7f6089d0 100644
--- a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt54.png
+++ b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt54.png
Binary files differ
diff --git a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt55.png b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt55.png
index 7f2fa397dd..7f2fa397dd 100644
--- a/Documentation/Intel/NativeRaminit/timA_lane0-3_rt55.png
+++ b/Documentation/northbridge/intel/sandybridge/timA_lane0-3_rt55.png
Binary files differ
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
index ab0b5135ed..ab0b5135ed 100644
--- a/Documentation/Intel/MultiProcessorInit/MultiProcessorInit.md
+++ b/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
index 5836140c53..5836140c53 100644
--- a/Documentation/Intel/MultiProcessorInit/coreboot_publish_mp_service_api.png
+++ b/Documentation/soc/intel/icelake/coreboot_publish_mp_service_api.png
Binary files differ
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)