micropython/drivers/esp-hosted
Angus Gratton decf8e6a8b all: Remove the "STATIC" macro and just use "static" instead.
The STATIC macro was introduced a very long time ago in commit
d5df6cd44a.  The original reason for this was
to have the option to define it to nothing so that all static functions
become global functions and therefore visible to certain debug tools, so
one could do function size comparison and other things.

This STATIC feature is rarely (if ever) used.  And with the use of LTO and
heavy inline optimisation, analysing the size of individual functions when
they are not static is not a good representation of the size of code when
fully optimised.

So the macro does not have much use and it's simpler to just remove it.
Then you know exactly what it's doing.  For example, newcomers don't have
to learn what the STATIC macro is and why it exists.  Reading the code is
also less "loud" with a lowercase static.

One other minor point in favour of removing it, is that it stops bugs with
`STATIC inline`, which should always be `static inline`.

Methodology for this commit was:

1) git ls-files | egrep '\.[ch]$' | \
   xargs sed -Ei "s/(^| )STATIC($| )/\1static\2/"

2) Do some manual cleanup in the diff by searching for the word STATIC in
   comments and changing those back.

3) "git-grep STATIC docs/", manually fixed those cases.

4) "rg -t python STATIC", manually fixed codegen lines that used STATIC.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
2024-03-07 14:20:42 +11:00
..
README.md
esp_hosted.proto
esp_hosted_bthci.c
esp_hosted_hal.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
esp_hosted_hal.h
esp_hosted_internal.h
esp_hosted_netif.c drivers/esp-hosted: Fix MTU size. 2023-10-02 14:47:31 +02:00
esp_hosted_netif.h
esp_hosted_stack.h
esp_hosted_wifi.c
esp_hosted_wifi.h

README.md

esp-hosted driver

This is a MicroPython driver for the Espressif esp_hosted communications coprocessor, which allows creating a Wi-Fi and/or Bluetooth interface from MicroPython to a separate connected ESP32 compatible device running the esp_hosted firmware.

Building

Enable this driver by setting MICROPY_PY_NETWORK_ESP_HOSTED to 1 in your Makefile. If MICROPY_PY_BLUETOOTH is set then the Bluetooth host driver will also be built.

In addition to normal MicroPython build requirements, building this driver requires the protocol buffer compiler (protoc) to be installed.

On Debian/Ubuntu, it can be installed by running:

sudo apt-get install protobuf-compiler