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