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	drivers: Add driver for CYW43xx WiFi SoCs.	2019-06-03 16:47:35 +10:00
cywbt.c	all: Remove the "STATIC" macro and just use "static" instead.	2024-03-07 14:20:42 +11:00

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 drivers: Add driver for CYW43xx WiFi SoCs. 2019-06-03 16:47:35 +10:00

cywbt.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00

README.md

CYW43xx WiFi SoC driver

This is a driver for the CYW43xx WiFi SoC.

There are four layers to the driver:

SDIO bus interface, provided by the host device/system.
Low-level CYW43xx interface, managing the bus, control messages, Ethernet frames and asynchronous events. Includes download of SoC firmware. The header file cyw43_ll.h defines the interface to this layer.
Mid-level CYW43xx control, to control and set WiFi parameters and manage events. See cyw43_ctrl.c.
TCP/IP bindings to lwIP. See cyw43_lwip.c.