ser_open(): Document a bit more.

[bertos.git] / drv / ser.c

diff --git a/drv/ser.c b/drv/ser.c
index 9b42a70dbfaf1a936684bbb26e4f736e033b0458..02e3e2d1519006252875ed28fb9891f7a64e77a3 100755 (executable)
--- a/drv/ser.c
+++ b/drv/ser.c
@@ -3,7 +3,7 @@
  * <!--
  * 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.
+ * This file is part of DevLib - See README.devlib for information.
  * -->
  *
  * \brief Buffered serial I/O driver
@@ -28,6 +28,30 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.29  2006/05/18 00:39:30  bernie
+ *#* ser_open(): Document a bit more.
+ *#*
+ *#* Revision 1.28  2006/02/17 22:23:06  bernie
+ *#* Update POSIX serial emulator.
+ *#*
+ *#* Revision 1.27  2005/11/27 23:33:40  bernie
+ *#* Use appconfig.h instead of cfg/config.h.
+ *#*
+ *#* Revision 1.26  2005/11/04 16:20:02  bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* 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.
  *#*
@@ -93,9 +117,9 @@
 #include "ser.h"
 #include "ser_p.h"
 #include <mware/formatwr.h>
-#include <debug.h>
-#include <hw.h>
-#include <config.h>
+#include <cfg/debug.h>
+//#include <hw.h>
+#include <appconfig.h>
 
 /*
  * Sanity check for config parameters required by this module.
@@ -151,7 +175,7 @@ int ser_putchar(int c, struct Serial *port)
        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... */
@@ -175,7 +199,7 @@ 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 extended char */
        return (int)((unsigned char)c);
@@ -196,7 +220,7 @@ int ser_getchar(struct Serial *port)
        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
@@ -243,7 +267,7 @@ int ser_getchar_nowait(struct Serial *port)
 
 #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.
@@ -369,7 +393,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;
@@ -385,9 +409,9 @@ void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout)
  *
  * \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(port, delay, port->txtimeout);
        do
@@ -406,13 +430,13 @@ void ser_resync(struct Serial *port, time_t delay)
 
 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);
 }
 
 
@@ -436,7 +460,12 @@ 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 CONFIG_KERNEL && CONFIG_KERN_SCHED
                        /* Give up timeslice to other processes. */
@@ -447,7 +476,9 @@ void ser_drain(struct Serial *ser)
 
 
 /*!
- * Initialize serial
+ * Initialize a serial port.
+ *
+ * \param unit  Serial unit to open. Possible values are architecture dependant.
  */
 struct Serial *ser_open(unsigned int unit)
 {
@@ -494,6 +525,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);
 }