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