2018-04-08 00:13:46 +00:00
# TREZOR One Bootloader and Firmware
2015-08-05 14:38:53 +00:00
2016-05-11 19:07:56 +00:00
[](https://travis-ci.org/trezor/trezor-mcu) [](https://gitter.im/trezor/community)
2015-08-05 14:38:53 +00:00
2017-01-10 14:14:29 +00:00
https://trezor.io/
2015-08-05 14:38:53 +00:00
2018-04-08 00:13:46 +00:00
## How to build the TREZOR bootloader and firmware?
2015-08-05 14:38:53 +00:00
2017-12-18 18:38:34 +00:00
1. [Install Docker ](https://docs.docker.com/engine/installation/ )
2015-08-05 14:38:53 +00:00
2. `git clone https://github.com/trezor/trezor-mcu.git`
3. `cd trezor-mcu`
2018-04-08 00:13:46 +00:00
4. `./build.sh BOOTLOADER_TAG FIRMWARE_TAG` (where BOOTLOADER_TAG is bl1.5.0 and FIRMWARE_TAG is v1.7.0 for example, if left blank the script builds latest commit in master branch)
2015-08-05 14:38:53 +00:00
2018-04-08 00:13:46 +00:00
This creates the files `build/bootloader-BOOTLOADER_TAG.bin` and `build/trezor-FIRMWARE_TAG.bin` and prints their fingerprints and sizes at the end of the build log.
2015-08-05 14:38:53 +00:00
2018-02-18 22:13:40 +00:00
## How to build TREZOR emulator for Linux?
1. [Install Docker ](https://docs.docker.com/engine/installation/ )
2. `git clone https://github.com/trezor/trezor-mcu.git`
3. `cd trezor-mcu`
4. `./build-emulator.sh TAG` (where TAG is v1.5.0 for example, if left blank the script builds latest commit in master branch)
This creates binary file `build/trezor-emulator-TAG` , which can be run and works as a trezor emulator. (Use `TREZOR_OLED_SCALE` env. variable to make screen bigger.)
2016-05-11 19:07:56 +00:00
## How to get fingerprint of firmware signed and distributed by SatoshiLabs?
2015-08-05 14:38:53 +00:00
2018-03-22 19:23:56 +00:00
1. Pick version of firmware binary listed on https://wallet.trezor.io/data/firmware/1/releases.json
2018-03-22 19:26:44 +00:00
2. Download it: `wget -O trezor.signed.bin https://wallet.trezor.io/data/firmware/1/trezor-1.6.1.bin`
2017-07-24 17:44:10 +00:00
3. Compute fingerprint: `tail -c +257 trezor.signed.bin | sha256sum`
2015-08-05 14:38:53 +00:00
2017-07-24 17:44:10 +00:00
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.
2017-12-10 22:40:06 +00:00
## 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!**
2017-12-18 18:38:34 +00:00
1. Install python-trezor: `pip install trezor` ([more info](https://github.com/trezor/python-trezor))
2017-12-10 22:40:06 +00:00
2. `trezorctl firmware_update -f build/trezor-TAG.bin`
2017-12-18 18:38:42 +00:00
## Building for development
If you want to build device firmware, make sure you have the
[GNU ARM Embedded toolchain ](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads ) installed.
* 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
1. To initialize the repository, run `script/setup`
2. To build the firmware or emulator, 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 -t udp` (for example, `trezorctl -t udp get_features` ).
If `trezorctl -t udp` appears to hang, make sure you have run `export TREZOR_TRANSPORT_V1=1` .
