Updated with Doxygen 1.3.8.

[bertos.git] / drv / ser.c

diff --git a/drv/ser.c b/drv/ser.c
index ec3d87b1e9dd9f7090e4dee8b075082f0953ac70..d88b0425689d69ffe3ae77aae1210c16052ba0ef 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.
  * -->
@@ -28,6 +28,15 @@
 
 /*
  * $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.
  *
@@ -51,7 +60,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
 
@@ -77,7 +86,7 @@ int ser_putchar(int c, struct Serial *port)
 {
        if (fifo_isfull_locked(&port->txfifo))
        {
-#ifdef CONFIG_SER_TXTIMEOUT
+#if CONFIG_SER_TXTIMEOUT != -1
                time_t start_time = timer_gettick();
 #endif
 
@@ -88,7 +97,7 @@ int ser_putchar(int c, struct Serial *port)
                        /* Give up timeslice to other processes. */
                        proc_switch();
 #endif
-#ifdef CONFIG_SER_TXTIMEOUT
+#if CONFIG_SER_TXTIMEOUT != -1
                        if (timer_gettick() - start_time >= port->txtimeout)
                        {
                                port->status |= SERRF_TXTIMEOUT;
@@ -124,17 +133,17 @@ int ser_getchar(struct Serial *port)
 
        if (fifo_isempty_locked(&port->rxfifo))
        {
-#ifdef CONFIG_SER_RXTIMEOUT
+#if CONFIG_SER_RXTIMEOUT != -1
                time_t start_time = timer_gettick();
 #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 CONFIG_SER_RXTIMEOUT != -1
                        if (timer_gettick() - start_time >= port->rxtimeout)
                        {
                                port->status |= SERRF_RXTIMEOUT;
@@ -169,6 +178,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.
@@ -182,9 +192,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)
@@ -195,7 +206,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)
                {
@@ -211,6 +226,7 @@ int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
 
        return i;
 }
+#endif /* !CONFIG_SER_GETS */
 
 
 /*!
@@ -254,18 +270,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
  */
@@ -281,14 +302,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)
@@ -308,8 +331,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
+       }
 }
 
 
@@ -321,13 +363,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));
@@ -337,10 +378,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;
 }
@@ -352,8 +395,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;
 }