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