Documentation/mainboard/protectli/fw6.md

   1 # Protectli Vault FW6 series
   2
   3 This page describes how to run coreboot on the [Protectli FW6].
   4
   5 ![](fw6.jpg)
   6
   7 ## Required proprietary blobs
   8
   9 To build a minimal working coreboot image some blobs are required (assuming
  10 only the BIOS region is being modified).
  11
  12 ```eval_rst
  13 +-----------------+---------------------------------+---------------------+
  14 | Binary file     | Apply                           | Required / Optional |
  15 +=================+=================================+=====================+
  16 | FSP-M, FSP-S    | Intel Firmware Support Package  | Required            |
  17 +-----------------+---------------------------------+---------------------+
  18 | microcode       | CPU microcode                   | Required            |
  19 +-----------------+---------------------------------+---------------------+
  20 | vgabios         | VGA Option ROM                  | Optional            |
  21 +-----------------+---------------------------------+---------------------+
  22 ```
  23
  24 FSP-M and FSP-S are obtained after splitting the Kaby Lake FSP binary (done
  25 automatically by the coreboot build system and included into the image) from
  26 the `3rdparty/fsp` submodule.
  27
  28 Microcode updates are automatically included into the coreboot image by build
  29 system from the `3rdparty/intel-microcode` submodule.
  30
  31 VGA Option ROM is not required to boot, but if one needs graphics in pre-OS
  32 stage, it should be included (if not using libgfxinit).
  33
  34 ## Flashing coreboot
  35
  36 ### Internal programming
  37
  38 The main SPI flash can be accessed using [flashrom]. The first version
  39 supporting the chipset is flashrom v1.1. Firmware an be easily flashed
  40 with internal programmer (either BIOS region or full image).
  41
  42 ### External programming
  43
  44 The system has an internal flash chip which is a 8 MiB soldered SOIC-8 chip.
  45 This chip is located on the bottom side of the case (the radiator side). One
  46 has to remove all screws (in order): 4 top cover screws, 4 side cover screws
  47 (one side is enough), 4 mainboard screws, 4 CPU screws (under DIMMs). Lift up
  48 the mainboard and turn around it. The flash chip is near the SoC on the DIMM
  49 slots side. Use a clip (or solder the wires) to program the chip. Specifically,
  50 it's a Macronix MX25L6406E (3.3V) -[datasheet][MX25L6406E].
  51
  52 ## Known issues
  53
  54 - After flashing with external programmer it is always required to reset RTC
  55   with jumper or disconnect coin cell temporarily. Only then the platform will
  56   boot after flashing.
  57 - FW6A does not always work reliably with all DIMMs. Linux happens to hang or
  58   gives many panics. This issue was present also with vendor BIOS.
  59 - Sometimes FSPMemoryInit return errors or hangs (especially with 2 DIMMs
  60   connected). A workaround is to power cycle the board (even a few times) or
  61   temporarily disconnect DIMM when platform is powered off.
  62 - When using libgfxinit and SeaBIOS bootsplash, the red color is dim
  63
  64 ## Untested
  65
  66 Not all mainboard's peripherals and functions were tested because of lack of
  67 the cables or not being populated on the board case.
  68
  69 - Internal USB 2.0 headers
  70 - Boot with cleaned ME
  71
  72 ## Working
  73
  74 - USB 3.0 front ports (SeaBIOS and Linux)
  75 - 6 Ethernet ports
  76 - HDMI port with libgfxinit and VGA Option ROM
  77 - flashrom
  78 - PCIe WiFi
  79 - SATA and mSATA
  80 - Super I/O serial port 0 (RS232 via front RJ45 connector)
  81 - SMBus (reading SPD from DIMMs)
  82 - Initialization with KBL FSP 2.0 (with MemoryInit issues)
  83 - SeaBIOS payload (version rel-1.12.1)
  84 - Mini PCIe debug card connected to mSATA (mSATA slot has LPC signals routed)
  85 - Reset switch
  86 - Booting Debian, Ubuntu, FreeBSD
  87
  88 ## Technology
  89
  90 There are 3 variants of FW6 boards: FW6A, FW6B and FW6C. They differ only in
  91 used SoC.
  92
  93 - FW6A:
  94
  95 ```eval_rst
  96 +------------------+--------------------------------------------------+
  97 | CPU              | Intel Celeron 3865U                              |
  98 +------------------+--------------------------------------------------+
  99 | PCH              | Kaby Lake U w/ iHDCP2.2 Base                     |
 100 +------------------+--------------------------------------------------+
 101 | Super I/O, EC    | ITE IT8772E                                      |
 102 +------------------+--------------------------------------------------+
 103 | Coprocessor      | Intel Management Engine                          |
 104 +------------------+--------------------------------------------------+
 105 ```
 106
 107 - FW6B:
 108
 109 ```eval_rst
 110 +------------------+--------------------------------------------------+
 111 | CPU              | Intel Core i3-7100U                              |
 112 +------------------+--------------------------------------------------+
 113 | PCH              | Kaby Lake U w/ iHDCP2.2 Premium                  |
 114 +------------------+--------------------------------------------------+
 115 | Super I/O, EC    | ITE IT8772E                                      |
 116 +------------------+--------------------------------------------------+
 117 | Coprocessor      | Intel Management Engine                          |
 118 +------------------+--------------------------------------------------+
 119 ```
 120
 121 - FW6C:
 122
 123 ```eval_rst
 124 +------------------+--------------------------------------------------+
 125 | CPU              | Intel Core i5-7200U                              |
 126 +------------------+--------------------------------------------------+
 127 | PCH              | Kaby Lake U w/ iHDCP2.2 Premium                  |
 128 +------------------+--------------------------------------------------+
 129 | Super I/O, EC    | ITE IT8772E                                      |
 130 +------------------+--------------------------------------------------+
 131 | Coprocessor      | Intel Management Engine                          |
 132 +------------------+--------------------------------------------------+
 133 ```
 134
 135 [Protectli FW6]: https://protectli.com/vault-6-port/
 136 [MX25L6406E]: https://www.macronix.com/Lists/Datasheet/Attachments/7370/MX25L6406E,%203V,%2064Mb,%20v1.9.pdf
 137 [flashrom]: https://flashrom.org/Flashrom