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 #include "cfg/cfg_ser.h"   /* Serialport configuration settings */
  50
  51 typedef uint8_t serstatus_t;
  52
  53 /* Software errors */
  54 #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
  55 #define SERRF_RXTIMEOUT      BV(5)  /**< Receive timeout */
  56 #define SERRF_TXTIMEOUT      BV(6)  /**< Transmit timeout */
  57
  58 /*
  59 * Hardware errors.
  60 * These flags map directly to the AVR XMEGA UART Status Register.
  61 */
  62 #define SERRF_RXSROVERRUN    BV(3)  /**< Rx shift register overrun */
  63 #define SERRF_FRAMEERROR     BV(4)  /**< Stop bit missing */
  64 #define SERRF_PARITYERROR    BV(2)  /**< Parity error */
  65 #define SERRF_NOISEERROR     0      /**< Unsupported */
  66
  67 /*
  68  * XMEGA_D4 has 2 serial ports
  69  * XMEGA_D3 has 3 serial ports
  70  * XMEGA_A4 has 5 serial ports
  71  * XMEGA_A3 has 7 serial ports
  72  * XMEGA_A1 has 8 serial ports
  73  *
  74  * These serial ports can be enabled or disabled in the cfg_ser.h file
  75  * Generate definitions whether a serial port needs to be implementend by
  76  * the driver, depending on the type of XMega and the settings in cfg_ser.h
  77  */
  78 #if CONFIG_UART0_ENABLED
  79         #define IMPLEMENT_SER_UART0 1
  80 #else
  81         #define IMPLEMENT_SER_UART0 0
  82 #endif
  83 #if CONFIG_UART1_ENABLED
  84         #define IMPLEMENT_SER_UART1 1
  85 #else
  86         #define IMPLEMENT_SER_UART1 0
  87 #endif
  88 #if (CPU_AVR_XMEGA_D3 || CPU_AVR_XMEGA_A4 || CPU_AVR_XMEGA_A3 || CPU_AVR_XMEGA_A1) && CONFIG_UART2_ENABLED
  89         #define IMPLEMENT_SER_UART2 1
  90 #else
  91         #define IMPLEMENT_SER_UART2 0
  92 #endif
  93 #if CPU_AVR_XMEGA_A4 || CPU_AVR_XMEGA_A3 || CPU_AVR_XMEGA_A1
  94         #if CONFIG_UART3_ENABLED
  95                 #define IMPLEMENT_SER_UART3 1
  96         #else
  97                 #define IMPLEMENT_SER_UART3 0
  98         #endif
  99         #if CONFIG_UART4_ENABLED
 100                 #define IMPLEMENT_SER_UART4 1
 101         #else
 102                 #define IMPLEMENT_SER_UART4 0
 103         #endif
 104 #else
 105         #define IMPLEMENT_SER_UART3 0
 106         #define IMPLEMENT_SER_UART4 0
 107 #endif
 108 #if CPU_AVR_XMEGA_A3 || CPU_AVR_XMEGA_A1
 109         #if CONFIG_UART5_ENABLED
 110                 #define IMPLEMENT_SER_UART5 1
 111         #else
 112                 #define IMPLEMENT_SER_UART5 0
 113         #endif
 114         #if CONFIG_UART6_ENABLED
 115                 #define IMPLEMENT_SER_UART6 1
 116         #else
 117                 #define IMPLEMENT_SER_UART6 0
 118         #endif
 119 #else
 120         #define IMPLEMENT_SER_UART5 0
 121         #define IMPLEMENT_SER_UART6 0
 122 #endif
 123 #if CPU_AVR_XMEGA_A1 && CONFIG_UART7_ENABLED
 124         #define IMPLEMENT_SER_UART7 1
 125 #else
 126         #define IMPLEMENT_SER_UART7 0
 127 #endif
 128
 129 /*
 130  *
 131  * \name Serial hw numbers
 132  *
 133  * \{
 134  */
 135 enum
 136 {
 137 #if IMPLEMENT_SER_UART0
 138         SER_UART0,
 139 #endif
 140 #if IMPLEMENT_SER_UART1
 141         SER_UART1,
 142 #endif
 143 #if IMPLEMENT_SER_UART2
 144         SER_UART2,
 145 #endif
 146 #if IMPLEMENT_SER_UART3
 147         SER_UART3,
 148 #endif
 149 #if IMPLEMENT_SER_UART4
 150         SER_UART4,
 151 #endif
 152 #if IMPLEMENT_SER_UART5
 153         SER_UART5,
 154 #endif
 155 #if IMPLEMENT_SER_UART6
 156         SER_UART6,
 157 #endif
 158 #if IMPLEMENT_SER_UART7
 159         SER_UART7,
 160 #endif
 161         SER_CNT /**< Number of serial ports implemented*/
 162 };
 163 /*\}*/
 164
 165 #endif /* DRV_SER_XMEGA_H */