2016-05-11 19:07:56 +00:00
# TREZOR 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
2016-05-11 19:07:56 +00:00
## How to build TREZOR 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`
2017-07-24 17:44:10 +00:00
4. `./build-firmware.sh TAG` (where TAG is v1.5.0 for example, if left blank the script builds latest commit in master branch)
2015-08-05 14:38:53 +00:00
2017-07-24 17:44:10 +00:00
This creates file `build/trezor-TAG.bin` and prints its fingerprint and size at the end of the build log.
2015-08-05 14:38:53 +00:00
2016-05-11 19:07:56 +00:00
## How to build TREZOR bootloader?
2016-02-18 23:24:33 +00:00
2017-12-18 18:38:34 +00:00
1. [Install Docker ](https://docs.docker.com/engine/installation/ )
2016-02-18 23:24:33 +00:00
2. `git clone https://github.com/trezor/trezor-mcu.git`
3. `cd trezor-mcu`
2017-07-24 17:44:10 +00:00
4. `./build-bootloader.sh TAG` (where TAG is bl1.3.2 for example, if left blank the script builds latest commit in master branch)
2016-02-18 23:24:33 +00:00
2017-07-24 17:44:10 +00:00
This creates file `build/bootloader-TAG.bin` and prints its fingerprint and size at the end of the build log.
2016-02-18 23:24:33 +00:00
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
2017-01-10 14:14:29 +00:00
1. Pick version of firmware binary listed on https://wallet.trezor.io/data/firmware/releases.json
2. Download it: `wget -O trezor.signed.bin https://wallet.trezor.io/data/firmware/trezor-1.3.6.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` .
