bertos/cpu/arm/drv/ser_at91.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 2003,2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief High level serial I/O API
  35  *
  36  * \version $Id: ser_at91.h 20552 2008-02-14 16:40:41Z batt $
  37  * \author Daniele Basile <asterix@develer.com>
  38  */
  39
  40 #ifndef SER_AT91_H
  41 #define SER_AT91_H
  42
  43 #include <cfg/macros.h> /* BV() */
  44 #include <cfg/compiler.h>  /* uint32_t */
  45 #include <cpu/detect.h>  /* CPU_* */
  46
  47 /** \name Serial Error/status flags. */
  48 /*\{*/
  49 typedef uint32_t serstatus_t;
  50
  51 /* Software errors */
  52 #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
  53 #define SERRF_RXTIMEOUT      BV(1)  /**< Receive timeout */
  54 #define SERRF_TXTIMEOUT      BV(2)  /**< Transmit timeout */
  55
  56 /*
  57         * Hardware errors.
  58         * These flags map directly to the ARM USART Channel Status Register (US_CSR).
  59         */
  60 #define SERRF_RXSROVERRUN    BV(5)  /**< Rx shift register overrun */
  61 #define SERRF_FRAMEERROR     BV(6)  /**< Stop bit missing */
  62 #define SERRF_PARITYERROR    BV(7)  /**< Parity error */
  63 #define SERRF_NOISEERROR     0      /**< Unsupported */
  64 /*\}*/
  65
  66 /**
  67  * \name Serial hw numbers
  68  *
  69  * \{
  70  */
  71 enum
  72 {
  73 SER_UART0,
  74 SER_UART1,
  75 SER_SPI0,
  76 #if CPU_ARM_AT91SAM7X128 || CPU_ARM_AT91SAM7X256
  77 SER_SPI1,
  78 #endif
  79 SER_CNT  /**< Number of serial ports */
  80 };
  81 /*\}*/
  82
  83 #endif /* SER_AT91_H */