mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
36e8526046
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
164 lines
3.3 KiB
C
164 lines
3.3 KiB
C
/*
|
|
* Copyright (C) 2021 Gunar Schorcht
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup cpu_esp32
|
|
* @ingroup drivers_periph_gpio_ll
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief CPU specific part of the Peripheral GPIO Low-Level API
|
|
*
|
|
* @author Gunar Schorcht <gunar@schorcht.net>
|
|
* @}
|
|
*/
|
|
|
|
#ifndef GPIO_LL_ARCH_H
|
|
#define GPIO_LL_ARCH_H
|
|
|
|
#include "gpio_arch.h"
|
|
#include "irq.h"
|
|
#include "soc/gpio_reg.h"
|
|
#include "soc/soc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef DOXYGEN /* hide implementation specific details from Doxygen */
|
|
|
|
static inline gpio_port_t gpio_port(uword_t num)
|
|
{
|
|
return num;
|
|
}
|
|
|
|
static inline uword_t gpio_port_num(gpio_port_t port)
|
|
{
|
|
if (GPIO_PORT_NUMOF == 1) {
|
|
return 0;
|
|
}
|
|
|
|
return port;
|
|
}
|
|
|
|
static inline uword_t gpio_ll_read(gpio_port_t port)
|
|
{
|
|
static_assert(GPIO_PORT_NUMOF < 3);
|
|
volatile uword_t *in = (uint32_t *)GPIO_IN_REG;
|
|
/* return 0 for unconfigured pins, the current level at the pin otherwise */
|
|
#if GPIO_PORT_NUM > 1
|
|
if (gpio_port_num(port) != 0) {
|
|
in = (uint32_t *)GPIO_IN1_REG;
|
|
}
|
|
#endif
|
|
|
|
return *in;
|
|
}
|
|
|
|
static inline uword_t gpio_ll_read_output(gpio_port_t port)
|
|
{
|
|
static_assert(GPIO_PORT_NUMOF < 3);
|
|
volatile uword_t *out = (uint32_t *)GPIO_OUT_REG;
|
|
#if GPIO_PORT_NUM > 1
|
|
if (gpio_port_num(port) != 0) {
|
|
out = (uint32_t *)GPIO_OUT1_REG;
|
|
}
|
|
#endif
|
|
|
|
return *out;
|
|
}
|
|
|
|
static inline void gpio_ll_set(gpio_port_t port, uword_t mask)
|
|
{
|
|
static_assert(GPIO_PORT_NUMOF < 3);
|
|
volatile uword_t *out_w1ts = (uint32_t *)GPIO_OUT_W1TS_REG;
|
|
if (gpio_port_num(port) != 0) {
|
|
#if GPIO_PORT_NUM > 1
|
|
out_w1ts = (uint32_t)GPIO_OUT1_W1TS;
|
|
#endif
|
|
}
|
|
|
|
*out_w1ts = mask;
|
|
}
|
|
|
|
static inline void gpio_ll_clear(gpio_port_t port, uword_t mask)
|
|
{
|
|
static_assert(GPIO_PORT_NUMOF < 3);
|
|
volatile uword_t *out_w1tc = (uint32_t *)GPIO_OUT_W1TC_REG;
|
|
if (gpio_port_num(port) != 0) {
|
|
#if GPIO_PORT_NUM > 1
|
|
out_w1tc = (uint32_t)GPIO_OUT1_W1TC;
|
|
#endif
|
|
}
|
|
|
|
*out_w1tc = mask;
|
|
}
|
|
|
|
static inline void gpio_ll_toggle(gpio_port_t port, uword_t mask)
|
|
{
|
|
static_assert(GPIO_PORT_NUMOF < 3);
|
|
volatile uword_t *out = (uint32_t *)GPIO_OUT_REG;
|
|
#if GPIO_PORT_NUM > 1
|
|
if (gpio_port_num(port) != 0) {
|
|
out = (uint32_t *)GPIO_OUT1_REG;
|
|
}
|
|
#endif
|
|
unsigned irq_state = irq_disable();
|
|
*out ^= mask;
|
|
irq_restore(irq_state);
|
|
}
|
|
|
|
static inline void gpio_ll_write(gpio_port_t port, uword_t value)
|
|
{
|
|
static_assert(GPIO_PORT_NUMOF < 3);
|
|
volatile uword_t *out = (uint32_t *)GPIO_OUT_REG;
|
|
#if GPIO_PORT_NUM > 1
|
|
if (gpio_port_num(port) != 0) {
|
|
out = (uint32_t *)GPIO_OUT1_REG;
|
|
}
|
|
#endif
|
|
*out = value;
|
|
}
|
|
|
|
static inline gpio_port_t gpio_get_port(gpio_t pin)
|
|
{
|
|
return gpio_port(pin >> 5);
|
|
}
|
|
|
|
static inline uint8_t gpio_get_pin_num(gpio_t pin)
|
|
{
|
|
return pin & 0x1f;
|
|
}
|
|
|
|
static inline gpio_port_t gpio_port_pack_addr(void *addr)
|
|
{
|
|
return (gpio_port_t)addr;
|
|
}
|
|
|
|
static inline void * gpio_port_unpack_addr(gpio_port_t port)
|
|
{
|
|
if (port <= 1) {
|
|
return NULL;
|
|
}
|
|
|
|
return (void *)port;
|
|
}
|
|
|
|
static inline bool is_gpio_port_num_valid(uint_fast8_t num)
|
|
{
|
|
return (num < GPIO_PORT_NUMOF);
|
|
}
|
|
|
|
#endif /* DOXYGEN */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* GPIO_LL_ARCH_H */
|