drv/ser.h

   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 README.devlib for information.
   7  * -->
   8  *
   9  * \brief High level serial I/O API
  10  *
  11  * \version $Id$
  12  * \author Bernardo Innocenti <bernie@develer.com>
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.35  2007/01/27 20:47:12  batt
  18  *#* Add clear status.
  19  *#*
  20  *#* Revision 1.34  2006/11/20 15:07:40  batt
  21  *#* Revert unneeded locked functions.
  22  *#*
  23  *#* Revision 1.33  2006/11/17 17:03:58  batt
  24  *#* Implement ser_setstatus and ser_getstatus as functions to avoid race conditions.
  25  *#*
  26  *#* Revision 1.32  2006/11/17 16:01:12  batt
  27  *#* Serial status MUST be volatile.
  28  *#*
  29  *#* Revision 1.31  2006/09/13 18:22:48  bernie
  30  *#* Typo.
  31  *#*
  32  *#* Revision 1.30  2006/09/13 18:21:23  bernie
  33  *#* Add configurable SPI pin mapping.
  34  *#*
  35  *#* Revision 1.29  2006/09/13 13:59:11  bernie
  36  *#* Documentation fixes.
  37  *#*
  38  *#* Revision 1.28  2006/07/21 10:58:00  batt
  39  *#* Use timer_clock() instead of obsolete timer_ticks().
  40  *#*
  41  *#* Revision 1.27  2006/07/19 12:56:26  bernie
  42  *#* Convert to new Doxygen style.
  43  *#*
  44  *#* Revision 1.26  2006/05/18 00:39:13  bernie
  45  *#* Add struct Serial friendly typedef.
  46  *#*
  47  *#* Revision 1.25  2006/02/17 22:28:00  bernie
  48  *#* Rename ser_emul.c to ser_posix.c.
  49  *#*
  50  *#* Revision 1.24  2006/02/17 22:23:06  bernie
  51  *#* Update POSIX serial emulator.
  52  *#*
  53  *#* Revision 1.23  2005/11/27 23:33:40  bernie
  54  *#* Use appconfig.h instead of cfg/config.h.
  55  *#*
  56  *#* Revision 1.22  2005/11/04 16:20:02  bernie
  57  *#* Fix reference to README.devlib in header.
  58  *#*
  59  *#* Revision 1.21  2005/04/11 19:10:27  bernie
  60  *#* Include top-level headers from cfg/ subdir.
  61  *#*
  62  *#* Revision 1.20  2005/01/22 04:20:01  bernie
  63  *#* Reformat.
  64  *#*
  65  *#* Revision 1.19  2005/01/11 18:08:16  aleph
  66  *#* Add missing include
  67  *#*
  68  *#* Revision 1.18  2004/12/08 08:57:17  bernie
  69  *#* Rename time_t to mtime_t.
  70  *#*
  71  *#* Revision 1.17  2004/11/16 21:54:56  bernie
  72  *#* Changes for SC Monoboard support.
  73  *#*
  74  *#* Revision 1.16  2004/10/19 11:48:05  bernie
  75  *#* Reformat.
  76  *#*
  77  *#* Revision 1.15  2004/10/19 08:11:53  bernie
  78  *#* SERRF_TX, SERRF_RX: New macros; Enhance documentation.
  79  *#*
  80  *#* Revision 1.14  2004/10/03 18:43:18  bernie
  81  *#* Fix a nasty bug caused by confusion between old-style and new-style configuration macros.
  82  *#*
  83  *#* Revision 1.13  2004/09/14 21:04:57  bernie
  84  *#* Don't vanely call kdebug.h.
  85  *#*
  86  *#* Revision 1.12  2004/09/06 21:40:50  bernie
  87  *#* Move buffer handling in chip-specific driver.
  88  *#*
  89  *#* Revision 1.11  2004/08/25 14:12:08  rasky
  90  *#* Aggiornato il comment block dei log RCS
  91  *#*
  92  *#* Revision 1.10  2004/08/24 16:20:48  bernie
  93  *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write()
  94  *#*
  95  *#* Revision 1.9  2004/08/15 05:32:22  bernie
  96  *#* ser_resync(): New function.
  97  *#*
  98  *#* Revision 1.8  2004/08/02 20:20:29  aleph
  99  *#* Merge from project_ks
 100  *#*
 101  *#* Revision 1.7  2004/07/30 14:15:53  rasky
 102  *#* Nuovo supporto unificato per detect della CPU
 103  *#*
 104  *#* Revision 1.6  2004/07/29 22:57:09  bernie
 105  *#* ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros.
 106  *#*
 107  *#* Revision 1.5  2004/07/18 21:54:23  bernie
 108  *#* Add ATmega8 support.
 109  *#*
 110  *#* Revision 1.4  2004/06/03 11:27:09  bernie
 111  *#* Add dual-license information.
 112  *#*
 113  *#* Revision 1.3  2004/06/02 21:35:24  aleph
 114  *#* Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
 115  *#*
 116  *#* Revision 1.2  2004/05/23 18:21:53  bernie
 117  *#* Trim CVS logs and cleanup header info.
 118  *#*
 119  *#*/
 120 #ifndef DRV_SER_H
 121 #define DRV_SER_H
 122
 123 #include <mware/fifobuf.h>
 124 #include <cfg/compiler.h>
 125 #include <cfg/macros.h> /* BV() */
 126 #include <cfg/os.h>
 127 #include <appconfig.h>
 128
 129 /** \name Serial Error/status flags. */
 130 /*\{*/
 131 #if CPU_AVR
 132         typedef uint8_t serstatus_t;
 133
 134         /* Software errors */
 135         #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
 136         #define SERRF_RXTIMEOUT      BV(5)  /**< Receive timeout */
 137         #define SERRF_TXTIMEOUT      BV(6)  /**< Transmit timeout */
 138
 139         /*
 140          * Hardware errors.
 141          * These flags map directly to the AVR UART Status Register (USR).
 142          */
 143         #define SERRF_RXSROVERRUN    BV(3)  /**< Rx shift register overrun */
 144         #define SERRF_FRAMEERROR     BV(4)  /**< Stop bit missing */
 145         #define SERRF_PARITYERROR    BV(7)  /**< Parity error */
 146         #define SERRF_NOISEERROR     0      /**< Unsupported */
 147 #elif CPU_DSP56K
 148         typedef uint16_t serstatus_t;
 149
 150         /* Software errors */
 151         #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
 152         #define SERRF_RXTIMEOUT      BV(1)  /**< Receive timeout */
 153         #define SERRF_TXTIMEOUT      BV(2)  /**< Transmit timeout */
 154
 155         /*
 156          * Hardware errors.
 157          * These flags map directly to the SCI Control Register.
 158          */
 159         #define SERRF_PARITYERROR    BV(8)  /**< Parity error */
 160         #define SERRF_FRAMEERROR     BV(9)  /**< Stop bit missing */
 161         #define SERRF_NOISEERROR     BV(10) /**< Noise error */
 162         #define SERRF_RXSROVERRUN    BV(11) /**< Rx shift register overrun */
 163 #elif OS_HOSTED
 164         typedef uint16_t serstatus_t;
 165
 166         /* Software errors */
 167         #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
 168         #define SERRF_RXTIMEOUT      BV(1)  /**< Receive timeout */
 169         #define SERRF_TXTIMEOUT      BV(2)  /**< Transmit timeout */
 170
 171         /* Hardware errors */
 172         #define SERRF_RXSROVERRUN    0      /**< Unsupported in emulated serial port. */
 173         #define SERRF_FRAMEERROR     0      /**< Unsupported in emulated serial port. */
 174         #define SERRF_PARITYERROR    0      /**< Unsupported in emulated serial port. */
 175         #define SERRF_NOISEERROR     0      /**< Unsupported in emulated serial port. */
 176
 177 #else
 178         #error unknown architecture
 179 #endif
 180 /*\}*/
 181
 182 /**
 183  * \name Masks to group TX/RX errors.
 184  * \{
 185  */
 186 #define SERRF_RX \
 187         ( SERRF_RXFIFOOVERRUN \
 188         | SERRF_RXTIMEOUT \
 189         | SERRF_RXSROVERRUN \
 190         | SERRF_PARITYERROR \
 191         | SERRF_FRAMEERROR \
 192         | SERRF_NOISEERROR)
 193 #define SERRF_TX  (SERRF_TXTIMEOUT)
 194 /*\}*/
 195
 196 /**
 197  * \name LSB or MSB first data order, used with SPI AVR serial
 198  * \{
 199  */
 200 #define SER_MSB_FIRST 0
 201 #define SER_LSB_FIRST 1
 202 /*\}*/
 203
 204 /**
 205  * \name Parity settings for ser_setparity().
 206  *
 207  * \note Values are AVR-specific for performance reasons.
 208  *       Other processors should either decode them or
 209  *       redefine these macros.
 210  * \{
 211  */
 212 #define SER_PARITY_NONE  0
 213 #define SER_PARITY_EVEN  2
 214 #define SER_PARITY_ODD   3
 215 /*\}*/
 216
 217 /**
 218  * \name Serial hw numbers
 219  *
 220  * \{
 221  */
 222 enum
 223 {
 224 #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 || CPU_AVR_ATMEGA1281
 225         SER_UART0,
 226         SER_UART1,
 227         SER_SPI,
 228 #elif CPU_AVR_ATMEGA103 || CPU_AVR_ATMEGA8
 229         SER_UART0,
 230         SER_SPI,
 231 #elif CPU_DSP56K
 232         // \todo since we now support "fake" multiplexed serials, this should be moved to hw.h
 233         SER_UART0,
 234         SER_PUNTALI,
 235         SER_BARCODE,
 236 #elif OS_HOSTED
 237         SER_UART0,
 238         SER_UART1,
 239 #else
 240         #error unknown architecture
 241 #endif
 242         SER_CNT  /**< Number of serial ports */
 243 };
 244 /*\}*/
 245
 246
 247 struct SerialHardware;
 248
 249 /** Human-readable serial error descriptions */
 250 extern const char * const serial_errors[8];
 251
 252 /** Serial handle structure */
 253 typedef struct Serial
 254 {
 255         /** Physical port number */
 256         unsigned int unit;
 257
 258 #ifdef _DEBUG
 259         bool is_open;
 260 #endif
 261
 262         /**
 263          * \name Transmit and receive FIFOs.
 264          *
 265          * Declared volatile because handled asinchronously by interrupts.
 266          *
 267          * \{
 268          */
 269         FIFOBuffer txfifo;
 270         FIFOBuffer rxfifo;
 271         /* \} */
 272
 273 #if CONFIG_SER_RXTIMEOUT != -1
 274         ticks_t rxtimeout;
 275 #endif
 276 #if CONFIG_SER_TXTIMEOUT != -1
 277         ticks_t txtimeout;
 278 #endif
 279
 280         /** Holds the flags defined above.  Will be 0 when no errors have occurred. */
 281         volatile serstatus_t status;
 282
 283         /** Low-level interface to hardware. */
 284         struct SerialHardware* hw;
 285 } Serial;
 286
 287
 288 /* Function prototypes */
 289 extern int ser_putchar(int c, struct Serial *port);
 290 extern int ser_getchar(struct Serial *port);
 291 extern int ser_getchar_nowait(struct Serial *port);
 292
 293 extern int ser_write(struct Serial *port, const void *buf, size_t len);
 294 extern int ser_read(struct Serial *port, void *buf, size_t size);
 295
 296 extern int ser_print(struct Serial *port, const char *s);
 297 extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
 298
 299 extern int ser_gets(struct Serial *port, char *buf, int size);
 300 extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
 301
 302 extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
 303 extern void ser_setparity(struct Serial *port, int parity);
 304 extern void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout);
 305 extern void ser_resync(struct Serial *port, mtime_t delay);
 306 extern void ser_purge(struct Serial *port);
 307 extern void ser_drain(struct Serial *port);
 308
 309 extern void ser_clearstatus(struct Serial *port);
 310
 311 extern struct Serial *ser_open(unsigned int unit);
 312 extern void ser_close(struct Serial *port);
 313
 314 /**
 315  * \name Additional functions implemented as macros
 316  *
 317  * \{
 318  */
 319 #define ser_getstatus(h)    ((h)->status)
 320 #define ser_setstatus(h, x) ((h)->status = (x))
 321 /* \} */
 322
 323 #endif /* DRV_SER_H */