ketCube_uart.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __KETCUBE_UART_H
#define __KETCUBE_UART_H
 
#include "ketCube_cfg.h"
#include "ketCube_gpio.h"
 
#define KETCUBE_UART_NAME               "uart_drv"        
 
 
typedef enum {
    KETCUBE_UART_CHANNEL_1 = 0,
    KETCUBE_UART_CHANNEL_2 = 1,
    KETCUBE_UART_CHANNEL_3 = 2,
    KETCUBE_UART_CHANNEL_4 = 3,
    KETCUBE_UART_CHANNEL_5 = 4,
 
    KETCUBE_UART_CHANNEL_COUNT
} ketCube_UART_ChannelNo_t;
 
typedef void (*ketCube_UART_SimpleCbFn_t) (void);
 
typedef struct {
    UART_HandleTypeDef *handle;
    IRQn_Type irqNumber;
    int irqPriority;
    int irqSubPriority;
    ketCube_UART_SimpleCbFn_t fnIoInit;
    ketCube_UART_SimpleCbFn_t fnIoDeInit;
    ketCube_UART_SimpleCbFn_t fnIRQCallback;
    ketCube_UART_SimpleCbFn_t fnReceiveCallback;
    ketCube_UART_SimpleCbFn_t fnTransmitCallback;
    ketCube_UART_SimpleCbFn_t fnErrorCallback;
    ketCube_UART_SimpleCbFn_t fnWakeupCallback;
} ketCube_UART_descriptor_t;
 
extern ketCube_cfg_DrvError_t
ketCube_UART_RegisterHandle(ketCube_UART_ChannelNo_t channel,
                            ketCube_UART_descriptor_t * descriptor);
extern ketCube_cfg_DrvError_t
ketCube_UART_UnRegisterHandle(ketCube_UART_ChannelNo_t channel);
extern ketCube_cfg_DrvError_t ketCube_UART_SetupPin(ketCube_gpio_port_t port,
                                                    ketCube_gpio_pin_t pin,
                                                    uint8_t af);
 
extern UART_HandleTypeDef *ketCube_UART_GetHandle(ketCube_UART_ChannelNo_t
                                                  channel);
 
extern void ketCube_UART_IRQCallback(ketCube_UART_ChannelNo_t channel);
extern void ketCube_UART_ReceiveCallback(ketCube_UART_ChannelNo_t channel);
extern void ketCube_UART_TransmitCallback(ketCube_UART_ChannelNo_t
                                          channel);
extern void ketCube_UART_ErrorCallback(ketCube_UART_ChannelNo_t channel);
extern void ketCube_UART_WakeupCallback(ketCube_UART_ChannelNo_t channel);
 
extern void ketCube_UART_IoInitCallback(ketCube_UART_ChannelNo_t channel);
extern void ketCube_UART_IoDeInitCallback(ketCube_UART_ChannelNo_t
                                          channel);
 
extern void ketCube_UART_IoInitAll(void);
extern void ketCube_UART_IoDeInitAll(void);
 
extern void ketCube_UART_EnableAll(void);
extern void ketCube_UART_DisableAll(void);
 
#endif                          /* __KETCUBE_UART_H */