#pragma once

#ifdef __cplusplus
extern "C" {
#endif

#include <device.h>

#define GPIO_OPTIONS_MASK 0x1f

#define GPIO_ACTIVE_HIGH (0 << 0)
#define GPIO_ACTIVE_LOW (1 << 0)

#define GPIO_UNIDIRECTIONAL (0 << 1)
#define GPIO_BIDIRECTIONAL (1 << 1)

#define GPIO_OPEN_DRAIN (GPIO_UNIDIRECTIONAL | (0 << 2))
#define GPIO_OPEN_SOURCE (GPIO_UNIDIRECTIONAL | (1 << 2))

#define GPIO_PULL_UP (0 << 3)
#define GPIO_PULL_DOWN (1 << 4)

#define GPIO_INTERRUPT_WAKE_UP (1 << 5)

/**
 * @brief Provides a type to hold a GPIO pin index.
 *
 * This reduced-size type is sufficient to record a pin number,
 * e.g. from a devicetree GPIOS property.
 */
typedef uint8_t gpio_pin_t;

/**
 * @brief Identifies a set of pins associated with a port.
 *
 * The pin with index n is present in the set if and only if the bit
 * identified by (1U << n) is set.
 */
typedef uint32_t gpio_pinset_t;

/**
 * @brief Provides a type to hold GPIO devicetree flags.
 *
 * All GPIO flags that can be expressed in devicetree fit in the low 16
 * bits of the full flags field, so use a reduced-size type to record
 * that part of a GPIOS property.
 *
 * The lower 8 bits are used for standard flags. The upper 8 bits are reserved
 * for SoC specific flags.
 */
typedef uint16_t gpio_flags_t;

/**
 * @brief Container for GPIO pin information specified in dts files
 *
 * This type contains a pointer to a GPIO device, pin identifier for a pin
 * controlled by that device, and the subset of pin configuration
 * flags which may be given in devicetree.
 */
struct gpio_pin_config {
    /** GPIO device controlling the pin */
    const struct device* port;
    /** The pin's number on the device */
    gpio_pin_t pin;
    /** The pin's configuration flags as specified in devicetree */
    gpio_flags_t dt_flags;
};


/**
 * @brief Validate that GPIO port is ready.
 *
 * @param spec GPIO specification from devicetree
 *
 * @retval true if the GPIO spec is ready for use.
 * @retval false if the GPIO spec is not ready for use.
 */
inline bool gpio_is_ready(const struct gpio_pin_config* pin_config) {
    return device_is_ready(pin_config->port);
}

#ifdef __cplusplus
}
#endif