ATMEL: uart_lib.h Source File

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

# uart_lib.h

Go to the documentation of this file.

    00001 /*This file is prepared for Doxygen automatic documentation generation.*/
    00013
    00014 /* Copyright (c) 2009 Atmel Corporation. All rights reserved.
    00015  *
    00016  * Redistribution and use in source and binary forms, with or without
    00017  * modification, are permitted provided that the following conditions are met:
    00018  *
    00019  * 1. Redistributions of source code must retain the above copyright notice,
    00020  * this list of conditions and the following disclaimer.
    00021  *
    00022  * 2. Redistributions in binary form must reproduce the above copyright notice,
    00023  * this list of conditions and the following disclaimer in the documentation
    00024  * and/or other materials provided with the distribution.
    00025  *
    00026  * 3. The name of Atmel may not be used to endorse or promote products derived
    00027  * from this software without specific prior written permission.
    00028  *
    00029  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
    00030  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    00031  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY AND
    00032  * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
    00033  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    00034  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    00035  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00036  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    00037  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    00038  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    00039  */
    00040
    00041 #ifndef _UART_LIB_H_
    00042 #define _UART_LIB_H_
    00043
    00044 /*_____ I N C L U D E - F I L E S ____________________________________________*/
    00045 #include "uart_drv.h"
    00046
    00047
    00048 /*_____ D E F I N I T I O N S ______________________________________________*/
    00049 #ifndef UART_CONFIG
    00050 #define UART_CONFIG     MSK_UART_8BIT
    00051 #endif
    00052
    00053 #ifndef BAUDRATE
    00054 #error You must define BAUDRATE in config.h
    00055 #define BAUDRATE        999
    00056 #endif
    00057
    00058 #define AUTOBAUD        0
    00059
    00060 #if BAUDRATE == AUTOBAUD
    00061 #define Uart_set_baudrate(bdr)  autobaud()
    00062 #include "modules/autobaud/autobaud.h"
    00063 #else
    00064 #include "lib_mcu/uart/uart_bdr.h"
    00065 #endif
    00066
    00067 /*_____ D E C L A R A T I O N ______________________________________________*/
    00068
    00069 /*_____ M A C R O S ________________________________________________________*/
    00070
    00071 /*_____ P R O T O T Y P E S ____________________________________________________________*/
    00072
    00083 bit uart_init (void);
    00084
    00097 r_uart_ptchar uart_putchar (p_uart_ptchar uc_wr_byte);
    00098
    00105 char uart_getchar (void);
    00106
    00113 bit uart_test_hit (void);
    00114
    00115
    00116
    00117 #endif /* _UART_LIB_H_ */