ketCube_gpio.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __KETCUBE_GPIO_H
#define __KETCUBE_GPIO_H
 
#include "stm32l0xx_hal_gpio.h"
#include "ketCube_cfg.h"
 
#define KETCUBE_GPIO_NAME               "gpio_drv"         
 
#define KETCUBE_GPIO_LED_PERIOD         500                
 
 
typedef enum {
    KETCUBE_GPIO_NOPIN = 0,
    KETCUBE_GPIO_PIN_0 = GPIO_PIN_0,
    KETCUBE_GPIO_PIN_1 = GPIO_PIN_1,
    KETCUBE_GPIO_PIN_2 = GPIO_PIN_2,
    KETCUBE_GPIO_PIN_3 = GPIO_PIN_3,
    KETCUBE_GPIO_PIN_4 = GPIO_PIN_4,
    KETCUBE_GPIO_PIN_5 = GPIO_PIN_5,
    KETCUBE_GPIO_PIN_6 = GPIO_PIN_6,
    KETCUBE_GPIO_PIN_7 = GPIO_PIN_7,
    KETCUBE_GPIO_PIN_8 = GPIO_PIN_8,
    KETCUBE_GPIO_PIN_9 = GPIO_PIN_9,
    KETCUBE_GPIO_PIN_10 = GPIO_PIN_10,
    KETCUBE_GPIO_PIN_11 = GPIO_PIN_11,
    KETCUBE_GPIO_PIN_12 = GPIO_PIN_12,
    KETCUBE_GPIO_PIN_13 = GPIO_PIN_13,
    KETCUBE_GPIO_PIN_14 = GPIO_PIN_14,
    KETCUBE_GPIO_PIN_15 = GPIO_PIN_15
} ketCube_gpio_pin_t;
 
typedef enum {
    KETCUBE_GPIO_PA = GPIOA_BASE,
    KETCUBE_GPIO_PB = GPIOB_BASE,
    KETCUBE_GPIO_PC = GPIOC_BASE,
    KETCUBE_GPIO_PD = GPIOD_BASE,
    KETCUBE_GPIO_PE = GPIOE_BASE,
    KETCUBE_GPIO_PH = GPIOH_BASE
} ketCube_gpio_port_t;
 
typedef enum {
    KETCUBE_GPIO_FUNCTION_GPIO = 0,    
    KETCUBE_GPIO_FUNCTION_LED,         
    KETCUBE_GPIO_FUNCTION_BUTTON,      
} ketCube_gpio_function_t;
 
typedef enum {
    KETCUBE_GPIO_POLARITY_ON  = TRUE,   
    KETCUBE_GPIO_POLARITY_OFF = FALSE,  
} ketCube_gpio_polarity_t;
 
typedef enum {
    KETCUBE_GPIO_LED_OFF = 0,        
    KETCUBE_GPIO_LED_ON,             
    KETCUBE_GPIO_LED_BLINK_SINGLE,   
    KETCUBE_GPIO_LED_BLINK_CONT      
} ketCube_gpio_LEDState_t;
 
 
#ifdef __ARMCC_VERSION
#pragma anon_unions
#endif
typedef struct {
    bool used:1;   
    ketCube_gpio_function_t function:2;  
    /* settings */
    union {
        uint8_t value:4;  
        struct {
            ketCube_gpio_LEDState_t LED_state:3; 
            ketCube_gpio_polarity_t polarity:1;  
        };
    } settings;
} ketCube_gpio_descriptor_t;
 
 
typedef void (*ketCube_GPIO_VoidFn_t) (void* context);
 
/* Init functions called by KETCube core */
extern void ketCube_GPIO_InitDriver(void);
extern ketCube_cfg_DrvError_t ketCube_GPIO_SleepEnter(void);
 
 
/* Init functions called by modules */
extern ketCube_cfg_DrvError_t ketCube_GPIO_Init(ketCube_gpio_port_t port,
                                                uint16_t pin,
                                                GPIO_InitTypeDef *
                                                initStruct);
extern ketCube_cfg_DrvError_t ketCube_GPIO_InitLED(ketCube_gpio_port_t port,
                                                   uint16_t pin,
                                                   ketCube_gpio_polarity_t polarity);
extern ketCube_cfg_DrvError_t ketCube_GPIO_ReInit(ketCube_gpio_port_t port,
                                                  uint16_t pin,
                                                  GPIO_InitTypeDef * initStruct);
extern ketCube_cfg_DrvError_t ketCube_GPIO_Release(ketCube_gpio_port_t port,
                                                   ketCube_gpio_pin_t pin);
 
 
/* Interrupt-related functions */
extern ketCube_cfg_DrvError_t ketCube_GPIO_SetIrq(ketCube_gpio_port_t port,
                                                  ketCube_gpio_pin_t pin,
                                                  uint32_t prio,
                                                  ketCube_GPIO_VoidFn_t
                                                  irqHandler);
extern ketCube_cfg_DrvError_t ketCube_GPIO_ClearIrq(ketCube_gpio_port_t port,
                                                    ketCube_gpio_pin_t pin);
 
/* Read/Write functions */
extern void ketCube_GPIO_Write(ketCube_gpio_port_t port,
                               ketCube_gpio_pin_t pin, bool bit);
extern bool ketCube_GPIO_Read(ketCube_gpio_port_t port,
                              ketCube_gpio_pin_t pin);
extern void ketCube_GPIO_SetLED(ketCube_gpio_port_t port,
                                ketCube_gpio_pin_t pin,
                                ketCube_gpio_LEDState_t state);
 
/* Handlers */
extern void EXTI0_1_IRQHandler(void);
extern void EXTI2_3_IRQHandler(void);
extern void EXTI4_15_IRQHandler(void);
 
 
#endif