coreboot-kgpe-d16/Documentation/mainboard/starlabs/common/flashing.md

72 lines
2.4 KiB
Markdown
Raw Normal View History

# Flashing with fwupd
#### **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.
Documentation: Fix sphinx warnings This fixes the following warnings: mainboard/starlabs/common/flashing.md:: WARNING: image file not readable: - mainboard/starlabs/common/fwupdVersion.png - mainboard/starlabs/common/BiosLock.jpg - mainboard/starlabs/common/SwitchBranch.png cbfstool/index.md:: WARNING: document isn't included in any toctree internals/devicetree_keywords.md:: WARNING: document isn't included in any toctree mainboard/asus/wifigo_v1.md:: WARNING: document isn't included in any toctree mainboard/google/index.md:: WARNING: document isn't included in any toctree mainboard/starlabs/common/flashing.md:: WARNING: document isn't included in any toctree releases/boards_supported_on_branches.md:: WARNING: document isn't included in any toctree WARNING: None:any reference target not found: - releases/coreboot-4.16-relnotes - releases/coreboot-4.15-relnotes - releases/coreboot-4.14-relnotes - releases/coreboot-4.13-relnotes - releases/coreboot-4.12-relnotes - releases/coreboot-4.11-relnotes - releases/coreboot-4.10-relnotes - releases/coreboot-4.9-relnotes - releases/coreboot-4.8.1-relnotes - releases/coreboot-4.7-relnotes - releases/coreboot-4.6-relnotes - releases/coreboot-4.5-relnotes - releases/coreboot-4.4-relnotes - releases/coreboot-4.3-relnotes - releases/coreboot-4.2-relnotes - releases/coreboot-4.1-relnotes - ../../src/soc/intel/common/block/cse/cse.c Change-Id: I22273bc1bc34b6297cef4e594c454c2316d4215a Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/64576 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net> Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
2022-05-23 02:17:06 +02:00
![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**
Documentation: Fix sphinx warnings This fixes the following warnings: mainboard/starlabs/common/flashing.md:: WARNING: image file not readable: - mainboard/starlabs/common/fwupdVersion.png - mainboard/starlabs/common/BiosLock.jpg - mainboard/starlabs/common/SwitchBranch.png cbfstool/index.md:: WARNING: document isn't included in any toctree internals/devicetree_keywords.md:: WARNING: document isn't included in any toctree mainboard/asus/wifigo_v1.md:: WARNING: document isn't included in any toctree mainboard/google/index.md:: WARNING: document isn't included in any toctree mainboard/starlabs/common/flashing.md:: WARNING: document isn't included in any toctree releases/boards_supported_on_branches.md:: WARNING: document isn't included in any toctree WARNING: None:any reference target not found: - releases/coreboot-4.16-relnotes - releases/coreboot-4.15-relnotes - releases/coreboot-4.14-relnotes - releases/coreboot-4.13-relnotes - releases/coreboot-4.12-relnotes - releases/coreboot-4.11-relnotes - releases/coreboot-4.10-relnotes - releases/coreboot-4.9-relnotes - releases/coreboot-4.8.1-relnotes - releases/coreboot-4.7-relnotes - releases/coreboot-4.6-relnotes - releases/coreboot-4.5-relnotes - releases/coreboot-4.4-relnotes - releases/coreboot-4.3-relnotes - releases/coreboot-4.2-relnotes - releases/coreboot-4.1-relnotes - ../../src/soc/intel/common/block/cse/cse.c Change-Id: I22273bc1bc34b6297cef4e594c454c2316d4215a Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/64576 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net> Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
2022-05-23 02:17:06 +02:00
![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:
Documentation: Fix sphinx warnings This fixes the following warnings: mainboard/starlabs/common/flashing.md:: WARNING: image file not readable: - mainboard/starlabs/common/fwupdVersion.png - mainboard/starlabs/common/BiosLock.jpg - mainboard/starlabs/common/SwitchBranch.png cbfstool/index.md:: WARNING: document isn't included in any toctree internals/devicetree_keywords.md:: WARNING: document isn't included in any toctree mainboard/asus/wifigo_v1.md:: WARNING: document isn't included in any toctree mainboard/google/index.md:: WARNING: document isn't included in any toctree mainboard/starlabs/common/flashing.md:: WARNING: document isn't included in any toctree releases/boards_supported_on_branches.md:: WARNING: document isn't included in any toctree WARNING: None:any reference target not found: - releases/coreboot-4.16-relnotes - releases/coreboot-4.15-relnotes - releases/coreboot-4.14-relnotes - releases/coreboot-4.13-relnotes - releases/coreboot-4.12-relnotes - releases/coreboot-4.11-relnotes - releases/coreboot-4.10-relnotes - releases/coreboot-4.9-relnotes - releases/coreboot-4.8.1-relnotes - releases/coreboot-4.7-relnotes - releases/coreboot-4.6-relnotes - releases/coreboot-4.5-relnotes - releases/coreboot-4.4-relnotes - releases/coreboot-4.3-relnotes - releases/coreboot-4.2-relnotes - releases/coreboot-4.1-relnotes - ../../src/soc/intel/common/block/cse/cse.c Change-Id: I22273bc1bc34b6297cef4e594c454c2316d4215a Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/64576 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net> Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
2022-05-23 02:17:06 +02:00
![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.