Use debug.h instead of kdebug.h; Spelling fixes.
[bertos.git] / drv / ser.c
index d88b0425689d69ffe3ae77aae1210c16052ba0ef..35a4d192fb9c346dcafcbc874b321fc94c062d0d 100755 (executable)
--- a/drv/ser.c
+++ b/drv/ser.c
@@ -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
  *
  *
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*
- * $Log$
- * 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.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 <debug.h>
 #include "ser.h"
 #include "ser_p.h"
 #include "hw.h"
@@ -84,21 +111,22 @@ 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_gettick();
+               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
 #if CONFIG_SER_TXTIMEOUT != -1
-                       if (timer_gettick() - start_time >= port->txtimeout)
+                       if (timer_ticks() - start_time >= port->txtimeout)
                        {
                                port->status |= SERRF_TXTIMEOUT;
                                return EOF;
@@ -134,7 +162,7 @@ int ser_getchar(struct Serial *port)
        if (fifo_isempty_locked(&port->rxfifo))
        {
 #if CONFIG_SER_RXTIMEOUT != -1
-               time_t start_time = timer_gettick();
+               time_t start_time = timer_ticks();
 #endif
                /* Wait while buffer is empty */
                do
@@ -144,7 +172,7 @@ int ser_getchar(struct Serial *port)
                        proc_switch();
 #endif
 #if CONFIG_SER_RXTIMEOUT != -1
-                       if (timer_gettick() - start_time >= port->rxtimeout)
+                       if (timer_ticks() - start_time >= port->rxtimeout)
                        {
                                port->status |= SERRF_RXTIMEOUT;
                                return EOF;
@@ -158,7 +186,7 @@ int ser_getchar(struct Serial *port)
         * Get a byte from the FIFO (avoiding sign-extension),
         * re-enable RTS, then return result.
         */
-       result = (int)(unsigned char)fifo_pop(&port->rxfifo);
+       result = (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
        return port->status ? EOF : result;
 }
 
@@ -174,7 +202,7 @@ 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);
 }
 
 
@@ -230,21 +258,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;
@@ -313,6 +342,33 @@ void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t 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(port, delay, port->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(port, old_rxtimeout, port->txtimeout);
+}
+#endif /* CONFIG_SER_RXTIMEOUT */
+
 
 void ser_setbaudrate(struct Serial *port, unsigned long rate)
 {
@@ -329,12 +385,13 @@ 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);
+       fifo_flush_locked(&port->rxfifo);
+       fifo_flush_locked(&port->txfifo);
 }
 
+
 /*!
  * Wait until all pending output is completely
  * transmitted to the other end.
@@ -345,7 +402,7 @@ void ser_purge(struct Serial *ser)
  */
 void ser_drain(struct Serial *ser)
 {
-       while(!fifo_isempty(&ser->txfifo))
+       while (!fifo_isempty(&ser->txfifo))
        {
 #if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
@@ -370,11 +427,12 @@ 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 */
+       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 */