Loading...
Searching...
No Matches
gpio_ll_arch.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2023 Gunar Schorcht <gunar@schorcht.net>
3 * SPDX-License-Identifier: LGPL-2.1-only
4 */
5
6#pragma once
7
18
19#include "architecture.h"
20#include "periph_cpu.h"
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26#ifndef DOXYGEN /* hide implementation specific details from Doxygen */
27
31#define GPIO_PORT_NUMOF 5
32
33#define GPIO_PORT_NUMBERING_ALPHABETIC 1
34
35#ifdef GPIOA_BASE
36# define GPIO_PORT_0 GPIOA_BASE
37#endif
38
39#ifdef GPIOB_BASE
40# define GPIO_PORT_1 GPIOB_BASE
41#endif
42
43#ifdef GPIOC_BASE
44# define GPIO_PORT_2 GPIOC_BASE
45#endif
46
47#ifdef GPIOD_BASE
48# define GPIO_PORT_3 GPIOD_BASE
49#endif
50
51#ifdef GPIOE_BASE
52# define GPIO_PORT_4 GPIOE_BASE
53#endif
54
55#ifdef GPIOF_BASE
56# define GPIO_PORT_5 GPIOF_BASE
57#endif
58
59#ifdef GPIOG_BASE
60# define GPIO_PORT_6 GPIOG_BASE
61#endif
62
63#ifdef GPIOH_BASE
64# define GPIO_PORT_7 GPIOH_BASE
65#endif
66
67#ifdef GPIOI_BASE
68# define GPIO_PORT_8 GPIOI_BASE
69#endif
70
71#ifdef GPIOJ_BASE
72# define GPIO_PORT_9 GPIOJ_BASE
73#endif
74
75#ifdef GPIOK_BASE
76# define GPIO_PORT_10 GPIOK_BASE
77#endif
78
79static inline gpio_port_t gpio_port(uword_t num)
80{
81#if defined(CPU_FAM_STM32MP1)
82 return GPIOA_BASE + (num << 12);
83#else
84 return GPIOA_BASE + (num << 10);
85#endif
86}
87
88static inline uword_t gpio_port_num(gpio_port_t port)
89{
90#if defined(CPU_FAM_STM32MP1)
91 return (port - GPIOA_BASE) >> 12;
92#else
93 return (port - GPIOA_BASE) >> 10;
94#endif
95}
96
97static inline uword_t gpio_ll_read(gpio_port_t port)
98{
99 return ((GPIO_Type *)port)->ISTAT;
100}
101
102static inline uword_t gpio_ll_read_output(gpio_port_t port)
103{
104 return ((GPIO_Type *)port)->OCTL;
105}
106
107static inline void gpio_ll_set(gpio_port_t port, uword_t mask)
108{
109 ((GPIO_Type *)port)->BOP = mask;
110}
111
112static inline void gpio_ll_clear(gpio_port_t port, uword_t mask)
113{
114 ((GPIO_Type *)port)->BOP = mask << 16;
115}
116
117static inline void gpio_ll_toggle(gpio_port_t port, uword_t mask)
118{
119 unsigned irq_state = irq_disable();
120 ((GPIO_Type *)port)->OCTL ^= mask;
121 irq_restore(irq_state);
122}
123
124static inline void gpio_ll_write(gpio_port_t port, uword_t value)
125{
126 ((GPIO_Type *)port)->OCTL = value;
127}
128
129static inline gpio_port_t gpio_get_port(gpio_t pin)
130{
131 return pin & 0xfffffff0UL;
132}
133
134static inline uint8_t gpio_get_pin_num(gpio_t pin)
135{
136 return pin & 0xfUL;
137}
138
139static inline gpio_port_t gpio_port_pack_addr(void *addr)
140{
141 return (gpio_port_t)addr;
142}
143
144static inline void * gpio_port_unpack_addr(gpio_port_t port)
145{
146 if (port < GPIOA_BASE) {
147 return (void *)port;
148 }
149
150 return NULL;
151}
152
153static inline bool is_gpio_port_num_valid(uint_fast8_t num)
154{
155 return num < GPIO_PORT_NUMOF;
156}
157
158#endif /* DOXYGEN */
159
160#ifdef __cplusplus
161}
162#endif
163
Platform-independent access to architecture details.
CPU specific definitions for internal peripheral handling.
MAYBE_INLINE void irq_restore(unsigned state)
This function restores the IRQ disable bit in the status register to the value contained within passe...
MAYBE_INLINE unsigned irq_disable(void)
This function sets the IRQ disable bit in the status register.
static uint8_t gpio_get_pin_num(gpio_t pin)
Extract the pin number from a gpio_t
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_port_t gpio_port(uword_t num)
Get the gpio_port_t value of the port number num.
static gpio_port_t gpio_port_pack_addr(void *addr)
Pack a pointer into a gpio_port_t.
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
uword_t gpio_port_num(gpio_port_t port)
Get the number of the GPIO port port refers to.
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.
uintptr_t gpio_port_t
GPIO port type.
Definition gpio_ll.h:95
uint< NUM > _t uword_t
Word sized unsigned integer.