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