Include top-level headers from cfg/ subdir.
[bertos.git] / drv / ser.c
index 52e5652eb0b89074ceaa01e1b62e9db5d5c11316..59ab1fea388e72114593093af0ef92739b3c4eff 100755 (executable)
--- a/drv/ser.c
+++ b/drv/ser.c
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*
- * $Log$
- * Revision 1.12  2004/08/24 13:49:39  bernie
- * Fix thinko.
- *
- * Revision 1.11  2004/08/15 05:32:22  bernie
- * ser_resync(): New function.
- *
- * Revision 1.10  2004/08/10 06:29:50  bernie
- * Rename timer_gettick() to timer_ticks().
- *
- * Revision 1.9  2004/08/08 06:06:20  bernie
- * Use new-style CONFIG_ idiom; Fix module-wide documentation.
- *
- * Revision 1.8  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.7  2004/07/18 21:49:03  bernie
- * Make CONFIG_SER_DEFBAUDRATE optional.
- *
- * Revision 1.6  2004/06/07 15:56:28  aleph
- * Remove cast-as-lvalue extension abuse
- *
- * Revision 1.5  2004/06/06 16:41:44  bernie
- * ser_putchar(): Use fifo_push_locked() to fix potential race on 8bit processors.
- *
- * 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.
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.25  2005/04/11 19:10:27  bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.24  2005/01/21 20:13:15  aleph
+ *#* Fix drain at ser_close()
+ *#*
+ *#* Revision 1.23  2005/01/14 00:47:07  aleph
+ *#* ser_drain(): Wait for hw transmission complete.
+ *#*
+ *#* Revision 1.22  2004/12/08 08:56:14  bernie
+ *#* Rename time_t to mtime_t.
+ *#*
+ *#* Revision 1.21  2004/11/16 18:10:13  bernie
+ *#* Add sanity checks for missing configuration parameters.
+ *#*
+ *#* Revision 1.20  2004/10/19 11:48:00  bernie
+ *#* Remove unused variable.
+ *#*
+ *#* Revision 1.19  2004/10/19 08:14:13  bernie
+ *#* Fix a few longstanding bugs wrt status handling (made by rasky on scfirm).
+ *#*
+ *#* Revision 1.18  2004/09/20 03:31:15  bernie
+ *#* Sanitize for C++.
+ *#*
+ *#* Revision 1.17  2004/09/14 21:06:07  bernie
+ *#* Use debug.h instead of kdebug.h; Spelling fixes.
+ *#*
+ *#* Revision 1.16  2004/09/06 21:40:50  bernie
+ *#* Move buffer handling in chip-specific driver.
+ *#*
+ *#* Revision 1.15  2004/08/25 14:12:08  rasky
+ *#* Aggiornato il comment block dei log RCS
+ *#*
+ *#* Revision 1.14  2004/08/24 16:22:57  bernie
+ *#* Thinkos; Doxygen fixes
+ *#*
+ *#* Revision 1.13  2004/08/24 16:20:48  bernie
+ *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write()
+ *#*
+ *#* Revision 1.12  2004/08/24 13:49:39  bernie
+ *#* Fix thinko.
+ *#*
+ *#* Revision 1.11  2004/08/15 05:32:22  bernie
+ *#* ser_resync(): New function.
+ *#*
+ *#* Revision 1.10  2004/08/10 06:29:50  bernie
+ *#* Rename timer_gettick() to timer_ticks().
+ *#*
+ *#* Revision 1.9  2004/08/08 06:06:20  bernie
+ *#* Use new-style CONFIG_ idiom; Fix module-wide documentation.
+ *#*
+ *#* Revision 1.8  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.7  2004/07/18 21:49:03  bernie
+ *#* Make CONFIG_SER_DEFBAUDRATE optional.
+ *#*
+ *#* Revision 1.6  2004/06/07 15:56:28  aleph
+ *#* Remove cast-as-lvalue extension abuse
+ *#*
+ *#* Revision 1.5  2004/06/06 16:41:44  bernie
+ *#* ser_putchar(): Use fifo_push_locked() to fix potential race on 8bit processors.
+ *#*
+ *#* 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.
+ *#*
+ *#*/
 
-#include <mware/formatwr.h>
-#include <drv/kdebug.h>
 #include "ser.h"
 #include "ser_p.h"
-#include "hw.h"
+#include <mware/formatwr.h>
+#include <cfg/debug.h>
+#include <hw.h>
+#include <cfg/config.h>
 
