Utility and driver for interacting with Baikal Electronics BE-M1000 SoC Boot SPI Flash from Linux userspace. The interaction diagram is shown in the figure below.
flowchart LR
baikal-scp-flash["baikal-scp-flash<br>(CLI Utility)"]
baikal-scp-lib["baikal-scp-lib<br>(Shared Library)"]
baikal-scp["baikal-scp<br>(Kernel Module)"]
boot-flash["SPI Boot Flash<br>Firmware<br>(A-TF, UEFI, ...)"]
a-tf["ARM Trusted<br>Firmware"]
scp["System Control<br>Processor (SCP)"]
subgraph soc ["Baikal Electronics BE-M1000 SoC"]
subgraph user ["Linux Userspace"]
baikal-scp-flash -- "API" --> baikal-scp-lib
end
subgraph kernel ["Linux Kernel"]
baikal-scp-lib -- "IOCTL" --> baikal-scp
end
baikal-scp -- "SMC" --> a-tf
a-tf -- "MailBox SRAM<br>and Signalling" --> scp
end
scp -- "SPI0" --> boot-flash
This repository contains sources for the following components:
- baikal-scp — Linux kernel module which interacts with A-TF using SMC calls that provides access to the SPI Boot flash;
- baikal-scp-lib — Linux userspace shared library for interacting with baikal-scp kernel module using IOCTL;
- baikal-scp-flash — Linux userspace CLI utility for flashing SPI Boot Flash using baikal-scp-lib shared library API.
For successful use of this utility and driver, the A-TF and UEFI firmware from the Baikal ARM64 SDK version 5.4 (20220126) or higher is required. Follow the instructions from the SDK to update the firmware on your board.
You can use this utility and the driver with older firmware versions (at least version 5.1), but in this case you should use an explicit offset specifying for the SPI flash memory (option -o, --offset) for the read/write/erase operations, instead of specifying the partition name (option -p, --part). The built-in flash offsets for named partitions are only valid for firmware version 5.4 or higher.
Usage syntax:
baikal-scp-flash [options]
Where [options] is a one or more options that are described in the "Options" section.
Write image to SPI Boot Flash from file <filepath>. You can select SPI Boot Flash offset by built-in named partition (option -p, --part) or manually specify flash offset (option -o, --offset) and write size (option -s, --size). Also you can skip specified amount of bytes from the beginning of input image file using the skip option (-k, --skip).
The following steps will be performed sequentially when performing the write operation:
- erase flash memory area;
- writing data to flash memory;
- read back and verify written data with the original data (if the
-noption is not specified).
You can specify an HTTP (http://), HTTPS (https://) or FTP (ftp://) link to the file on the remote server as the <filepath>. In this case, the file will be downloaded from the remote server and then used to write to the SPI Boot Flash memory.
Read SPI Boot Flash contents to file <filepath>. You can select SPI Boot Flash offset by built-in named partition (option -p, --part) or manually specify flash offset (option -o, --offset) and read size (option -s, --size).
Erase SPI Boot Flash contents. You can select SPI Boot Flash offset by built-in named partition (option -p, --part) or manually specify flash offset (option -o, --offset) and erase size (option -s, --size).
Select SPI Boot Flash offset and size by built-in named partition for read (option -r, --read), write (option -w, --write) or/and erase (option -e, --erase) operations. This option automatically sets the size (option -s, --size) and offset (-o, --offset) to values corresponding to the selected flash partition by name.
Available built-in partitions:
| Partition Name | Offset | Size | Description |
|---|---|---|---|
bl1 |
0x000000 | 0x040000 (256 KiB) | ARM Trusted Firmware (BL1) |
dtb |
0x040000 | 0x040000 (256 KiB) | Flattened Device Tree Blob (DTB) |
var |
0x080000 | 0x0c0000 (768 KiB) | EFI variables |
fip |
0x140000 | 0x640000 (6400 KiB) | Firmware Image Package (FIP) |
Important: The offsets and sizes in the table above are valid only for Baikal ARM64 SDK firmware version 5.4 or higher.
Specify size for read (option -r, --read), write (option -w, --write) or erase (option -e, --erase) operations. The specified size is automatically up-aligned to the 32-byte boundary.
Specify SPI Boot Flash offset for read (option -r, --read), write (option -w, --write) or erase (option -e, --erase) operations. The specified size is automatically up-aligned to the 32-byte boundary.
The number of bytes to skip at the beginning of the input file during a write (option -w, --write) operation.
Do not read and verify the written data with the original data during the write (option -w, --write) operation.
Automatically confirm destructive operations (write, erase) without displaying a prompt.
Be quiet. Do not output any messages to the standard output (stdout) except the destructive operation confirmation prompt (unless the -y option is specified).
Show help and usage text.
Display information about utility, shared library and kernel module versions.
Write flattened device tree blob (DTB) to SPI Boot Flash from update.dtb file:
# baikal-scp-flash -w update.dtb -p dtb
Write a file flash.bin downloaded from the remote server (http://example.com/firmware/latest/flash.bin) to the SPI Boot Flash:
# baikal-scp-flash -w http://example.com/firmware/latest/flash.bin
Read full SPI Boot Flash contents to flash.bin file:
# baikal-scp-flash -r flash.bin
Erase 256 KiB on SPI Boot Flash at 8 MiB offset:
# baikal-scp-flash -e -s 0x40000 -o 0x800000
Write a block of 768 KiB from flash.bin file to SPI Boot Flash memory at 256 KiB offset, skipping the first 512 KiB of the file:
# baikal-scp-flash --write flash.bin --size 0xc0000 --offset 0x40000 --skip 0x80000
See this illustration:
This work is free. You can redistribute it and/or modify it under the terms of the MIT License.
- Anton Kikin mailto:[email protected]