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