Documentation/mainboard/protectli/vp46xx.md

   1 # Protectli Vault VP46xx series
   2
   3 This page describes how to run coreboot on the [Protectli VP46xx].
   4
   5 ![](vp46xx_front.jpg)
   6 ![](vp46xx_back.jpg)
   7
   8 ## Required proprietary blobs
   9
  10 To build a minimal working coreboot image some blobs are required (assuming
  11 only the BIOS region is being modified).
  12
  13 ```{eval-rst}
  14 +-----------------+---------------------------------+---------------------+
  15 | Binary file     | Apply                           | Required / Optional |
  16 +=================+=================================+=====================+
  17 | FSP-M, FSP-S    | Intel Firmware Support Package  | Required            |
  18 +-----------------+---------------------------------+---------------------+
  19 | microcode       | CPU microcode                   | Required            |
  20 +-----------------+---------------------------------+---------------------+
  21 ```
  22
  23 FSP-M and FSP-S are obtained after splitting the Comet Lake FSP binary (done
  24 automatically by the coreboot build system and included into the image) from
  25 the `3rdparty/fsp` submodule. VP4630 and VP4650 use CometLake2 FSP and VP4670
  26 use CometLake1 FSP (see [variants](#variants) section), so be sure to select
  27 the correct board in the coreboot's menuconfig, otherwise the platform will not
  28 succeed on memory initialization.
  29
  30 Microcode updates are automatically included into the coreboot image by build
  31 system from the `3rdparty/intel-microcode` submodule.
  32
  33 ## Flashing coreboot
  34
  35 ### Internal programming
  36
  37 The main SPI flash can be accessed using [flashrom]. The first version
  38 supporting the chipset is flashrom v1.2. Firmware an be easily flashed
  39 with internal programmer (either BIOS region or full image).
  40
  41 ### External programming
  42
  43 The system has an internal flash chip which is a 16 MiB socketed SOIC-8 chip.
  44 This chip is located on the top side of the case (the lid side). One has to
  45 remove 4 top cover screws and lift up the lid. The flash chip is near the M.2
  46 WiFi slot connector. Remove the chip from socket and use a clip to program the
  47 chip. Specifically, it's a KH25L12835F (3.3V) which is a clone of Macronix
  48 MX25L12835F - [datasheet][MX25L12835F].
  49
  50 ![](vp46xx_flash.jpg)
  51
  52 ## Known issues
  53
  54 - After flashing with external programmer it is always required to reset RTC
  55   with a jumper or disconnect the coin cell temporarily. Only then the platform
  56   will boot after flashing.
  57
  58 ## Working
  59
  60 - USB 3.0 front ports (SeaBIOS, Tianocore UEFIPayload and Linux)
  61 - 6 Ethernet ports
  62 - HDMI, DisplayPort and USB-C Display Port with libgfxinit and FSP GOP
  63 - flashrom
  64 - M.2 WiFi
  65 - M.2 4G LTE
  66 - M.2 SATA and NVMe
  67 - 2.5'' SATA SSD
  68 - eMMC
  69 - Super I/O serial port 0 via front microUSB connector (Fintek F81232 USB to
  70   UART adapter present on board)
  71 - SMBus (reading SPD from DIMMs)
  72 - Initialization with CometLake FSP 2.0
  73 - SeaBIOS payload (version rel-1.16.0)
  74 - TianoCore UEFIPayload
  75 - LPC TPM module (using Protectli custom-designed module with Infineon SLB9660)
  76 - Reset switch
  77 - Booting Debian, Ubuntu, FreeBSD
  78
  79 ## Variants
  80
  81 There are 3 variants of VP46xx boards: VP4630, VP4650 and VP4670. They differ
  82 only in used SoC and some units may come with different Super I/O chips, either
  83 ITE IT8786E or IT8784E, but the configuration is the same on this platform.
  84
  85 - VP4630:
  86
  87 ```{eval-rst}
  88 +------------------+--------------------------------------------------+
  89 | CPU              | Intel Core i3-10110U                             |
  90 +------------------+--------------------------------------------------+
  91 | PCH              | Intel Comet Lake U Premium                       |
  92 +------------------+--------------------------------------------------+
  93 | Super I/O, EC    | ITE IT8786E/IT8784E                              |
  94 +------------------+--------------------------------------------------+
  95 | Coprocessor      | Intel Management Engine                          |
  96 +------------------+--------------------------------------------------+
  97 ```
  98
  99 - VP4650:
 100
 101 ```{eval-rst}
 102 +------------------+--------------------------------------------------+
 103 | CPU              | Intel Core i5-10210U                             |
 104 +------------------+--------------------------------------------------+
 105 | PCH              | Intel Comet Lake U Premium                       |
 106 +------------------+--------------------------------------------------+
 107 | Super I/O, EC    | ITE IT8786E/IT8784E                              |
 108 +------------------+--------------------------------------------------+
 109 | Coprocessor      | Intel Management Engine                          |
 110 +------------------+--------------------------------------------------+
 111 ```
 112
 113 - VP4670:
 114
 115 ```{eval-rst}
 116 +------------------+--------------------------------------------------+
 117 | CPU              | Intel Core i7-10810U                             |
 118 +------------------+--------------------------------------------------+
 119 | PCH              | Intel Comet Lake U Premium                       |
 120 +------------------+--------------------------------------------------+
 121 | Super I/O, EC    | ITE IT8786E/IT8784E                              |
 122 +------------------+--------------------------------------------------+
 123 | Coprocessor      | Intel Management Engine                          |
 124 +------------------+--------------------------------------------------+
 125 ```
 126
 127 ## Useful links
 128
 129 - [VP4600 Hardware Overview](https://protectli.com/kb/vp4600-hardware-overview/)
 130 - [VP4630 Product Page](https://protectli.com/product/vp4630/)
 131 - [Protectli TPM module](https://protectli.com/product/tpm-module/)
 132
 133 [Protectli VP46xx]: https://protectli.com/vault-6-port/
 134 [MX25L12835F]: https://www.mxic.com.tw/Lists/Datasheet/Attachments/8653/MX25L12835F,%203V,%20128Mb,%20v1.6.pdf
 135 [flashrom]: https://flashrom.org/Flashrom