ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new...

[bertos.git] / drv / ser.h

diff --git a/drv/ser.h b/drv/ser.h
index 9d584a8091d93f703d1809693abbf2690e4b7e89..57d66cb0b4aa5556fe699ef8205c8061d8e47fe4 100755 (executable)
--- a/drv/ser.h
+++ b/drv/ser.h
@@ -3,7 +3,7 @@
  * <!--
  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * All Rights Reserved.
+ * This file is part of DevLib - See devlib/README for information.
  * -->
  *
  * \brief High level serial I/O API
@@ -14,6 +14,18 @@
 
 /*
  * $Log$
+ * Revision 1.6  2004/07/29 22:57:09  bernie
+ * ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros.
+ *
+ * Revision 1.5  2004/07/18 21:54:23  bernie
+ * Add ATmega8 support.
+ *
+ * Revision 1.4  2004/06/03 11:27:09  bernie
+ * Add dual-license information.
+ *
+ * Revision 1.3  2004/06/02 21:35:24  aleph
+ * Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
+ *
  * Revision 1.2  2004/05/23 18:21:53  bernie
  * Trim CVS logs and cleanup header info.
  *
@@ -21,9 +33,10 @@
 #ifndef DRV_SER_H
 #define DRV_SER_H
 
-#include "compiler.h"
 #include <mware/fifobuf.h>
-#include "config.h"
+#include <drv/kdebug.h>
+#include <compiler.h>
+#include <config.h>
 
 /*!
  * \name Serial Error/status flags
@@ -36,6 +49,8 @@
  */
 /*\{*/
 #if defined(__AVR__)
+       typedef uint8_t serstatus_t;
+
        /* Software errors */
        #define SERRF_RXFIFOOVERRUN  BV(0)  /*!< Rx FIFO buffer overrun */
        #define SERRF_RXTIMEOUT      BV(5)  /*!< Receive timeout */
@@ -46,6 +61,8 @@
        #define SERRF_FRAMEERROR     BV(4)  /*!< Stop bit missing */
        #define SERRF_PARITYERROR    BV(7)  /*!< Parity error */
 #elif defined(__m56800__)
+       typedef uint16_t serstatus_t;
+
        /* Software errors */
        #define SERRF_RXFIFOOVERRUN  BV(0)  /*!< Rx FIFO buffer overrun */
        #define SERRF_RXTIMEOUT      BV(1)  /*!< Receive timeout */
@@ -75,22 +92,19 @@
  */
 enum
 {
-       #if defined(__AVR_ATmega64__)
+#if defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__)
        SER_UART0,
        SER_UART1,
        SER_SPI,
-
-       #elif defined(__AVR_ATmega103__)
+#elif defined(__AVR_ATmega103__) || defined(__AVR_ATmega8__)
        SER_UART0,
        SER_SPI,
-
-       #elif defined (__m56800__)
+#elif defined (__m56800__)
        SER_UART0,
        SER_UART1,
-
-       #else
-               #error unknown architecture
-       #endif
+#else
+       #error unknown architecture
+#endif
 
        SER_CNT       /**< Number of serial ports */
 };
@@ -108,7 +122,7 @@ struct Serial
        /*! Physical port number */
        unsigned int unit;
 
-       bool is_open;
+       DB(bool is_open;)
 
        /*!
         * \name FIFO transmit and receive buffers.
@@ -117,21 +131,21 @@ struct Serial
         *
         * \{
         */
-       volatile FIFOBuffer txfifo;
-       volatile FIFOBuffer     rxfifo;
+       FIFOBuffer txfifo;
+       FIFOBuffer rxfifo;
        unsigned char txbuffer[CONFIG_SER_TXBUFSIZE];
        unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE];
        /* \} */
 
-#ifdef CONFIG_SER_RXTIMEOUT
+#if CONFIG_SER_RXTIMEOUT != -1
        time_t rxtimeout;
 #endif
-#ifdef CONFIG_SER_TXTIMEOUT
+#if CONFIG_SER_TXTIMEOUT != -1
        time_t txtimeout;
 #endif
 
        /*! Holds the flags defined above.  Will be 0 when no errors have occurred. */
-       REGISTER uint16_t status;
+       serstatus_t status;
 
        /*! Low-level interface to hardware. */
        struct SerialHardware* hw;
@@ -142,20 +156,24 @@ struct Serial
 extern int ser_putchar(int c, struct Serial *port);
 extern int ser_getchar(struct Serial *port);
 extern int ser_getchar_nowait(struct Serial *port);
+
 extern int ser_write(struct Serial *port, const void *buf, size_t len);
 extern int ser_read(struct Serial *port, char *buf, size_t size);
+
 extern int ser_print(struct Serial *port, const char *s);
+extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
+
 extern int ser_gets(struct Serial *port, char *buf, int size);
 extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
-extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
+
 extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
 extern void ser_setparity(struct Serial *port, int parity);
+extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
 extern void ser_purge(struct Serial *port);
+extern void ser_drain(struct Serial *port);
+
 extern struct Serial *ser_open(unsigned int unit);
 extern void ser_close(struct Serial *port);
-#if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT)
-       extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
-#endif
 
 /*!
  * \name Additional functions implemented as macros