-#ifdef CONFIG_KERNEL
+/*
+ * Sanity check for config parameters required by this module.
+ */
+#if !defined(CONFIG_KERNEL) || ((CONFIG_KERNEL != 0) && CONFIG_KERNEL != 1)
+       #error CONFIG_KERNEL must be set to either 0 or 1 in config.h
+#endif
+#if !defined(CONFIG_SER_RXTIMEOUT)
+       #error CONFIG_SER_TXTIMEOUT missing in config.h
+#endif
+#if !defined(CONFIG_SER_RXTIMEOUT)
+       #error CONFIG_SER_RXTIMEOUT missing in config.h
+#endif
+#if !defined(CONFIG_SER_GETS) || ((CONFIG_SER_GETS != 0) && CONFIG_SER_GETS != 1)
+       #error CONFIG_SER_GETS must be set to either 0 or 1 in config.h
+#endif
+#if !defined(CONFIG_SER_DEFBAUDRATE)
+       #error CONFIG_SER_DEFBAUDRATE missing in config.h
+#endif
+#if !defined(CONFIG_PRINTF)
+       #error CONFIG_PRINTF missing in config.h
+#endif
+
+#if CONFIG_KERNEL
        #include <kern/proc.h>
 #endif
+
 #if CONFIG_SER_TXTIMEOUT != -1 || CONFIG_SER_RXTIMEOUT != -1
        #include <drv/timer.h>
 #endif
