-/*!
+/**
* \file
* <!--
- * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2003, 2004, 2006 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
/*#*
*#* $Log$
+ *#* Revision 1.31 2006/07/21 10:58:00 batt
+ *#* Use timer_clock() instead of obsolete timer_ticks().
+ *#*
+ *#* Revision 1.30 2006/07/19 12:56:26 bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* 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.
*#*
#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 <appconfig.h>
/*
* Sanity check for config parameters required by this module.
/* Serial configuration parameters */
-#define SER_CTSDELAY 70 /*!< CTS line retry interval (ms) */
-#define SER_TXPOLLDELAY 2 /*!< Transmit buffer full retry interval (ms) */
-#define SER_RXPOLLDELAY 2 /*!< Receive buffer empty retry interval (ms) */
+#define SER_CTSDELAY 70 /**< CTS line retry interval (ms) */
+#define SER_TXPOLLDELAY 2 /**< Transmit buffer full retry interval (ms) */
+#define SER_RXPOLLDELAY 2 /**< Receive buffer empty retry interval (ms) */
struct Serial ser_handles[SER_CNT];
-/*!
+/**
* Inserisce il carattere c nel buffer di trasmissione.
* Questa funzione mette il processo chiamante in attesa
* quando il buffer e' pieno.
if (fifo_isfull_locked(&port->txfifo))
{
#if CONFIG_SER_TXTIMEOUT != -1
- time_t start_time = timer_ticks();
+ ticks_t start_time = timer_clock();
#endif
/* Attende finche' il buffer e' pieno... */
proc_switch();
#endif
#if CONFIG_SER_TXTIMEOUT != -1
- if (timer_ticks() - start_time >= port->txtimeout)
+ if (timer_clock() - start_time >= port->txtimeout)
{
port->status |= SERRF_TXTIMEOUT;
return EOF;
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);
}
-/*!
+/**
* Preleva un carattere dal buffer di ricezione.
* Questa funzione mette il processo chiamante in attesa
* quando il buffer e' vuoto. L'attesa ha un timeout
if (fifo_isempty_locked(&port->rxfifo))
{
#if CONFIG_SER_RXTIMEOUT != -1
- time_t start_time = timer_ticks();
+ ticks_t start_time = timer_clock();
#endif
/* Wait while buffer is empty */
do
proc_switch();
#endif
#if CONFIG_SER_RXTIMEOUT != -1
- if (timer_ticks() - start_time >= port->rxtimeout)
+ if (timer_clock() - start_time >= port->rxtimeout)
{
port->status |= SERRF_RXTIMEOUT;
return EOF;
}
-/*!
+/**
* Preleva un carattere dal buffer di ricezione.
* Se il buffer e' vuoto, ser_getchar_nowait() ritorna
* immediatamente EOF.
#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.
}
-/*!
+/**
* Read a line long at most as size and put it
* in buf, with optional echo.
*
#endif /* !CONFIG_SER_GETS */
-/*!
+/**
* Read at most \a size bytes from \a port and put them in \a buf
*
* \return number of bytes actually read, or EOF in
}
-/*!
+/**
* Write a string to serial.
* \return 0 if OK, EOF in case of error.
*/
}
-/*!
+/**
* \brief Write a buffer to serial.
*
* \return 0 if OK, EOF in case of error.
#if CONFIG_PRINTF
-/*!
+/**
* Formatted write
*/
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;
+ port->rxtimeout = ms_to_ticks(rxtimeout);
+ port->txtimeout = ms_to_ticks(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
*
* \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 = ticks_to_ms(port->rxtimeout);
- ser_settimeouts(port, delay, port->txtimeout);
+ ser_settimeouts(port, delay, ticks_to_ms(port->txtimeout));
do
{
ser_setstatus(port, 0);
/* Restore port to an usable status */
ser_setstatus(port, 0);
- ser_settimeouts(port, old_rxtimeout, port->txtimeout);
+ ser_settimeouts(port, old_rxtimeout, ticks_to_ms(port->txtimeout));
}
#endif /* CONFIG_SER_RXTIMEOUT */
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);
}
-/*!
+/**
* Flush both the RX and TX buffers.
*/
void ser_purge(struct Serial *port)
}
-/*!
+/**
* Wait until all pending output is completely
* transmitted to the other end.
*
*/
void ser_drain(struct Serial *ser)
{
- while (!fifo_isempty(&ser->txfifo))
+ /*
+ * Wait until the FIFO becomes 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. */
}
-/*!
- * Initialize serial
+/**
+ * Initialize a serial port.
+ *
+ * \param unit Serial unit to open. Possible values are architecture dependant.
*/
struct Serial *ser_open(unsigned int unit)
{
}
-/*!
+/**
* Clean up serial port, disabling the associated hardware.
*/
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);
}
projects / bertos.git / blobdiff