summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMichael Niewöhner <foss@mniewoehner.de>2019-09-23 21:54:58 +0200
committerPatrick Georgi <pgeorgi@google.com>2019-10-04 16:24:59 +0000
commit258f52b5203cb40b671b0d4f8b2d2eba5fa02668 (patch)
tree57a260e3d2ab60fb54b38f81e7457a71db4370c9 /Documentation
parentb71181adc336625ee6ecae7a46c6926cb7c3c28c (diff)
downloadcoreboot-258f52b5203cb40b671b0d4f8b2d2eba5fa02668.tar.xz
mb/supermicro/x11-lga1151-series: rework documentation
This splits the x11-lga1151-series' documentation into a generic and a board specific section as a preparation for CB:35427. Additionally this adds some more information on the x11ssh board. Signed-off-by: Michael Niewöhner <foss@mniewoehner.de> Change-Id: I40ddd0b5cce0b1a3306eae22fc0a0bc6b2a6263c Reviewed-on: https://review.coreboot.org/c/coreboot/+/35547 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Rudolph <siro@das-labor.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/mainboard/index.md2
-rw-r--r--Documentation/mainboard/supermicro/x11-lga1151-series/index.md7
-rw-r--r--Documentation/mainboard/supermicro/x11-lga1151-series/x11-lga1151-series.md61
-rw-r--r--Documentation/mainboard/supermicro/x11-lga1151-series/x11ssh-tf/x11ssh-tf.md81
4 files changed, 111 insertions, 40 deletions
diff --git a/Documentation/mainboard/index.md b/Documentation/mainboard/index.md
index ea476eb59f..9531940d6f 100644
--- a/Documentation/mainboard/index.md
+++ b/Documentation/mainboard/index.md
@@ -108,7 +108,7 @@ The boards in this section are not real mainboards, but emulators.
## Supermicro
- [X10SLM+-F](supermicro/x10slm-f.md)
-- [X11 LGA1151 series](supermicro/x11-lga1151-series/index.md)
+- [X11 LGA1151 series](supermicro/x11-lga1151-series/x11-lga1151-series.md)
## UP
diff --git a/Documentation/mainboard/supermicro/x11-lga1151-series/index.md b/Documentation/mainboard/supermicro/x11-lga1151-series/index.md
deleted file mode 100644
index 79d2571009..0000000000
--- a/Documentation/mainboard/supermicro/x11-lga1151-series/index.md
+++ /dev/null
@@ -1,7 +0,0 @@
-# X11 LGA1151 series
-
-The supermicros X11 series with socket LGA1151 are mostly the same boards with some minor
-differences in internal and external interfaces like available PCIe slots, 1 GbE, 10 GbE,
-IPMI etc. This is why those boards are grouped as "X11 LGA1151 series".
-
-- [X11SSH-TF](x11ssh-tf/x11ssh-tf.md)
diff --git a/Documentation/mainboard/supermicro/x11-lga1151-series/x11-lga1151-series.md b/Documentation/mainboard/supermicro/x11-lga1151-series/x11-lga1151-series.md
new file mode 100644
index 0000000000..6a613e77d1
--- /dev/null
+++ b/Documentation/mainboard/supermicro/x11-lga1151-series/x11-lga1151-series.md
@@ -0,0 +1,61 @@
+# X11 LGA1151 series
+
+The [Supermicro X11 LGA1151 series] are mostly the same boards with some minor differences in
+internal and external interfaces like available PCIe slots, NICs (1 GbE, 10 GbE), IPMI, RAID
+Controller etc.
+
+## Supported boards
+
+- [X11SSH-TF](x11ssh-tf/x11ssh-tf.md)
+
+## Required proprietary blobs
+
+- [Intel FSP2.0]
+- Intel ME
+
+## De-blobbing
+
+- [Intel FSP2.0] can not be removed as long as there is no free replacement
+- Intel ME can be cleaned using me_cleaner (~4.5 MB more free space)
+- Intel Ethernet Controller Firmware can be removed when it's extended functionality is not
+ needed. For more details refer to the respective datasheet (e.g 333016-008 for I210).
+- Boards with [AST2400] BMC/IPMI: Firmware can be replaced by [OpenBMC]
+
+## Flashing coreboot
+
+Look at the [flashing tutorial] and the board-specific section.
+
+## Known issues
+
+These issues apply to all boards. Have a look at the board-specific issues, too.
+
+- Intel SGX causes secondary APs to crash (disabled for now) when HT is enabled (Fix is WIP CB:35312)
+- TianoCore doesn't work with Aspeed NGI, as it's text mode only (Fix is WIP CB:35726)
+
+## ToDo
+
+- Fix issues above
+- Fix issues in board specific sections
+- Fix TODOs mentioned in code
+- Add more boards! :-)
+
+## Technology
+
+```eval_rst
++------------------+--------------------------------------------------+
+| CPU | Intel Kaby Lake |
++------------------+--------------------------------------------------+
+| PCH | Intel C232/C236 |
++------------------+--------------------------------------------------+
+| Coprocessor | Intel SPS (server version of the ME) |
++------------------+--------------------------------------------------+
+```
+
+## Extra links
+
+[Supermicro X11 LGA1151 series]: https://www.supermicro.com/products/motherboard/Xeon3000/#1151
+[OpenBMC]: https://www.openbmc.org/
+[flashrom]: https://flashrom.org/Flashrom
+[flashing tutorial]: ../../../../flash_tutorial/ext_power.md
+[Intel FSP2.0]: ../../../../soc/intel/fsp/index.md
+[AST2400]: https://www.aspeedtech.com/products.php?fPath=20&rId=376
diff --git a/Documentation/mainboard/supermicro/x11-lga1151-series/x11ssh-tf/x11ssh-tf.md b/Documentation/mainboard/supermicro/x11-lga1151-series/x11ssh-tf/x11ssh-tf.md
index 79e7f3e5eb..1caa34b3f7 100644
--- a/Documentation/mainboard/supermicro/x11-lga1151-series/x11ssh-tf/x11ssh-tf.md
+++ b/Documentation/mainboard/supermicro/x11-lga1151-series/x11ssh-tf/x11ssh-tf.md
@@ -2,46 +2,40 @@
This section details how to run coreboot on the [Supermicro X11SSH-TF].
-## Required proprietary blobs
-
-* [Intel FSP2.0]
-* Intel ME
-
## Flashing coreboot
-The board can be flashed externally using *some* programmers.
-The CH341 was found working, while Dediprog won't detect the chip.
-
-For more details have a look at the [flashing tutorial].
+The board can be flashed externally using *some* programmers. The CH341 was found working, while
+Dediprog didn't detect the chip.
The flash IC can be found between the two PCIe slots near the southbridge:
![](x11ssh-tf_flash.jpg)
## BMC (IPMI)
-This board has an ASPEED [AST2400], which has BMC functionality. The
-BMC firmware resides in a 32 MiB SOIC-16 chip in the corner of the
-mainboard near the [AST2400]. This chip is an [MX25L25635F].
-
-## Known issues
-
-- Intel SGX causes secondary APs to crash (disabled for now).
-- Tianocore doesn't work with Aspeed NGI, as it's text mode only.
-- SMBus / I2C does not work (interrupt timeout)
+This board has an ASPEED [AST2400], which has BMC/[IPMI] functionality. The BMC firmware resides
+in a 32 MiB SOIC-16 chip in the corner of the mainboard near the [AST2400]. This chip is an
+[MX25L25635F].
## Tested and working
- USB ports
-- M.2 2280 NVMe slot
-- 2x 10GB Ethernet
-- SATA
-- RS232
-- VGA on Aspeed
-- Super I/O initialisation
+- Ethernet
+- SATA ports
+- RS232 external
- ECC DRAM detection
- PCIe slots
-- TPM on TPM expansion header
+- M.2 2280 NVMe slot
- BMC (IPMI)
+- VGA on Aspeed
+- TPM on TPM expansion header
+
+## Known issues
+
+See general issue section.
+
+## ToDo
+
+- Fix TODOs mentioned in code
## Technology
@@ -51,23 +45,46 @@ mainboard near the [AST2400]. This chip is an [MX25L25635F].
+------------------+--------------------------------------------------+
| PCH | Intel C236 |
+------------------+--------------------------------------------------+
+| Coprocessor | Intel SPS (server version of the ME) |
++------------------+--------------------------------------------------+
| Super I/O | ASPEED AST2400 |
+------------------+--------------------------------------------------+
-| Coprocessor | Intel SPS (server version of the ME) |
+| Ethernet | 2x Intel® X550 10GBase-T Ethernet |
+| | 1x dedicated BMC |
++------------------+--------------------------------------------------+
+| PCIe slots | 1x 3.0 x8 |
+| | 1x 3.0 x2 (in x4) |
+| | 1x 3.0 M.2 2260 x4 (Key M, with S-ATA) |
+------------------+--------------------------------------------------+
-| Coprocessor | ASPEED AST2400 |
+| USB slots | 2x USB 2.0 (ext) |
+| | 2x USB 3.0 (ext) |
+| | 1x USB 3.0 (int) |
+| | 1x dual USB 3.0 header |
+| | 2x dual USB 2.0 header |
++------------------+--------------------------------------------------+
+| SATA slots | 8x SATA III |
++------------------+--------------------------------------------------+
+| Other slots | 1x RS232 (ext) |
+| | 1x RS232 header |
+| | 1x TPM header |
+| | 1x Power SMB header |
+| | 6x PWM Fan connector |
+| | 2x I-SGPIO |
+| | 2x S-ATA DOM Power connector |
+| | 1x XDP Port |
+| | 1x External BMC I2C Header (for IPMI card) |
+| | 1x Chassis Intrusion Header |
+------------------+--------------------------------------------------+
```
## Extra links
+- [Supermicro X11SSH-TF]
- [Board manual]
-[AST2400]: https://www.aspeedtech.com/products.php?fPath=20&rId=376
+[Supermicro X11SSH-TF]: https://www.supermicro.com/en/products/motherboard/X11SSH-TF
[Board manual]: https://www.supermicro.com/manuals/motherboard/C236/MNL-1783.pdf
-[flashrom]: https://flashrom.org/Flashrom
+[AST2400]: https://www.aspeedtech.com/products.php?fPath=20&rId=376
+[IPMI]: ../../../../drivers/ipmi_kcs.md
[MX25L25635F]: https://media.digikey.com/pdf/Data%20Sheets/Macronix/MX25L25635F.pdf
[N25Q128A]: https://www.micron.com/~/media/Documents/Products/Data%20Sheet/NOR%20Flash/Serial%20NOR/N25Q/n25q_128mb_3v_65nm.pdf
-[flashing tutorial]: ../../../../flash_tutorial/ext_power.md
-[Intel FSP2.0]: ../../../../soc/intel/fsp/index.md
-[Supermicro X11SSH-TF]: https://www.supermicro.com/en/products/motherboard/X11SSH-TF