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