Document AVR dependency.
[bertos.git] / drv / ser.h
index 9d584a8091d93f703d1809693abbf2690e4b7e89..40f27054385480472a4eb45267c69519ecfe67f7 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
 
 /*
  * $Log$
+ * 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.
  *
@@ -36,6 +45,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 +57,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 */
  */
 enum
 {
-       #if defined(__AVR_ATmega64__)
+#if defined(__AVR_ATmega64__)
        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 */
 };
@@ -117,8 +127,8 @@ struct Serial
         *
         * \{
         */
-       volatile FIFOBuffer txfifo;
-       volatile FIFOBuffer     rxfifo;
+       FIFOBuffer txfifo;
+       FIFOBuffer rxfifo;
        unsigned char txbuffer[CONFIG_SER_TXBUFSIZE];
        unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE];
        /* \} */
@@ -131,8 +141,8 @@ struct Serial
 #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,21 +152,27 @@ 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_purge(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
 
+extern struct Serial *ser_open(unsigned int unit);
+extern void ser_close(struct Serial *port);
+
 /*!
  * \name Additional functions implemented as macros
  *