summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNathaniel Graff <nathaniel.graff@sifive.com>2019-05-02 20:04:34 +0000
committerGitHub <noreply@github.com>2019-05-02 20:04:34 +0000
commit139149a670354a74cb2a5693c270bb24ea39dc05 (patch)
tree01ff5eda110417a43bcbff9c6b76fb62a6a5191d /doc
parentb178ea51465fdaf68e848dc8f55be03bd140013a (diff)
parentb555941a3d06c31e03ecf51eef608c7356bdb3b9 (diff)
Merge pull request #239 from sifive/bare-header
Update to use metal-platform.h (bare header)
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/contents.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/sphinx/contents.rst b/doc/sphinx/contents.rst
index d0d7cc5..cad7f78 100644
--- a/doc/sphinx/contents.rst
+++ b/doc/sphinx/contents.rst
@@ -64,9 +64,16 @@ and consist of the following:
- The Freedom Metal machine header which is used internally to Freedom Metal
to instantiate structures to support the target device.
-* ``metal.lds``
+* ``metal-platform.h``
- - The linker script for the target device.
+ - The Freedom Metal platform header which is used internally to Freedom Metal
+ as the source for each device's memory-mapped base address, memory-mapped
+ size, properties, and memory-mapped register offsets.
+
+* ``metal.%.lds``
+
+ - Linker scripts for the target device. Scripts other than ``metal.default.lds``
+ are used for alternative memory layouts.
* ``openocd.cfg`` (for development board and FPGA targets)
@@ -74,7 +81,8 @@ and consist of the following:
* ``settings.mk``
- - Used to set ``-march`` and ``-mabi`` arguments to the RISC-V GNU Toolchain.
+ - Used to set ``-march`` and ``-mabi`` arguments to the RISC-V GNU Toolchain
+ as well as configure target-specific build steps.
Freedom Metal
-------------