Remove cvs log.
[bertos.git] / drv / ser.h
old mode 100755 (executable)
new mode 100644 (file)
index 5b07fbc..6a62642
--- a/drv/ser.h
+++ b/drv/ser.h
@@ -1,9 +1,34 @@
 /**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief High level serial I/O API
 
 /*#*
  *#* $Log$
+ *#* Revision 1.36  2007/01/29 11:30:30  batt
+ *#* Reimplement ser_clearstatus as a macro.
+ *#*
+ *#* Revision 1.35  2007/01/27 20:47:12  batt
+ *#* Add clear status.
+ *#*
+ *#* Revision 1.34  2006/11/20 15:07:40  batt
+ *#* Revert unneeded locked functions.
+ *#*
+ *#* Revision 1.33  2006/11/17 17:03:58  batt
+ *#* Implement ser_setstatus and ser_getstatus as functions to avoid race conditions.
+ *#*
+ *#* Revision 1.32  2006/11/17 16:01:12  batt
+ *#* Serial status MUST be volatile.
+ *#*
  *#* Revision 1.31  2006/09/13 18:22:48  bernie
  *#* Typo.
  *#*
 #ifndef DRV_SER_H
 #define DRV_SER_H
 
+
 #include <mware/fifobuf.h>
 #include <cfg/compiler.h>
-#include <cfg/macros.h> /* BV() */
-#include <cfg/os.h>
-#include <appconfig.h>
-
-/** \name Serial Error/status flags. */
-/*\{*/
-#if CPU_AVR
-       typedef uint8_t serstatus_t;
-
-       /* Software errors */
-       #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
-       #define SERRF_RXTIMEOUT      BV(5)  /**< Receive timeout */
-       #define SERRF_TXTIMEOUT      BV(6)  /**< Transmit timeout */
 
-       /*
-        * Hardware errors.
-        * These flags map directly to the AVR UART Status Register (USR).
-        */
-       #define SERRF_RXSROVERRUN    BV(3)  /**< Rx shift register overrun */
-       #define SERRF_FRAMEERROR     BV(4)  /**< Stop bit missing */
-       #define SERRF_PARITYERROR    BV(7)  /**< Parity error */
-       #define SERRF_NOISEERROR     0      /**< Unsupported */
-#elif CPU_DSP56K
-       typedef uint16_t serstatus_t;
-
-       /* Software errors */
-       #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
-       #define SERRF_RXTIMEOUT      BV(1)  /**< Receive timeout */
-       #define SERRF_TXTIMEOUT      BV(2)  /**< Transmit timeout */
-
-       /*
-        * Hardware errors.
-        * These flags map directly to the SCI Control Register.
-        */
-       #define SERRF_PARITYERROR    BV(8)  /**< Parity error */
-       #define SERRF_FRAMEERROR     BV(9)  /**< Stop bit missing */
-       #define SERRF_NOISEERROR     BV(10) /**< Noise error */
-       #define SERRF_RXSROVERRUN    BV(11) /**< Rx shift register overrun */
-#elif OS_HOSTED
-       typedef uint16_t serstatus_t;
+#include CPU_HEADER(ser)
 
-       /* Software errors */
-       #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
-       #define SERRF_RXTIMEOUT      BV(1)  /**< Receive timeout */
-       #define SERRF_TXTIMEOUT      BV(2)  /**< Transmit timeout */
+#include <appconfig.h>
 
-       /* Hardware errors */
-       #define SERRF_RXSROVERRUN    0      /**< Unsupported in emulated serial port. */
-       #define SERRF_FRAMEERROR     0      /**< Unsupported in emulated serial port. */
-       #define SERRF_PARITYERROR    0      /**< Unsupported in emulated serial port. */
-       #define SERRF_NOISEERROR     0      /**< Unsupported in emulated serial port. */
 
-#else
-       #error unknown architecture
-#endif
-/*\}*/
 
 /**
  * \name Masks to group TX/RX errors.
 /*\}*/
 
 /**
- * \name LSB or MSB first data order, used with SPI AVR serial
+ * \name LSB or MSB first data order for SPI driver.
  * \{
  */
 #define SER_MSB_FIRST 0
 #define SER_PARITY_ODD   3
 /*\}*/
 
-/**
- * \name Serial hw numbers
- *
- * \{
- */
-enum
-{
-#if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
-       SER_UART0,
-       SER_UART1,
-       SER_SPI,
-#elif CPU_AVR_ATMEGA103 || CPU_AVR_ATMEGA8
-       SER_UART0,
-       SER_SPI,
-#elif CPU_DSP56K
-       // \todo since we now support "fake" multiplexed serials, this should be moved to hw.h
-       SER_UART0,
-       SER_PUNTALI,
-       SER_BARCODE,
-#elif OS_HOSTED
-       SER_UART0,
-       SER_UART1,
-#else
-       #error unknown architecture
-#endif
-       SER_CNT  /**< Number of serial ports */
-};
-/*\}*/
-
 
 struct SerialHardware;
 
@@ -266,7 +228,7 @@ typedef struct Serial
 #endif
 
        /** Holds the flags defined above.  Will be 0 when no errors have occurred. */
-       serstatus_t status;
+       volatile serstatus_t status;
 
        /** Low-level interface to hardware. */
        struct SerialHardware* hw;
@@ -304,6 +266,7 @@ extern void ser_close(struct Serial *port);
  */
 #define ser_getstatus(h)    ((h)->status)
 #define ser_setstatus(h, x) ((h)->status = (x))
+#define ser_clearstatus(h)  ser_setstatus(h, 0)
 /* \} */
 
 #endif /* DRV_SER_H */