X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fser.c;h=e776075b5f0609e12d34e9f472d71cb6020df63b;hb=272271646858e81780184331f386656203223575;hp=8999a2fff4c812bc9c3b0ad8166c55ae1162e9e1;hpb=0b0d84571d28ac4cecce4c476cd75e4cf87f5517;p=bertos.git diff --git a/drv/ser.c b/drv/ser.c old mode 100755 new mode 100644 index 8999a2ff..e776075b --- a/drv/ser.c +++ b/drv/ser.c @@ -1,9 +1,34 @@ -/*! +/** * \file * * * \brief Buffered serial I/O driver @@ -26,91 +51,56 @@ * \author Bernardo Innocenti */ -/*#* - *#* $Log$ - *#* Revision 1.20 2004/10/19 11:48:00 bernie - *#* Remove unused variable. - *#* - *#* Revision 1.19 2004/10/19 08:14:13 bernie - *#* Fix a few longstanding bugs wrt status handling (made by rasky on scfirm). - *#* - *#* Revision 1.18 2004/09/20 03:31:15 bernie - *#* Sanitize for C++. - *#* - *#* Revision 1.17 2004/09/14 21:06:07 bernie - *#* Use debug.h instead of kdebug.h; Spelling fixes. - *#* - *#* Revision 1.16 2004/09/06 21:40:50 bernie - *#* Move buffer handling in chip-specific driver. - *#* - *#* Revision 1.15 2004/08/25 14:12:08 rasky - *#* Aggiornato il comment block dei log RCS - *#* - *#* Revision 1.14 2004/08/24 16:22:57 bernie - *#* Thinkos; Doxygen fixes - *#* - *#* Revision 1.13 2004/08/24 16:20:48 bernie - *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write() - *#* - *#* Revision 1.12 2004/08/24 13:49:39 bernie - *#* Fix thinko. - *#* - *#* Revision 1.11 2004/08/15 05:32:22 bernie - *#* ser_resync(): New function. - *#* - *#* Revision 1.10 2004/08/10 06:29:50 bernie - *#* Rename timer_gettick() to timer_ticks(). - *#* - *#* Revision 1.9 2004/08/08 06:06:20 bernie - *#* Use new-style CONFIG_ idiom; Fix module-wide documentation. - *#* - *#* 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. - *#* - *#* Revision 1.4 2004/06/03 11:27:09 bernie - *#* Add dual-license information. - *#* - *#* Revision 1.3 2004/06/02 21:35:24 aleph - *#* Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens - *#* - *#* Revision 1.2 2004/05/23 18:21:53 bernie - *#* Trim CVS logs and cleanup header info. - *#* - *#*/ - -#include -#include #include "ser.h" + +#include "wdt.h" + #include "ser_p.h" -#include "hw.h" +#include +#include +#include -#ifdef CONFIG_KERNEL +/* + * 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 +#endif +#if !defined(CONFIG_SER_RXTIMEOUT) + #error CONFIG_SER_TXTIMEOUT missing in config.h +#endif +#if !defined(CONFIG_SER_RXTIMEOUT) + #error CONFIG_SER_RXTIMEOUT missing in config.h +#endif +#if !defined(CONFIG_SER_GETS) || ((CONFIG_SER_GETS != 0) && CONFIG_SER_GETS != 1) + #error CONFIG_SER_GETS must be set to either 0 or 1 in config.h +#endif +#if !defined(CONFIG_SER_DEFBAUDRATE) + #error CONFIG_SER_DEFBAUDRATE missing in config.h +#endif +#if !defined(CONFIG_PRINTF) + #error CONFIG_PRINTF missing in config.h +#endif + +#if CONFIG_KERNEL #include #endif + #if CONFIG_SER_TXTIMEOUT != -1 || CONFIG_SER_RXTIMEOUT != -1 #include #endif /* 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. @@ -124,20 +114,21 @@ 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(); + ticks_t start_time = timer_clock(); #endif /* Attende finche' il buffer e' pieno... */ do { -#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED + wdt_reset(); +#if CONFIG_KERNEL && CONFIG_KERN_SCHED /* Give up timeslice to other processes. */ 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; + ATOMIC(port->status |= SERRF_TXTIMEOUT); return EOF; } #endif /* CONFIG_SER_TXTIMEOUT */ @@ -148,14 +139,14 @@ 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); } -/*! +/** * 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 @@ -169,37 +160,38 @@ int ser_getchar(struct Serial *port) 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 { -#if defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED + wdt_reset(); +#if CONFIG_KERNEL && CONFIG_KERN_SCHED /* Give up timeslice to other processes. */ 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; + ATOMIC(port->status |= SERRF_RXTIMEOUT); return EOF; } #endif /* CONFIG_SER_RXTIMEOUT */ } - while (fifo_isempty_locked(&port->rxfifo) && (port->status & SERRF_RX) == 0); + while (fifo_isempty_locked(&port->rxfifo) && (ser_getstatus(port) & SERRF_RX) == 0); } /* * Get a byte from the FIFO (avoiding sign-extension), * re-enable RTS, then return result. */ - if (port->status & SERRF_RX) + if (ser_getstatus(port) & SERRF_RX) return EOF; return (int)(unsigned char)fifo_pop_locked(&port->rxfifo); } -/*! +/** * Preleva un carattere dal buffer di ricezione. * Se il buffer e' vuoto, ser_getchar_nowait() ritorna * immediatamente EOF. @@ -215,8 +207,8 @@ 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. @@ -227,7 +219,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. * @@ -265,7 +257,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 @@ -288,7 +280,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. */ @@ -303,7 +295,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. @@ -324,7 +316,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, ...) @@ -342,15 +334,15 @@ 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 @@ -358,11 +350,11 @@ 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 = 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); @@ -372,24 +364,24 @@ void ser_resync(struct Serial *port, time_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 */ 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) @@ -399,7 +391,7 @@ void ser_purge(struct Serial *port) } -/*! +/** * Wait until all pending output is completely * transmitted to the other end. * @@ -409,18 +401,26 @@ void ser_purge(struct Serial *port) */ 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 defined(CONFIG_KERN_SCHED) && CONFIG_KERN_SCHED + #if CONFIG_KERNEL && CONFIG_KERN_SCHED /* Give up timeslice to other processes. */ proc_switch(); -#endif + #endif + wdt_reset(); } } -/*! - * Initialize serial +/** + * Initialize a serial port. + * + * \param unit Serial unit to open. Possible values are architecture dependant. */ struct Serial *ser_open(unsigned int unit) { @@ -452,11 +452,14 @@ struct Serial *ser_open(unsigned int unit) ser_setbaudrate(port, CONFIG_SER_DEFBAUDRATE); #endif + /* Clear error flags */ + ser_setstatus(port, 0); + return port; } -/*! +/** * Clean up serial port, disabling the associated hardware. */ void ser_close(struct Serial *port) @@ -464,6 +467,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); }