gpio.h

Go to the documentation of this file.

 
#ifndef PHAL_G4_GPIO_H
#define PHAL_G4_GPIO_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "stm32g474xx.h"
 
typedef enum {
    GPIO_TYPE_INPUT,
    GPIO_TYPE_OUTPUT,
    GPIO_TYPE_AF,
    GPIO_TYPE_ANALOG,
} PHAL_GPIO_PinType_t;
 
typedef enum {
    GPIO_OUTPUT_LOW_SPEED,   
    GPIO_OUTPUT_MED_SPEED,   
    GPIO_OUTPUT_HIGH_SPEED,  
    GPIO_OUTPUT_ULTRA_SPEED, 
} PHAL_GPIO_OutputSpeed_t;
typedef enum {
    GPIO_OUTPUT_PUSH_PULL,  
    GPIO_OUTPUT_OPEN_DRAIN, 
} PHAL_GPIO_OutputPull_t;
 
typedef enum {
    GPIO_INPUT_OPEN_DRAIN, 
    GPIO_INPUT_PULL_UP,    
    GPIO_INPUT_PULL_DOWN,  
} PHAL_GPIO_InputPull_t;
 
 
typedef struct {
    GPIO_TypeDef *bank;       
    uint8_t pin;              
    PHAL_GPIO_PinType_t type; 
    union {
        struct {
            PHAL_GPIO_InputPull_t pull; 
        } input; 
        struct {
            PHAL_GPIO_OutputSpeed_t ospeed; 
            PHAL_GPIO_OutputPull_t otype;   
        } output; 
        struct {
            uint8_t af_num;                 
            PHAL_GPIO_OutputSpeed_t ospeed; 
            PHAL_GPIO_OutputPull_t otype;   
            PHAL_GPIO_InputPull_t pull;     
        } af; 
        // GPIO_TYPE_ANALOG needs no additional configuration
    } config; 
} PHAL_GPIO_InitConfig_t;
 
bool PHAL_GPIO_init(PHAL_GPIO_InitConfig_t config[], size_t config_len);
 
bool PHAL_GPIO_read(const GPIO_TypeDef *bank, uint8_t pin);
 
void PHAL_GPIO_write(GPIO_TypeDef *bank, uint8_t pin, bool value);
 
void PHAL_GPIO_toggle(GPIO_TypeDef *bank, uint8_t pin);
 
#define PHAL_GPIO_INIT_INPUT(gpio_bank, pin_num, input_pull_sel)                    \
    {                                                                          \
        .bank = gpio_bank,                                                     \
        .pin = pin_num,                                                        \
        .type = GPIO_TYPE_INPUT,                                               \
        .config = {                                                            \
            .input = {                                                         \
                .pull = input_pull_sel                                         \
            }                                                                  \
        }                                                                      \
    }
 
#define PHAL_GPIO_INIT_OUTPUT(gpio_bank, pin_num, ospeed_sel)                  \
    {                                                                          \
        .bank = gpio_bank,                                                     \
        .pin = pin_num,                                                        \
        .type = GPIO_TYPE_OUTPUT,                                              \
        .config = {                                                            \
            .output = {                                                        \
                .ospeed = ospeed_sel,                                          \
                .otype  = GPIO_OUTPUT_PUSH_PULL                                \
            }                                                                  \
        }                                                                      \
    }
 
#define PHAL_GPIO_INIT_OUTPUT_OPEN_DRAIN(gpio_bank, pin_num, ospeed_sel)       \
    {                                                                          \
        .bank = gpio_bank,                                                     \
        .pin = pin_num,                                                        \
        .type = GPIO_TYPE_OUTPUT,                                              \
        .config = {                                                            \
            .output = {                                                        \
                .ospeed = ospeed_sel,                                          \
                .otype  = GPIO_OUTPUT_OPEN_DRAIN                               \
            }                                                                  \
        }                                                                      \
    }
 
#define PHAL_GPIO_INIT_ANALOG(gpio_bank, pin_num)                              \
    {                                                                          \
        .bank = gpio_bank,                                                     \
        .pin = pin_num,                                                        \
        .type = GPIO_TYPE_ANALOG                                               \
    }
 
#define PHAL_GPIO_INIT_AF(gpio_bank, pin_num, alt_func_num, ospeed_sel, otype_sel, input_pull_sel) \
    {                                                                                              \
        .bank = gpio_bank,                                                                         \
        .pin = pin_num,                                                                            \
        .type = GPIO_TYPE_AF,                                                                      \
        .config = {                                                                                \
            .af = {                                                                                \
                .af_num = alt_func_num,                                                            \
                .ospeed = ospeed_sel,                                                              \
                .otype  = otype_sel,                                                               \
                .pull   = input_pull_sel                                                           \
            }                                                                                      \
        }                                                                                          \
    }
 
#endif // PHAL_G4_GPIO_H