mb/starlabs/starbook_mtl: Fix USB port assignments/descriptions
[coreboot.git] / Documentation / mainboard / topton / adl / x2f-n100.md
blobc386ad35a114403a815bc8d604a7a276c2d3a468
1 # Topton N100 (X2F)2 Firewall Appliance
3 This page describes how to run coreboot on the Topton N100.
5 ```{eval-rst}
6 +---------------+---------------------------------+----------------------+
7 | Binary file   | Apply                           | Required / Optional  |
8 +===============+=================================+======================+
9 | IFD           | Intel Flash Descriptor          | Required (see below) |
10 +---------------+---------------------------------+----------------------+
11 | ME            | Intel Management Engine         | Required (see below) |
12 +---------------+---------------------------------+----------------------+
13 | FSP-M & FSP-S | Intel Firmware Support Package  | Required             |
14 +---------------+---------------------------------+----------------------+
15 ```
17 ## Flashing coreboot
19 **WARNING:** There are multiple devices from the same vendor with
20 similar name, using different board layout, capabilities and EC/SuperIO.
22 Likewise, there are other vendors selling their devices with
23 the same mainboard. According to the sticker on the box: `H30W-N100-226`.
25 Please **DO NOT cross-flash firmware on "similar-looking" device**.
26 Doing so **may kill your device**. You have been warned :)
28 ### Internally
30 Vendor of this motherboard hasn't locked any flash regions, resulting
31 in [flashprog] having full access to the SPI chip.
32 Assuming that user had booted Linux with `iomem=relaxed`, they can:
33 - Flash coreboot from stock firmware
34 - Flash stock firmware from coreboot
35 - Update coreboot build to a newer version
37         Without opening the case and connecting the SPI flasher.
39 Please note that for AlderLake-N platform you will need to use
40 [flashprog] v1.3.0 or newer.
42 [flashrom] is broken due to regressions, which results in
43 failed flashes, bricking the device.
45 [flashprog] is a better maintained fork of [flashrom], which
46 works flawlessly.
48 You can skip extracting `SI_BIOS` and `SI_ME` regions from your ROM
49 and flash coreboot to `SI_BIOS` region by issuing the following command:
50 `flashprog -p internal --ifd -i SI_BIOS -w ./build/coreboot.rom`
52 ### Externally
54 SPI chip on this mainboard is located near the SoC, on the other side
55 of the board (upper-right corner).
56 Please note that SPI voltage on this board is standard 3.3V, despite
57 using mobile SoC.
58 Vendor populated this board with Winbond W25Q128JV chip in SOIC-8 package.
60 ## Functionality
62 ### Tested and working
64 - All USB ports (including mPCIe)
65 - All NICs (4x Intel I226-V 2.5GbE)
66 - All display outputs (HDMI, DisplayPort)
67 - M.2 NVME (PCIe x2 electrically)
68 - mPCIe WiFi
69 - SATA port
70 - Intel PTT (fTPM 2.0)
71 - PC Speaker (goes beep-boop)
72 - Serial console on the front of the device (RS232 in RJ45 form-factor),
73 "Cisco-style"
74 - PCIe passtrough (NICs to VMs, such as OpenWrt using libvirt)
76 - Payload: EDK2, LinuxBoot
77 - OS: Alpine Linux, Windows 11
79 ### Untested, broken
81 - 5G modem on special M.2-like connector (lack hardware for it).
82 - Suspend in Windows 11
83 (might work, but Windows has been tested from USB drive).
85 ## Specification
86 ```{eval-rst}
87 +--------+-------------------------------+
88 | SoC    | Intel AlderLake N100 (IoT)    |
89 +--------+-------------------------------+
90 | Memory | DDR5 SO-DIMM (single-channel) |
91 +--------+-------------------------------+
92 | EC     | ITE IT8625E                   |
93 +--------+-------------------------------+
94 | SPI    | Winbond W25Q128 (16MiB 3.3V)  |
95 +--------+-------------------------------+
96 | NIC    | 4x Intel I226-V (2.5GbE)      |
97 +--------+-------------------------------+
98 ```
100 [flashprog]: https://flashprog.org/wiki/Flashprog
101 [flashrom]: https://flashrom.org/Flashrom