no_os_gpio.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_GPIO_H_
#define _NO_OS_GPIO_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define NO_OS_GPIO_OUT  0x01
#define NO_OS_GPIO_IN       0x00
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
struct no_os_gpio_platform_ops ;
 
enum no_os_gpio_pull_up {
    NO_OS_PULL_NONE,
    NO_OS_PULL_UP,
    NO_OS_PULL_DOWN,
    NO_OS_PULL_UP_WEAK,
    NO_OS_PULL_DOWN_WEAK
};
 
struct no_os_gpio_init_param {
    int32_t     port;
    int32_t     number;
    enum no_os_gpio_pull_up pull;
    const struct no_os_gpio_platform_ops *platform_ops;
    void        *extra;
};
 
struct no_os_gpio_desc {
    int32_t     port;
    int32_t     number;
    enum no_os_gpio_pull_up pull;
    const struct no_os_gpio_platform_ops *platform_ops;
    void        *extra;
};
 
enum no_os_gpio_values {
    NO_OS_GPIO_LOW,
    NO_OS_GPIO_HIGH,
    NO_OS_GPIO_HIGH_Z
};
 
struct no_os_gpio_platform_ops {
    int32_t (*gpio_ops_get)(struct no_os_gpio_desc **,
                const struct no_os_gpio_init_param *);
    int32_t (*gpio_ops_get_optional)(struct no_os_gpio_desc **,
                     const struct no_os_gpio_init_param *);
    int32_t (*gpio_ops_remove)(struct no_os_gpio_desc *);
    int32_t (*gpio_ops_direction_input)(struct no_os_gpio_desc *);
    int32_t (*gpio_ops_direction_output)(struct no_os_gpio_desc *, uint8_t);
    int32_t (*gpio_ops_get_direction)(struct no_os_gpio_desc *, uint8_t *);
    int32_t (*gpio_ops_set_value)(struct no_os_gpio_desc *, uint8_t);
    int32_t (*gpio_ops_get_value)(struct no_os_gpio_desc *, uint8_t *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Obtain the GPIO decriptor. */
int32_t no_os_gpio_get(struct no_os_gpio_desc **desc,
               const struct no_os_gpio_init_param *param);
 
/* Obtain optional GPIO descriptor. */
int32_t no_os_gpio_get_optional(struct no_os_gpio_desc **desc,
                const struct no_os_gpio_init_param *param);
 
/* Free the resources allocated by no_os_gpio_get(). */
int32_t no_os_gpio_remove(struct no_os_gpio_desc *desc);
 
/* Enable the input direction of the specified GPIO. */
int32_t no_os_gpio_direction_input(struct no_os_gpio_desc *desc);
 
/* Enable the output direction of the specified GPIO. */
int32_t no_os_gpio_direction_output(struct no_os_gpio_desc *desc,
                    uint8_t value);
 
/* Get the direction of the specified GPIO. */
int32_t no_os_gpio_get_direction(struct no_os_gpio_desc *desc,
                 uint8_t *direction);
 
/* Set the value of the specified GPIO. */
int32_t no_os_gpio_set_value(struct no_os_gpio_desc *desc,
                 uint8_t value);
 
/* Get the value of the specified GPIO. */
int32_t no_os_gpio_get_value(struct no_os_gpio_desc *desc,
                 uint8_t *value);
 
#endif // _NO_OS_GPIO_H_