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