Documentation/mainboard/starlabs/common/flashing.md

   1 # Flashing with fwupd
   2
   3 ## **Requirements:**
   4
   5 * fwupd version 1.5.6 or later
   6 * The battery must be charged to at least 30%
   7 * The charger must be connected (either USB-C or DC Jack)
   8 * BIOS Lock must be disabled
   9 * Supported Linux distribution (Ubuntu 20.04 +, Linux Mint 20.1 + elementaryOS 6 +, Manjaro 21+)
  10
  11 **fwupd 1.5.6 or later**
  12 To check the version of **fwupd** you have installed, open a terminal window and enter the below command:
  13
  14 ```
  15 fwupdmgr --version
  16 ```
  17
  18 This will show the version number. **1.5.6** or greater will work.
  19 ![fwupd version](../fwupdVersion.png)
  20 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:
  21
  22 ```
  23 sudo add-apt-repository ppa:starlabs/ppa
  24 sudo apt update
  25 sudo apt install fwupd
  26 ```
  27
  28 On Manjaro:
  29
  30 ```
  31 sudo pacman -Sy fwupd-git flashrom-starlabs
  32 ```
  33
  34 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.
  35
  36 **Disable BIOS Lock**
  37 BIOS Lock must be disabled when switching from the standard AMI (American Megatrends Inc.) firmware to coreboot. To disable BIOS Lock:
  38
  39 1\. Start with your LabTop turned off\. Turn it on whilst holding the **F2** key to access the BIOS settings.
  40 2\. When the BIOS settings load, use the arrow keys to navigate to the **Advanced** tab\. Here you will see **BIOS Lock**\.
  41 3\. Press `Enter` to change this setting from **Enabled** to **Disabled**
  42
  43 ![Disable BIOS Lock](../BiosLock.jpg)
  44
  45 4\. Next, press the `F10` key to **Save & Exit** and then `Enter` to confirm.
  46
  47 ## **Switching Branch**
  48
  49 Switching branch refers to changing from AMI firmware to coreboot, or vice versa.
  50
  51 First, check for new firmware files with the below terminal command:
  52
  53 ```
  54 fwupdmgr refresh --force
  55 ```
  56
  57 Then, to change branch, enter the below terminal command:
  58
  59 ```
  60 fwupdmgr switch-branch
  61 ```
  62
  63 You can then select which branch you would like to use, by typing in the corresponding number:
  64 ![Switch Branch](../SwitchBranch.png)
  65 You will be prompted to confirm, press `y` to continue or `n` to cancel.
  66
  67 Once the switch has been completed, you will be prompted to restart.
  68
  69 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.
  70
  71 You can switch branch at any time.