Rename time_t to mtime_t.
[bertos.git] / drv / ser.c
1 /*!
2  * \file
3  * <!--
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 devlib/README for information.
7  * -->
8  *
9  * \brief Buffered serial I/O driver
10  *
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.
17  *
18  * MODULE CONFIGURATION
19  *
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
23  *
24  *
25  * \version $Id$
26  * \author Bernardo Innocenti <bernie@develer.com>
27  */
28
29 /*#*
30  *#* $Log$
31  *#* Revision 1.22  2004/12/08 08:56:14  bernie
32  *#* Rename time_t to mtime_t.
33  *#*
34  *#* Revision 1.21  2004/11/16 18:10:13  bernie
35  *#* Add sanity checks for missing configuration parameters.
36  *#*
37  *#* Revision 1.20  2004/10/19 11:48:00  bernie
38  *#* Remove unused variable.
39  *#*
40  *#* Revision 1.19  2004/10/19 08:14:13  bernie
41  *#* Fix a few longstanding bugs wrt status handling (made by rasky on scfirm).
42  *#*
43  *#* Revision 1.18  2004/09/20 03:31:15  bernie
44  *#* Sanitize for C++.
45  *#*
46  *#* Revision 1.17  2004/09/14 21:06:07  bernie
47  *#* Use debug.h instead of kdebug.h; Spelling fixes.
48  *#*
49  *#* Revision 1.16  2004/09/06 21:40:50  bernie
50  *#* Move buffer handling in chip-specific driver.
51  *#*
52  *#* Revision 1.15  2004/08/25 14:12:08  rasky
53  *#* Aggiornato il comment block dei log RCS
54  *#*
55  *#* Revision 1.14  2004/08/24 16:22:57  bernie
56  *#* Thinkos; Doxygen fixes
57  *#*
58  *#* Revision 1.13  2004/08/24 16:20:48  bernie
59  *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write()
60  *#*
61  *#* Revision 1.12  2004/08/24 13:49:39  bernie
62  *#* Fix thinko.
63  *#*
64  *#* Revision 1.11  2004/08/15 05:32:22  bernie
65  *#* ser_resync(): New function.
66  *#*
67  *#* Revision 1.10  2004/08/10 06:29:50  bernie
68  *#* Rename timer_gettick() to timer_ticks().
69  *#*
70  *#* Revision 1.9  2004/08/08 06:06:20  bernie
71  *#* Use new-style CONFIG_ idiom; Fix module-wide documentation.
72  *#*
73  *#* Revision 1.8  2004/07/29 22:57:09  bernie
74  *#* ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros.
75  *#*
76  *#* Revision 1.7  2004/07/18 21:49:03  bernie
77  *#* Make CONFIG_SER_DEFBAUDRATE optional.
78  *#*
79  *#* Revision 1.6  2004/06/07 15:56:28  aleph
80  *#* Remove cast-as-lvalue extension abuse
81  *#*
82  *#* Revision 1.5  2004/06/06 16:41:44  bernie
83  *#* ser_putchar(): Use fifo_push_locked() to fix potential race on 8bit processors.
84  *#*
85  *#* Revision 1.4  2004/06/03 11:27:09  bernie
86  *#* Add dual-license information.
87  *#*
88  *#* Revision 1.3  2004/06/02 21:35:24  aleph
89  *#* Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
90  *#*
91  *#* Revision 1.2  2004/05/23 18:21:53  bernie
92  *#* Trim CVS logs and cleanup header info.
93  *#*
94  *#*/
95
96 #include "ser.h"
97 #include "ser_p.h"
98 #include <mware/formatwr.h>
99 #include <debug.h>
100 #include <hw.h>
101 #include <config.h>
102
103 /*
104  * Sanity check for config parameters required by this module.
105  */
106 #if !defined(CONFIG_KERNEL) || ((CONFIG_KERNEL != 0) && CONFIG_KERNEL != 1)
107         #error CONFIG_KERNEL must be set to either 0 or 1 in config.h
108 #endif
109 #if !defined(CONFIG_SER_RXTIMEOUT)
110         #error CONFIG_SER_TXTIMEOUT missing in config.h
111 #endif
112 #if !defined(CONFIG_SER_RXTIMEOUT)
113         #error CONFIG_SER_RXTIMEOUT missing in config.h
114 #endif
115 #if !defined(CONFIG_SER_GETS) || ((CONFIG_SER_GETS != 0) && CONFIG_SER_GETS != 1)
116         #error CONFIG_SER_GETS must be set to either 0 or 1 in config.h
117 #endif
118 #if !defined(CONFIG_SER_DEFBAUDRATE)
119         #error CONFIG_SER_DEFBAUDRATE missing in config.h
120 #endif
121 #if !defined(CONFIG_PRINTF)
122         #error CONFIG_PRINTF missing in config.h
123 #endif
124
125 #if CONFIG_KERNEL
126         #include <kern/proc.h>
127 #endif
128
129 #if CONFIG_SER_TXTIMEOUT != -1 || CONFIG_SER_RXTIMEOUT != -1
130         #include <drv/timer.h>
131 #endif
132
133
134 /* Serial configuration parameters */
135 #define SER_CTSDELAY        70  /*!< CTS line retry interval (ms) */
136 #define SER_TXPOLLDELAY      2  /*!< Transmit buffer full retry interval (ms) */
137 #define SER_RXPOLLDELAY      2  /*!< Receive buffer empty retry interval (ms) */
138
139
140 struct Serial ser_handles[SER_CNT];
141
142
143 /*!
144  * Inserisce il carattere c nel buffer di trasmissione.
145  * Questa funzione mette il processo chiamante in attesa
146  * quando il buffer e' pieno.
147  *
148  * \return EOF in caso di errore o timeout, altrimenti
149  *         il carattere inviato.
150  */
151 int ser_putchar(int c, struct Serial *port)
152 {
153         //ASSERT_VALID_FIFO(&port->txfifo);
154         if (fifo_isfull_locked(&port->txfifo))
155         {
156 #if CONFIG_SER_TXTIMEOUT != -1
157                 mtime_t start_time = timer_ticks();
158 #endif
159
160                 /* Attende finche' il buffer e' pieno... */
161                 do
162                 {
163 #if CONFIG_KERNEL && CONFIG_KERN_SCHED
164                         /* Give up timeslice to other processes. */
165                         proc_switch();
166 #endif
167 #if CONFIG_SER_TXTIMEOUT != -1
168                         if (timer_ticks() - start_time >= port->txtimeout)
169                         {
170                                 port->status |= SERRF_TXTIMEOUT;
171                                 return EOF;
172                         }
173 #endif /* CONFIG_SER_TXTIMEOUT */
174                 }
175                 while (fifo_isfull_locked(&port->txfifo));
176         }
177
178         fifo_push_locked(&port->txfifo, (unsigned char)c);
179
180         /* (re)trigger tx interrupt */
181         port->hw->table->enabletxirq(port->hw);
182
183         /* Avoid returning signed extended char */
184         return (int)((unsigned char)c);
185 }
186
187
188 /*!
189  * Preleva un carattere dal buffer di ricezione.
190  * Questa funzione mette il processo chiamante in attesa
191  * quando il buffer e' vuoto. L'attesa ha un timeout
192  * di ser_rxtimeout millisecondi.
193  *
194  * \return EOF in caso di errore o timeout, altrimenti
195  *         il carattere ricevuto.
196  */
197 int ser_getchar(struct Serial *port)
198 {
199         if (fifo_isempty_locked(&port->rxfifo))
200         {
201 #if CONFIG_SER_RXTIMEOUT != -1
202                 mtime_t start_time = timer_ticks();
203 #endif
204                 /* Wait while buffer is empty */
205                 do
206                 {
207 #if CONFIG_KERNEL && CONFIG_KERN_SCHED
208                         /* Give up timeslice to other processes. */
209                         proc_switch();
210 #endif
211 #if CONFIG_SER_RXTIMEOUT != -1
212                         if (timer_ticks() - start_time >= port->rxtimeout)
213                         {
214                                 port->status |= SERRF_RXTIMEOUT;
215                                 return EOF;
216                         }
217 #endif /* CONFIG_SER_RXTIMEOUT */
218                 }
219                 while (fifo_isempty_locked(&port->rxfifo) && (port->status & SERRF_RX) == 0);
220         }
221
222         /*
223          * Get a byte from the FIFO (avoiding sign-extension),
224          * re-enable RTS, then return result.
225          */
226         if (port->status & SERRF_RX)
227                 return EOF;
228         return (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
229 }
230
231
232 /*!
233  * Preleva un carattere dal buffer di ricezione.
234  * Se il buffer e' vuoto, ser_getchar_nowait() ritorna
235  * immediatamente EOF.
236  */
237 int ser_getchar_nowait(struct Serial *port)
238 {
239         if (fifo_isempty_locked(&port->rxfifo))
240                 return EOF;
241
242         /* NOTE: the double cast prevents unwanted sign extension */
243         return (int)(unsigned char)fifo_pop_locked(&port->rxfifo);
244 }
245
246
247 #if CONFIG_SER_GETS
248 /*!
249  * Read a line long at most as size and put it
250  * in buf.
251  * \return number of chars read or EOF in case
252  *         of error.
253  */
254 int ser_gets(struct Serial *port, char *buf, int size)
255 {
256         return ser_gets_echo(port, buf, size, false);
257 }
258
259
260 /*!
261  * Read a line long at most as size and put it
262  * in buf, with optional echo.
263  *
264  * \return number of chars read, or EOF in case
265  *         of error.
266  */
267 int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo)
268 {
269         int i = 0;
270         int c;
271
272         for (;;)
273         {
274                 if ((c = ser_getchar(port)) == EOF)
275                 {
276                         buf[i] = '\0';
277                         return -1;
278                 }
279
280                 /* FIXME */
281                 if (c == '\r' || c == '\n' || i >= size-1)
282                 {
283                         buf[i] = '\0';
284                         if (echo)
285                                 ser_print(port, "\r\n");
286                         break;
287                 }
288                 buf[i++] = c;
289                 if (echo)
290                         ser_putchar(c, port);
291         }
292
293         return i;
294 }
295 #endif /* !CONFIG_SER_GETS */
296
297
298 /*!
299  * Read at most \a size bytes from \a port and put them in \a buf
300  *
301  * \return number of bytes actually read, or EOF in
302  *         case of error.
303  */
304 int ser_read(struct Serial *port, void *buf, size_t size)
305 {
306         size_t i = 0;
307         char *_buf = (char *)buf;
308         int c;
309
310         while (i < size)
311         {
312                 if ((c = ser_getchar(port)) == EOF)
313                         return EOF;
314                 _buf[i++] = c;
315         }
316
317         return i;
318 }
319
320
321 /*!
322  * Write a string to serial.
323  * \return 0 if OK, EOF in case of error.
324  */
325 int ser_print(struct Serial *port, const char *s)
326 {
327         while (*s)
328         {
329                 if (ser_putchar(*s++, port) == EOF)
330                         return EOF;
331         }
332         return 0;
333 }
334
335
336 /*!
337  * \brief Write a buffer to serial.
338  *
339  * \return 0 if OK, EOF in case of error.
340  *
341  * \todo Optimize with fifo_pushblock()
342  */
343 int ser_write(struct Serial *port, const void *_buf, size_t len)
344 {
345         const char *buf = (const char *)_buf;
346
347         while (len--)
348         {
349                 if (ser_putchar(*buf++, port) == EOF)
350                         return EOF;
351         }
352         return 0;
353 }
354
355
356 #if CONFIG_PRINTF
357 /*!
358  * Formatted write
359  */
360 int ser_printf(struct Serial *port, const char *format, ...)
361 {
362         va_list ap;
363         int len;
364
365         va_start(ap, format);
366         len = _formatted_write(format, (void (*)(char, void *))ser_putchar, port, ap);
367         va_end(ap);
368
369         return len;
370 }
371 #endif /* CONFIG_PRINTF */
372
373
374 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
375 void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout)
376 {
377         port->rxtimeout = rxtimeout;
378         port->txtimeout = txtimeout;
379 }
380 #endif /* CONFIG_SER_RXTIMEOUT || CONFIG_SER_TXTIMEOUT */
381
382 #if CONFIG_SER_RXTIMEOUT != -1
383 /*!
384  * Discard input to resynchronize with remote end.
385  *
386  * Discard incoming data until the port stops receiving
387  * characters for at least \a delay milliseconds.
388  *
389  * \note Serial errors are reset before and after executing the purge.
390  */
391 void ser_resync(struct Serial *port, mtime_t delay)
392 {
393         mtime_t old_rxtimeout = port->rxtimeout;
394
395         ser_settimeouts(port, delay, port->txtimeout);
396         do
397         {
398                 ser_setstatus(port, 0);
399                 ser_getchar(port);
400         }
401         while (!(ser_getstatus(port) & SERRF_RXTIMEOUT));
402
403         /* Restore port to an usable status */
404         ser_setstatus(port, 0);
405         ser_settimeouts(port, old_rxtimeout, port->txtimeout);
406 }
407 #endif /* CONFIG_SER_RXTIMEOUT */
408
409
410 void ser_setbaudrate(struct Serial *port, unsigned long rate)
411 {
412         port->hw->table->setbaudrate(port->hw, rate);
413 }
414
415
416 void ser_setparity(struct Serial *port, int parity)
417 {
418         port->hw->table->setparity(port->hw, parity);
419 }
420
421
422 /*!
423  * Flush both the RX and TX buffers.
424  */
425 void ser_purge(struct Serial *port)
426 {
427         fifo_flush_locked(&port->rxfifo);
428         fifo_flush_locked(&port->txfifo);
429 }
430
431
432 /*!
433  * Wait until all pending output is completely
434  * transmitted to the other end.
435  *
436  * \note The current implementation only checks the
437  *       software transmission queue. Any hardware
438  *       FIFOs are ignored.
439  */
440 void ser_drain(struct Serial *ser)
441 {
442         while (!fifo_isempty(&ser->txfifo))
443         {
444                 #if CONFIG_KERNEL && CONFIG_KERN_SCHED
445                         /* Give up timeslice to other processes. */
446                         proc_switch();
447                 #endif
448         }
449 }
450
451
452 /*!
453  * Initialize serial
454  */
455 struct Serial *ser_open(unsigned int unit)
456 {
457         struct Serial *port;
458
459         ASSERT(unit < countof(ser_handles));
460         port = &ser_handles[unit];
461
462         ASSERT(!port->is_open);
463         DB(port->is_open = true;)
464
465         port->unit = unit;
466
467         port->hw = ser_hw_getdesc(unit);
468
469         /* Initialize circular buffers */
470         ASSERT(port->hw->txbuffer);
471         ASSERT(port->hw->rxbuffer);
472         fifo_init(&port->txfifo, port->hw->txbuffer, port->hw->txbuffer_size);
473         fifo_init(&port->rxfifo, port->hw->rxbuffer, port->hw->rxbuffer_size);
474
475         port->hw->table->init(port->hw, port);
476
477         /* Set default values */
478 #if CONFIG_SER_RXTIMEOUT != -1 || CONFIG_SER_TXTIMEOUT != -1
479         ser_settimeouts(port, CONFIG_SER_RXTIMEOUT, CONFIG_SER_TXTIMEOUT);
480 #endif
481 #if CONFIG_SER_DEFBAUDRATE
482         ser_setbaudrate(port, CONFIG_SER_DEFBAUDRATE);
483 #endif
484
485         /* Clear error flags */
486         ser_setstatus(port, 0);
487
488         return port;
489 }
490
491
492 /*!
493  * Clean up serial port, disabling the associated hardware.
494  */
495 void ser_close(struct Serial *port)
496 {
497         ASSERT(port->is_open);
498         DB(port->is_open = false;)
499
500         port->hw->table->cleanup(port->hw);
501         port->hw = NULL;
502 }