drv/ser.c

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