Move gfx diplay driver to AVR driver dir.

[bertos.git] / drv / ser.h

diff --git a/drv/ser.h b/drv/ser.h
old mode 100755 (executable)
new mode 100644 (file)
index f9ff2dd..ceb275f
--- 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
@@ -14,6 +39,33 @@
 
 /*#*
  *#* $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.
+ *#*
+ *#* Revision 1.30  2006/09/13 18:21:23  bernie
+ *#* Add configurable SPI pin mapping.
+ *#*
+ *#* Revision 1.29  2006/09/13 13:59:11  bernie
+ *#* Documentation fixes.
+ *#*
+ *#* Revision 1.28  2006/07/21 10:58:00  batt
+ *#* Use timer_clock() instead of obsolete timer_ticks().
+ *#*
  *#* Revision 1.27  2006/07/19 12:56:26  bernie
  *#* Convert to new Doxygen style.
  *#*
@@ -155,7 +207,10 @@
 #endif
 /*\}*/
 
-/** Mask to group all RX errors. */
+/**
+ * \name Masks to group TX/RX errors.
+ * \{
+ */
 #define SERRF_RX \
        ( SERRF_RXFIFOOVERRUN \
        | SERRF_RXTIMEOUT \
@@ -163,10 +218,16 @@
        | SERRF_PARITYERROR \
        | SERRF_FRAMEERROR \
        | SERRF_NOISEERROR)
-
-/** Mask to group all TX errors. */
 #define SERRF_TX  (SERRF_TXTIMEOUT)
+/*\}*/
 
+/**
+ * \name LSB or MSB first data order, used with SPI AVR serial
+ * \{
+ */
+#define SER_MSB_FIRST 0
+#define SER_LSB_FIRST 1
+/*\}*/
 
 /**
  * \name Parity settings for ser_setparity().
@@ -174,8 +235,8 @@
  * \note Values are AVR-specific for performance reasons.
  *       Other processors should either decode them or
  *       redefine these macros.
+ * \{
  */
-/*\{*/
 #define SER_PARITY_NONE  0
 #define SER_PARITY_EVEN  2
 #define SER_PARITY_ODD   3
@@ -188,7 +249,7 @@
  */
 enum
 {
-#if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
+#if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 || CPU_AVR_ATMEGA1281
        SER_UART0,
        SER_UART1,
        SER_SPI,
@@ -238,14 +299,14 @@ typedef struct Serial
        /* \} */
 
 #if CONFIG_SER_RXTIMEOUT != -1
-       mtime_t rxtimeout;
+       ticks_t rxtimeout;
 #endif
 #if CONFIG_SER_TXTIMEOUT != -1
-       mtime_t txtimeout;
+       ticks_t txtimeout;
 #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;
@@ -283,6 +344,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 */