@@ -96,16 +159,17 @@ struct Serial ser_handles[SER_CNT];
  */
 int ser_putchar(int c, struct Serial *port)
 {
+       //ASSERT_VALID_FIFO(&port->txfifo);
        if (fifo_isfull_locked(&port->txfifo))
        {
 #if CONFIG_SER_TXTIMEOUT != -1
-               time_t start_time = timer_ticks();
+               mtime_t start_time = timer_ticks();
 #endif
 
                /* Attende finche' il buffer e' pieno... */
                do
                {
-#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
+#if CONFIG_KERNEL && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
                        proc_switch();
 #endif
@@ -123,9 +187,9 @@ int ser_putchar(int c, struct Serial *port)
        fifo_push_locked(&port->txfifo, (unsigned char)c);
 
        /* (re)trigger tx interrupt */
-       port->hw->table->enabletxirq(port->hw);
+       port->hw->table->txStart(port->hw);
 
-       /* Avoid returning signed estended char */
+       /* Avoid returning signed extended char */
        return (int)((unsigned char)c);
 }
 
@@ -141,17 +205,15 @@ int ser_putchar(int c, struct Serial *port)
  */
 int ser_getchar(struct Serial *port)
 {
-       int result;
-
        if (fifo_isempty_locked(&port->rxfifo))
        {
 #if CONFIG_SER_RXTIMEOUT != -1
-               time_t start_time = timer_ticks();
+               mtime_t start_time = timer_ticks();
 #endif
                /* Wait while buffer is empty */
                do
                {
-#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
+#if CONFIG_KERNEL && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
                        proc_switch();
 #endif
@@ -163,15 +225,16 @@ int ser_getchar(struct Serial *port)
                        }
 #endif /* CONFIG_SER_RXTIMEOUT */
                }
-               while (fifo_isempty_locked(&port->rxfifo));
+               while (fifo_isempty_locked(&port->rxfifo) && (port->status & SERRF_RX) == 0);
        }
 
        /*
         * Get a byte from the FIFO (avoiding sign-extension),
         * re-enable RTS, then return result.
         */
-       result = (int)(unsigned char)fifo_pop(&port->rxfifo);
-       return port->status ? EOF : result;
+       if (port->status & SERRF_RX)
+               return EOF;
+       return (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
 }
 
 
@@ -186,13 +249,13 @@ int ser_getchar_nowait(struct Serial *port)
                return EOF;
 
        /* NOTE: the double cast prevents unwanted sign extension */
-       return (int)(unsigned char)fifo_pop(&port->rxfifo);
+       return (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
 }
 
 
 #if CONFIG_SER_GETS
 /*!
- * Read a line long at most as size and puts it
+ * Read a line long at most as size and put it
  * in buf.
  * \return number of chars read or EOF in case
  *         of error.
@@ -242,21 +305,22 @@ int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
 
 
 /*!
- * Read at most size bytes and puts them
- * in buf.
- * \return number of bytes read or EOF in case
- *         of error.
+ * Read at most \a size bytes from \a port and put them in \a buf
+ *
+ * \return number of bytes actually read, or EOF in
+ *         case of error.
  */
-int ser_read(struct Serial *port, char *buf, size_t size)
+int ser_read(struct Serial *port, void *buf, size_t size)
 {
        size_t i = 0;
+       char *_buf = (char *)buf;
        int c;
 
        while (i < size)
        {
                if ((c = ser_getchar(port)) == EOF)
                        return EOF;
-               buf[i++] = c;
+               _buf[i++] = c;
        }
 
        return i;
@@ -287,7 +351,7 @@ int ser_print(struct Serial *port, const char *s)
  */
 int ser_write(struct Serial *port, const void *_buf, size_t len)
 {
-       const char *buf = _buf;
+       const char *buf = (const char *)_buf;
 
        while (len--)
        {
@@ -307,7 +371,6 @@ int ser_printf(struct Serial *port, const char *format, ...)
        va_list ap;
        int len;
 
-       ser_setstatus(port, 0);
        va_start(ap, format);
        len = _formatted_write(format, (void (*)(char, void *))ser_putchar, port, ap);
        va_end(ap);
@@ -318,7 +381,7 @@ int ser_printf(struct Serial *port, const char *format, ...)
 
 
 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
-void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout)
+void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout)
 {
        port->rxtimeout = rxtimeout;
        port->txtimeout = txtimeout;
@@ -327,18 +390,18 @@ void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout)
 
 #if CONFIG_SER_RXTIMEOUT != -1
 /*!
- * Discard input to resynchronize with remote end
+ * Discard input to resynchronize with remote end.
  *
  * Discard incoming data until the port stops receiving
  * characters for at least \a delay milliseconds.
  *
  * \note Serial errors are reset before and after executing the purge.
  */
-void ser_resync(struct Serial *port, time_t delay)
+void ser_resync(struct Serial *port, mtime_t delay)
 {
-       time_t old_rxtimeout = port->rxtimeout;
+       mtime_t old_rxtimeout = port->rxtimeout;
 
-       ser_settimeouts(delay, ser->txtimeout);
+       ser_settimeouts(port, delay, port->txtimeout);
        do
        {
                ser_setstatus(port, 0);
@@ -348,20 +411,20 @@ void ser_resync(struct Serial *port, time_t delay)
 
        /* Restore port to an usable status */
        ser_setstatus(port, 0);
-       ser_settimeouts(old_rxtimeout, ser->txtimeout);
+       ser_settimeouts(port, old_rxtimeout, port->txtimeout);
 }
 #endif /* CONFIG_SER_RXTIMEOUT */
 
 
 void ser_setbaudrate(struct Serial *port, unsigned long rate)
 {
-       port->hw->table->setbaudrate(port->hw, rate);
+       port->hw->table->setBaudrate(port->hw, rate);
 }
 
 
 void ser_setparity(struct Serial *port, int parity)
 {
-       port->hw->table->setparity(port->hw, parity);
+       port->hw->table->setParity(port->hw, parity);
 }
 
 
@@ -385,12 +448,17 @@ void ser_purge(struct Serial *port)
  */
 void ser_drain(struct Serial *ser)
 {
-       while (!fifo_isempty(&ser->txfifo))
+       /*
+        * Wait until the FIFO is empty, and then until the byte currently in
+        * the hardware register gets shifted out.
+        */
+       while (!fifo_isempty(&ser->txfifo)
+              || ser->hw->table->txSending(ser->hw))
        {
-#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
+               #if CONFIG_KERNEL && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
                        proc_switch();
-#endif
+               #endif
        }
 }
 
@@ -410,11 +478,14 @@ struct Serial *ser_open(unsigned int unit)
 
        port->unit = unit;
 
-       /* Initialize circular buffer */
-       fifo_init(&port->rxfifo, port->rxbuffer, sizeof(port->rxbuffer));
-       fifo_init(&port->txfifo, port->txbuffer, sizeof(port->txbuffer));
-
        port->hw = ser_hw_getdesc(unit);
+
+       /* Initialize circular buffers */
+       ASSERT(port->hw->txbuffer);
+       ASSERT(port->hw->rxbuffer);
+       fifo_init(&port->txfifo, port->hw->txbuffer, port->hw->txbuffer_size);
+       fifo_init(&port->rxfifo, port->hw->rxbuffer, port->hw->rxbuffer_size);
+
        port->hw->table->init(port->hw, port);
 
        /* Set default values */
@@ -425,6 +496,9 @@ struct Serial *ser_open(unsigned int unit)
        ser_setbaudrate(port, CONFIG_SER_DEFBAUDRATE);
 #endif
 
+       /* Clear error flags */
+       ser_setstatus(port, 0);
+
        return port;
 }
 
@@ -437,6 +511,15 @@ void ser_close(struct Serial *port)
        ASSERT(port->is_open);
        DB(port->is_open = false;)
 
+       // Wait until we finish sending everything
+       ser_drain(port);
+
        port->hw->table->cleanup(port->hw);
-       port->hw = NULL;
+       DB(port->hw = NULL;)
+
+       /*
+        * We purge the FIFO buffer only after the low-level cleanup, so that
+        * we are sure that there are no more interrupts.
+        */
+       ser_purge(port);
 }