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