gpio.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2026 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
/*
 * Clean-room re-implementation of ESP-IDF public API "driver/gpio.h".
 * Authored from ESP-IDF v5.1 public API only; no ESP-IDF source was
 * copied. The VSF port bridges onto
 *
 *     hal/driver/common/template/vsf_template_gpio.h
 *
 * via the global vsf_hw_io_mapper (hal/utilities/io_mapper).
 *
 * Pin numbering contract (shim-defined, deterministic across MCUs):
 *
 *     gpio_num = (port_index << VSF_HW_IO_MAPPER_PORT_BITS_LOG2)
 *                | pin_index_within_port;
 *
 * With the default VSF_HW_IO_MAPPER_PORT_BITS_LOG2 = 8 this is the
 * natural "port * 256 + pin" layout. Users that need the classic
 * ESP-IDF-style symbolic names (GPIO_NUM_0 ... GPIO_NUM_48) may either
 * rely on the numeric enum below or define their own port/pin macros in
 * the board configuration.
 */
 
#ifndef __VSF_ESPIDF_DRIVER_GPIO_H__
#define __VSF_ESPIDF_DRIVER_GPIO_H__
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
#include "esp_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ TYPES =========================================*/
 
typedef int32_t gpio_num_t;
 
#define GPIO_NUM_NC     (-1)
 
typedef enum {
    GPIO_MODE_DISABLE       = 0,
    GPIO_MODE_INPUT         = 1,
    GPIO_MODE_OUTPUT        = 2,
    GPIO_MODE_OUTPUT_OD     = 3,    
    GPIO_MODE_INPUT_OUTPUT_OD = 4,  
    GPIO_MODE_INPUT_OUTPUT  = 5,    
} gpio_mode_t;
 
typedef enum {
    GPIO_PULLUP_DISABLE = 0,
    GPIO_PULLUP_ENABLE  = 1,
} gpio_pullup_t;
 
typedef enum {
    GPIO_PULLDOWN_DISABLE = 0,
    GPIO_PULLDOWN_ENABLE  = 1,
} gpio_pulldown_t;
 
typedef enum {
    GPIO_FLOATING        = 0,       
    GPIO_PULLUP_ONLY     = 1,
    GPIO_PULLDOWN_ONLY   = 2,
    GPIO_PULLUP_PULLDOWN = 3,       
} gpio_pull_mode_t;
 
typedef enum {
    GPIO_INTR_DISABLE    = 0,
    GPIO_INTR_POSEDGE    = 1,
    GPIO_INTR_NEGEDGE    = 2,
    GPIO_INTR_ANYEDGE    = 3,
    GPIO_INTR_LOW_LEVEL  = 4,
    GPIO_INTR_HIGH_LEVEL = 5,
} gpio_int_type_t;
 
typedef enum {
    GPIO_LOW  = 0,
    GPIO_HIGH = 1,
} gpio_level_t;
 
typedef uint64_t gpio_pin_bit_mask_t;
 
typedef struct {
    gpio_pin_bit_mask_t pin_bit_mask;
    gpio_mode_t         mode;
    gpio_pullup_t       pull_up_en;
    gpio_pulldown_t     pull_down_en;
    gpio_int_type_t     intr_type;
} gpio_config_t;
 
typedef void (*gpio_isr_t)(void *arg);
 
/*============================ PROTOTYPES ====================================*/
 
extern esp_err_t gpio_config(const gpio_config_t *config);
 
extern esp_err_t gpio_reset_pin(gpio_num_t gpio_num);
 
extern esp_err_t gpio_set_direction(gpio_num_t gpio_num, gpio_mode_t mode);
 
extern esp_err_t gpio_set_pull_mode(gpio_num_t gpio_num, gpio_pull_mode_t pull);
 
extern esp_err_t gpio_set_level(gpio_num_t gpio_num, uint32_t level);
 
extern int gpio_get_level(gpio_num_t gpio_num);
 
extern esp_err_t gpio_pullup_en(gpio_num_t gpio_num);
extern esp_err_t gpio_pullup_dis(gpio_num_t gpio_num);
extern esp_err_t gpio_pulldown_en(gpio_num_t gpio_num);
extern esp_err_t gpio_pulldown_dis(gpio_num_t gpio_num);
 
extern esp_err_t gpio_set_intr_type(gpio_num_t gpio_num, gpio_int_type_t intr_type);
 
extern esp_err_t gpio_intr_enable(gpio_num_t gpio_num);
extern esp_err_t gpio_intr_disable(gpio_num_t gpio_num);
 
extern esp_err_t gpio_install_isr_service(int intr_alloc_flags);
 
extern void gpio_uninstall_isr_service(void);
 
extern esp_err_t gpio_isr_handler_add(gpio_num_t gpio_num,
                                        gpio_isr_t isr_handler,
                                        void *args);
 
extern esp_err_t gpio_isr_handler_remove(gpio_num_t gpio_num);
 
/*---------------------------- not supported --------------------------------*/
 
typedef void *gpio_isr_handle_t;
 
extern esp_err_t gpio_isr_register(void (*fn)(void *),
                                    void *arg,
                                    int intr_alloc_flags,
                                    gpio_isr_handle_t *handle);
 
extern esp_err_t gpio_wakeup_enable(gpio_num_t gpio_num,
                                    gpio_int_type_t intr_type);
extern esp_err_t gpio_wakeup_disable(gpio_num_t gpio_num);
 
#ifdef __cplusplus
}
#endif
 
#endif      // __VSF_ESPIDF_DRIVER_GPIO_H__