cpu_gpio.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Freie Universität Berlin
 *               2017 OTA keys S.A.
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PERIPH_CPU_GPIO_H
#define PERIPH_CPU_GPIO_H
 
#include <stdint.h>
#include "cpu.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef DOXYGEN
#define HAVE_GPIO_T
typedef uint32_t gpio_t;
#endif
 
#define GPIO_UNDEF          (0xffffffff)
 
#if defined(CPU_FAM_STM32MP1)
#define GPIO_PIN(x, y)      ((GPIOA_BASE + (x << 12)) | y)
#else
#define GPIO_PIN(x, y)      ((GPIOA_BASE + (x << 10)) | y)
#endif
 
enum {
#ifdef GPIOA
    PORT_A = 0,             
#endif
#ifdef GPIOB
    PORT_B = 1,             
#endif
#ifdef GPIOC
    PORT_C = 2,             
#endif
#ifdef GPIOD
    PORT_D = 3,             
#endif
#ifdef GPIOE
    PORT_E = 4,             
#endif
#ifdef GPIOF
    PORT_F = 5,             
#endif
#ifdef GPIOG
    PORT_G = 6,             
#endif
#ifdef GPIOH
    PORT_H = 7,             
#endif
#ifdef GPIOI
    PORT_I = 8,             
#endif
#ifdef GPIOJ
    PORT_J = 9,             
#endif
#ifdef GPIOK
    PORT_K = 10,            
#endif
};
 
typedef enum {
#ifdef CPU_FAM_STM32F1
    GPIO_AF_OUT_PP = 0xb,   
    GPIO_AF_OUT_OD = 0xf,   
#else
    GPIO_AF0 = 0,           
    GPIO_AF1,               
    GPIO_AF2,               
    GPIO_AF3,               
    GPIO_AF4,               
    GPIO_AF5,               
    GPIO_AF6,               
    GPIO_AF7,               
#ifndef CPU_FAM_STM32F0
    GPIO_AF8,               
    GPIO_AF9,               
    GPIO_AF10,              
    GPIO_AF11,              
    GPIO_AF12,              
    GPIO_AF13,              
    GPIO_AF14,              
    GPIO_AF15,              
#endif
#endif
    GPIO_AF_UNDEF           
} gpio_af_t;
 
#ifdef CPU_FAM_STM32F1
#ifndef DOXYGEN
#define GPIO_MODE(mode, cnf, odr)       (mode | (cnf << 2) | (odr << 4))
 
#define HAVE_GPIO_MODE_T
typedef enum {
    GPIO_IN    = GPIO_MODE(0, 1, 0),    
    GPIO_IN_PD = GPIO_MODE(0, 2, 0),    
    GPIO_IN_PU = GPIO_MODE(0, 2, 1),    
    GPIO_OUT   = GPIO_MODE(3, 0, 0),    
    GPIO_OD    = GPIO_MODE(3, 1, 0),    
    GPIO_OD_PU = (0xff)                 
} gpio_mode_t;
#endif /* ndef DOXYGEN */
 
#define HAVE_GPIO_PP_T
typedef enum {
    GPIO_NOPULL = 4,        
    GPIO_PULLUP = 9,        
    GPIO_PULLDOWN = 8       
} gpio_pp_t;
#else /* CPU_FAM_STM32F1 */
#define GPIO_MODE(io, pr, ot)   ((io << 0) | (pr << 2) | (ot << 4))
 
#ifndef DOXYGEN
#define HAVE_GPIO_MODE_T
typedef enum {
    GPIO_IN    = GPIO_MODE(0, 0, 0),    
    GPIO_IN_PD = GPIO_MODE(0, 2, 0),    
    GPIO_IN_PU = GPIO_MODE(0, 1, 0),    
    GPIO_OUT   = GPIO_MODE(1, 0, 0),    
    GPIO_OD    = GPIO_MODE(1, 0, 1),    
    GPIO_OD_PU = GPIO_MODE(1, 1, 1)     
} gpio_mode_t;
#endif /* ndef DOXYGEN */
#endif /* ndef CPU_FAM_STM32F1 */
 
#ifndef DOXYGEN
#define HAVE_GPIO_FLANK_T
typedef enum {
    GPIO_RISING = 1,        
    GPIO_FALLING = 2,       
    GPIO_BOTH = 3           
} gpio_flank_t;
#endif /* ndef DOXYGEN */
 
void gpio_init_af(gpio_t pin, gpio_af_t af);
 
void gpio_init_analog(gpio_t pin);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PERIPH_CPU_GPIO_H */