Merge contributed patch to extend support of atxmega.
[bertos.git] / bertos / cpu / avr / drv / ser_xmega.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2007, 2010 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2011 Onno <developer@gorgoz.org>
31  * -->
32  *
33  *
34  * \brief Low-level serial module for AVR XMEGA (interface).
35  *
36  * This file is heavily inspired by the AVR implementation for BeRTOS,
37  * but uses a different approach for implementing the different debug
38  * ports, by using the USART_t structs.
39  *
40  * \author Onno <developer@gorgoz.org>
41  *
42  */
43
44 #ifndef DRV_SER_XMEGA_H
45 #define DRV_SER_XMEGA_H
46
47 #include <cfg/macros.h>   /* BV() */
48 #include <cfg/compiler.h> /* uint8_t */
49
50 typedef uint8_t serstatus_t;
51
52 /* Software errors */
53 #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
54 #define SERRF_RXTIMEOUT      BV(5)  /**< Receive timeout */
55 #define SERRF_TXTIMEOUT      BV(6)  /**< Transmit timeout */
56
57 /*
58 * Hardware errors.
59 * These flags map directly to the AVR XMEGA UART Status Register.
60 */
61 #define SERRF_RXSROVERRUN    BV(3)  /**< Rx shift register overrun */
62 #define SERRF_FRAMEERROR     BV(4)  /**< Stop bit missing */
63 #define SERRF_PARITYERROR    BV(2)  /**< Parity error */
64 #define SERRF_NOISEERROR     0      /**< Unsupported */
65
66 /*
67  * \name Serial hw numbers
68  *
69  * \{
70  */
71 enum
72 {
73         SER_UART0,
74         SER_UART1,
75 #ifdef CPU_AVR_XMEGA_A
76         //the XMEGA A Family have 5 USART ports
77         SER_UART2,
78         SER_UART3,
79         SER_UART4,
80 #endif
81         SER_CNT  /**< Number of serial ports */
82 };
83 /*\}*/
84
85 #endif /* DRV_SER_XMEGA_H */