mira_uart.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (C) 2016 LumenRadio AB                                         *
 *                                                                          *
 * This file is part of MiraOS.                                             *
 *                                                                          *
 *   MiraOS contains software components that are patented by LumenRadio.   *
 *   Use of this software is under the terms of the LumenRadio MiraOS       *
 *   license.
 *                                                                          *
 *   You should have received a copy of the MiraOS license from your        *
 *   LumenRadio representative. If not, email to <licenses@lumenradio.com>  *
 ****************************************************************************/

#ifndef LIBMIRA_UART_H_
#define LIBMIRA_UART_H_

#include <stdint.h>

typedef enum {
    MIRA_UART_NONE      = 0x00,     
    MIRA_UART_ERROR     = 0x01      
} MiraUartError;

typedef enum { 
    MIRA_UART_BITS_5 = 5,
    MIRA_UART_BITS_6,
    MIRA_UART_BITS_7,
    MIRA_UART_BITS_8
} MiraUartBits;

typedef enum {
    MIRA_UART_PARITY_NONE,
    MIRA_UART_PARITY_ODD,
    MIRA_UART_PARITY_EVEN
} MiraUartParity;

typedef enum {
    MIRA_UART_STOP_BITS_1 = 1,
    MIRA_UART_STOP_BITS_2
} MiraUartStopBits;

typedef void (* MiraUartDataReceivedCallback)(uint8_t* data_ptr, uint8_t length);

MiraUartError mira_uart_init(
    uint32_t baud_rate, 
    MiraUartBits bits, 
    MiraUartParity parity, 
    MiraUartStopBits stop_bits, 
    MiraUartDataReceivedCallback callback);

void mira_uart_send_byte(uint8_t data);

uint8_t mira_uart_receive_byte();

uint8_t mira_uart_send_buffer_is_full();

uint8_t mira_uart_send_buffer_is_empty();

uint8_t mira_uart_receive_buffer_is_full();

uint8_t mira_uart_receive_buffer_is_empty();

#endif /* LIBMIRA_UART_H_ */