69#ifndef PERIPH_GPIO_LL_H
70#define PERIPH_GPIO_LL_H
78#include "periph_cpu.h"
89#if !defined(GPIO_PORT_UNDEF) || defined(DOXYGEN)
93#define GPIO_PORT_UNDEF UINTPTR_MAX
106#define GPIO_PORT(num) implementation_specific
126#define GPIO_PORT_NUM(port) implementation_specific
129#if !defined(HAVE_GPIO_STATE_T) || defined(DOXYGEN)
221#if !defined(HAVE_GPIO_PULL_T) || defined(DOXYGEN)
234#if !defined(HAVE_GPIO_PULL_STRENGTH_T) || defined(DOXYGEN)
261#define GPIO_PULL_NUMOF (1U + (GPIO_PULL_WEAKEST != GPIO_PULL_WEAK) \
262 + (GPIO_PULL_WEAK != GPIO_PULL_STRONG) \
263 + (GPIO_PULL_STRONG != GPIO_PULL_STRONGEST))
265#if !defined(HAVE_GPIO_DRIVE_STRENGTH_T) || defined(DOXYGEN)
290#define GPIO_DRIVE_NUMOF (1U + (GPIO_DRIVE_WEAKEST != GPIO_DRIVE_WEAK) \
291 + (GPIO_DRIVE_WEAK != GPIO_DRIVE_STRONG) \
292 + (GPIO_DRIVE_STRONG != GPIO_DRIVE_STRONGEST))
294#if !defined(HAVE_GPIO_SLEW_T) || defined(DOXYGEN)
325#define GPIO_SLEW_NUMOF (1U + (GPIO_SLEW_SLOWEST != GPIO_SLEW_SLOW) \
326 + (GPIO_SLEW_SLOW != GPIO_SLEW_FAST) \
327 + (GPIO_SLEW_FAST != GPIO_SLEW_FASTEST))
375#if !defined(HAVE_GPIO_CONF_T) && !defined(DOXYGEN)
462 .initial_value =
false,
474 .initial_value =
true,
487 .initial_value =
true,
657#if defined(DOXYGEN) || !defined(HAVE_GPIO_LL_PREPARE_WRITE_ALL_PINS)
688#if defined(DOXYGEN) || !defined(HAVE_GPIO_LL_PREPARE_WRITE)
831#if !MODULE_PERIPH_GPIO_LL_SWITCH_DIR
847 extern void gpio_ll_switch_dir_output_used_but_feature_gpio_ll_switch_dir_is_not_provided(
void);
848 gpio_ll_switch_dir_output_used_but_feature_gpio_ll_switch_dir_is_not_provided();
856 extern void gpio_ll_switch_dir_input_used_but_feature_gpio_ll_switch_dir_is_not_provided(
void);
857 gpio_ll_switch_dir_input_used_but_feature_gpio_ll_switch_dir_is_not_provided();
869#include "gpio_ll_arch.h"
Platform-independent access to architecture details.
POSIX.1-2008 compliant version of the assert macro.
Low-level GPIO peripheral driver interface definitions.
static const gpio_conf_t gpio_ll_in_pk
A standard configuration for a generic input pin with pull resistor to keep signal at bus level.
static uint8_t gpio_get_pin_num(gpio_t pin)
Extract the pin number from a gpio_t
static void gpio_ll_switch_dir_output(gpio_port_t port, uword_t outputs)
Turn GPIO pins specified by the bitmask outputs to outputs.
static void gpio_ll_set(gpio_port_t port, uword_t mask)
Perform an reg |= mask operation on the I/O register of the port.
gpio_pull_t
Enumeration of pull resistor configurations.
static void gpio_ll_switch_dir_input(gpio_port_t port, uword_t inputs)
Turn GPIO pins specified by the bitmask inputs to inputs.
gpio_pull_strength_t
Enumeration of pull resistor values.
static const gpio_conf_t gpio_ll_in_pd
A standard configuration for a generic input pin with pull down resistor.
static const gpio_conf_t gpio_ll_out
A standard configuration for a generic push-pull output pin.
gpio_state_t
Enumeration of GPIO states (direction)
gpio_slew_t
Enumeration of slew rate settings.
int gpio_ll_init(gpio_port_t port, uint8_t pin, gpio_conf_t conf)
Initialize the given GPIO pin as specified.
static uword_t gpio_ll_prepare_write(gpio_port_t port, uword_t mask, uword_t value)
Helper to use gpio_ll_write side-effect free.
static gpio_port_t gpio_port_pack_addr(void *addr)
Pack a pointer into a gpio_port_t.
gpio_conf_t gpio_ll_query_conf(gpio_port_t port, uint8_t pin)
Retrieve the current configuration of a GPIO pin.
void gpio_ll_print_conf_common(const gpio_conf_t conf)
INTERNAL, use gpio_ll_print_conf instead.
gpio_drive_strength_t
Enumeration of drive strength options.
static const gpio_conf_t gpio_ll_in_pu
A standard configuration for a generic input pin with pull up resistor.
static uword_t gpio_ll_read(gpio_port_t port)
Get the current input value of all GPIO pins of the given port as bitmask.
static gpio_port_t gpio_get_port(gpio_t pin)
Extract the gpio_port_t from a gpio_t
static uword_t gpio_ll_prepare_write_all_outputs(gpio_port_t port, uword_t value)
Same as gpio_ll_prepare_write(port, UWORD_MAX, value), but faster.
typedef gpio_conf_t
GPIO pin configuration.
static const gpio_conf_t gpio_ll_in
A standard configuration for a generic floating input pin.
static const gpio_conf_t gpio_ll_od_pu
A standard configuration for a generic open drain output with pull up.
static void * gpio_port_unpack_addr(gpio_port_t port)
Extract a data pointer that was packed by gpio_port_pack_addr.
static bool is_gpio_port_num_valid(uint_fast8_t num)
Check if the given number is a valid argument for GPIO_PORT.
static uword_t gpio_ll_read_output(gpio_port_t port)
Get the current output value of all GPIO pins of the given port as bitmask.
static void gpio_ll_clear(gpio_port_t port, uword_t mask)
Perform an reg &= ~mask operation on the I/O register of the port.
static void gpio_ll_toggle(gpio_port_t port, uword_t mask)
Perform an reg ^= mask operation on the I/O register of the port.
static void gpio_ll_write(gpio_port_t port, uword_t state)
Perform a masked write operation on the I/O register of the port.
static const gpio_conf_t gpio_ll_od
A standard configuration for a generic floating open drain output.
uintptr_t gpio_port_t
GPIO port type.
void gpio_ll_print_conf(const gpio_conf_t conf)
Utility function to print a given GPIO configuration to stdio.
@ GPIO_FLOATING
No pull ups nor pull downs enabled.
@ GPIO_PULL_KEEP
Keep the signal at current logic level with pull up/down resistors.
@ GPIO_PULL_DOWN
Pull down resistor enabled.
@ GPIO_PULL_UP
Pull up resistor enabled.
@ GPIO_PULL_WEAKEST
Use the weakest (highest Ohm value) resistor.
@ GPIO_PULL_WEAK
Use a weak pull resistor.
@ GPIO_PULL_STRONG
Use a strong pull resistor.
@ GPIO_PULL_STRONGEST
Use the strongest pull resistor.
@ GPIO_OUTPUT_OPEN_SOURCE
Use pin as output in open emitter configuration.
@ GPIO_USED_BY_PERIPHERAL
The GPIO pin is used by a peripheral.
@ GPIO_OUTPUT_OPEN_DRAIN
Use pin as output in open collector configuration.
@ GPIO_OUTPUT_PUSH_PULL
Use pin as output in push-pull configuration.
@ GPIO_DISCONNECT
Disconnect pin from all peripherals.
@ GPIO_INPUT
Use pin as input.
@ GPIO_SLEW_SLOWEST
let the output voltage level rise/fall as slow as possible
@ GPIO_SLEW_FAST
let the output voltage level rise/fall fast
@ GPIO_SLEW_SLOW
let the output voltage level rise/fall slowly
@ GPIO_SLEW_FASTEST
let the output voltage level rise/fall as fast as possible
@ GPIO_DRIVE_STRONG
Use a strong drive strength.
@ GPIO_DRIVE_WEAK
Use a weak drive strength.
@ GPIO_DRIVE_STRONGEST
Use the strongest drive strength.
@ GPIO_DRIVE_WEAKEST
Use the weakest drive strength.
uint< NUM > _t uword_t
Word sized unsigned integer.
Public members of gpio_conf_t
uint8_t bits
The raw bits of the configuration.
gpio_pull_t pull
Pull resistor configuration.
bool initial_value
Initial value of the output.
gpio_state_t state
State of the pin.