Matt DeVillier has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/51550 )
Change subject: documentation: Add documentation for Purism Librem 14 ......................................................................
documentation: Add documentation for Purism Librem 14
Change-Id: Ic68a3d17534f78dae8c432253982e8d10a6427f0 Signed-off-by: Matt DeVillier matt.devillier@puri.sm --- A Documentation/mainboard/purism/librem_14.jpg A Documentation/mainboard/purism/librem_14.md A Documentation/mainboard/purism/librem_14_ec_flash.jpg A Documentation/mainboard/purism/librem_14_flash.jpg 4 files changed, 109 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/50/51550/1
diff --git a/Documentation/mainboard/purism/librem_14.jpg b/Documentation/mainboard/purism/librem_14.jpg new file mode 100644 index 0000000..5e86758 --- /dev/null +++ b/Documentation/mainboard/purism/librem_14.jpg Binary files differ diff --git a/Documentation/mainboard/purism/librem_14.md b/Documentation/mainboard/purism/librem_14.md new file mode 100644 index 0000000..b51421f --- /dev/null +++ b/Documentation/mainboard/purism/librem_14.md @@ -0,0 +1,109 @@ +# Purism Librem 14 + +This page describes how to run coreboot on the [Purism Librem 14]. + +```eval_rst ++------------------+--------------------------------------------------+ +| CPU | Intel Core i7-10710U | ++------------------+--------------------------------------------------+ +| PCH | Comet Lake LP Premium (Comet Lake-U) | ++------------------+--------------------------------------------------+ +| EC | ITE IT8528E | ++------------------+--------------------------------------------------+ +| Coprocessor | Intel Management Engine (CSME 14.x) | ++------------------+--------------------------------------------------+ +``` + + + + + +## Required proprietary blobs + +To build a minimal working coreboot image some blobs are required (assuming +only the BIOS region is being modified). + +```eval_rst ++-----------------+---------------------------------+---------------------+ +| Binary file | Apply | Required / Optional | ++=================+=================================+=====================+ +| FSP-M, FSP-S | Intel Firmware Support Package | Required | ++-----------------+---------------------------------+---------------------+ +| microcode | CPU microcode | Required | ++-----------------+---------------------------------+---------------------+ +``` + +FSP-M and FSP-S are obtained after splitting the CometLake1 FSP binary +(done automatically by the coreboot build system and included into the image) +from the `3rdparty/fsp` submodule. + +Microcode updates are automatically included into the coreboot image by the build +system from the `3rdparty/intel-microcode` submodule. Official Purism release +images may include newer microcode, which is instead pulled from Purism's +[purism-blobs] repository. + +A VGA Option ROM is not required to boot, as the Librem 14 uses libgfxinit. + +## Intel Management Engine + +The Librem 14 uses version 14.x of the Intel Management Engine (ME) / +Converged Security Engine (CSE). The ME/CSE is disabled using the High +Assurance Platform (HAP) bit, which puts the ME into a disabled state after +platform bring-up (BUP) and disables all PCI/HECI interfaces. +This can be verified via the coreboot cbmem utility: + + `sudo ./cbmem -1 | grep 'ME:'` + +provided coreboot has been modified to output the ME status even when +the PCI device is not visible/active (as it is in Purism's release builds). + +## Flashing coreboot + +### Internal programming + +The main SPI flash can be accessed using [flashrom]. No official flashrom +release supports the CometLake-U SoC yet, so it must be built from source. +Version v1.2-107-gb1f858f or later is needed. Firmware an be easily +flashed with internal programmer (either BIOS region or full image). + +### External programming + +The system has an internal flash chip which is a 16 MiB soldered SOIC-8 chip, +and has a diode attached to the VCC line for in-system programming. +This chip is located on the bottom side of the board, in between the CPU +heatsink and the left cooling fan, just above the left sodimm socket. + +One has to remove all 9 screws from the bottom cover, then disconnect the +battery from the mainboard (bottom left of mainboard). Use a SOIC-8 chip clip +to program the chip (a Gigadevice GD25Q127C (3.3V) - [datasheet][GD25Q127C]). + +The EC firmware is stored on a separate SOIC-8 chip (a Gigadevices GD25Q80C), +located underneath the Wi-Fi module, below the left cooling fan. + +## Known issues + + * Automatic detection of external audio input/output via the 3.5mm jack. + +## Working + + * Internal display with libgfxinit, VGA option ROM, or FSP/GOP init + * External displays via HDMI, USB-C Alt-Mode + * SeaBIOS (1.14), Tianocore (CorebootPayloadPkg), Heads (Purism downstream) payloads + * Ethernet, m.2 2230 Wi-Fi + * System firmware updates via flashrom + * m.2 storage (NVMe, SATA III) + * Built-in audio (speakers, microphone) + * SMBus (reading SPD from DIMMs) + * Initialization with FSP 2.0 (CometLake1) + * S3 Suspend/Resume + * Booting PureOS 10.x, Debian 11.x, Qubes 4.0.4, Linux Mint 20.1, Windows 10 20H2 + +## Not working / untested + + * N/A + + +[Purism Librem 14]: https://puri.sm/products/librem-14/ +[purism-blobs]: https://source.puri.sm/coreboot/purism-blobs +[GD25Q127C]: https://www.gigadevice.com/datasheet/gd25q127c/ +[flashrom]: https://flashrom.org/Flashrom diff --git a/Documentation/mainboard/purism/librem_14_ec_flash.jpg b/Documentation/mainboard/purism/librem_14_ec_flash.jpg new file mode 100644 index 0000000..a8a2246 --- /dev/null +++ b/Documentation/mainboard/purism/librem_14_ec_flash.jpg Binary files differ diff --git a/Documentation/mainboard/purism/librem_14_flash.jpg b/Documentation/mainboard/purism/librem_14_flash.jpg new file mode 100644 index 0000000..2015fa7 --- /dev/null +++ b/Documentation/mainboard/purism/librem_14_flash.jpg Binary files differ