[riot-notifications] [RIOT-OS/RIOT] esp8266: Download Espressif RTOS SDK as a new RIOT PKG (#16425)

iosabi notifications at github.com
Sat May 1 19:17:16 CEST 2021


### Contribution description

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. 

### Testing procedure
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/
```

### Issues/PRs references

This is relate to issue #16402 and would simplify updating the SDK to fix it.
You can view, comment on, or merge this pull request online at:

  https://github.com/RIOT-OS/RIOT/pull/16425

-- Commit Summary --

  * esp8266: Download Espressif RTOS SDK as a new RIOT PKG

-- File Changes --

    M cpu/esp8266/Makefile.dep (3)
    M cpu/esp8266/Makefile.include (17)
    M cpu/esp8266/doc.txt (29)
    M cpu/esp8266/include/sdk_conf.h (4)
    M cpu/esp8266/vendor/esp-idf/wpa_supplicant/src/crypto/Makefile (19)
    M cpu/esp_common/Makefile.include (3)
    M cpu/esp_common/lib_printf.c (3)
    M dist/tools/packer/scripts/toolchains.sh (15)
    A pkg/esp8266_sdk/Makefile (40)
    A pkg/esp8266_sdk/Makefile.include (17)
    A pkg/esp8266_sdk/doc.txt (6)
    A pkg/esp8266_sdk/symbol_renames.txt (25)

-- Patch Links --

https://github.com/RIOT-OS/RIOT/pull/16425.patch
https://github.com/RIOT-OS/RIOT/pull/16425.diff

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/16425
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20210501/a098ab40/attachment-0001.htm>


More information about the notifications mailing list