Change in coreboot[master]: Documentation/mainboard: Move flashing instructions to common dir
Felix Held has submitted this change. ( https://review.coreboot.org/c/coreboot/+/62300 )
Change subject: Documentation/mainboard: Move flashing instructions to common dir ......................................................................
Documentation/mainboard: Move flashing instructions to common dir
Move the instructions for flashing coreboot with fwupd to common directory as the process is identical across all models and variants.
Signed-off-by: Sean Rhodes sean@starlabs.systems Change-Id: I293acf962b32c81fdf482e0df15363e1cffa39bd Reviewed-on: https://review.coreboot.org/c/coreboot/+/62300 Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Angel Pons th3fanbus@gmail.com --- A Documentation/mainboard/starlabs/common/flashing.md M Documentation/mainboard/starlabs/lite_glk.md M Documentation/mainboard/starlabs/starbook_tgl.md 3 files changed, 73 insertions(+), 70 deletions(-)
Approvals: build bot (Jenkins): Verified Angel Pons: Looks good to me, approved
diff --git a/Documentation/mainboard/starlabs/common/flashing.md b/Documentation/mainboard/starlabs/common/flashing.md new file mode 100644 index 0000000..b28cffb --- /dev/null +++ b/Documentation/mainboard/starlabs/common/flashing.md @@ -0,0 +1,71 @@ +# 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. + +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** + + + +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: + +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. diff --git a/Documentation/mainboard/starlabs/lite_glk.md b/Documentation/mainboard/starlabs/lite_glk.md index 0fbb5f6..2b475e5 100644 --- a/Documentation/mainboard/starlabs/lite_glk.md +++ b/Documentation/mainboard/starlabs/lite_glk.md @@ -80,4 +80,4 @@ | External flashing | yes | +---------------------+------------+
-Please see [here](../common/flashing.md) for instructions on how to flash with fwupd. \ No newline at end of file +Please see [here](../common/flashing.md) for instructions on how to flash with fwupd. diff --git a/Documentation/mainboard/starlabs/starbook_tgl.md b/Documentation/mainboard/starlabs/starbook_tgl.md index b69073c..fe12edc 100644 --- a/Documentation/mainboard/starlabs/starbook_tgl.md +++ b/Documentation/mainboard/starlabs/starbook_tgl.md @@ -83,72 +83,4 @@ | 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. - -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** - - - -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: - -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. +Please see [here](../common/flashing.md) for instructions on how to flash with fwupd.
-
Felix Held (Code Review)