Update preset.
[bertos.git] / bertos / drv / ser.c
index 558c1ba342018e36e0dbe8d6fc79def2ed3d70e2..c9c3b0f7611e13bcb97632eb3c40bdc04ac9bb7f 100644 (file)
@@ -27,8 +27,7 @@
  * the GNU General Public License.
  *
  * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- *
+ * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
  * \brief Buffered serial I/O driver
  *  \li \c CONFIG_SER_TXTIMEOUT - Enable software serial transmission timeouts
  *
  *
- * \version $Id$
- * \author Bernardo Innocenti <bernie@develer.com>
+ * \author Bernie Innocenti <bernie@codewiz.org>
  */
 
 #include "ser.h"
 #include "wdt.h"
+#include "timer.h"
 #include "ser_p.h"
 
 #include "cfg/cfg_ser.h"
-#include "cfg/cfg_kern.h"
+#include "cfg/cfg_proc.h"
 #include <cfg/debug.h>
 
 #include <mware/formatwr.h>
 
-#include <string.h> /* memset */
+#include <cpu/power.h> /* cpu_relax() */
+
+#include <string.h> /* memset() */
 
 /*
  * Sanity check for config parameters required by this module.
  */
-#if !defined(CONFIG_KERNEL) || ((CONFIG_KERNEL != 0) && CONFIG_KERNEL != 1)
-       #error CONFIG_KERNEL must be set to either 0 or 1 in config.h
+#if !defined(CONFIG_KERN) || ((CONFIG_KERN != 0) && CONFIG_KERN != 1)
+       #error CONFIG_KERN must be set to either 0 or 1 in cfg_kern.h
 #endif
 #if !defined(CONFIG_SER_RXTIMEOUT)
-       #error CONFIG_SER_TXTIMEOUT missing in config.h
+       #error CONFIG_SER_TXTIMEOUT missing in cfg_ser.h
 #endif
 #if !defined(CONFIG_SER_RXTIMEOUT)
-       #error CONFIG_SER_RXTIMEOUT missing in config.h
+       #error CONFIG_SER_RXTIMEOUT missing in cfg_ser.h
 #endif
 #if !defined(CONFIG_SER_DEFBAUDRATE)
-       #error CONFIG_SER_DEFBAUDRATE missing in config.h
-#endif
-
-#if CONFIG_KERNEL
-       #include <kern/proc.h>
-#endif
-
-#if CONFIG_SER_TXTIMEOUT != -1 || CONFIG_SER_RXTIMEOUT != -1
-       #include <drv/timer.h>
+       #error CONFIG_SER_DEFBAUDRATE missing in cfg_ser.h
 #endif
 
 
