hal_gpio.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 * --  _____       ______  _____                                              -
 * -- |_   _|     |  ____|/ ____|                                             -
 * --   | |  _ __ | |__  | (___    Institute of Embedded Systems              -
 * --   | | | '_ \|  __|  \___ \   Zurich University of                       -
 * --  _| |_| | | | |____ ____) |  Applied Sciences                           -
 * -- |_____|_| |_|______|_____/   8401 Winterthur, Switzerland               -
 * ------------------------------------------------------------------------- */
/* Re-definition guard */
#ifndef _HAL_GPIO_H
#define _HAL_GPIO_H


/* User includes */
#include "reg_stm32f4xx.h"
#include "hal_common.h"


/* -- Type definitions
 * ------------------------------------------------------------------------- */

typedef enum {
    HAL_GPIO_MODE_IN = 0x00,            
    HAL_GPIO_MODE_OUT = 0x01,           
    HAL_GPIO_MODE_AF = 0x02,            
    HAL_GPIO_MODE_AN = 0x03             
} hal_gpio_mode_t;


typedef enum {
    HAL_GPIO_OUT_SPEED_2MHZ = 0x00,     
    HAL_GPIO_OUT_SPEED_10MHZ = 0x01,    
    HAL_GPIO_OUT_SPEED_50MHZ = 0x02,    
    HAL_GPIO_OUT_SPEED_100MHZ = 0x03    
} hal_gpio_out_speed_t;


typedef enum {
    HAL_GPIO_OUT_TYPE_PP = 0x00,        
    HAL_GPIO_OUT_TYPE_OD = 0x01         
} hal_gpio_out_type_t;


typedef enum {
    HAL_GPIO_PUPD_NOPULL = 0x00,        
    HAL_GPIO_PUPD_UP = 0x01,            
    HAL_GPIO_PUPD_DOWN = 0x02           
} hal_gpio_pupd_t;


typedef enum {
    /* AF0 */
    HAL_GPIO_AF_RTC50HZ   = 0x00,
    HAL_GPIO_AF_MCO       = 0x00,
    HAL_GPIO_AF_TAMPER    = 0x00,
    HAL_GPIO_AF_SWJ       = 0x00,
    HAL_GPIO_AF_TRACE     = 0x00,
    /* AF 1 */
    HAL_GPIO_AF_TIM1      = 0x01,
    HAL_GPIO_AF_TIM2      = 0x01,
    /* AF 2 */
    HAL_GPIO_AF_TIM3      = 0x02,
    HAL_GPIO_AF_TIM4      = 0x02,
    HAL_GPIO_AF_TIM5      = 0x02,
    /* AF 3 */
    HAL_GPIO_AF_TIM8      = 0x03,
    HAL_GPIO_AF_TIM9      = 0x03,
    HAL_GPIO_AF_TIM10     = 0x03,
    HAL_GPIO_AF_TIM11     = 0x03,
    /* AF 4 */
    HAL_GPIO_AF_I2C1      = 0x04,
    HAL_GPIO_AF_I2C2      = 0x04,
    HAL_GPIO_AF_I2C3      = 0x04,
    /* AF 5 */
    HAL_GPIO_AF_SPI1      = 0x05,
    HAL_GPIO_AF_SPI2      = 0x05,
    HAL_GPIO_AF_SPI4      = 0x05,
    HAL_GPIO_AF_SPI5      = 0x05,
    HAL_GPIO_AF_SPI6      = 0x05,
    /* AF 6 */
    HAL_GPIO_AF_SPI3      = 0x06,
    HAL_GPIO_AF_SAI1      = 0x06,
    /* AF 7 */
    HAL_GPIO_AF_USART1    = 0x07,
    HAL_GPIO_AF_USART2    = 0x07,
    HAL_GPIO_AF_USART3    = 0x07,
    HAL_GPIO_AF_I2S3ext   = 0x07,
    /* AF 8 */
    HAL_GPIO_AF_UART4     = 0x08,
    HAL_GPIO_AF_UART5     = 0x08,
    HAL_GPIO_AF_USART6    = 0x08,
    HAL_GPIO_AF_UART7     = 0x08,
    HAL_GPIO_AF_UART8     = 0x08,
    /* AF 9 */
    HAL_GPIO_AF_CAN1      = 0x09,
    HAL_GPIO_AF_CAN2      = 0x09,
    HAL_GPIO_AF_TIM12     = 0x09,
    HAL_GPIO_AF_TIM13     = 0x09,
    HAL_GPIO_AF_TIM14     = 0x09,
    /* AF 10 */
    HAL_GPIO_AF_OTG_FS    = 0x0a,
    HAL_GPIO_AF_OTG_HS    = 0x0a,
    /* AF 11 */
    HAL_GPIO_AF_ETH       = 0x0b,
    /* AF 12 */
    HAL_GPIO_AF_FMC       = 0x0c,
    HAL_GPIO_AF_OTG_HS_FS = 0x0c,
    HAL_GPIO_AF_SDIO      = 0x0c,
    /* AF 13 */
    HAL_GPIO_AF_DCMI      = 0x0d,
    /* AF 14 */
    HAL_GPIO_AF_LTDC      = 0x0e,
    /* AF 15 */
    HAL_GPIO_AF_EVENTOUT  = 0x0f
} hal_gpio_af_t;


