35599f9a66
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>
4.3 KiB
4.3 KiB
OCP Tioga Pass
This page describes coreboot support status for the OCP (Open Compute Project) Tioga Pass server platform.
Introduction
OCP Tioga Pass server platform was contributed by Facebook, and was accepted in 2019. The design collateral including datasheet can be found at OCP Tioga Pass.
Since complete EE design collateral is open sourced, anyone can build server as-is or a variant based on the original design. It can also be purchased from OCP Market Place. An off-the-shelf version is available, as well as rack ready version. With the off-the-shelf version, the server can be plugged into wall power outlet.
With the off-the-shelf version of Tioga Pass, a complete software solution is available. Off-the-shelf Host Firmware takes the approach of UEFI/Linuxboot.
coreboot as of release 4.13 is a proof-of-concept project between Facebook, Intel, Wiwynn and Quanta. The context is described at OCP Tioga Pass POC Blog.
Required blobs
This board currently requires:
- FSP blob: The blob (Intel Skylake Scalable Processor Firmware Support Package) is not yet available to the public. The binary is at POC status, hopefully someday an IBV is able to obtain the privilege to maintain it.
- Microcode:
3rdparty/intel-microcode/intel-ucode/06-55-04 - ME binary: The binary can be extracted from Off-the-shelf Host Firmware.
Payload
- Linuxboot: This is necessary only if you use Linuxboot as coreboot payload. U-root as initramfs, is used in the POC activity. It can be extracted from Off-the-shelf Host Firmware, or it can be built following All about u-root.
Flashing coreboot
To do in-band FW image update, use flashrom:
flashrom -p internal:ich_spi_mode=hwseq -c "Opaque flash chip" --ifd
-i bios --noverify-all -w
From OpenBMC, to update FW image: fw-util mb --force --update
To power off/on the host: power-util mb off power-util mb on
To connect to console through SOL (Serial Over Lan): sol-util mb
Known issues / feature gaps
- C6 state is not supported. Workaround is to disable C6 support through target OS and Linuxboot kernel parameter, such as "cpuidle.off=1".
- SMI handlers are not implemented.
- xSDT tables are not fully populated, such as processor/socket devices, PCIe bridge devices.
- There is boot stability issue. Occasionally the boot hangs at ramstage with following message "BIOS PCU Misc Config Read timed out."
- If CB 40500 patchset is not merged, when PCIe riser card is used, boot fails.
- PCIe devices connected to socket 1 may not work, because FSP does not support PCIe topology input for socket 1.k
- SMBIOS type 7 and type 17 are not populated.
Working
The solution was developed using Linuxboot payload. The Linuxboot kernel versions tried are 4.16.18 and 5.2.9. The initramfs image is u-root.
- Most SMBIOS types
- BMC integration:
- BMC readiness check
- IPMI commands
- watchdog timer
- POST complete pin acknowledgement
- SEL record generation
- Early serial output
- port 80h direct to GPIO
- ACPI tables: APIC/DMAR/DSDT/FACP/FACS/HPET/MCFG/SPMI/SRAT/SLIT/SSDT
Technology
+------------------------+---------------------------------------------+
| Processor (2 sockets) | Intel Skylake Scalable Processor LGA3647 |
+------------------------+---------------------------------------------+
| BMC | Aspeed AST 2500 |
+------------------------+---------------------------------------------+
| PCH | Intel Lewisburg C621 |
+------------------------+---------------------------------------------+