ser_resync(): New function.
[bertos.git] / drv / ser.c
index 96c93df59370946432de6ae8d61c5bc26577109b..3e0c3440d4a1c88ec39dfebd6465f252df61f7a4 100755 (executable)
--- a/drv/ser.c
+++ b/drv/ser.c
@@ -1,9 +1,9 @@
 /*!
  * \file
  * <!--
+ * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
- * All Rights Reserved.
+ * This file is part of DevLib - See devlib/README for information.
  * -->
  *
  * \brief Buffered serial I/O driver
@@ -16,9 +16,9 @@
  * 38400bps on a 16MHz 80196.
  *
  * MODULE CONFIGURATION
- *     \li \c CONFIG_SER_HWHANDSHAKE define this preprocessor symbol to enable
- *     support for RTS/CTS handshake. Support is incomplete/untested
- *     for 80196.
+ *
+ *  \li \c CONFIG_SER_HWHANDSHAKE - set to 1 to enable RTS/CTS handshake.
+ *         Support is incomplete/untested.
  *  \li \c CONFIG_SER_TXTIMEOUT - Enable software serial transmission timeouts
  *
  *
 
 /*
  * $Log$
- * Revision 1.1  2004/05/23 18:10:11  bernie
- * Import drv/ modules.
+ * 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.5  2004/05/14 12:47:26  rasky
- * Importato nuovo supporto seriale per AVR da Stefano
+ * 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.4  2004/04/29 16:40:23  rasky
- * Durante i busy loop della seriale, chiama la proc_switch() per cambiare processo
+ * Revision 1.7  2004/07/18 21:49:03  bernie
+ * Make CONFIG_SER_DEFBAUDRATE optional.
  *
- * Revision 1.3  2004/04/21 17:38:24  rasky
- * New application
+ * Revision 1.6  2004/06/07 15:56:28  aleph
+ * Remove cast-as-lvalue extension abuse
  *
- * Revision 1.16  2004/04/03 18:30:49  aleph
- * Move timeout defines in config, private define in .c
+ * 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.15  2004/03/29 17:01:02  aleph
- * Add function to set serial parity, fix it when ser_open is used
+ * Revision 1.4  2004/06/03 11:27:09  bernie
+ * Add dual-license information.
  *
- * Revision 1.14  2004/03/29 16:19:33  aleph
- * Add ser_cleanup function; Various code improvements
+ * 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.
  *
- * Revision 1.13  2004/03/24 15:48:53  bernie
- * Remove Copyright messages from Doxygen output
  */
 
 #include <mware/formatwr.h>
@@ -62,7 +69,7 @@
 #ifdef CONFIG_KERNEL
        #include <kern/proc.h>
 #endif
-#if defined(CONFIG_SER_TXTIMEOUT) || defined(CONFIG_SER_RXTIMEOUT)
+#if CONFIG_SER_TXTIMEOUT != -1 || CONFIG_SER_RXTIMEOUT != -1
        #include <drv/timer.h>
 #endif
 
