1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/cpu/nrf5x_common/include
Marian Buschsieweke 36e8526046
drivers/periph_gpio_ll: change API to access GPIO ports
The API was based on the assumption that GPIO ports are mapped in memory
sanely, so that a `GPIO_PORT(num)` macro would work allow for constant
folding when `num` is known and still be efficient when it is not.

Some MCUs, however, will need a look up tables to efficiently translate
GPIO port numbers to the port's base address. This will prevent the use
of such a `GPIO_PORT(num)` macro in constant initializers.

As a result, we rather provide `GPIO_PORT_0`, `GPIO_PORT_1`, etc. macros
for each GPIO port present (regardless of MCU naming scheme), as well as
`GPIO_PORT_A`, `GPIO_PORT_B`, etc. macros if (and only if) the MCU port
naming scheme uses letters rather than numbers.

These can be defined as macros to the peripheral base address even when
those are randomly mapped into the address space. In addition, a C
function `gpio_port()` replaces the role of the `GPIO_PORT()` and
`gpio_port_num()` the `GPIO_PORT_NUM()` macro. Those functions will
still be implemented as efficient as possible and will allow constant
folding where it was formerly possible. Hence, there is no downside for
MCUs with sane peripheral memory mapping, but it is highly beneficial
for the crazy ones.

There are also two benefits for the non-crazy MCUs:
1. We can now test for valid port numbers with `#ifdef GPIO_PORT_<NUM>`
    - This directly benefits the test in `tests/periph/gpio_ll`, which
      can now provide a valid GPIO port for each and every board
    - Writing to invalid memory mapped I/O addresses was treated as
      triggering undefined behavior by the compiler and used as a
      optimization opportunity
2. We can now detect at compile time if the naming scheme of the MCU
   uses letters or numbers, and produce more user friendly output.
    - This is directly applied in the test app
2024-08-02 09:55:24 +02:00
..
gpio_ll_arch.h drivers/periph_gpio_ll: change API to access GPIO ports 2024-08-02 09:55:24 +02:00
nrf_clock.h cpu/nrf5x: allow to request/release HFXO clk src 2021-01-29 11:10:15 +01:00
nrfble.h cpu/nrf5x: added nrfble radio driver 2018-04-06 11:18:53 +02:00
nrfmin_gnrc.h netdev2: rename to netdev and remove gnrc_netdev 2017-03-15 09:31:20 +01:00
nrfmin.h treewide: Remove excessive newlines 2021-08-13 19:50:38 +02:00
nrfusb.h cpu/nrf5x_common: move usbdev driver to nrf5x_common 2023-07-07 10:53:55 +02:00
nrfx_riot.h pkg: add nrfx as package 2022-06-02 14:59:50 +02:00
periph_cpu_common.h drivers/periph/gpio_ll: shrink gpio_conf_t 2024-01-21 08:38:40 +01:00
timer_arch.h drivers/periph: Add timer_poll feature and timer_poll_channel function 2023-12-19 11:13:41 +01:00