MrChromebox.tech

https://docs.mrchromebox.tech
Admin
MrChromebox.tech provides custom coreboot firmware and utilities for Chromebooks and Chromeboxes,...
Tokens:28,272
Snippets:478
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Terminal Emulator Setup

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Commands to install and initialize common terminal emulators for serial communication.

```bash
sudo apt install minicom
minicom -D /dev/ttyUSB1 -b 115200
```

```bash
sudo apt install picocom
picocom -b 115200 /dev/ttyUSB1
```

```bash
screen /dev/ttyUSB1 115200
```

--------------------------------

### Initialize Linux Environment

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to prepare the terminal and install the flashrom utility.

```bash
cd;
```

```bash
sudo apt update
sudo apt install flashrom
```

--------------------------------

### Install build dependencies

Source: https://docs.mrchromebox.tech/docs/support/compiling.html

Install the required tools and libraries for coreboot and edk2 development based on your Linux distribution.

```bash
sudo apt install -y bison build-essential curl flex git gnat imagemagick libncurses5-dev m4 nasm python-is-python3 uuid-dev zlib1g-dev libssl-dev pkg-config libcmocka-dev libnss3-dev
```

```bash
sudo pacman --needed -S base-devel curl git gcc-ada ncurses zlib nasm imagemagick pkgconf cmocka nss
```

```bash
sudo dnf install git make gcc-gnat flex bison xz bzip2 gcc g++ ncurses-devel wget zlib-devel patch openssl libuuid-devel nasm texinfo pkgconfig cmocka-devel nss-devel
```

--------------------------------

### Launch Ventoy Executables

Source: https://docs.mrchromebox.tech/docs/support/bootableusb.html

Run the appropriate Ventoy executable for your operating system to begin the installation process.

```bash
Ventoy2Disk.exe
```

```bash
VentoyGUI.x86_64
```

--------------------------------

### Prepare Linux Environment and Verify Connection

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-suzyq

Commands to install flashrom and verify the Suzy-Q cable connection on a Linux host.

```bash
cd;
```

```bash
sudo apt update
sudo apt install flashrom
```

```bash
ls /dev/ttyUSB*
```

--------------------------------

### Install curl on Ubuntu

Source: https://docs.mrchromebox.tech/docs/firmware/updating-firmware.html

Installs the curl utility required for downloading the firmware script on Ubuntu-based distributions.

```bash
sudo apt update && sudo apt install -y curl
```

--------------------------------

### Access Boot Menu

Source: https://docs.mrchromebox.tech/docs/support/bootableusb.html

Keyboard shortcuts to access the boot menu depending on the firmware type installed.

```text
CTRL+L
```

```text
ESC
```

--------------------------------

### Download and Prepare Utilities

Source: https://docs.mrchromebox.tech/docs/firmware/manual-flashing.html

Downloads and sets execution permissions for flashrom, cbfstool, and gbb_utility.

```bash
# Download and extract flashrom
wget -O flashrom.tar.gz https://mrchromebox.tech/files/util/flashrom_ups_libpci37_20240418.tar.gz
tar -zxf flashrom.tar.gz
chmod +x flashrom

# Download and extract cbfstool
wget https://mrchromebox.tech/files/util/cbfstool.tar.gz
tar -zxf cbfstool.tar.gz
chmod +x cbfstool

# Download and extract gbb_utility
wget https://mrchromebox.tech/files/util/gbb_utility.tar.gz
tar -zxf gbb_utility.tar.gz
chmod +x gbb_utility
```

--------------------------------

### Initialize submodules

Source: https://docs.mrchromebox.tech/docs/support/compiling.html

Update and initialize the required submodules within the coreboot directory.

```bash
cd coreboot
git submodule update --init --checkout --recursive
```

--------------------------------

### Build the firmware

Source: https://docs.mrchromebox.tech/docs/support/compiling.html

Execute the build script for a specific board name to generate the firmware image.

```bash
./build-uefi.sh <boardname>
```

```bash
./build-uefi.sh panther
```

--------------------------------

### Execute Firmware Utility Script

Source: https://docs.mrchromebox.tech/docs/fwscript.html

Standard command to download and execute the script on ChromeOS or Linux.

