Adjust for DevLib.

[bertos.git] / drv / ser.c

diff --git a/drv/ser.c b/drv/ser.c
index 1adda23b20404e10f4e5986690146af33df3316c..ca2b35925975e1093c2d47917152b71745ef44bc 100755 (executable)
--- a/drv/ser.c
+++ b/drv/ser.c
@@ -1,7 +1,7 @@
 /*!
  * \file
  * <!--
- * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
  * This file is part of DevLib - See devlib/README for information.
  * -->
@@ -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
  *
  *
@@ -28,6 +28,18 @@
 
 /*
  * $Log$
+ * 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
  *
@@ -54,7 +66,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
 
@@ -80,19 +92,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;
@@ -127,18 +139,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;
@@ -172,6 +184,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.
@@ -185,9 +198,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)
@@ -198,7 +212,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)
                {
@@ -214,6 +232,7 @@ int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
 
        return i;
 }
+#endif /* !CONFIG_SER_GETS */
 
 
 /*!
@@ -273,6 +292,7 @@ int ser_write(struct Serial *port, const void *_buf, size_t len)
 }
 
 
+#if CONFIG_PRINTF
 /*!
  * Formatted write
  */
@@ -288,14 +308,16 @@ 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 */
 
 
 void ser_setbaudrate(struct Serial *port, unsigned long rate)
@@ -315,8 +337,27 @@ void ser_setparity(struct Serial *port, int parity)
  */
 void ser_purge(struct Serial *ser)
 {
-       fifo_flush(&ser->rxfifo);
-       fifo_flush(&ser->txfifo);
+       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)
+{
+       while(!fifo_isempty(&ser->txfifo))
+       {
+#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED
+                       /* Give up timeslice to other processes. */
+                       proc_switch();
+#endif
+       }
 }
 
 
@@ -328,13 +369,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));
@@ -344,10 +384,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;
 }
@@ -359,8 +401,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;
 }