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.10  2004/08/24 16:20:48  bernie
  18  * ser_read(): Make buffer argument void * for consistency with ANSI C and ser_write()
  19  *
  20  * Revision 1.9  2004/08/15 05:32:22  bernie
  21  * ser_resync(): New function.
  22  *
  23  * Revision 1.8  2004/08/02 20:20:29  aleph
  24  * Merge from project_ks
  25  *
  26  * Revision 1.7  2004/07/30 14:15:53  rasky
  27  * Nuovo supporto unificato per detect della CPU
  28  *
  29  * Revision 1.6  2004/07/29 22:57:09  bernie
  30  * ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros.
  31  *
  32  * Revision 1.5  2004/07/18 21:54:23  bernie
  33  * Add ATmega8 support.
  34  *
  35  * Revision 1.4  2004/06/03 11:27:09  bernie
  36  * Add dual-license information.
  37  *
  38  * Revision 1.3  2004/06/02 21:35:24  aleph
  39  * Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
  40  *
  41  * Revision 1.2  2004/05/23 18:21:53  bernie
  42  * Trim CVS logs and cleanup header info.
  43  *
  44  */
  45 #ifndef DRV_SER_H
  46 #define DRV_SER_H
  47
  48 #include <mware/fifobuf.h>
  49 #include <drv/kdebug.h>
  50 #include <compiler.h>
  51 #include <config.h>
  52
  53 /*!
  54  * \name Serial Error/status flags
  55  *
  56  * Some of these flags map directly to the flags
  57  * in AVR UART Status Register(USR).
  58  * \todo  flags of DSP56k aren't mapped to these flags. Luckily
  59  *        these flags doesn't collide with the DSP56k ones,
  60  *        which are from 0x0100 to 0x8000
  61  */
  62 /*\{*/
  63 #if CPU_AVR
  64         typedef uint8_t serstatus_t;
  65
  66         /* Software errors */
  67         #define SERRF_RXFIFOOVERRUN  BV(0)  /*!< Rx FIFO buffer overrun */
  68         #define SERRF_RXTIMEOUT      BV(5)  /*!< Receive timeout */
  69         #define SERRF_TXTIMEOUT      BV(6)  /*!< Transmit timeout */
  70
  71         /* Hardware errors */
  72         #define SERRF_RXSROVERRUN    BV(3)  /*!< Rx shift register overrun */
  73         #define SERRF_FRAMEERROR     BV(4)  /*!< Stop bit missing */
  74         #define SERRF_PARITYERROR    BV(7)  /*!< Parity error */
  75 #elif CPU_DSP56K
  76         typedef uint16_t serstatus_t;
  77
  78         /* Software errors */
  79         #define SERRF_RXFIFOOVERRUN  BV(0)  /*!< Rx FIFO buffer overrun */
  80         #define SERRF_RXTIMEOUT      BV(1)  /*!< Receive timeout */
  81         #define SERRF_TXTIMEOUT      BV(2)  /*!< Transmit timeout */
  82
  83         /* Hardware errors */
  84         #define SERRF_PARITYERROR    BV(8)  /*!< Parity error */
  85         #define SERRF_FRAMEERROR     BV(9)  /*!< Stop bit missing */
  86         #define SERRF_NOISEERROR     BV(10) /*!< Noise error */
  87         #define SERRF_RXSROVERRUN    BV(11) /*!< Rx shift register overrun */
  88 #else
  89         #error unknown architecture
  90 #endif
  91 /*\}*/
  92
  93 /*! \name Parity settings for ser_setparity() */
  94 /*\{*/
  95 #define SER_PARITY_NONE  0
  96 #define SER_PARITY_EVEN  2
  97 #define SER_PARITY_ODD   3
  98 /*\}*/
  99
 100 /*!
 101  * \name Serial hw numbers
 102  *
 103  * \{
 104  */
 105 enum
 106 {
 107 #if defined(CPU_AVR_ATMEGA64) || defined(CPU_AVR_ATMEGA128)
 108         SER_UART0,
 109         SER_UART1,
 110         SER_SPI,
 111 #elif defined(CPU_AVR_ATMEGA103) || defined(CPU_AVR_ATMEGA8)
 112         SER_UART0,
 113         SER_SPI,
 114 #elif CPU_DSP56K
 115         SER_UART0,
 116         SER_UART1,
 117 #else
 118         #error unknown architecture
 119 #endif
 120         SER_CNT  /*!< Number of serial ports */
 121 };
 122 /*\}*/
 123
 124
 125 struct SerialHardware;
 126
 127 /*! Human-readable serial error descriptions */
 128 extern const char * const serial_errors[8];
 129
 130 /*! Serial handle structure */
 131 struct Serial
 132 {
 133         /*! Physical port number */
 134         unsigned int unit;
 135
 136         DB(bool is_open;)
 137
 138         /*!
 139          * \name FIFO transmit and receive buffers.
 140          *
 141          * Declared volatile because handled asinchronously by interrupts.
 142          *
 143          * \{
 144          */
 145         FIFOBuffer txfifo;
 146         FIFOBuffer rxfifo;
 147         unsigned char txbuffer[CONFIG_SER_TXBUFSIZE];
 148         unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE];
 149         /* \} */
 150
 151 #if CONFIG_SER_RXTIMEOUT != -1
 152         time_t rxtimeout;
 153 #endif
 154 #if CONFIG_SER_TXTIMEOUT != -1
 155         time_t txtimeout;
 156 #endif
 157
 158         /*! Holds the flags defined above.  Will be 0 when no errors have occurred. */
 159         serstatus_t status;
 160
 161         /*! Low-level interface to hardware. */
 162         struct SerialHardware* hw;
 163 };
 164
 165
 166 /* Function prototypes */
 167 extern int ser_putchar(int c, struct Serial *port);
 168 extern int ser_getchar(struct Serial *port);
 169 extern int ser_getchar_nowait(struct Serial *port);
 170
 171 extern int ser_write(struct Serial *port, const void *buf, size_t len);
 172 extern int ser_read(struct Serial *port, void *buf, size_t size);
 173
 174 extern int ser_print(struct Serial *port, const char *s);
 175 extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
 176
 177 extern int ser_gets(struct Serial *port, char *buf, int size);
 178 extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
 179
 180 extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
 181 extern void ser_setparity(struct Serial *port, int parity);
 182 extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
 183 extern void ser_resync(struct Serial *port, time_t delay);
 184 extern void ser_purge(struct Serial *port);
 185 extern void ser_drain(struct Serial *port);
 186
 187 extern struct Serial *ser_open(unsigned int unit);
 188 extern void ser_close(struct Serial *port);
 189
 190 /*!
 191  * \name Additional functions implemented as macros
 192  *
 193  * \{
 194  */
 195 #define ser_getstatus(h)    ((h)->status)
 196 #define ser_setstatus(h, x) ((h)->status = (x))
 197 /* \} */
 198
 199 #endif /* DRV_SER_H */