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