15#ifndef ZEPHYR_INCLUDE_DRIVERS_GPIO_H_
16#define ZEPHYR_INCLUDE_DRIVERS_GPIO_H_
40#define GPIO_INT_DEBOUNCE (1U << 8) __DEPRECATED_MACRO
47#define GPIO_DS_LOW_POS 9 __DEPRECATED_MACRO
48#define GPIO_DS_LOW_MASK (0x1U << GPIO_DS_LOW_POS) __DEPRECATED_MACRO
49#define GPIO_DS_HIGH_POS 10 __DEPRECATED_MACRO
50#define GPIO_DS_HIGH_MASK (0x1U << GPIO_DS_HIGH_POS) __DEPRECATED_MACRO
51#define GPIO_DS_MASK (GPIO_DS_LOW_MASK | GPIO_DS_HIGH_MASK) __DEPRECATED_MACRO
53#define GPIO_DS_DFLT_LOW (0x0U << GPIO_DS_LOW_POS) __DEPRECATED_MACRO
54#define GPIO_DS_ALT_LOW (0x1U << GPIO_DS_LOW_POS) __DEPRECATED_MACRO
55#define GPIO_DS_DFLT_HIGH (0x0U << GPIO_DS_HIGH_POS) __DEPRECATED_MACRO
56#define GPIO_DS_ALT_HIGH (0x1U << GPIO_DS_HIGH_POS) __DEPRECATED_MACRO
57#define GPIO_DS_DFLT (GPIO_DS_DFLT_LOW | GPIO_DS_DFLT_HIGH) __DEPRECATED_MACRO
58#define GPIO_DS_ALT (GPIO_DS_ALT_LOW | GPIO_DS_ALT_HIGH) __DEPRECATED_MACRO
67#define GPIO_INPUT (1U << 16)
70#define GPIO_OUTPUT (1U << 17)
73#define GPIO_DISCONNECTED 0
78#define GPIO_OUTPUT_INIT_LOW (1U << 18)
81#define GPIO_OUTPUT_INIT_HIGH (1U << 19)
84#define GPIO_OUTPUT_INIT_LOGICAL (1U << 20)
89#define GPIO_OUTPUT_LOW (GPIO_OUTPUT | GPIO_OUTPUT_INIT_LOW)
91#define GPIO_OUTPUT_HIGH (GPIO_OUTPUT | GPIO_OUTPUT_INIT_HIGH)
93#define GPIO_OUTPUT_INACTIVE (GPIO_OUTPUT | \
94 GPIO_OUTPUT_INIT_LOW | \
95 GPIO_OUTPUT_INIT_LOGICAL)
97#define GPIO_OUTPUT_ACTIVE (GPIO_OUTPUT | \
98 GPIO_OUTPUT_INIT_HIGH | \
99 GPIO_OUTPUT_INIT_LOGICAL)
115#define GPIO_INT_DISABLE (1U << 21)
120#define GPIO_INT_ENABLE (1U << 22)
127#define GPIO_INT_LEVELS_LOGICAL (1U << 23)
136#define GPIO_INT_EDGE (1U << 24)
144#define GPIO_INT_LOW_0 (1U << 25)
152#define GPIO_INT_HIGH_1 (1U << 26)
154#define GPIO_INT_MASK (GPIO_INT_DISABLE | \
156 GPIO_INT_LEVELS_LOGICAL | \
165#define GPIO_INT_EDGE_RISING (GPIO_INT_ENABLE | \
172#define GPIO_INT_EDGE_FALLING (GPIO_INT_ENABLE | \
179#define GPIO_INT_EDGE_BOTH (GPIO_INT_ENABLE | \
187#define GPIO_INT_LEVEL_LOW (GPIO_INT_ENABLE | \
193#define GPIO_INT_LEVEL_HIGH (GPIO_INT_ENABLE | \
199#define GPIO_INT_EDGE_TO_INACTIVE (GPIO_INT_ENABLE | \
200 GPIO_INT_LEVELS_LOGICAL | \
207#define GPIO_INT_EDGE_TO_ACTIVE (GPIO_INT_ENABLE | \
208 GPIO_INT_LEVELS_LOGICAL | \
215#define GPIO_INT_LEVEL_INACTIVE (GPIO_INT_ENABLE | \
216 GPIO_INT_LEVELS_LOGICAL | \
222#define GPIO_INT_LEVEL_ACTIVE (GPIO_INT_ENABLE | \
223 GPIO_INT_LEVELS_LOGICAL | \
229#define GPIO_DIR_MASK (GPIO_INPUT | GPIO_OUTPUT)
336#define GPIO_DT_SPEC_GET_BY_IDX(node_id, prop, idx) \
338 .port = DEVICE_DT_GET(DT_GPIO_CTLR_BY_IDX(node_id, prop, idx)),\
339 .pin = DT_GPIO_PIN_BY_IDX(node_id, prop, idx), \
340 .dt_flags = DT_GPIO_FLAGS_BY_IDX(node_id, prop, idx), \
360#define GPIO_DT_SPEC_GET_BY_IDX_OR(node_id, prop, idx, default_value) \
361 COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop), \
362 (GPIO_DT_SPEC_GET_BY_IDX(node_id, prop, idx)), \
373#define GPIO_DT_SPEC_GET(node_id, prop) \
374 GPIO_DT_SPEC_GET_BY_IDX(node_id, prop, 0)
386#define GPIO_DT_SPEC_GET_OR(node_id, prop, default_value) \
387 GPIO_DT_SPEC_GET_BY_IDX_OR(node_id, prop, 0, default_value)
399#define GPIO_DT_SPEC_INST_GET_BY_IDX(inst, prop, idx) \
400 GPIO_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), prop, idx)
413#define GPIO_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, idx, default_value) \
414 GPIO_DT_SPEC_GET_BY_IDX_OR(DT_DRV_INST(inst), prop, idx, default_value)
424#define GPIO_DT_SPEC_INST_GET(inst, prop) \
425 GPIO_DT_SPEC_INST_GET_BY_IDX(inst, prop, 0)
437#define GPIO_DT_SPEC_INST_GET_OR(inst, prop, default_value) \
438 GPIO_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, 0, default_value)
443#define GPIO_MAX_PINS_PER_PORT (sizeof(gpio_port_pins_t) * __CHAR_BIT__)
530 GPIO_INT_MODE_LEVEL = GPIO_INT_ENABLE,
531 GPIO_INT_MODE_EDGE = GPIO_INT_ENABLE | GPIO_INT_EDGE,
537 GPIO_INT_TRIG_LOW = GPIO_INT_LOW_0,
540 GPIO_INT_TRIG_HIGH = GPIO_INT_HIGH_1,
542 GPIO_INT_TRIG_BOTH = GPIO_INT_LOW_0 | GPIO_INT_HIGH_1,
545__subsystem
struct gpio_driver_api {
548 int (*port_get_raw)(
const struct device *port,
550 int (*port_set_masked_raw)(
const struct device *port,
553 int (*port_set_bits_raw)(
const struct device *port,
555 int (*port_clear_bits_raw)(
const struct device *port,
557 int (*port_toggle_bits)(
const struct device *port,
559 int (*pin_interrupt_configure)(
const struct device *port,
561 enum gpio_int_mode,
enum gpio_int_trig);
562 int (*manage_callback)(
const struct device *port,
596static inline int z_impl_gpio_pin_interrupt_configure(
const struct device *port,
600 const struct gpio_driver_api *api =
601 (
const struct gpio_driver_api *)port->
api;
606 enum gpio_int_trig trig;
607 enum gpio_int_mode mode;
611 "Cannot both enable and disable interrupts");
614 "Must either enable or disable interrupts");
616 __ASSERT(((
flags & GPIO_INT_ENABLE) == 0) ||
617 ((
flags & GPIO_INT_EDGE) != 0) ||
618 ((
flags & (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1)) !=
619 (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1)),
620 "Only one of GPIO_INT_LOW_0, GPIO_INT_HIGH_1 can be "
621 "enabled for a level interrupt.");
623 __ASSERT(((
flags & GPIO_INT_ENABLE) == 0) ||
624 ((
flags & (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1)) != 0),
625 "At least one of GPIO_INT_LOW_0, GPIO_INT_HIGH_1 has to be "
632 if (((
flags & GPIO_INT_LEVELS_LOGICAL) != 0) &&
635 flags ^= (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1);
638 trig = (
enum gpio_int_trig)(
flags & (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1));
641 return api->pin_interrupt_configure(port, pin, mode, trig);
682static inline int z_impl_gpio_pin_configure(
const struct device *port,
686 const struct gpio_driver_api *api =
687 (
const struct gpio_driver_api *)port->
api;
693 __ASSERT((
flags & GPIO_INT_MASK) == 0,
694 "Interrupt flags are not supported");
698 "Pull Up and Pull Down should not be enabled simultaneously");
701 "Output needs to be enabled for 'Open Drain', 'Open Source' "
702 "mode to be supported");
704 __ASSERT_NO_MSG((
flags & GPIO_SINGLE_ENDED) != 0 ||
705 (
flags & GPIO_LINE_OPEN_DRAIN) == 0);
707 __ASSERT((
flags & (GPIO_OUTPUT_INIT_LOW | GPIO_OUTPUT_INIT_HIGH)) == 0
709 "Output needs to be enabled to be initialized low or high");
711 __ASSERT((
flags & (GPIO_OUTPUT_INIT_LOW | GPIO_OUTPUT_INIT_HIGH))
712 != (GPIO_OUTPUT_INIT_LOW | GPIO_OUTPUT_INIT_HIGH),
713 "Output cannot be initialized low and high");
715 if (((
flags & GPIO_OUTPUT_INIT_LOGICAL) != 0)
716 && ((
flags & (GPIO_OUTPUT_INIT_LOW | GPIO_OUTPUT_INIT_HIGH)) != 0)
718 flags ^= GPIO_OUTPUT_INIT_LOW | GPIO_OUTPUT_INIT_HIGH;
721 flags &= ~GPIO_OUTPUT_INIT_LOGICAL;
733 return api->pin_configure(port, pin,
flags);
775static inline int z_impl_gpio_port_get_raw(
const struct device *port,
778 const struct gpio_driver_api *api =
779 (
const struct gpio_driver_api *)port->
api;
781 return api->port_get_raw(port, value);
811 *value ^=
data->invert;
838static inline int z_impl_gpio_port_set_masked_raw(
const struct device *port,
842 const struct gpio_driver_api *api =
843 (
const struct gpio_driver_api *)port->
api;
845 return api->port_set_masked_raw(port, mask, value);
875 value ^=
data->invert;
893static inline int z_impl_gpio_port_set_bits_raw(
const struct device *port,
896 const struct gpio_driver_api *api =
897 (
const struct gpio_driver_api *)port->
api;
899 return api->port_set_bits_raw(port, pins);
931static inline int z_impl_gpio_port_clear_bits_raw(
const struct device *port,
934 const struct gpio_driver_api *api =
935 (
const struct gpio_driver_api *)port->
api;
937 return api->port_clear_bits_raw(port, pins);
969static inline int z_impl_gpio_port_toggle_bits(
const struct device *port,
972 const struct gpio_driver_api *api =
973 (
const struct gpio_driver_api *)port->
api;
975 return api->port_toggle_bits(port, pins);
993 __ASSERT((set_pins & clear_pins) == 0,
"Set and Clear pins overlap");
1013 __ASSERT((set_pins & clear_pins) == 0,
"Set and Clear pins overlap");
1174 value = (value != 0) ? 0 : 1;
1243 __ASSERT(callback,
"Callback pointer should not be NULL");
1244 __ASSERT(
handler,
"Callback handler pointer should not be NULL");
1265 const struct gpio_driver_api *api =
1266 (
const struct gpio_driver_api *)port->
api;
1268 if (api->manage_callback == NULL) {
1272 return api->manage_callback(port, callback,
true);
1294 const struct gpio_driver_api *api =
1295 (
const struct gpio_driver_api *)port->
api;
1297 if (api->manage_callback == NULL) {
1301 return api->manage_callback(port, callback,
false);
1319static inline int z_impl_gpio_get_pending_int(
const struct device *dev)
1321 const struct gpio_driver_api *api =
1322 (
const struct gpio_driver_api *)dev->
api;
1324 if (api->get_pending_int == NULL) {
1328 return api->get_pending_int(dev);
1339#include <syscalls/gpio.h>
static int gpio_add_callback(const struct device *port, struct gpio_callback *callback)
Add an application callback.
Definition: gpio.h:1262
#define GPIO_OUTPUT
Definition: gpio.h:70
static int gpio_pin_get_raw(const struct device *port, gpio_pin_t pin)
Get physical level of an input pin.
Definition: gpio.h:1033
static int gpio_pin_get(const struct device *port, gpio_pin_t pin)
Get logical level of an input pin.
Definition: gpio.h:1071
int gpio_port_set_bits_raw(const struct device *port, gpio_port_pins_t pins)
Set physical level of selected output pins to high.
static int gpio_pin_interrupt_configure_dt(const struct gpio_dt_spec *spec, gpio_flags_t flags)
Configure pin interrupts from a gpio_dt_spec.
Definition: gpio.h:657
void(* gpio_callback_handler_t)(const struct device *port, struct gpio_callback *cb, gpio_port_pins_t pins)
Define the application callback handler function signature.
Definition: gpio.h:486
static int gpio_pin_toggle_dt(const struct gpio_dt_spec *spec)
Toggle pin level from a gpio_dt_spec.
Definition: gpio.h:1228
uint8_t gpio_pin_t
Provides a type to hold a GPIO pin index.
Definition: gpio.h:259
int gpio_get_pending_int(const struct device *dev)
Function to get pending interrupts.
static int gpio_pin_configure_dt(const struct gpio_dt_spec *spec, gpio_flags_t extra_flags)
Configure a single pin from a gpio_dt_spec and some extra flags.
Definition: gpio.h:747
static int gpio_pin_set_dt(const struct gpio_dt_spec *spec, int value)
Set logical level of a output pin from a gpio_dt_spec.
Definition: gpio.h:1191
static int gpio_port_set_bits(const struct device *port, gpio_port_pins_t pins)
Set logical level of selected output pins to active.
Definition: gpio.h:912
uint32_t gpio_flags_t
Provides a type to hold GPIO configuration flags.
Definition: gpio.h:279
#define GPIO_ACTIVE_LOW
Definition: gpio.h:23
static int gpio_port_set_clr_bits_raw(const struct device *port, gpio_port_pins_t set_pins, gpio_port_pins_t clear_pins)
Set physical level of selected output pins.
Definition: gpio.h:989
static int gpio_port_set_clr_bits(const struct device *port, gpio_port_pins_t set_pins, gpio_port_pins_t clear_pins)
Set logical level of selected output pins.
Definition: gpio.h:1009
static void gpio_init_callback(struct gpio_callback *callback, gpio_callback_handler_t handler, gpio_port_pins_t pin_mask)
Helper to initialize a struct gpio_callback properly.
Definition: gpio.h:1239
uint32_t gpio_port_pins_t
Identifies a set of pins associated with a port.
Definition: gpio.h:238
int gpio_port_toggle_bits(const struct device *port, gpio_port_pins_t pins)
Toggle level of selected output pins.
#define GPIO_INT_DISABLE
Definition: gpio.h:115
int gpio_pin_interrupt_configure(const struct device *port, gpio_pin_t pin, gpio_flags_t flags)
Configure pin interrupt.
int gpio_port_clear_bits_raw(const struct device *port, gpio_port_pins_t pins)
Set physical level of selected output pins to low.
int gpio_port_set_masked_raw(const struct device *port, gpio_port_pins_t mask, gpio_port_value_t value)
Set physical level of output pins in a port.
#define GPIO_PULL_UP
Definition: gpio.h:72
static int gpio_pin_get_dt(const struct gpio_dt_spec *spec)
Get logical level of an input pin from a gpio_dt_spec.
Definition: gpio.h:1100
static int gpio_pin_toggle(const struct device *port, gpio_pin_t pin)
Toggle pin level.
Definition: gpio.h:1206
uint32_t gpio_port_value_t
Provides values for a set of pins associated with a port.
Definition: gpio.h:251
static int gpio_pin_set(const struct device *port, gpio_pin_t pin, int value)
Set logical level of an output pin.
Definition: gpio.h:1161
static int gpio_port_clear_bits(const struct device *port, gpio_port_pins_t pins)
Set logical level of selected output pins to inactive.
Definition: gpio.h:950
static int gpio_remove_callback(const struct device *port, struct gpio_callback *callback)
Remove an application callback.
Definition: gpio.h:1291
static int gpio_port_set_masked(const struct device *port, gpio_port_pins_t mask, gpio_port_value_t value)
Set logical level of output pins in a port.
Definition: gpio.h:868
uint16_t gpio_dt_flags_t
Provides a type to hold GPIO devicetree flags.
Definition: gpio.h:271
#define GPIO_PULL_DOWN
Definition: gpio.h:75
static int gpio_pin_set_raw(const struct device *port, gpio_pin_t pin, int value)
Set physical level of an output pin.
Definition: gpio.h:1120
int gpio_port_get_raw(const struct device *port, gpio_port_value_t *value)
Get physical level of all input pins in a port.
static int gpio_port_get(const struct device *port, gpio_port_value_t *value)
Get logical level of all input pins in a port.
Definition: gpio.h:802
int gpio_pin_configure(const struct device *port, gpio_pin_t pin, gpio_flags_t flags)
Configure a single pin.
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition: util_macro.h:44
#define ENOTSUP
Definition: errno.h:115
flags
Definition: http_parser.h:131
static ZTEST_BMEM volatile int ret
Definition: k_float_disable.c:28
Single-linked list implementation.
struct _snode sys_snode_t
Definition: slist.h:33
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition: device.h:456
const void * api
Definition: device.h:462
void *const data
Definition: device.h:466
const void * config
Definition: device.h:460
GPIO callback structure.
Definition: gpio.h:500
sys_snode_t node
Definition: gpio.h:504
gpio_port_pins_t pin_mask
Definition: gpio.h:515
gpio_callback_handler_t handler
Definition: gpio.h:507
gpio_port_pins_t port_pin_mask
Definition: gpio.h:456
gpio_port_pins_t invert
Definition: gpio.h:469
Container for GPIO pin information specified in devicetree.
Definition: gpio.h:293
const struct device * port
Definition: gpio.h:295
gpio_pin_t pin
Definition: gpio.h:297
gpio_dt_flags_t dt_flags
Definition: gpio.h:299
static fdata_t data[2]
Definition: test_fifo_contexts.c:15
static void handler(struct k_timer *timer)
Definition: main.c:19