Files

Nicholas Chin 35599f9a66 Docs: Replace Recommonmark with MyST Parser

Recommonmark has been deprecated since 2021 [1] and the last release was
over 3 years ago [2]. As per their announcement, Markedly Structured
Text (MyST) Parser [3] is the recommended replacement.

For the most part, the existing documentation is compatible with MyST,
as both parsers are built around the CommonMark flavor of Markdown. The
main difference that affects coreboot is how the Sphinx toctree is
generated. Recommonmark has a feature called auto_toc_tree, which
converts single level lists of references into a toctree:

* [Part 1: Starting from scratch](part1.md)
* [Part 2: Submitting a patch to coreboot.org](part2.md)
* [Part 3: Writing unit tests](part3.md)
* [Managing local additions](managing_local_additions.md)
* [Flashing firmware](flashing_firmware/index.md)

MyST Parser does not provide a replacement for this feature, meaning the
toctree must be defined manually. This is done using MyST's syntax for
Sphinx directives:

```{toctree}
:maxdepth: 1

Part 1: Starting from scratch <part1.md>
Part 2: Submitting a patch to coreboot.org <part2.md>
Part 3: Writing unit tests <part3.md>
Managing local additions <managing_local_additions.md>
Flashing firmware <flashing_firmware/index.md>
```

Internally, auto_toc_tree essentially converts lists of references into
the Sphinx toctree structure that the MyST syntax above more directly
represents.

The toctrees were converted to the MyST syntax using the following
command and Python script:

`find ./ -iname "*.md" | xargs -n 1 python conv_toctree.py`

```
import re
import sys

in_list = False
f = open(sys.argv[1])
lines = f.readlines()
f.close()

with open(sys.argv[1], "w") as f:
    for line in lines:
        match = re.match(r"^[-*+] \[(.*)\]\((.*)\)$", line)
        if match is not None:
            if not in_list:
                in_list = True
                f.write("```{toctree}\n")
                f.write(":maxdepth: 1\n\n")
            f.write(match.group(1) + " <" + match.group(2) + ">\n")
        else:
            if in_list:
                f.write("```\n")
            f.write(line)
            in_list = False

    if in_list:
        f.write("```\n")
```

While this does add a little more work for creating the toctree, this
does give more control over exactly what goes into the toctree. For
instance, lists of links to external resources currently end up in the
toctree, but we may want to limit it to pages within coreboot.

This change does break rendering and navigation of the documentation in
applications that can render Markdown, such as Okular, Gitiles, or the
GitHub mirror. Assuming the docs are mainly intended to be viewed after
being rendered to doc.coreboot.org, this is probably not an issue in
practice.

Another difference is that MyST natively supports Markdown tables,
whereas with Recommonmark, tables had to be written in embedded rST [4].
However, MyST also supports embedded rST, so the existing tables can be
easily converted as the syntax is nearly identical.

These were converted using
`find ./ -iname "*.md" | xargs -n 1 sed -i "s/eval_rst/{eval-rst}/"`

Makefile.sphinx and conf.py were regenerated from scratch by running
`sphinx-quickstart` using the updated version of Sphinx, which removes a
lot of old commented out boilerplate. Any relevant changes coreboot had
made on top of the previous autogenerated versions of these files were
ported over to the newly generated file.

From some initial testing the generated webpages appear and function
identically to the existing documentation built with Recommonmark.

TEST: `make -C util/docker docker-build-docs` builds the documentation
successfully and the generated output renders properly when viewed in
a web browser.

[1] https://github.com/readthedocs/recommonmark/issues/221
[2] https://pypi.org/project/recommonmark/
[3] https://myst-parser.readthedocs.io/en/latest/
[4] https://doc.coreboot.org/getting_started/writing_documentation.html

Change-Id: I0837c1722fa56d25c9441ea218e943d8f3d9b804
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/73158
Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

2024-03-21 16:11:56 +00:00

3.3 KiB

Raw Blame History

Kontron mAL10 Computer-on-Modules platform

The Kontron mAL10 COMe is a credit card sized Computer-on-Modules platform based on the Intel Atom E3900 Series, Pentium and Celeron processors.

Technology

+------------------+----------------------------------+
| COMe Type        | mini pin-out type 10             |
+------------------+----------------------------------+
| SoC              | Intel Atom x5-E3940 (4 core)     |
+------------------+----------------------------------+
| GPU              | Intel HD Graphics 500            |
+------------------+----------------------------------+
| Coprocessor      | Intel TXE 3.0                    |
+------------------+----------------------------------+
| RAM              | 8GB DDR3L                        |
+------------------+----------------------------------+
| eMMC Flash       | 32GB eMMC pSLC                   |
+------------------+----------------------------------+
| USB3             | x2                               |
+------------------+----------------------------------+
| USB2             | x6                               |
+------------------+----------------------------------+
| SATA             | x2                               |
+------------------+----------------------------------+
| LAN              | Intel I210IT, I211AT             |
+------------------+----------------------------------+
| Super IO/EC      | Kontron CPLD/EC                  |
+------------------+----------------------------------+
| HWM              | NCT7802                          |
+------------------+----------------------------------+

Building coreboot

The following commands will build a working image:

make distclean
make defconfig KBUILD_DEFCONFIG=configs/config.kontron_mal10
make

Payloads

SeaBIOS
edk2
Linux as payload

Flashing coreboot

The SPI flash can be accessed internally using flashrom. The following command is used to flash BIOS region.

$ flashrom -p internal --ifd -i bios -w coreboot.rom --noverify-all

Hardware Monitor

The Nuvoton NCT7802Y is a hardware monitoring IC, capable of monitor critical system parameters including power supply voltages, fan speeds, and temperatures. The remote inputs can be connected to CPU/GPU thermal diode or any thermal diode sensors and thermistor.

6 temperature sensors;
5 voltage sensors;
3 fan speed sensors;
4 sets of temperature setting points.

PECI is not supported by Apollo Lake Pentium/Celeron/Atom processors and the CPU temperature value is taken from a thermal resistor (NTC) that is placed very close to the CPU.

Untested

IGD/LVDS
SDIO

Tested and working

Kontron CPLD/EC (Serial ports, I2C port, GPIOs)
NCT7802 [HWM](#Hardware Monitor)
USB2/3
Gigabit Ethernet ports
eMMC
SATA
PCIe ports
IGD/DP

TODO

Onboard audio (codec IDT 92HD73C1X5, currently disabled)
S3 suspend/resume

3.3 KiB Raw Blame History