uart.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef UART_H_
#define UART_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum uart_size {
    UART_CS_5,
    UART_CS_6,
    UART_CS_7,
    UART_CS_8,
    UART_CS_9,
};
 
enum uart_parity {
    UART_PAR_NO,
    UART_PAR_MARK,
    UART_PAR_SPACE,
    UART_PAR_ODD,
    UART_PAR_EVEN
};
 
enum uart_stop {
    UART_STOP_1_BIT,
    UART_STOP_2_BIT
};
 
struct uart_init_param {
    uint8_t device_id;
    uint32_t        baud_rate;
    enum uart_size      size;
    enum uart_parity    parity;
    enum uart_stop      stop;
    void        *extra;
};
 
struct uart_desc {
    uint8_t     device_id;
    uint32_t    baud_rate;
    void        (*callback)(void *callback_ctx, uint32_t event,
                    void *extra);
    void        *callback_ctx;
    void        *extra;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Read data from UART. Blocking function */
int32_t uart_read(struct uart_desc *desc, uint8_t *data, uint32_t bytes_number);
 
/* Write data to UART. Blocking function */
int32_t uart_write(struct uart_desc *desc, const uint8_t *data,
           uint32_t bytes_number);
 
/* Read data from UART. Non blocking function */
int32_t uart_read_nonblocking(struct uart_desc *desc, uint8_t *data,
                  uint32_t bytes_number);
 
/* Write data to UART. Non blocking function*/
int32_t uart_write_nonblocking(struct uart_desc *desc, const uint8_t *data,
                   uint32_t bytes_number);
 
/* Initialize the UART communication peripheral. */
int32_t uart_init(struct uart_desc **desc, struct uart_init_param *param);
 
/* Free the resources allocated by uart_init(). */
int32_t uart_remove(struct uart_desc *desc);
 
/* Check if UART errors occurred. */
uint32_t uart_get_errors(struct uart_desc *desc);
 
#endif /* UART_H_ */