```bash
cd; curl -LOf https://mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh
```

```bash
cd; curl -LOfk https://mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh
```

--------------------------------

### Build the coreboot toolchain

Source: https://docs.mrchromebox.tech/docs/support/compiling.html

Compile the cross-compiler toolchain for i386 architecture using available CPU cores.

```bash
make crossgcc-i386 CPUS=$(nproc)
```

--------------------------------

### Backup Current Firmware

Source: https://docs.mrchromebox.tech/docs/firmware/manual-flashing.html

Creates a backup of the existing firmware. Use the appropriate command for your device architecture.

```bash
sudo ./flashrom -p internal -r backup.rom
```

```bash
sudo ./flashrom -p internal -r backup.rom --ifd -i bios
```

--------------------------------

### Run Firmware Utility Script

Source: https://docs.mrchromebox.tech/docs/firmware/updating-firmware.html

Downloads and executes the MrChromebox firmware utility script from the terminal.

```bash
cd; curl -LOf https://mrchromebox.tech/firmware-util.sh && sudo bash firmware-util.sh
```

--------------------------------

### Download UEFI Full ROM Firmware

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to fetch and execute the script for downloading full UEFI firmware images.

```bash
wget https://raw.githubusercontent.com/MrChromebox/scripts/main/download-fullrom.sh
chmod +x download-fullrom.sh
./download-fullrom.sh <board or HWID>
```

```bash
./download-fullrom.sh edgar
./download-fullrom.sh EDGAR
./download-fullrom.sh -n edgar
```

```bash
./download-fullrom.sh 2606.1 edgar
```

```bash
./download-fullrom.sh -h
```

--------------------------------

### Download and extract utility binaries

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Download and extract the necessary cbfstool and gbb_utility binaries for firmware manipulation.

```bash
wget https://mrchromebox.tech/files/util/cbfstool.tar.gz && tar -zxf cbfstool.tar.gz
```

```bash
wget https://mrchromebox.tech/files/util/gbb_utility.tar.gz && tar -zxf gbb_utility.tar.gz
```

--------------------------------

### Manually Collect System Information

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Captures hardware identification and device enumeration logs manually.

```bash
sudo dmidecode > dmidecode.txt
sudo lspci -vvnn > lspci.txt
lsusb -vv > lsusb.txt
```

--------------------------------

### Manually Collect Firmware and Kernel Logs

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Captures coreboot logs and kernel message buffers.

```bash
sudo cbmem -1 > cbmem.log
dmesg > dmesg.txt
```

--------------------------------

### Extract and Inject VPD

Source: https://docs.mrchromebox.tech/docs/firmware/manual-flashing.html

Extracts Vital Product Data from the backup and writes it to the new firmware image.

```bash
./cbfstool backup.rom read -r RO_VPD -f vpd.bin
```

```bash
./cbfstool coreboot.rom write -r RO_VPD -f vpd.bin
```

--------------------------------

### Verify SuzyQable Connection

Source: https://docs.mrchromebox.tech/docs/firmware/wp/disabling.html

Command to check if the SuzyQable is correctly detected by the system.

```bash
ls /dev/ttyUSB*
```

--------------------------------

### Flash firmware via SuzyQ

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-suzyq

Commands to flash firmware on Intel-based and other ChromeOS devices.

```bash
sudo flashrom -p raiden_debug_spi:target=AP -w <filename> --ifd -i bios -N
```

```bash
sudo flashrom -p raiden_debug_spi:target=AP -w <filename>
```

--------------------------------

### Enable Closed Case Debugging

Source: https://docs.mrchromebox.tech/docs/firmware/wp/disabling.html

Command to initiate the CCD opening process on a ChromeOS device.

```bash
gsctool -a -o
```

--------------------------------

### Reinstall GRUB Bootloader

Source: https://docs.mrchromebox.tech/docs/faq.html

Commands to re-register the boot entry with the firmware after a boot order reset.

```bash
sudo grub-install
sudo update-grub
```

--------------------------------

### Download the Debugging Script

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Downloads the diagnostic script to the current user's desktop.

```bash
cd ~/Desktop
wget https://raw.githubusercontent.com/chrultrabook/linux-tools/main/debugging.sh
```

--------------------------------

