Typo.

[bertos.git] / drv / ser.c

diff --git a/drv/ser.c b/drv/ser.c
index 5761d688105fca9c9e1c0b01f21cd90d486ea4a5..d73a29348e8b8093979d0d82d017179f3aac2111 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, 2006 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
  * This file is part of DevLib - See README.devlib for information.
  * -->
@@ -28,6 +28,21 @@
 
 /*#*
  *#* $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.
  *#*
@@ -109,8 +124,7 @@
 #include "ser_p.h"
 #include <mware/formatwr.h>
 #include <cfg/debug.h>
-#include <hw.h>
-#include <cfg/config.h>
+#include <appconfig.h>
 
 /*
  * Sanity check for config parameters required by this module.
@@ -144,15 +158,15 @@
 
 
 /* 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.
@@ -166,7 +180,7 @@ int ser_putchar(int c, struct Serial *port)
        if (fifo_isfull_locked(&port->txfifo))
        {
 #if CONFIG_SER_TXTIMEOUT != -1
-               mtime_t start_time = timer_ticks();
+               ticks_t start_time = timer_clock();
 #endif
 
                /* Attende finche' il buffer e' pieno... */
@@ -177,7 +191,7 @@ int ser_putchar(int c, struct Serial *port)
                        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;
@@ -197,7 +211,7 @@ int ser_putchar(int c, struct Serial *port)
 }
 
 
-/*!
+/**
  * 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
@@ -211,7 +225,7 @@ int ser_getchar(struct Serial *port)
        if (fifo_isempty_locked(&port->rxfifo))
        {
 #if CONFIG_SER_RXTIMEOUT != -1
-               mtime_t start_time = timer_ticks();
+               ticks_t start_time = timer_clock();
 #endif
                /* Wait while buffer is empty */
                do
@@ -221,7 +235,7 @@ int ser_getchar(struct Serial *port)
                        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;
@@ -241,7 +255,7 @@ int ser_getchar(struct Serial *port)
 }
 
 
-/*!
+/**
  * Preleva un carattere dal buffer di ricezione.
  * Se il buffer e' vuoto, ser_getchar_nowait() ritorna
  * immediatamente EOF.
@@ -257,7 +271,7 @@ int ser_getchar_nowait(struct Serial *port)
 
 
 #if CONFIG_SER_GETS
-/*!
+/**
  * Read a line long at most as size and put it
  * in buf.
  * \return number of chars read or EOF in case
@@ -269,7 +283,7 @@ int ser_gets(struct Serial *port, char *buf, int size)
 }
 
 
-/*!
+/**
  * Read a line long at most as size and put it
  * in buf, with optional echo.
  *
@@ -307,7 +321,7 @@ int ser_gets_echo(struct Serial *port, char *buf, int size, bool 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
@@ -330,7 +344,7 @@ int ser_read(struct Serial *port, void *buf, size_t size)
 }
 
 
-/*!
+/**
  * Write a string to serial.
  * \return 0 if OK, EOF in case of error.
  */
@@ -345,7 +359,7 @@ int ser_print(struct Serial *port, const char *s)
 }
 
 
-/*!
+/**
  * \brief Write a buffer to serial.
  *
  * \return 0 if OK, EOF in case of error.
@@ -366,7 +380,7 @@ int ser_write(struct Serial *port, const void *_buf, size_t len)
 
 
 #if CONFIG_PRINTF
-/*!
+/**
  * Formatted write
  */
 int ser_printf(struct Serial *port, const char *format, ...)
@@ -386,13 +400,13 @@ int ser_printf(struct Serial *port, const char *format, ...)
 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
 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
@@ -402,9 +416,9 @@ void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout)
  */
 void ser_resync(struct Serial *port, mtime_t delay)
 {
-       mtime_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);
@@ -414,7 +428,7 @@ void ser_resync(struct Serial *port, mtime_t delay)
 
        /* 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 */
 
@@ -431,7 +445,7 @@ void ser_setparity(struct Serial *port, int parity)
 }
 
 
-/*!
+/**
  * Flush both the RX and TX buffers.
  */
 void ser_purge(struct Serial *port)
@@ -441,7 +455,7 @@ void ser_purge(struct Serial *port)
 }
 
 
-/*!
+/**
  * Wait until all pending output is completely
  * transmitted to the other end.
  *
@@ -452,7 +466,7 @@ void ser_purge(struct Serial *port)
 void ser_drain(struct Serial *ser)
 {
        /*
-        * Wait until the FIFO is empty, and then until the byte currently in
+        * Wait until the FIFO becomes empty, and then until the byte currently in
         * the hardware register gets shifted out.
         */
        while (!fifo_isempty(&ser->txfifo)
@@ -466,8 +480,10 @@ 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)
 {
@@ -506,7 +522,7 @@ struct Serial *ser_open(unsigned int unit)
 }
 
 
-/*!
+/**
  * Clean up serial port, disabling the associated hardware.
  */
 void ser_close(struct Serial *port)