typedef enum {
    HAL_GPIO_PIN_0   = 0x0001,
    HAL_GPIO_PIN_1   = 0x0002,
    HAL_GPIO_PIN_2   = 0x0004,
    HAL_GPIO_PIN_3   = 0x0008,
    HAL_GPIO_PIN_4   = 0x0010,
    HAL_GPIO_PIN_5   = 0x0020,
    HAL_GPIO_PIN_6   = 0x0040,
    HAL_GPIO_PIN_7   = 0x0080,
    HAL_GPIO_PIN_8   = 0x0100,
    HAL_GPIO_PIN_9   = 0x0200,
    HAL_GPIO_PIN_10  = 0x0400,
    HAL_GPIO_PIN_11  = 0x0800,
    HAL_GPIO_PIN_12  = 0x1000,
    HAL_GPIO_PIN_13  = 0x2000,
    HAL_GPIO_PIN_14  = 0x4000,
    HAL_GPIO_PIN_15  = 0x8000,
    HAL_GPIO_PIN_All = 0xffff,
} hal_gpio_pin_t;


typedef enum {
    HAL_GPIO_TRG_POS = 0x1,         
    HAL_GPIO_TRG_NEG = 0x2,         
    HAL_GPIO_TRG_BOTH = 0x3         
} hal_gpio_trg_t;


typedef struct {
    uint16_t pins;
    hal_gpio_pupd_t pupd;
} hal_gpio_input_t;


typedef struct {
    uint16_t pins;
    hal_gpio_pupd_t pupd;
    hal_gpio_out_speed_t out_speed;
    hal_gpio_out_type_t out_type;
} hal_gpio_output_t;


/* -- Public function declarations
 * ------------------------------------------------------------------------- */

void hal_gpio_reset(reg_gpio_t *port)
__attribute__((deprecated("Please use GPIOx_RESET().")));

void hal_gpio_init_input(reg_gpio_t *port, hal_gpio_input_t init);

void hal_gpio_init_analog(reg_gpio_t *port, hal_gpio_input_t init);

void hal_gpio_init_output(reg_gpio_t *port, hal_gpio_output_t init);

void hal_gpio_init_alternate(reg_gpio_t *port, 
                             hal_gpio_af_t af_mode,
                             hal_gpio_output_t init);

uint16_t hal_gpio_input_read(reg_gpio_t *port);

uint16_t hal_gpio_output_read(reg_gpio_t *port);

void hal_gpio_output_write(reg_gpio_t *port, uint16_t value);

void hal_gpio_bit_set(reg_gpio_t *port, uint16_t pins);

void hal_gpio_bit_reset(reg_gpio_t *port, uint16_t pins);

void hal_gpio_bit_toggle(reg_gpio_t *port, uint16_t pins);

void hal_gpio_irq_set(reg_gpio_t *port, 
                      uint16_t pins, 
                      hal_gpio_trg_t edge,
                      hal_bool_t status);

hal_bool_t hal_gpio_irq_status(uint16_t pin);

void hal_gpio_irq_clear(uint16_t pin);

#endif