summaryrefslogtreecommitdiff
path: root/Documentation/mainboard/starlabs/starbook_tgl.md
diff options
context:
space:
mode:
authorSean Rhodes <sean@starlabs.systems>2021-07-05 16:03:15 +0100
committerFelix Held <felix-coreboot@felixheld.de>2021-11-22 14:53:04 +0000
commit17441a3ac5a114fc8386e8da50ef802e159c97b7 (patch)
tree0ef9df707f826c2b901bd2ee14aa81ba30d45a9e /Documentation/mainboard/starlabs/starbook_tgl.md
parentbe0722ac9145ac0203aca26165cbc9ee46b2b1b7 (diff)
mainboard/starlabs: Add StarBook Mk V
Tested using MrChromeBox's `uefipayload_202107` branch: * Windows 10 * Ubuntu 20.04 * MX Linux 19.4 * Manjaro 21 No known issues. https://starlabs.systems/pages/starbook-specification Signed-off-by: Sean Rhodes <sean@starlabs.systems> Change-Id: I090971a9e8d2be5b08be886d00d304607304b645 Reviewed-on: https://review.coreboot.org/c/coreboot/+/56088 Reviewed-by: Angel Pons <th3fanbus@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Documentation/mainboard/starlabs/starbook_tgl.md')
-rw-r--r--Documentation/mainboard/starlabs/starbook_tgl.md154
1 files changed, 154 insertions, 0 deletions
diff --git a/Documentation/mainboard/starlabs/starbook_tgl.md b/Documentation/mainboard/starlabs/starbook_tgl.md
new file mode 100644
index 0000000000..b69073c2e8
--- /dev/null
+++ b/Documentation/mainboard/starlabs/starbook_tgl.md
@@ -0,0 +1,154 @@
+# StarBook Mk V
+
+## Specs
+
+- CPU (full processor specs available at https://ark.intel.com)
+ - Intel i7-1165G7 (Tiger Lake)
+ - Intel i3-1110G4 (Tiger Lake)
+- EC
+ - ITE IT5570E
+ - Backlit Keyboard, with standard PS/2 keycodes and SCI hotkeys
+ - Battery
+ - Charger, using AC adapter or USB-C PD
+ - Suspend / resume
+- GPU
+ - IntelĀ® IrisĀ® Xe Graphics
+ - GOP driver is recommended, VBT is provided
+ - eDP 14-inch 1920x1080 LCD
+ - HDMI video
+ - USB-C DisplayPort video
+- Memory
+ - 2 x DDR4 SODIMM
+- Networking
+ - AX201 2230 WiFi / Bluetooth
+- Sound
+ - Realtek ALC256
+ - Internal speakers
+ - Internal microphone
+ - Combined headphone / microphone 3.5-mm jack
+ - HDMI audio
+ - USB-C DisplayPort audio
+- Storage
+ - M.2 PCIe SSD
+ - RTS5129 MicroSD card reader
+- USB
+ - 1280x720 CCD camera
+ - Thunderbolt 4.0 (left)
+ - USB 3.1 Gen 2 Type-A (left)
+ - USB 3.1 Gen 1 Type-A (right)
+ - USB 2.0 Type-A (right)
+
+## Building coreboot
+
+### Preliminaries
+
+Prior to building coreboot the following files are required:
+* Intel Flash Descriptor file (descriptor.bin)
+* Intel Management Engine firmware (me.bin)
+* ITE Embedded Controller firmware (ec.bin)
+
+The files listed below are optional:
+- Splash screen image in Windows 3.1 BMP format (Logo.bmp)
+
+These files exist in the correct location in the StarLabsLtd/blobs repo on GitHub which is used in place of the standard 3rdparty/blobs repo.
+
+### Build
+
+The following commands will build a working image:
+
+```bash
+make distclean
+make defconfig KBUILD_DEFCONFIG=configs/config.starlabs_starbook_tgl
+make
+```
+
+## Flashing coreboot
+
+```eval_rst
++---------------------+------------+
+| Type | Value |
++=====================+============+
+| Socketed flash | no |
++---------------------+------------+
+| Vendor | Winbond |
++---------------------+------------+
+| Model | 25Q128JVSQ |
++---------------------+------------+
+| Size | 16 MiB |
++---------------------+------------+
+| Package | SOIC-8 |
++---------------------+------------+
+| Internal flashing | yes |
++---------------------+------------+
+| External flashing | yes |
++---------------------+------------+
+
+#### **Requirements:**
+
+* fwupd version 1.5.6 or later
+* The battery must be charged to at least 30%
+* The charger must be connected (either USB-C or DC Jack)
+* BIOS Lock must be disabled
+* Supported Linux distribution (Ubuntu 20.04 +, Linux Mint 20.1 + elementaryOS 6 +, Manjaro 21+)
+
+**fwupd 1.5.6 or later**
+To check the version of **fwupd** you have installed, open a terminal window and enter the below command:
+
+```
+fwupdmgr --version
+```
+
+This will show the version number. **1.5.6** or greater will work.
+![fwupd version](fwupdVersion.png)
+On Ubuntu 20.04, Ubuntu 20.10, Linux Mint 20.1 and elementaryOS 6, fwupd 1.5.6 can be installed from our PPA with the below terminal commands:
+
+```
+sudo add-apt-repository ppa:starlabs/ppa
+sudo apt update
+sudo apt install fwupd
+```
+
+On Manjaro:
+
+```
+sudo pacman -Sy fwupd-git flashrom-starlabs
+```
+
+Instructions for other distributions will be added once fwupd 1.5.6 is available. If you are not using one of the distributions listed above, it is possible to install coreboot using a Live USB.
+
+**Disable BIOS Lock**
+BIOS Lock must be disabled when switching from the standard AMI (American Megatrends Inc.) firmware to coreboot. To disable BIOS Lock:
+
+1\. Start with your LabTop turned off\. Turn it on whilst holding the **F2** key to access the BIOS settings.
+2\. When the BIOS settings load, use the arrow keys to navigate to the **Advanced** tab\. Here you will see **BIOS Lock**\.
+3\. Press `Enter` to change this setting from **Enabled** to **Disabled**
+
+![Disable BIOS Lock](BiosLock.jpg)
+
+4\. Next, press the `F10` key to **Save & Exit** and then `Enter` to confirm.
+
+#### **Switching Branch**
+
+Switching branch refers to changing from AMI firmware to coreboot, or vice versa.
+
+First, check for new firmware files with the below terminal command:
+
+```
+fwupdmgr refresh --force
+```
+
+Then, to change branch, enter the below terminal command:
+
+```
+fwupdmgr switch-branch
+```
+
+You can then select which branch you would like to use, by typing in the corresponding number:
+![Switch Branch](SwitchBranch.png)
+You will be prompted to confirm, press `y` to continue or `n` to cancel.
+
+Once the switch has been completed, you will be prompted to restart.
+
+The next reboot can take up to **5 minutes,** do not interrupt this process or disconnect the charger. Once the reboot is complete, that's it - you'll continue to receive updates for whichever branch you are using.
+
+You can switch branch at any time.