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