1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
RIOT/dist/tools/packer
iosabi 7b1f083cd8 esp8266: Download Espressif RTOS SDK as a new RIOT PKG
RIOT-OS uses part of Espressif ESP8266 RTOS SDK to build support for
this CPU. The SDK includes some vendor-provided closed source
pre-compiled libraries that we need to modify to adapt to RIOT-OS
usage. This library modifications was done once and uploaded to a fork
of the vendor repository and was provided as an environment variable.

This patch changes two things:

1. It installs the SDK as a RIOT PKG from the new pkg/esp8266_sdk
directory instead of requiring the user to download it separately.

2. It performs the library modifications (symbol renames) on the pkg
Makefile removing the need to use a fork with the modifications applied
and simplifying the SDK update and future modifications.

This change sets the SDK package version (git SHA) to the same one that
our fork was using as a parent in the vendor repository, meaning that
the output libraries are exactly the same as before.

Tested with
```
ESP8266_RTOS_SDK_DIR=/dev/null USEMODULE=esp_log_startup make -C tests/shell BOARD=esp8266-esp-12x flash
```

and verified that the program works. The boot message now includes:
```
ESP8266-RTOS-SDK Version v3.1-51-g913a06a9
```
confirming the SDK version used.

`/dev/null` in the test is just to make sure that no evaluation of
`ESP8266_RTOS_SDK_DIR` in make is affected by the environment variable
value which would be set to the SDK for people who followed the set up
instructions before this change.

Tested the checkout size:
```bash
$ du -hs build/pkg/esp8266_sdk/
124M	build/pkg/esp8266_sdk/
```
2021-10-23 11:13:38 +00:00
..
http tools/packer: adapt for Ubuntu 18.04 2020-02-19 19:23:07 +01:00
scripts esp8266: Download Espressif RTOS SDK as a new RIOT PKG 2021-10-23 11:13:38 +00:00
udev_rules packer: add dfu-util and bluepill udev rules 2017-11-03 13:44:39 +01:00
.gitignore tools/packer: adapt for Ubuntu 18.04 2020-02-19 19:23:07 +01:00
README.md dist/tools/packer: remove trailing whitespaces from README 2020-12-19 09:58:31 +01:00
riot.json tools/packer: adapt for Ubuntu 18.04 2020-02-19 19:23:07 +01:00
vagrantfile.tpl tools/packer: adapt for Ubuntu 18.04 2020-02-19 19:23:07 +01:00

Packer

About

Packer is a command-line tool to create virtual machines based on a source configuration file.

Requirements

To use packer you need to download and install it (compare Install Packer).

Usage

A simple build of the vagrant box can be done by:

packer build riot.json

This command must be executed in the packer directory RIOT/dist/tools/packer. Note that the build process might take several minutes.