4 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
6 * This file is part of DevLib - See README.devlib for information.
9 * \brief Buffered serial I/O driver
11 * The serial rx interrupt buffers incoming data in a software FIFO
12 * to decouple the higher level protocols from the line speed.
13 * Outgoing data is buffered as well for better performance.
14 * This driver is not optimized for best performance, but it
15 * has proved to be fast enough to handle transfer rates up to
16 * 38400bps on a 16MHz 80196.
18 * MODULE CONFIGURATION
20 * \li \c CONFIG_SER_HWHANDSHAKE - set to 1 to enable RTS/CTS handshake.
21 * Support is incomplete/untested.
22 * \li \c CONFIG_SER_TXTIMEOUT - Enable software serial transmission timeouts
26 * \author Bernardo Innocenti <bernie@develer.com>
31 *#* Revision 1.26 2005/11/04 16:20:02 bernie
32 *#* Fix reference to README.devlib in header.
34 *#* Revision 1.25 2005/04/11 19:10:27 bernie
35 *#* Include top-level headers from cfg/ subdir.
37 *#* Revision 1.24 2005/01/21 20:13:15 aleph
38 *#* Fix drain at ser_close()
40 *#* Revision 1.23 2005/01/14 00:47:07 aleph
41 *#* ser_drain(): Wait for hw transmission complete.
43 *#* Revision 1.22 2004/12/08 08:56:14 bernie
44 *#* Rename time_t to mtime_t.
46 *#* Revision 1.21 2004/11/16 18:10:13 bernie
47 *#* Add sanity checks for missing configuration parameters.
49 *#* Revision 1.20 2004/10/19 11:48:00 bernie
50 *#* Remove unused variable.
52 *#* Revision 1.19 2004/10/19 08:14:13 bernie
53 *#* Fix a few longstanding bugs wrt status handling (made by rasky on scfirm).
55 *#* Revision 1.18 2004/09/20 03:31:15 bernie
58 *#* Revision 1.17 2004/09/14 21:06:07 bernie
59 *#* Use debug.h instead of kdebug.h; Spelling fixes.
61 *#* Revision 1.16 2004/09/06 21:40:50 bernie
62 *#* Move buffer handling in chip-specific driver.
64 *#* Revision 1.15 2004/08/25 14:12:08 rasky
65 *#* Aggiornato il comment block dei log RCS
67 *#* Revision 1.14 2004/08/24 16:22:57 bernie
68 *#* Thinkos; Doxygen fixes
70 *#* Revision 1.13 2004/08/24 16:20:48 bernie
71 *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write()
73 *#* Revision 1.12 2004/08/24 13:49:39 bernie
76 *#* Revision 1.11 2004/08/15 05:32:22 bernie
77 *#* ser_resync(): New function.
79 *#* Revision 1.10 2004/08/10 06:29:50 bernie
80 *#* Rename timer_gettick() to timer_ticks().
82 *#* Revision 1.9 2004/08/08 06:06:20 bernie
83 *#* Use new-style CONFIG_ idiom; Fix module-wide documentation.
85 *#* Revision 1.8 2004/07/29 22:57:09 bernie
86 *#* ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros.
88 *#* Revision 1.7 2004/07/18 21:49:03 bernie
89 *#* Make CONFIG_SER_DEFBAUDRATE optional.
91 *#* Revision 1.6 2004/06/07 15:56:28 aleph
92 *#* Remove cast-as-lvalue extension abuse
94 *#* Revision 1.5 2004/06/06 16:41:44 bernie
95 *#* ser_putchar(): Use fifo_push_locked() to fix potential race on 8bit processors.
97 *#* Revision 1.4 2004/06/03 11:27:09 bernie
98 *#* Add dual-license information.
100 *#* Revision 1.3 2004/06/02 21:35:24 aleph
101 *#* Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
103 *#* Revision 1.2 2004/05/23 18:21:53 bernie
104 *#* Trim CVS logs and cleanup header info.
110 #include <mware/formatwr.h>
111 #include <cfg/debug.h>
113 #include <cfg/config.h>
116 * Sanity check for config parameters required by this module.
118 #if !defined(CONFIG_KERNEL) || ((CONFIG_KERNEL != 0) && CONFIG_KERNEL != 1)
119 #error CONFIG_KERNEL must be set to either 0 or 1 in config.h
121 #if !defined(CONFIG_SER_RXTIMEOUT)
122 #error CONFIG_SER_TXTIMEOUT missing in config.h
124 #if !defined(CONFIG_SER_RXTIMEOUT)
125 #error CONFIG_SER_RXTIMEOUT missing in config.h
127 #if !defined(CONFIG_SER_GETS) || ((CONFIG_SER_GETS != 0) && CONFIG_SER_GETS != 1)
128 #error CONFIG_SER_GETS must be set to either 0 or 1 in config.h
130 #if !defined(CONFIG_SER_DEFBAUDRATE)
131 #error CONFIG_SER_DEFBAUDRATE missing in config.h
133 #if !defined(CONFIG_PRINTF)
134 #error CONFIG_PRINTF missing in config.h
138 #include <kern/proc.h>
141 #if CONFIG_SER_TXTIMEOUT != -1 || CONFIG_SER_RXTIMEOUT != -1
142 #include <drv/timer.h>
146 /* Serial configuration parameters */
147 #define SER_CTSDELAY 70 /*!< CTS line retry interval (ms) */
148 #define SER_TXPOLLDELAY 2 /*!< Transmit buffer full retry interval (ms) */
149 #define SER_RXPOLLDELAY 2 /*!< Receive buffer empty retry interval (ms) */
152 struct Serial ser_handles[SER_CNT];
156 * Inserisce il carattere c nel buffer di trasmissione.
157 * Questa funzione mette il processo chiamante in attesa
158 * quando il buffer e' pieno.
160 * \return EOF in caso di errore o timeout, altrimenti
161 * il carattere inviato.
163 int ser_putchar(int c, struct Serial *port)
165 //ASSERT_VALID_FIFO(&port->txfifo);
166 if (fifo_isfull_locked(&port->txfifo))
168 #if CONFIG_SER_TXTIMEOUT != -1
169 mtime_t start_time = timer_ticks();
172 /* Attende finche' il buffer e' pieno... */
175 #if CONFIG_KERNEL && CONFIG_KERN_SCHED
176 /* Give up timeslice to other processes. */
179 #if CONFIG_SER_TXTIMEOUT != -1
180 if (timer_ticks() - start_time >= port->txtimeout)
182 port->status |= SERRF_TXTIMEOUT;
185 #endif /* CONFIG_SER_TXTIMEOUT */
187 while (fifo_isfull_locked(&port->txfifo));
190 fifo_push_locked(&port->txfifo, (unsigned char)c);
192 /* (re)trigger tx interrupt */
193 port->hw->table->txStart(port->hw);
195 /* Avoid returning signed extended char */
196 return (int)((unsigned char)c);
201 * Preleva un carattere dal buffer di ricezione.
202 * Questa funzione mette il processo chiamante in attesa
203 * quando il buffer e' vuoto. L'attesa ha un timeout
204 * di ser_rxtimeout millisecondi.
206 * \return EOF in caso di errore o timeout, altrimenti
207 * il carattere ricevuto.
209 int ser_getchar(struct Serial *port)
211 if (fifo_isempty_locked(&port->rxfifo))
213 #if CONFIG_SER_RXTIMEOUT != -1
214 mtime_t start_time = timer_ticks();
216 /* Wait while buffer is empty */
219 #if CONFIG_KERNEL && CONFIG_KERN_SCHED
220 /* Give up timeslice to other processes. */
223 #if CONFIG_SER_RXTIMEOUT != -1
224 if (timer_ticks() - start_time >= port->rxtimeout)
226 port->status |= SERRF_RXTIMEOUT;
229 #endif /* CONFIG_SER_RXTIMEOUT */
231 while (fifo_isempty_locked(&port->rxfifo) && (port->status & SERRF_RX) == 0);
235 * Get a byte from the FIFO (avoiding sign-extension),
236 * re-enable RTS, then return result.
238 if (port->status & SERRF_RX)
240 return (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
245 * Preleva un carattere dal buffer di ricezione.
246 * Se il buffer e' vuoto, ser_getchar_nowait() ritorna
247 * immediatamente EOF.
249 int ser_getchar_nowait(struct Serial *port)
251 if (fifo_isempty_locked(&port->rxfifo))
254 /* NOTE: the double cast prevents unwanted sign extension */
255 return (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
261 * Read a line long at most as size and put it
263 * \return number of chars read or EOF in case
266 int ser_gets(struct Serial *port, char *buf, int size)
268 return ser_gets_echo(port, buf, size, false);
273 * Read a line long at most as size and put it
274 * in buf, with optional echo.
276 * \return number of chars read, or EOF in case
279 int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
286 if ((c = ser_getchar(port)) == EOF)
293 if (c == '\r' || c == '\n' || i >= size-1)
297 ser_print(port, "\r\n");
302 ser_putchar(c, port);
307 #endif /* !CONFIG_SER_GETS */
311 * Read at most \a size bytes from \a port and put them in \a buf
313 * \return number of bytes actually read, or EOF in
316 int ser_read(struct Serial *port, void *buf, size_t size)
319 char *_buf = (char *)buf;
324 if ((c = ser_getchar(port)) == EOF)
334 * Write a string to serial.
335 * \return 0 if OK, EOF in case of error.
337 int ser_print(struct Serial *port, const char *s)
341 if (ser_putchar(*s++, port) == EOF)
349 * \brief Write a buffer to serial.
351 * \return 0 if OK, EOF in case of error.
353 * \todo Optimize with fifo_pushblock()
355 int ser_write(struct Serial *port, const void *_buf, size_t len)
357 const char *buf = (const char *)_buf;
361 if (ser_putchar(*buf++, port) == EOF)
372 int ser_printf(struct Serial *port, const char *format, ...)
377 va_start(ap, format);
378 len = _formatted_write(format, (void (*)(char, void *))ser_putchar, port, ap);
383 #endif /* CONFIG_PRINTF */
386 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
387 void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout)
389 port->rxtimeout = rxtimeout;
390 port->txtimeout = txtimeout;
392 #endif /* CONFIG_SER_RXTIMEOUT || CONFIG_SER_TXTIMEOUT */
394 #if CONFIG_SER_RXTIMEOUT != -1
396 * Discard input to resynchronize with remote end.
398 * Discard incoming data until the port stops receiving
399 * characters for at least \a delay milliseconds.
401 * \note Serial errors are reset before and after executing the purge.
403 void ser_resync(struct Serial *port, mtime_t delay)
405 mtime_t old_rxtimeout = port->rxtimeout;
407 ser_settimeouts(port, delay, port->txtimeout);
410 ser_setstatus(port, 0);
413 while (!(ser_getstatus(port) & SERRF_RXTIMEOUT));
415 /* Restore port to an usable status */
416 ser_setstatus(port, 0);
417 ser_settimeouts(port, old_rxtimeout, port->txtimeout);
419 #endif /* CONFIG_SER_RXTIMEOUT */
422 void ser_setbaudrate(struct Serial *port, unsigned long rate)
424 port->hw->table->setBaudrate(port->hw, rate);
428 void ser_setparity(struct Serial *port, int parity)
430 port->hw->table->setParity(port->hw, parity);
435 * Flush both the RX and TX buffers.
437 void ser_purge(struct Serial *port)
439 fifo_flush_locked(&port->rxfifo);
440 fifo_flush_locked(&port->txfifo);
445 * Wait until all pending output is completely
446 * transmitted to the other end.
448 * \note The current implementation only checks the
449 * software transmission queue. Any hardware
452 void ser_drain(struct Serial *ser)
455 * Wait until the FIFO is empty, and then until the byte currently in
456 * the hardware register gets shifted out.
458 while (!fifo_isempty(&ser->txfifo)
459 || ser->hw->table->txSending(ser->hw))
461 #if CONFIG_KERNEL && CONFIG_KERN_SCHED
462 /* Give up timeslice to other processes. */
472 struct Serial *ser_open(unsigned int unit)
476 ASSERT(unit < countof(ser_handles));
477 port = &ser_handles[unit];
479 ASSERT(!port->is_open);
480 DB(port->is_open = true;)
484 port->hw = ser_hw_getdesc(unit);
486 /* Initialize circular buffers */
487 ASSERT(port->hw->txbuffer);
488 ASSERT(port->hw->rxbuffer);
489 fifo_init(&port->txfifo, port->hw->txbuffer, port->hw->txbuffer_size);
490 fifo_init(&port->rxfifo, port->hw->rxbuffer, port->hw->rxbuffer_size);
492 port->hw->table->init(port->hw, port);
494 /* Set default values */
495 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
496 ser_settimeouts(port, CONFIG_SER_RXTIMEOUT, CONFIG_SER_TXTIMEOUT);
498 #if CONFIG_SER_DEFBAUDRATE
499 ser_setbaudrate(port, CONFIG_SER_DEFBAUDRATE);
502 /* Clear error flags */
503 ser_setstatus(port, 0);
510 * Clean up serial port, disabling the associated hardware.
512 void ser_close(struct Serial *port)
514 ASSERT(port->is_open);
515 DB(port->is_open = false;)
517 // Wait until we finish sending everything
520 port->hw->table->cleanup(port->hw);
524 * We purge the FIFO buffer only after the low-level cleanup, so that
525 * we are sure that there are no more interrupts.