### Verify firmware integrity

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to verify the written firmware against the source file.

```bash
sudo flashrom -p ch341a_spi -v <filename> --ifd -i bios
```

```bash
sudo flashrom -p ch341a_spi -v <filename>
```

--------------------------------

### Disable Hardware Write Protection via SuzyQable

Source: https://docs.mrchromebox.tech/docs/firmware/wp/disabling.html

Commands to disable write protection and configure boot settings via the debug cable.

```bash
echo "wp false" > /dev/ttyUSB0
echo "wp false atboot" > /dev/ttyUSB0
```

--------------------------------

### Clone the coreboot repository

Source: https://docs.mrchromebox.tech/docs/support/compiling.html

Download the coreboot source code from the official repository.

```bash
git clone https://github.com/mrchromebox/coreboot.git
```

--------------------------------

### Download cbmem utility

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Download the cbmem utility archive from the official repository.

```bash
wget https://mrchromebox.tech/files/util/cbmem.tar.gz
```

--------------------------------

### Identify and Flash Drive with dd

Source: https://docs.mrchromebox.tech/docs/support/bootableusb.html

Use lsblk to identify the target drive and dd to flash the ISO image to the device.

```bash
lsblk
```

```bash
umount
```

```bash
dd if=myfile.iso of=/dev/<device name (as shown by lsblk)> bs=16M status=progress
```

--------------------------------

### Inject VPD and HWID into new firmware

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to write the extracted VPD and HWID data into the target firmware image.

```bash
./cbfstool <Shellball ROM/UEFI Full ROM filename> write -r RO_VPD -f vpd.bin
```

```bash
./cbfstool <UEFI Full ROM filename> add -n hwid -f hwid.txt -t raw
```

```bash
./gbb_utility <Shellball ROM> --set --hwid="$(cat hwid.txt)"
```

--------------------------------

### Extract VPD and HWID from device firmware

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to read the current firmware from the device and extract the RO_VPD section and HWID.

```bash
sudo flashrom -p ch341a_spi -r badflash.rom
```

```bash
./cbfstool badflash.rom read -r RO_VPD -f vpd.bin
```

```bash
./gbb_utility badflash.rom --get --hwid | sed 's/^hardware_id: //' > hwid.txt
```

--------------------------------

### Extract and prepare cbmem

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Extract the downloaded archive and set the executable permission for the utility.

```bash
tar -xf cbmem.tar.gz
rm cbmem.tar.gz
chmod +x cbmem
```

--------------------------------

### Flash firmware using flashrom

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to write firmware to the chip, with specific flags for Intel-based devices.

```bash
sudo flashrom -p ch341a_spi -w <filename> --ifd -i bios -N
```

```bash
sudo flashrom -p ch341a_spi -w <filename>
```

--------------------------------

### Extract and Inject HWID

Source: https://docs.mrchromebox.tech/docs/firmware/manual-flashing.html

Extracts the Hardware ID from existing firmware and adds it to the custom ROM.

```bash
./cbfstool backup.rom extract -n hwid -f hwid.txt
```

```bash
./gbb_utility backup.rom --get --hwid > hwid.txt
```

```bash
./cbfstool coreboot.rom add -n hwid -f hwid.txt -t raw
```

--------------------------------

### Extract VPD and HWID from stock firmware backup

Source: https://docs.mrchromebox.tech/docs/support/unbricking/unbrick-ch341a

Commands to extract RO_VPD and HWID from a previously created stock firmware backup file.

```bash
./cbfstool stock-firmware-<devicename>-<date>.rom read -r RO_VPD -f vpd.bin
```

```bash
./gbb_utility stock-firmware-<devicename>-<date>.rom --get --hwid | sed 's/^hardware_id: //' > hwid.txt
```

--------------------------------

### Verify Backup File

Source: https://docs.mrchromebox.tech/docs/firmware/manual-flashing.html

Checks the file size of the created backup to ensure it is valid.

```bash
ls -lh backup.rom
```

--------------------------------

### Run cbmem and save output

Source: https://docs.mrchromebox.tech/docs/support/debugging.html

Execute the cbmem utility with the -1 flag to capture the log to a file.

```bash
sudo ./cbmem -1 > cbmem.log
```
Tokens:
Raw