gpio.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 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.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __HAL_DRIVER_RP2040_GPIO_H__
#define __HAL_DRIVER_RP2040_GPIO_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
 
#if VSF_HAL_USE_GPIO == ENABLED
 
#include "../__device.h"
 
/*============================ MACROS ========================================*/
 
/* RP2040 hardware constants for the FUNCSEL field in IO_BANK0.GPIOx_CTRL. */
#define __VSF_HW_GPIO_FUNCSEL_SHIFT         0
#define __VSF_HW_GPIO_FUNCSEL_BITS          5
#define __VSF_HW_GPIO_FUNCSEL_MASK          ((1u << __VSF_HW_GPIO_FUNCSEL_BITS) - 1)
#define __VSF_HW_GPIO_FUNCSEL_SIO           5u
#define __VSF_HW_GPIO_FUNCSEL_NULL          0x1Fu   /* 31 = NULL function */
 
/* Bit positions in the packed vsf_gpio_mode_t. */
#define __VSF_HW_GPIO_IS_OUTPUT_POS         5
#define __VSF_HW_GPIO_IS_AF_POS             14
#define __VSF_HW_GPIO_OD_EMULATED_POS       15
#define __VSF_HW_GPIO_PULL_POS              8
#define __VSF_HW_GPIO_PULL_MASK             0x3u
#define __VSF_HW_GPIO_EXTI_TRIG_POS         10
#define __VSF_HW_GPIO_EXTI_TRIG_MASK        0xFu
 
/* PADS_BANK0 bit positions — directly encoded in mode bits [7:6]. */
#define __RP2040_PADS_PDE                   (1u << 2)
#define __RP2040_PADS_PUE                   (1u << 3)
#define __RP2040_PADS_IE                    (1u << 6)   /* mode bit 6 */
#define __RP2040_PADS_OD                    (1u << 7)   /* mode bit 7 */
 
/* PADS_BANK0 reset default: SCHMITT=1 (bit 1), DRIVE=01 (bit 4). */
#define __RP2040_PADS_DEFAULT               0x12
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
/* The RP2040 GPIO driver reimplements vsf_gpio_mode_t so that mode bits
 * directly encode hardware register fields, eliminating manual translation
 * in gpio.c.
 *
 * Bit layout:
 *   [4:0]   FUNCSEL — written directly to IO_BANK0.GPIOx_CTRL
 *           __VSF_HW_GPIO_FUNCSEL_SIO  (for INPUT/OUTPUT/EXTI)
 *           __VSF_HW_GPIO_FUNCSEL_NULL (for ANALOG)
 *   [5]     is_output — direction hint; RP2040 direction is SIO.OE, not PADS
 *   [6]     IE — directly maps to PADS_BANK0 bit 6 (input enable)
 *   [7]     OD — directly maps to PADS_BANK0 bit 7 (output disable)
 *   [9:8]   pull: 0 = none, 1 = up, 2 = down
 *   [13:10] EXTI trigger — directly maps to IO_BANK0 INTR/INTE 4-bit field
 *           1 = LEVEL_LOW, 2 = LEVEL_HIGH, 4 = EDGE_LOW, 8 = EDGE_HIGH
 *   [14]    is_AF — alternate function mode, FUNCSEL from cfg.alternate_function
 *   [15]    OD_emulated — open-drain is software-emulated via OE toggling
 *
 * Hardware reference (RP2040 datasheet, IO_BANK0 / PADS_BANK0 / SIO):
 *   IO_BANK0 GPIOn_CTRL: [4:0] FUNCSEL
 *   PADS_BANK0 GPIOn:    [7] OD, [6] IE, [3] PUE, [2] PDE
 *   SIO:                 gpio_oe, gpio_out, gpio_in
 */
 
#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE      ENABLED
 
