bertos/cpu/avr/drv/ser_avr.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 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \version $Id: timer_arm.h 18273 2007-10-11 14:53:02Z batt $
  34  *
  35  * \author Daniele Basile <asterix@develer.com>
  36  *
  37  * \brief Low-level serial module for AVR (interface).
  38  *
  39  */
  40
  41 #ifndef DRV_SER_AVR_H
  42 #define DRV_SER_AVR_H
  43
  44 #include <cfg/macros.h> /* BV() */
  45 #include <cfg/compiler.h>  /* uint32_t */
  46
  47 typedef uint8_t serstatus_t;
  48
  49 /* Software errors */
  50 #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
  51 #define SERRF_RXTIMEOUT      BV(5)  /**< Receive timeout */
  52 #define SERRF_TXTIMEOUT      BV(6)  /**< Transmit timeout */
  53
  54 /*
  55 * Hardware errors.
  56 * These flags map directly to the AVR UART Status Register (USR).
  57 */
  58 #define SERRF_RXSROVERRUN    BV(3)  /**< Rx shift register overrun */
  59 #define SERRF_FRAMEERROR     BV(4)  /**< Stop bit missing */
  60 #define SERRF_PARITYERROR    BV(7)  /**< Parity error */
  61 #define SERRF_NOISEERROR     0      /**< Unsupported */
  62
  63
  64 /**
  65  * SPI clock polarity.
  66  *
  67  * $WIZ$ ser_spi_pol = "SPI_NORMAL_LOW", "SPI_NORMAL_HIGH"
  68  * }
  69  */
  70 #define SPI_NORMAL_LOW      0
  71 #define SPI_NORMAL_HIGH     1
  72
  73 /**
  74  * SPI clock phase.
  75  *
  76  * $WIZ$ ser_spi_phase = "SPI_SAMPLE_ON_FIRST_EDGE", "SPI_SAMPLE_ON_SECOND_EDGE"
  77  * }
  78  */
  79 #define SPI_SAMPLE_ON_FIRST_EDGE    0
  80 #define SPI_SAMPLE_ON_SECOND_EDGE   1
  81
  82 /**
  83  * \name Serial hw numbers
  84  *
  85  * \{
  86  */
  87 enum
  88 {
  89 #if  CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 || CPU_AVR_ATMEGA1281
  90         SER_UART0,
  91         SER_UART1,
  92         SER_SPI,
  93 #elif CPU_AVR_ATMEGA103 || CPU_AVR_ATMEGA8
  94         SER_UART0,
  95         SER_SPI,
  96 #else
  97         #error unknown architecture
  98 #endif
  99         SER_CNT  /**< Number of serial ports */
 100 };
 101 /*\}*/
 102
 103 #endif /* DRV_SER_AVR_H */