mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-22 15:38:11 +00:00

History

Pavol Rusnak a978290d50 legacy: detect CALLBACK fields and fail build when found		2019-06-24 15:23:14 +02:00
..
bootloader
demo
emulator
firmware
gen
gitian
script
vendor
.dockerignore
.gitignore	toplevel: reorganize .gitignore files	2019-04-17 00:05:24 +02:00
build.sh
buttons.c
buttons.h
common.c
common.h
CONTRIBUTING.md
COPYING
flash.c
flash.h
layout.c
layout.h
Makefile
Makefile.include
memory_app_0.0.0.ld
memory_app_1.0.0.ld
memory_app_1.8.0.ld
memory_app_fastflash.ld
memory.c
memory.h
memory.ld
norcow_config.h
oled.c
oled.h
README.md
rng.c
rng.h
secbool.h
setup.c
setup.h
startup.s
supervise.c
supervise.h
timer.c
timer.h
usb21_standard.c
usb21_standard.h
usb_private.h
usb_standard.c
util.c
util.h
webusb_defs.h
webusb.c
webusb.h
winusb_defs.h
winusb.c
winusb.h

README.md

Trezor One Bootloader and Firmware

https://trezor.io/

How to build the Trezor bootloader, firmware and emulator

Ensure that you have Docker installed. You can follow Docker's installation instructions.

Clone this repository:

git clone https://github.com/trezor/trezor-mcu.git`
cd trezor-mcu

Use the build.sh command to build the images.

to build bootloader 1.6.0 and firmware 1.7.0:
```
./build.sh bl1.6.0 v1.7.0
```
to build latest firmware from master:
```
./build.sh
```
to build the emulator from master:
```
./build.sh EMU
```
to build the emulator for version 1.7.0:
```
./build.sh EMU v1.7.0
```

Build results are stored in the build/ directory. File bootloader-<tag>.bin represents the bootloader, trezor-<tag>.bin is the firmware image, and trezor-emulator-<tag>.elf is the emulator executable.

You can use TREZOR_OLED_SCALE environment variable to make emulator screen bigger.

How to get fingerprint of firmware signed and distributed by SatoshiLabs?

Pick version of firmware binary listed on https://wallet.trezor.io/data/firmware/1/releases.json
Download it: wget -O trezor.signed.bin https://wallet.trezor.io/data/firmware/1/trezor-1.6.1.bin
Compute fingerprint: tail -c +257 trezor.signed.bin | sha256sum

Step 3 should produce the same sha256 fingerprint like your local build (for the same version tag). Firmware has a special header (of length 256 bytes) holding signatures themselves, which must be avoided while calculating the fingerprint, that's why tail command has to be used.

How to install custom built firmware?

WARNING: This will erase the recovery seed stored on the device! You should never do this on Trezor that contains coins!

Install python-trezor: pip install trezor (more info)
trezorctl firmware_update -f build/trezor-TAG.bin

Building for development

If you want to build device firmware, make sure you have the GNU ARM Embedded toolchain installed. You will also need Python 3.5 or later and pipenv.

If you want to build the emulator instead of the firmware, run export EMULATOR=1 TREZOR_TRANSPORT_V1=1
If you want to build with the debug link, run export DEBUG_LINK=1. Use this if you want to run the device tests.
When you change these variables, use script/setup to clean the repository

To initialize the repository, run script/setup
To initialize a Python environment, run pipenv install
To build the firmware or emulator, run pipenv run script/cibuild

If you are building device firmware, the firmware will be in firmware/trezor.bin.

You can launch the emulator using firmware/trezor.elf. To use trezorctl with the emulator, use trezorctl -p udp (for example, trezorctl -p udp get_features).