15#ifndef ZEPHYR_INCLUDE_DRIVERS_GPIO_H_ 
   16#define ZEPHYR_INCLUDE_DRIVERS_GPIO_H_ 
   45#define GPIO_INPUT              (1U << 16) 
   48#define GPIO_OUTPUT             (1U << 17) 
   51#define GPIO_DISCONNECTED       0 
   56#define GPIO_OUTPUT_INIT_LOW    (1U << 18) 
   59#define GPIO_OUTPUT_INIT_HIGH   (1U << 19) 
   62#define GPIO_OUTPUT_INIT_LOGICAL (1U << 20) 
   67#define GPIO_OUTPUT_LOW         (GPIO_OUTPUT | GPIO_OUTPUT_INIT_LOW) 
   69#define GPIO_OUTPUT_HIGH        (GPIO_OUTPUT | GPIO_OUTPUT_INIT_HIGH) 
   71#define GPIO_OUTPUT_INACTIVE    (GPIO_OUTPUT |                  \ 
   72                                 GPIO_OUTPUT_INIT_LOW |         \ 
   73                                 GPIO_OUTPUT_INIT_LOGICAL) 
   75#define GPIO_OUTPUT_ACTIVE      (GPIO_OUTPUT |                  \ 
   76                                 GPIO_OUTPUT_INIT_HIGH |        \ 
   77                                 GPIO_OUTPUT_INIT_LOGICAL) 
   93#define GPIO_INT_DISABLE               (1U << 21) 
   98#define GPIO_INT_ENABLE                (1U << 22) 
  105#define GPIO_INT_LEVELS_LOGICAL        (1U << 23) 
  114#define GPIO_INT_EDGE                  (1U << 24) 
  122#define GPIO_INT_LOW_0                 (1U << 25) 
  130#define GPIO_INT_HIGH_1                (1U << 26) 
  132#define GPIO_INT_MASK                  (GPIO_INT_DISABLE | \ 
  134                                        GPIO_INT_LEVELS_LOGICAL | \ 
  143#define GPIO_INT_EDGE_RISING           (GPIO_INT_ENABLE | \ 
  150#define GPIO_INT_EDGE_FALLING          (GPIO_INT_ENABLE | \ 
  157#define GPIO_INT_EDGE_BOTH             (GPIO_INT_ENABLE | \ 
  165#define GPIO_INT_LEVEL_LOW             (GPIO_INT_ENABLE | \ 
  171#define GPIO_INT_LEVEL_HIGH            (GPIO_INT_ENABLE | \ 
  177#define GPIO_INT_EDGE_TO_INACTIVE      (GPIO_INT_ENABLE | \ 
  178                                        GPIO_INT_LEVELS_LOGICAL | \ 
  185#define GPIO_INT_EDGE_TO_ACTIVE        (GPIO_INT_ENABLE | \ 
  186                                        GPIO_INT_LEVELS_LOGICAL | \ 
  193#define GPIO_INT_LEVEL_INACTIVE        (GPIO_INT_ENABLE | \ 
  194                                        GPIO_INT_LEVELS_LOGICAL | \ 
  200#define GPIO_INT_LEVEL_ACTIVE          (GPIO_INT_ENABLE | \ 
  201                                        GPIO_INT_LEVELS_LOGICAL | \ 
  207#define GPIO_DIR_MASK           (GPIO_INPUT | GPIO_OUTPUT) 
  314#define GPIO_DT_SPEC_GET_BY_IDX(node_id, prop, idx)                            \ 
  316                .port = DEVICE_DT_GET(DT_GPIO_CTLR_BY_IDX(node_id, prop, idx)),\ 
  317                .pin = DT_GPIO_PIN_BY_IDX(node_id, prop, idx),                 \ 
  318                .dt_flags = DT_GPIO_FLAGS_BY_IDX(node_id, prop, idx),          \ 
  338#define GPIO_DT_SPEC_GET_BY_IDX_OR(node_id, prop, idx, default_value)   \ 
  339        COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop),                    \ 
  340                    (GPIO_DT_SPEC_GET_BY_IDX(node_id, prop, idx)),      \ 
  351#define GPIO_DT_SPEC_GET(node_id, prop) \ 
  352        GPIO_DT_SPEC_GET_BY_IDX(node_id, prop, 0) 
  364#define GPIO_DT_SPEC_GET_OR(node_id, prop, default_value) \ 
  365        GPIO_DT_SPEC_GET_BY_IDX_OR(node_id, prop, 0, default_value) 
  377#define GPIO_DT_SPEC_INST_GET_BY_IDX(inst, prop, idx) \ 
  378        GPIO_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), prop, idx) 
  391#define GPIO_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, idx, default_value)         \ 
  392        COND_CODE_1(DT_PROP_HAS_IDX(DT_DRV_INST(inst), prop, idx),              \ 
  393                    (GPIO_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), prop, idx)),    \ 
  404#define GPIO_DT_SPEC_INST_GET(inst, prop) \ 
  405        GPIO_DT_SPEC_INST_GET_BY_IDX(inst, prop, 0) 
  417#define GPIO_DT_SPEC_INST_GET_OR(inst, prop, default_value) \ 
  418        GPIO_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, 0, default_value) 
  423#define GPIO_MAX_PINS_PER_PORT (sizeof(gpio_port_pins_t) * __CHAR_BIT__) 
  510        GPIO_INT_MODE_LEVEL = GPIO_INT_ENABLE,
 
  511        GPIO_INT_MODE_EDGE = GPIO_INT_ENABLE | GPIO_INT_EDGE,
 
  517        GPIO_INT_TRIG_LOW = GPIO_INT_LOW_0,
 
  520        GPIO_INT_TRIG_HIGH = GPIO_INT_HIGH_1,
 
  522        GPIO_INT_TRIG_BOTH = GPIO_INT_LOW_0 | GPIO_INT_HIGH_1,
 
  525__subsystem 
