erebion/coreboot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc/rmodules.md: Change header levels

Browse source 
Increase the header levels of headers following the initial "Relocatable
Modules (rmodules)" so that there is only one title for the page with
the other headings as subheadings. Also fix header capitalization while
we're here.

Change-Id: I72ae99ba10bf5b2386da2cc702efaf25328d6811
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/84239
Reviewed-by: Nico Huber <nico.h@gmx.de>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
Nicholas Chin 2024-09-06 21:54:08 -06:00 • committed by Nico Huber
commit 26f5b5f3d0
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Documentation/rmodules.md
View file

@ -15,9 +15,9 @@ done by fixing up all relocation entries in the relocatable module
based on the location of the binary (which was returned by CBMEM
at runtime).
# Implementation Details
## Implementation Details
## build time
### Build Time
At build time the rmodtool (util/cbfstool/rmodtool.c) is used to
create relocatable modules. The rmodtool basically takes an ELF
@ -44,7 +44,7 @@ which are all created by the rmodtool.
2. program (.program)
3. relocation entries (.relocs)
## runtime
### Runtime
Either rmodule\_load (lib/rmodule.c) is used directly or through the
rmodule\_stage\_load (lib/rmodule.c) wrapper. It is used to load the
@ -59,7 +59,7 @@ address pointing to a location that needs relocation. The relocation
itself is just a simple addition, that adds an offset from where the
image was "supposed" to be at link time, to where it is now relocated.
## module\_parameters
### module\_parameters
module\_parameters is a section inside the rmodule ELF file. Its
basically a way to pass runtime information to an rmodule
@ -73,7 +73,7 @@ volatile __attribute((aligned(4), __section__(".module_parameters")))
struct smm_runtime smm_runtime;
```
# x86 why rmodules
## x86 why rmodules
//TODO
x86: postcar and ramstage cannot conflict with payload regarding
memory placement. Therefore payload location is usually fixed and