uart_int.h

/*******************************************************************************
 * Copyright (c) 2009-2014, MAV'RIC Development Team
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

/*******************************************************************************
 * \file uart_int.h
 * 
 * \author MAV'RIC Team
 * \author Felix Schill
 *   
 * \brief This file implements the UART communication protocol
 * 
 ******************************************************************************/


#ifndef UART_INT_H_
#define UART_INT_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include "usart.h"
#include "buffer.h"
#include "streams.h"

typedef struct 
{
    avr32_usart_t *uart;                
    int32_t IRQ;                        
    buffer_t transmit_buffer;           
    buffer_t receive_buffer;            
    byte_stream_t *receive_stream;      
} uart_interface_t;

typedef struct
{
    uint8_t  pin;                       
    uint8_t  function;                  
} uart_gpio_map_t;


typedef struct 
{
    int32_t mode;                       
    uart_interface_t uart_device;       
    usart_options_t options;            
    uart_gpio_map_t rx_pin_map;         
    uart_gpio_map_t tx_pin_map;         
} usart_config_t;


enum UART_MODE 
{
    UART_OFF, 
    UART_IN, 
    UART_OUT, 
    UART_IN_OUT
};

enum AVAILABLE_UARTS 
{
    UART0, 
    UART1, 
    UART2, 
    UART3, 
    UART4,
    UART_COUNT
};

void uart_int_set_usart_conf(int32_t UID, usart_config_t* usart_config);

void uart_int_init(int32_t UID);

usart_config_t *uart_int_get_uart_handle(int32_t UID);

int8_t  uart_int_get_byte(usart_config_t *usart_conf);

int32_t uart_int_bytes_available(usart_config_t *usart_conf);

void uart_int_send_byte(usart_config_t *usart_conf, uint8_t data);

void uart_int_flush(usart_config_t *usart_conf );

void uart_int_register_write_stream(usart_config_t *usart_conf, byte_stream_t *stream);

void uart_int_register_write_stream_nonblocking(usart_config_t *usart_conf, byte_stream_t *stream);

void uart_int_register_read_stream(usart_config_t *usart_conf,  byte_stream_t *stream);

#ifdef __cplusplus
}
#endif

#endif /* UART_INT_H_ */