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