no_os_uart.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_UART_H_
#define _NO_OS_UART_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
#include "no_os_lf256fifo.h"
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum no_os_uart_size {
    NO_OS_UART_CS_5,
    NO_OS_UART_CS_6,
    NO_OS_UART_CS_7,
    NO_OS_UART_CS_8,
    NO_OS_UART_CS_9,
};
 
enum no_os_uart_parity {
    NO_OS_UART_PAR_NO,
    NO_OS_UART_PAR_MARK,
    NO_OS_UART_PAR_SPACE,
    NO_OS_UART_PAR_ODD,
    NO_OS_UART_PAR_EVEN
};
 
enum no_os_uart_stop {
    NO_OS_UART_STOP_1_BIT,
    NO_OS_UART_STOP_2_BIT
};
 
struct no_os_uart_platform_ops ;
 
struct no_os_uart_init_param {
    uint8_t device_id;
    uint32_t irq_id;
    bool asynchronous_rx;
    uint32_t        baud_rate;
    enum no_os_uart_size        size;
    enum no_os_uart_parity  parity;
    enum no_os_uart_stop        stop;
    const struct no_os_uart_platform_ops *platform_ops;
    void        *extra;
};
 
struct no_os_uart_desc {
    uint8_t     device_id;
    uint32_t    irq_id;
    struct lf256fifo *rx_fifo;
    uint32_t    baud_rate;
    const struct no_os_uart_platform_ops *platform_ops;
    void        *extra;
};
 
struct no_os_uart_platform_ops {
    int32_t (*init)(struct no_os_uart_desc **, struct no_os_uart_init_param *);
    int32_t (*read)(struct no_os_uart_desc *, uint8_t *, uint32_t);
    int32_t (*write)(struct no_os_uart_desc *, const uint8_t *, uint32_t);
    int32_t (*read_nonblocking)(struct no_os_uart_desc *, uint8_t *, uint32_t);
    int32_t (*write_nonblocking)(struct no_os_uart_desc *, const uint8_t *,
                     uint32_t);
    int32_t (*remove)(struct no_os_uart_desc *);
    uint32_t (*get_errors)(struct no_os_uart_desc *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Read data from UART. Blocking function */
int32_t no_os_uart_read(struct no_os_uart_desc *desc, uint8_t *data,
            uint32_t bytes_number);
 
/* Write data to UART. Blocking function */
int32_t no_os_uart_write(struct no_os_uart_desc *desc, const uint8_t *data,
             uint32_t bytes_number);
 
/* Read data from UART. Non blocking function */
int32_t no_os_uart_read_nonblocking(struct no_os_uart_desc *desc, uint8_t *data,
                    uint32_t bytes_number);
 
/* Write data to UART. Non blocking function*/
int32_t no_os_uart_write_nonblocking(struct no_os_uart_desc *desc,
                     const uint8_t *data,
                     uint32_t bytes_number);
 
/* Initialize the UART communication peripheral. */
int32_t no_os_uart_init(struct no_os_uart_desc **desc,
            struct no_os_uart_init_param *param);
 
/* Free the resources allocated by no_os_uart_init(). */
int32_t no_os_uart_remove(struct no_os_uart_desc *desc);
 
/* Check if UART errors occurred. */
uint32_t no_os_uart_get_errors(struct no_os_uart_desc *desc);
 
/* Make stdio to use this UART. */
void no_os_uart_stdio(struct no_os_uart_desc *desc);
 
#endif // _NO_OS_UART_H_