This repository contains the Transfer Entry definitions that are project-specific. This is an auxiliary document to theFirmware Handoff specification, which defines a data structure to transfer essential configuration information between firmware stages during platform initialization.
The documentation is generated using the Sphinx framework. A version of this specification, rendered in HTML, is available here.
For an Ubuntu development machine, install the following packages to build the specification:
librsvg2-binpython3-sphinxpython3-sphinxcontrib.svg2pdfconverterpython3-sphinx-rtd-themesphinx-multiversionlatexmktexlive-latex-extra
Note: This list has been tested on Ubuntu 22.04 LTS and 24.04 LTS running on AArch64 and AMD64.
The following are use to generate the specification:
- pdf:
make latexpdf- html:
make htmlThe output of these build commands goes into subdirectory build.