@@ -88,19 +95,19 @@ int ser_putchar(int c, struct Serial *port)
 {
        if (fifo_isfull_locked(&port->txfifo))
        {
-#ifdef CONFIG_SER_TXTIMEOUT
-               time_t start_time = timer_gettick();
+#if CONFIG_SER_TXTIMEOUT != -1
+               time_t start_time = timer_ticks();
 #endif
 
                /* Attende finche' il buffer e' pieno... */
                do
                {
-#ifdef CONFIG_KERN_SCHED
+#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
                        proc_switch();
 #endif
-#ifdef CONFIG_SER_TXTIMEOUT
-                       if (timer_gettick() - start_time >= port->txtimeout)
+#if CONFIG_SER_TXTIMEOUT != -1
+                       if (timer_ticks() - start_time >= port->txtimeout)
                        {
                                port->status |= SERRF_TXTIMEOUT;
                                return EOF;
@@ -110,7 +117,7 @@ int ser_putchar(int c, struct Serial *port)
                while (fifo_isfull_locked(&port->txfifo));
        }
 
-       fifo_push(&port->txfifo, (unsigned char)c);
+       fifo_push_locked(&port->txfifo, (unsigned char)c);
 
        /* (re)trigger tx interrupt */
        port->hw->table->enabletxirq(port->hw);
@@ -135,18 +142,18 @@ int ser_getchar(struct Serial *port)
 
        if (fifo_isempty_locked(&port->rxfifo))
        {
-#ifdef CONFIG_SER_RXTIMEOUT
-               time_t start_time = timer_gettick();
+#if CONFIG_SER_RXTIMEOUT != -1
+               time_t start_time = timer_ticks();
 #endif
                /* Wait while buffer is empty */
                do
                {
-#ifdef CONFIG_KERN_SCHED
+#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
                        proc_switch();
 #endif
-#ifdef CONFIG_SER_RXTIMEOUT
-                       if (timer_gettick() - start_time >= port->rxtimeout)
+#if CONFIG_SER_RXTIMEOUT != -1
+                       if (timer_ticks() - start_time >= port->rxtimeout)
                        {
                                port->status |= SERRF_RXTIMEOUT;
                                return EOF;
@@ -180,6 +187,7 @@ int ser_getchar_nowait(struct Serial *port)
 }
 
 
+#if CONFIG_SER_GETS
 /*!
  * Read a line long at most as size and puts it
  * in buf.
@@ -193,9 +201,10 @@ int ser_gets(struct Serial *port, char *buf, int size)
 
 
 /*!
- * Read a line long at most as size and puts it
+ * Read a line long at most as size and put it
  * in buf, with optional echo.
- * \return number of chars read or EOF in case
+ *
+ * \return number of chars read, or EOF in case
  *         of error.
  */
 int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
@@ -206,7 +215,11 @@ int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
        for (;;)
        {
                if ((c = ser_getchar(port)) == EOF)
+               {
+                       buf[i] = '\0';
                        return -1;
+               }
+
                /* FIXME */
                if (c == '\r' || c == '\n' || i >= size-1)
                {
@@ -222,6 +235,7 @@ int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
 
        return i;
 }
+#endif /* !CONFIG_SER_GETS */
 
 
 /*!
@@ -265,18 +279,23 @@ int ser_print(struct Serial *port, const char *s)
  * \brief Write a buffer to serial.
  *
  * \return 0 if OK, EOF in case of error.
+ *
+ * \todo Optimize with fifo_pushblock()
  */
-int ser_write(struct Serial *port, const void *buf, size_t len)
+int ser_write(struct Serial *port, const void *_buf, size_t len)
 {
+       const char *buf = _buf;
+
        while (len--)
        {
-               if (ser_putchar(*((const char *)buf)++, port) == EOF)
+               if (ser_putchar(*buf++, port) == EOF)
                        return EOF;
        }
        return 0;
 }
 
 
+#if CONFIG_PRINTF
 /*!
  * Formatted write
  */
@@ -292,14 +311,43 @@ int ser_printf(struct Serial *port, const char *format, ...)
 
        return len;
 }
+#endif /* CONFIG_PRINTF */
+
 
-#if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT)
+#if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
 void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout)
 {
        port->rxtimeout = rxtimeout;
        port->txtimeout = txtimeout;
 }
-#endif /* defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT) */
+#endif /* CONFIG_SER_RXTIMEOUT || CONFIG_SER_TXTIMEOUT */
+
+#if CONFIG_SER_RXTIMEOUT != -1
+/*!
+ * 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)
+{
+       time_t old_rxtimeout = port->rxtimeout;
+
+       ser_settimeouts(delay, ser->txtimeout);
+       do
+       {
+               ser_setstatus(port, 0);
+               ser_getchar(port);
+       }
+       while (!(ser_getstatus(port) & SERRF_RXTIMEOUT));
+
+       /* Restore port to an usable status */
+       ser_setstatus(port, 0);
+       ser_settimeouts(old_rxtimeout, ser->txtimeout);
+}
+#endif /* CONFIG_SER_RXTIMEOUT */
 
 
 void ser_setbaudrate(struct Serial *port, unsigned long rate)
@@ -317,10 +365,30 @@ void ser_setparity(struct Serial *port, int parity)
 /*!
  * Flush both the RX and TX buffers.
  */
-void ser_purge(struct Serial *ser)
+void ser_purge(struct Serial *port)
+{
+       fifo_flush_locked(&ser->rxfifo);
+       fifo_flush_locked(&ser->txfifo);
+}
+
+
+/*!
+ * Wait until all pending output is completely
+ * transmitted to the other end.
+ *
+ * \note The current implementation only checks the
+ *       software transmission queue. Any hardware
+ *       FIFOs are ignored.
+ */
+void ser_drain(struct Serial *ser)
 {
-       fifo_flush(&ser->rxfifo);
-       fifo_flush(&ser->txfifo);
+       while (!fifo_isempty(&ser->txfifo))
+       {
+#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
+                       /* Give up timeslice to other processes. */
+                       proc_switch();
+#endif
+       }
 }
 
 
@@ -332,13 +400,12 @@ struct Serial *ser_open(unsigned int unit)
        struct Serial *port;
 
        ASSERT(unit < countof(ser_handles));
-
        port = &ser_handles[unit];
 
        ASSERT(!port->is_open);
+       DB(port->is_open = true;)
 
        port->unit = unit;
-       port->is_open = true;
 
        /* Initialize circular buffer */
        fifo_init(&port->rxfifo, port->rxbuffer, sizeof(port->rxbuffer));
@@ -348,10 +415,12 @@ struct Serial *ser_open(unsigned int unit)
        port->hw->table->init(port->hw, port);
 
        /* Set default values */
-#if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT)
+#if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
        ser_settimeouts(port, CONFIG_SER_RXTIMEOUT, CONFIG_SER_TXTIMEOUT);
 #endif
+#if CONFIG_SER_DEFBAUDRATE
        ser_setbaudrate(port, CONFIG_SER_DEFBAUDRATE);
+#endif
 
        return port;
 }
@@ -363,8 +432,8 @@ struct Serial *ser_open(unsigned int unit)
 void ser_close(struct Serial *port)
 {
        ASSERT(port->is_open);
+       DB(port->is_open = false;)
 
-       port->is_open = false;
        port->hw->table->cleanup(port->hw);
-       port->hw = NULL;        
+       port->hw = NULL;
 }