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