2017-11-05 03:00:05 +00:00
|
|
|
# Build instructions
|
|
|
|
|
|
|
|
|
|
## Build instructions for Emulator (Unix port)
|
|
|
|
|
|
|
|
|
|
Run the following to checkout the project:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
git clone --recursive https://github.com/trezor/trezor-core.git
|
|
|
|
|
cd trezor-core
|
|
|
|
|
```
|
|
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
If you are building from an existing checkout, don't forget to use the following to refresh the submodules:
|
2018-03-02 15:36:19 +00:00
|
|
|
|
|
|
|
|
```sh
|
2018-03-05 12:08:42 +00:00
|
|
|
make vendor
|
2018-03-02 15:36:19 +00:00
|
|
|
```
|
|
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
Install the required packages, depending on your operating system.
|
|
|
|
|
* __Debian/Ubuntu__:
|
|
|
|
|
```sh
|
|
|
|
|
sudo dpkg --add-architecture i386
|
|
|
|
|
sudo apt-get update
|
|
|
|
|
sudo apt-get install scons libsdl2-dev:i386 libsdl2-image-dev:i386 gcc-multilib
|
|
|
|
|
```
|
|
|
|
|
* __Fedora__:
|
|
|
|
|
```sh
|
|
|
|
|
sudo yum install scons SDL2-devel.i686 SDL2_image-devel.i686
|
|
|
|
|
```
|
|
|
|
|
* __OpenSUSE__:
|
|
|
|
|
```sh
|
|
|
|
|
sudo zypper install scons libSDL2-devel-32bit libSDL2_image-devel-32bit
|
|
|
|
|
```
|
|
|
|
|
* __Arch__:
|
|
|
|
|
```sh
|
|
|
|
|
sudo pacman -S gcc-multilib scons lib32-sdl2 lib32-sdl2_image
|
|
|
|
|
```
|
|
|
|
|
* __Mac OS X__:
|
|
|
|
|
```sh
|
|
|
|
|
brew install scons sdl2 sdl2_image
|
|
|
|
|
```
|
|
|
|
|
* __Windows__: not supported yet, sorry.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Run the build with:
|
2017-11-05 03:00:05 +00:00
|
|
|
```sh
|
|
|
|
|
make build_unix
|
|
|
|
|
```
|
|
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
Now you can start the emulator:
|
2017-11-05 03:00:05 +00:00
|
|
|
```sh
|
2018-05-04 14:56:32 +00:00
|
|
|
./emu.sh
|
2017-11-05 03:00:05 +00:00
|
|
|
```
|
|
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
## Build instructions for Embedded (ARM port)
|
2017-11-05 03:00:05 +00:00
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
### Requirements
|
2017-11-05 03:00:05 +00:00
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
You will need the GCC ARM toolchain for building and OpenOCD for flashing to a device.
|
|
|
|
|
You will also need Python dependencies for signing.
|
2017-11-05 03:00:05 +00:00
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
#### Debian/Ubuntu
|
2017-11-05 03:00:05 +00:00
|
|
|
|
|
|
|
|
```sh
|
2018-05-04 14:56:32 +00:00
|
|
|
sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi
|
2017-11-05 03:00:05 +00:00
|
|
|
```
|
|
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
#### OS X
|
2017-11-05 03:00:05 +00:00
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
1. Download [gcc-arm-none-eabi](https://launchpad.net/gcc-arm-embedded/5.0/5-2016-q3-update/)
|
|
|
|
|
2. Follow the [install instructions](https://launchpadlibrarian.net/287100883/readme.txt)
|
|
|
|
|
3. To install OpenOCD, run `brew install open-ocd`
|
|
|
|
|
4. Run `make vendor build_boardloader build_bootloader build_firmware`
|
2017-11-05 03:00:05 +00:00
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
### Building
|
2017-11-05 03:00:05 +00:00
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
```sh
|
|
|
|
|
sudo pip3 install pipenv
|
|
|
|
|
pipenv install
|
|
|
|
|
pipenv run make vendor build_boardloader build_bootloader build_firmware
|
2017-11-05 03:00:05 +00:00
|
|
|
```
|
|
|
|
|
|
2018-05-04 14:56:32 +00:00
|
|
|
### Flashing
|
2017-11-05 03:00:05 +00:00
|
|
|
|
|
|
|
|
For flashing firmware to blank device (without bootloader) use `make flash`,
|
|
|
|
|
or `make flash STLINK_VER=v2-1` if using a ST-LINK/V2.1 interface.
|
|
|
|
|
You need to have OpenOCD installed.
|