struct gpio_driver_api {
 
  528#ifdef CONFIG_GPIO_GET_CONFIG 
  532        int (*port_get_raw)(
const struct device *port,
 
  534        int (*port_set_masked_raw)(
const struct device *port,
 
  537        int (*port_set_bits_raw)(
const struct device *port,
 
  539        int (*port_clear_bits_raw)(
const struct device *port,
 
  541        int (*port_toggle_bits)(
const struct device *port,
 
  543        int (*pin_interrupt_configure)(
const struct device *port,
 
  545                                       enum gpio_int_mode, 
enum gpio_int_trig);
 
  546        int (*manage_callback)(
const struct device *port,
 
  550#ifdef CONFIG_GPIO_GET_DIRECTION 
  598static inline int z_impl_gpio_pin_interrupt_configure(
const struct device *port,
 
  602        const struct gpio_driver_api *api =
 
  603                (
const struct gpio_driver_api *)port->
api;
 
  608        enum gpio_int_trig trig;
 
  609        enum gpio_int_mode mode;
 
  613                 "Cannot both enable and disable interrupts");
 
  616                 "Must either enable or disable interrupts");
 
  618        __ASSERT(((
flags & GPIO_INT_ENABLE) == 0) ||
 
  619                 ((
flags & GPIO_INT_EDGE) != 0) ||
 
  620                 ((
flags & (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1)) !=
 
  621                  (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1)),
 
  622                 "Only one of GPIO_INT_LOW_0, GPIO_INT_HIGH_1 can be " 
  623                 "enabled for a level interrupt.");
 
  625        __ASSERT(((
flags & GPIO_INT_ENABLE) == 0) ||
 
  626                 ((
flags & (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1)) != 0),
 
  627                 "At least one of GPIO_INT_LOW_0, GPIO_INT_HIGH_1 has to be " 
  633        if (((
flags & GPIO_INT_LEVELS_LOGICAL) != 0) &&
 
  636                flags ^= (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1);
 
  639        trig = (
enum gpio_int_trig)(
flags & (GPIO_INT_LOW_0 | GPIO_INT_HIGH_1));
 
  642        return api->pin_interrupt_configure(port, pin, mode, trig);
 
  683static inline int z_impl_gpio_pin_configure(
const struct device *port,
 
  687        const struct gpio_driver_api *api =
 
  688                (
const struct gpio_driver_api *)port->
api;
 
  694        __ASSERT((
flags & GPIO_INT_MASK) == 0,
 
  695                 "Interrupt flags are not supported");
 
  699                 "Pull Up and Pull Down should not be enabled simultaneously");
 
  702                 "Input cannot be enabled for 'Open Drain', 'Open Source' modes without Output");
 
  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;
 
  732        return api->pin_configure(port, pin, 
flags);
 
  775#ifdef CONFIG_GPIO_GET_DIRECTION 
  780        const struct gpio_driver_api *api = (
const struct gpio_driver_api *)port->
api;
 
  782        if (api->port_get_direction == NULL) {
 
  786        return api->port_get_direction(port, 
map, inputs, outputs);
 
  898#ifdef CONFIG_GPIO_GET_CONFIG 
  899static inline int z_impl_gpio_pin_get_config(
const struct device *port,
 
  903        const struct gpio_driver_api *api =
 
  904                (
const struct gpio_driver_api *)port->
api;
 
  906        if (api->pin_get_config == NULL)
 
  909        return api->pin_get_config(port, pin, 
flags);
 
  951static inline int z_impl_gpio_port_get_raw(
const struct device *port,
 
  954        const struct gpio_driver_api *api =
 
  955                (
const struct gpio_driver_api *)port->
api;
 
  957        return api->port_get_raw(port, value);
 
  987                *value ^= 
data->invert;
 
 1014static inline int z_impl_gpio_port_set_masked_raw(
const struct device *port,
 
 1018        const struct gpio_driver_api *api =
 
 1019                (
const struct gpio_driver_api *)port->
api;
 
 1021        return api->port_set_masked_raw(port, mask, value);
 
 1051        value ^= 
data->invert;
 
 1069static inline int z_impl_gpio_port_set_bits_raw(
const struct device *port,
 
 1072        const struct gpio_driver_api *api =
 
 1073                (
const struct gpio_driver_api *)port->
api;
 
 1075        return api->port_set_bits_raw(port, pins);
 
 1107static inline int z_impl_gpio_port_clear_bits_raw(
const struct device *port,
 
 1110        const struct gpio_driver_api *api =
 
 1111                (
const struct gpio_driver_api *)port->
api;
 
 1113        return api->port_clear_bits_raw(port, pins);
 
 1145static inline int z_impl_gpio_port_toggle_bits(
const struct device *port,
 
 1148        const struct gpio_driver_api *api =
 
 1149                (
const struct gpio_driver_api *)port->
api;
 
 1151        return api->port_toggle_bits(port, pins);
 
 1169        __ASSERT((set_pins & clear_pins) == 0, 
"Set and Clear pins overlap");
 
 1189        __ASSERT((set_pins & clear_pins) == 0, 
"Set and Clear pins overlap");
 
 1346                value = (value != 0) ? 0 : 1;
 
 1414        __ASSERT(callback, 
"Callback pointer should not be NULL");
 
 1415        __ASSERT(
handler, 
"Callback handler pointer should not be NULL");
 
 1436        const struct gpio_driver_api *api =
 
 1437                (
const struct gpio_driver_api *)port->
api;
 
 1439        if (api->manage_callback == NULL) {
 
 1443        return api->manage_callback(port, callback, 
true);
 
 1465        const struct gpio_driver_api *api =
 
 1466                (
const struct gpio_driver_api *)port->
api;
 
 1468        if (api->manage_callback == NULL) {
 
 1472        return api->manage_callback(port, callback, 
false);
 
 1490static inline int z_impl_gpio_get_pending_int(
const struct device *dev)
 
 1492        const struct gpio_driver_api *api =
 
 1493                (
const struct gpio_driver_api *)dev->
api;
 
 1495        if (api->get_pending_int == NULL) {
 
 1499        return api->get_pending_int(dev);
 
 1510#include <syscalls/gpio.h> 
volatile int rv
Definition: main.c:45
 
bool device_is_ready(const struct device *dev)
Verify that a device is ready for use.
 
static int gpio_add_callback(const struct device *port, struct gpio_callback *callback)
Add an application callback.
Definition: gpio.h:1433
 
#define GPIO_OUTPUT
Definition: gpio.h:48
 
static int gpio_pin_get_raw(const struct device *port, gpio_pin_t pin)
Get physical level of an input pin.
Definition: gpio.h:1209
 
int gpio_pin_get_config(const struct device *port, gpio_pin_t pin, gpio_flags_t *flags)
Get a configuration of a single pin.
 
static int gpio_pin_is_input(const struct device *port, gpio_pin_t pin)
Check if pin is configured for input.
Definition: gpio.h:802
 
static int gpio_pin_get(const struct device *port, gpio_pin_t pin)
Get logical level of an input pin.
Definition: gpio.h:1246
 
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_is_output_dt(const struct gpio_dt_spec *spec)
Check if a single pin from gpio_dt_spec is configured for output.
Definition: gpio.h:875
 
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:658
 
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:466
 
static int gpio_pin_toggle_dt(const struct gpio_dt_spec *spec)
Toggle pin level from a gpio_dt_spec.
Definition: gpio.h:1399
 
uint8_t gpio_pin_t
Provides a type to hold a GPIO pin index.
Definition: gpio.h:237
 
static int gpio_pin_is_output(const struct device *port, gpio_pin_t pin)
Check if pin is configured for output.
Definition: gpio.h:847
 
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:746
 
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:1363
 
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:1088
 
uint32_t gpio_flags_t
Provides a type to hold GPIO configuration flags.
Definition: gpio.h:257
 
#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:1165
 
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:1185
 
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:1410
 
static int gpio_pin_is_input_dt(const struct gpio_dt_spec *spec)
Check if a single pin from gpio_dt_spec is configured for input.
Definition: gpio.h:830
 
#define GPIO_INPUT
Definition: gpio.h:45
 
uint32_t gpio_port_pins_t
Identifies a set of pins associated with a port.
Definition: gpio.h:216
 
static int gpio_pin_get_config_dt(const struct gpio_dt_spec *spec, gpio_flags_t *flags)
Get a configuration of a single pin from a gpio_dt_spec.
Definition: gpio.h:925
 
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:93
 
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:1274
 
static int gpio_pin_toggle(const struct device *port, gpio_pin_t pin)
Toggle pin level.
Definition: gpio.h:1378
 
static bool gpio_is_ready_dt(const struct gpio_dt_spec *spec)
Validate that GPIO port is ready.
Definition: gpio.h:568
 
uint32_t gpio_port_value_t
Provides values for a set of pins associated with a port.
Definition: gpio.h:229
 
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:1334
 
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:1126
 
static int gpio_remove_callback(const struct device *port, struct gpio_callback *callback)
Remove an application callback.
Definition: gpio.h:1462
 
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:1044
 
int gpio_port_get_direction(const struct device *port, gpio_port_pins_t map, gpio_port_pins_t *inputs, gpio_port_pins_t *outputs)
 
uint16_t gpio_dt_flags_t
Provides a type to hold GPIO devicetree flags.
Definition: gpio.h:249
 
#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:1294
 
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:978
 
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 ENOSYS
Definition: errno.h:83
 
#define ENOTSUP
Definition: errno.h:115
 
static ZTEST_BMEM volatile int ret
Definition: k_float_disable.c:28
 
struct region_map map[]
Definition: main.c:35
 
flags
Definition: parser.h:96
 
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:378
 
void * data
Definition: device.h:388
 
const void * api
Definition: device.h:384
 
const void * config
Definition: device.h:382
 
GPIO callback structure.
Definition: gpio.h:480
 
sys_snode_t node
Definition: gpio.h:484
 
gpio_port_pins_t pin_mask
Definition: gpio.h:495
 
gpio_callback_handler_t handler
Definition: gpio.h:487
 
gpio_port_pins_t port_pin_mask
Definition: gpio.h:436
 
gpio_port_pins_t invert
Definition: gpio.h:449
 
Container for GPIO pin information specified in devicetree.
Definition: gpio.h:271
 
const struct device * port
Definition: gpio.h:273
 
gpio_pin_t pin
Definition: gpio.h:275
 
gpio_dt_flags_t dt_flags
Definition: gpio.h:277
 
static fdata_t data[2]
Definition: test_fifo_contexts.c:15
 
static void handler(struct k_timer *timer)
Definition: main.c:19