-struct Serial ser_handles[SER_CNT];
+struct Serial *ser_handles[SER_CNT];
 
 /**
  * Insert \a c in tx FIFO buffer.
@@ -113,11 +106,8 @@ static int ser_putchar(int c, struct Serial *port)
                /* Wait while buffer is full... */
                do
                {
-                       wdt_reset();
-#if CONFIG_KERNEL && CONFIG_KERN_SCHED
-                       /* Give up timeslice to other processes. */
-                       proc_switch();
-#endif
+                       cpu_relax();
+
 #if CONFIG_SER_TXTIMEOUT != -1
                        if (timer_clock() - start_time >= port->txtimeout)
                        {
@@ -158,14 +148,12 @@ static int ser_getchar(struct Serial *port)
 
                ticks_t start_time = timer_clock();
 #endif
+
                /* Wait while buffer is empty */
                do
                {
-                       wdt_reset();
-#if CONFIG_KERNEL && CONFIG_KERN_SCHED
-                       /* Give up timeslice to other processes. */
-                       proc_switch();
-#endif
+                       cpu_relax();
+
 #if CONFIG_SER_RXTIMEOUT != -1
                        if (timer_clock() - start_time >= port->rxtimeout)
                        {
@@ -192,13 +180,13 @@ static int ser_getchar(struct Serial *port)
  * EOF immediatly.
  * \note Deprecated, use ser_getchar with rx_timeout set to 0.
  */
-int ser_getchar_nowait(struct KFileSerial *fd)
+int ser_getchar_nowait(struct Serial *fd)
 {
-       if (fifo_isempty_locked(&fd->ser->rxfifo))
+       if (fifo_isempty_locked(&fd->rxfifo))
                return EOF;
 
        /* NOTE: the double cast prevents unwanted sign extension */
-       return (int)(unsigned char)fifo_pop_locked(&fd->ser->rxfifo);
+       return (int)(unsigned char)fifo_pop_locked(&fd->rxfifo);
 }
 
 
@@ -210,7 +198,7 @@ int ser_getchar_nowait(struct KFileSerial *fd)
  */
 static size_t ser_read(struct KFile *fd, void *_buf, size_t size)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
+       Serial *fds = SERIAL_CAST(fd);
 
        size_t i = 0;
        char *buf = (char *)_buf;
@@ -218,7 +206,7 @@ static size_t ser_read(struct KFile *fd, void *_buf, size_t size)
 
        while (i < size)
        {
-               if ((c = ser_getchar(fds->ser)) == EOF)
+               if ((c = ser_getchar(fds)) == EOF)
                        break;
                buf[i++] = c;
        }
@@ -235,13 +223,13 @@ static size_t ser_read(struct KFile *fd, void *_buf, size_t size)
  */
 static size_t ser_write(struct KFile *fd, const void *_buf, size_t size)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
+       Serial *fds = SERIAL_CAST(fd);
        const char *buf = (const char *)_buf;
        size_t i = 0;
 
        while (size--)
        {
-               if (ser_putchar(*buf++, fds->ser) == EOF)
+               if (ser_putchar(*buf++, fds) == EOF)
                        break;
                i++;
        }
@@ -250,62 +238,50 @@ static size_t ser_write(struct KFile *fd, const void *_buf, size_t size)
 
 
 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
-void ser_settimeouts(struct KFileSerial *fd, mtime_t rxtimeout, mtime_t txtimeout)
+void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout)
 {
-       fd->ser->rxtimeout = ms_to_ticks(rxtimeout);
-       fd->ser->txtimeout = ms_to_ticks(txtimeout);
+       #if CONFIG_SER_RXTIMEOUT != -1
+               fd->rxtimeout = ms_to_ticks(rxtimeout);
+       #else
+               (void)rxtimeout;
+       #endif
+
+       #if CONFIG_SER_TXTIMEOUT != -1
+               fd->txtimeout = ms_to_ticks(txtimeout);
+       #else
+               (void)txtimeout;
+       #endif
 }
 #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
- * characters for at least \a delay milliseconds.
- *
- * \note Serial errors are reset before and after executing the purge.
+ * Set the baudrate for the serial port
  */
-void ser_resync(struct KFileSerial *fd, mtime_t delay)
+void ser_setbaudrate(struct Serial *fd, unsigned long rate)
 {
-       mtime_t old_rxtimeout = ticks_to_ms(fd->ser->rxtimeout);
-
-       ser_settimeouts(fd, delay, ticks_to_ms(fd->ser->txtimeout));
-       do
-       {
-               ser_setstatus(fd->ser, 0);
-               ser_getchar(fd->ser);
-       }
-       while (!(ser_getstatus(fd->ser) & SERRF_RXTIMEOUT));
-
-       /* Restore port to an usable status */
-       ser_setstatus(fd->ser, 0);
-       ser_settimeouts(fd, old_rxtimeout, ticks_to_ms(fd->ser->txtimeout));
-}
-#endif /* CONFIG_SER_RXTIMEOUT */
-
-
-void ser_setbaudrate(struct KFileSerial *fd, unsigned long rate)
-{
-       fd->ser->hw->table->setBaudrate(fd->ser->hw, rate);
+       fd->hw->table->setBaudrate(fd->hw, rate);
 }
 
 
-void ser_setparity(struct KFileSerial *fd, int parity)
+/**
+ * Set the parity for the \a fd serial port
+ */
+void ser_setparity(struct Serial *fd, int parity)
 {
-       fd->ser->hw->table->setParity(fd->ser->hw, parity);
+       fd->hw->table->setParity(fd->hw, parity);
 }
 
 static int ser_error(struct KFile *fd)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
-       return ser_getstatus(fds->ser);
+       Serial *fds = SERIAL_CAST(fd);
+       return ser_getstatus(fds);
 }
 
 static void ser_clearerr(struct KFile *fd)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
-       ser_setstatus(fds->ser, 0);
+       Serial *fds = SERIAL_CAST(fd);
+       ser_setstatus(fds, 0);
 }
 
 
@@ -313,7 +289,7 @@ static void ser_clearerr(struct KFile *fd)
 /**
  * Flush both the RX and TX buffers.
  */
-void ser_purge(struct KFileSerial *fd)
+void ser_purge(struct Serial *fd)
 {
        ser_purgeRx(fd);
        ser_purgeTx(fd);
@@ -322,17 +298,17 @@ void ser_purge(struct KFileSerial *fd)
 /**
  * Flush RX buffer.
  */
-void ser_purgeRx(struct KFileSerial *fd)
+void ser_purgeRx(struct Serial *fd)
 {
-       fifo_flush_locked(&fd->ser->rxfifo);
+       fifo_flush_locked(&fd->rxfifo);
 }
 
 /**
  * Flush TX buffer.
  */
-void ser_purgeTx(struct KFileSerial *fd)
+void ser_purgeTx(struct Serial *fd)
 {
-       fifo_flush_locked(&fd->ser->txfifo);
+       fifo_flush_locked(&fd->txfifo);
 }
 
 
@@ -346,21 +322,15 @@ void ser_purgeTx(struct KFileSerial *fd)
  */
 static int ser_flush(struct KFile *fd)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
+       Serial *fds = SERIAL_CAST(fd);
 
        /*
         * Wait until the FIFO becomes empty, and then until the byte currently in
         * the hardware register gets shifted out.
         */
-       while (!fifo_isempty(&fds->ser->txfifo)
-              || fds->ser->hw->table->txSending(fds->ser->hw))
-       {
-               #if CONFIG_KERNEL && CONFIG_KERN_SCHED
-                       /* Give up timeslice to other processes. */
-                       proc_switch();
-               #endif
-                       wdt_reset();
-       }
+       while (!fifo_isempty(&fds->txfifo)
+              || fds->hw->table->txSending(fds->hw))
+               cpu_relax();
        return 0;
 }
 
@@ -371,29 +341,26 @@ static int ser_flush(struct KFile *fd)
  * \param fd KFile Serial struct interface.
  * \param unit  Serial unit to open. Possible values are architecture dependant.
  */
-static struct Serial *ser_open(struct KFileSerial *fd, unsigned int unit)
+static struct Serial *ser_open(struct Serial *fd, unsigned int unit)
 {
-       struct Serial *port;
-
        ASSERT(unit < countof(ser_handles));
-       port = &ser_handles[unit];
 
-       ASSERT(!port->is_open);
-       DB(port->is_open = true);
+       ser_handles[unit] = fd;
+       ASSERT(!fd->is_open);
+       DB(fd->is_open = true);
 
-       port->unit = unit;
+       fd->unit = unit;
 
-       port->hw = ser_hw_getdesc(unit);
+       fd->hw = ser_hw_getdesc(unit);
 
        /* Initialize circular buffers */
-       ASSERT(port->hw->txbuffer);
-       ASSERT(port->hw->rxbuffer);
-       fifo_init(&port->txfifo, port->hw->txbuffer, port->hw->txbuffer_size);
-       fifo_init(&port->rxfifo, port->hw->rxbuffer, port->hw->rxbuffer_size);
+       ASSERT(fd->hw->txbuffer);
+       ASSERT(fd->hw->rxbuffer);
+       fifo_init(&fd->txfifo, fd->hw->txbuffer, fd->hw->txbuffer_size);
+       fifo_init(&fd->rxfifo, fd->hw->rxbuffer, fd->hw->rxbuffer_size);
 
-       port->hw->table->init(port->hw, port);
+       fd->hw->table->init(fd->hw, fd);
 
-       fd->ser = port;
        /* Set default values */
 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
        ser_settimeouts(fd, CONFIG_SER_RXTIMEOUT, CONFIG_SER_TXTIMEOUT);
@@ -403,9 +370,9 @@ static struct Serial *ser_open(struct KFileSerial *fd, unsigned int unit)
 #endif
 
        /* Clear error flags */
-       ser_setstatus(port, 0);
+       ser_setstatus(fd, 0);
 
-       return port;
+       return fd;
 }
 
 
@@ -414,8 +381,8 @@ static struct Serial *ser_open(struct KFileSerial *fd, unsigned int unit)
  */
 static int ser_close(struct KFile *fd)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
-       Serial *port = fds->ser;
+       Serial *fds = SERIAL_CAST(fd);
+       Serial *port = fds;
 
        ASSERT(port->is_open);
        DB(port->is_open = false);
@@ -439,17 +406,19 @@ static int ser_close(struct KFile *fd)
  */
 static struct KFile *ser_reopen(struct KFile *fd)
 {
-       KFileSerial *fds = KFILESERIAL(fd);
+       Serial *fds = SERIAL_CAST(fd);
 
        ser_close(fd);
-       ser_open(fds, fds->ser->unit);
+       ser_open(fds, fds->unit);
        return (KFile *)fds;
 }
 
 /**
  * Init serial driver for \a unit.
+ *
+ * Use values SER_UARTn as values for \a unit.
  */
-void ser_init(struct KFileSerial *fds, unsigned int unit)
+void ser_init(struct Serial *fds, unsigned int unit)
 {
        memset(fds, 0, sizeof(*fds));
 
@@ -472,7 +441,7 @@ void ser_init(struct KFileSerial *fds, unsigned int unit)
  */
 static size_t spimaster_read(struct KFile *fd, void *_buf, size_t size)
 {
-       KFileSerial *fd_spi = KFILESERIAL(fd);
+       Serial *fd_spi = SERIAL_CAST(fd);
 
        ser_flush(&fd_spi->fd);
        ser_purgeRx(fd_spi);
@@ -487,9 +456,9 @@ static size_t spimaster_read(struct KFile *fd, void *_buf, size_t size)
                 * Send and receive chars 1 by 1, otherwise the rxfifo
                 * will overrun.
                 */
-               ser_putchar(0, fd_spi->ser);
+               ser_putchar(0, fd_spi);
 
-               if ((c = ser_getchar(fd_spi->ser)) == EOF)
+               if ((c = ser_getchar(fd_spi)) == EOF)
                        break;
 
                *buf++ = c;
@@ -503,7 +472,7 @@ static size_t spimaster_read(struct KFile *fd, void *_buf, size_t size)
  */
 static size_t spimaster_write(struct KFile *fd, const void *buf, size_t size)
 {
-       KFileSerial *fd_spi = KFILESERIAL(fd);
+       Serial *fd_spi = SERIAL_CAST(fd);
 
        ser_purgeRx(fd_spi);
 
@@ -514,6 +483,8 @@ static size_t spimaster_write(struct KFile *fd, const void *buf, size_t size)
 /**
  * Init SPI serial driver \a unit in master mode.
  *
+ * Use SER_SPIn for \a unit parameter.
+ *
  * This interface implements the SPI master protocol over a serial SPI
  * driver. This is needed because normal serial driver send/receive data
  * at the same time. SPI slaves like memories and other peripherals
@@ -522,7 +493,7 @@ static size_t spimaster_write(struct KFile *fd, const void *buf, size_t size)
  * we have to discard all incoming data. Then, when we want to
  * receive, we must write fake data to SPI to trigger slave devices.
  */
-void spimaster_init(KFileSerial *fds, unsigned int unit)
+void spimaster_init(Serial *fds, unsigned int unit)
 {
        ser_init(fds, unit);
        fds->fd.read = spimaster_read;