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