typedef enum vsf_gpio_mode_t {
    /* Base modes — FUNCSEL in bits [4:0], PADS IE/OD in bits [7:6] */
    VSF_GPIO_INPUT              = (__VSF_HW_GPIO_FUNCSEL_SIO << __VSF_HW_GPIO_FUNCSEL_SHIFT)
                                | (0 << __VSF_HW_GPIO_IS_OUTPUT_POS)
                                | __RP2040_PADS_IE
                                | (0 << __VSF_HW_GPIO_IS_AF_POS)
                                | (0 << __VSF_HW_GPIO_OD_EMULATED_POS),
    VSF_GPIO_ANALOG             = (__VSF_HW_GPIO_FUNCSEL_NULL << __VSF_HW_GPIO_FUNCSEL_SHIFT)
                                | (0 << __VSF_HW_GPIO_IS_OUTPUT_POS)
                                | __RP2040_PADS_OD
                                | (0 << __VSF_HW_GPIO_IS_AF_POS)
                                | (0 << __VSF_HW_GPIO_OD_EMULATED_POS),
    VSF_GPIO_OUTPUT_PUSH_PULL   = (__VSF_HW_GPIO_FUNCSEL_SIO << __VSF_HW_GPIO_FUNCSEL_SHIFT)
                                | (1 << __VSF_HW_GPIO_IS_OUTPUT_POS)
                                | __RP2040_PADS_IE
                                | (0 << __VSF_HW_GPIO_IS_AF_POS)
                                | (0 << __VSF_HW_GPIO_OD_EMULATED_POS),
    VSF_GPIO_OUTPUT_OPEN_DRAIN  = (__VSF_HW_GPIO_FUNCSEL_SIO << __VSF_HW_GPIO_FUNCSEL_SHIFT)
                                | (1 << __VSF_HW_GPIO_IS_OUTPUT_POS)
                                | __RP2040_PADS_IE
                                | (0 << __VSF_HW_GPIO_IS_AF_POS)
                                | (1 << __VSF_HW_GPIO_OD_EMULATED_POS),
    VSF_GPIO_AF                 = (0 << __VSF_HW_GPIO_FUNCSEL_SHIFT)
                                | (0 << __VSF_HW_GPIO_IS_OUTPUT_POS)
                                | __RP2040_PADS_IE
                                | (1 << __VSF_HW_GPIO_IS_AF_POS)
                                | (0 << __VSF_HW_GPIO_OD_EMULATED_POS),
    VSF_GPIO_EXTI               = VSF_GPIO_INPUT,
 
    /* Pull-up / pull-down */
    VSF_GPIO_NO_PULL_UP_DOWN    = (0 << __VSF_HW_GPIO_PULL_POS),
    VSF_GPIO_PULL_UP            = (1 << __VSF_HW_GPIO_PULL_POS),
    VSF_GPIO_PULL_DOWN          = (2 << __VSF_HW_GPIO_PULL_POS),
 
    /* EXTI trigger modes — values directly usable as RP2040 INTR/INTE field */
    VSF_GPIO_EXTI_MODE_NONE         = (0 << __VSF_HW_GPIO_EXTI_TRIG_POS),
    VSF_GPIO_EXTI_MODE_LOW_LEVEL    = (1 << __VSF_HW_GPIO_EXTI_TRIG_POS),
    VSF_GPIO_EXTI_MODE_HIGH_LEVEL   = (2 << __VSF_HW_GPIO_EXTI_TRIG_POS),
    VSF_GPIO_EXTI_MODE_FALLING      = (4 << __VSF_HW_GPIO_EXTI_TRIG_POS),
    VSF_GPIO_EXTI_MODE_RISING       = (8 << __VSF_HW_GPIO_EXTI_TRIG_POS),
    VSF_GPIO_EXTI_MODE_RISING_FALLING = (4 << __VSF_HW_GPIO_EXTI_TRIG_POS)
                                      | (8 << __VSF_HW_GPIO_EXTI_TRIG_POS),
} vsf_gpio_mode_t;
 
/*============================ INCLUDES ======================================*/
/*============================ PROTOTYPES ====================================*/
 
#endif      /* VSF_HAL_USE_GPIO */
#endif      /* __HAL_DRIVER_RP2040_GPIO_H__ */
/* EOF */