drv/ser.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
   5  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
   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.1  2004/05/23 18:10:11  bernie
  18  * Import drv/ modules.
  19  *
  20  * Revision 1.2  2004/04/21 17:38:24  rasky
  21  * New application
  22  *
  23  * Revision 1.16  2004/04/03 18:30:49  aleph
  24  * Move timeout defines in config, private define in .c
  25  *
  26  * Revision 1.15  2004/03/29 17:01:02  aleph
  27  * Add function to set serial parity, fix it when ser_open is used
  28  *
  29  * Revision 1.14  2004/03/29 16:19:33  aleph
  30  * Add ser_cleanup function; Various code improvements
  31  *
  32  * Revision 1.13  2004/03/24 15:22:27  aleph
  33  * Removed subdirs -I, fix header inclusion, move config.h in board_kf, kctrl
  34  *
  35  * Revision 1.12  2004/03/17 17:30:30  bernie
  36  * Add GCC format checks to printf()-like functions.
  37  *
  38  * Revision 1.11  2004/03/16 23:06:42  aleph
  39  * Doc fix
  40  *
  41  * Revision 1.10  2004/03/12 18:46:53  bernie
  42  * ser_read(): New function.
  43  *
  44  * Revision 1.9  2004/03/11 18:11:51  bernie
  45  * Cosmetic fixes
  46  */
  47 #ifndef SER_H
  48 #define SER_H
  49
  50 #include "compiler.h"
  51 #include <mware/fifobuf.h>
  52 #include "config.h"
  53
  54 /*!
  55  * \name Serial Error/status flags
  56  *
  57  * Some of these flags map directly to the flags
  58  * in AVR UART Status Register(USR).
  59  * \todo  flags of DSP56k aren't mapped to these flags. Luckily
  60  *        these flags doesn't collide with the DSP56k ones,
  61  *        which are from 0x0100 to 0x8000
  62  */
  63 /*\{*/
  64 #if defined(__AVR__)
  65         /* Software errors */
  66         #define SERRF_RXFIFOOVERRUN  BV(0)  /*!< Rx FIFO buffer overrun */
  67         #define SERRF_RXTIMEOUT      BV(5)  /*!< Receive timeout */
  68         #define SERRF_TXTIMEOUT      BV(6)  /*!< Transmit timeout */
  69
  70         /* Hardware errors */
  71         #define SERRF_RXSROVERRUN    BV(3)  /*!< Rx shift register overrun */
  72         #define SERRF_FRAMEERROR     BV(4)  /*!< Stop bit missing */
  73         #define SERRF_PARITYERROR    BV(7)  /*!< Parity error */
  74 #elif defined(__m56800__)
  75         /* Software errors */
  76         #define SERRF_RXFIFOOVERRUN  BV(0)  /*!< Rx FIFO buffer overrun */
  77         #define SERRF_RXTIMEOUT      BV(1)  /*!< Receive timeout */
  78         #define SERRF_TXTIMEOUT      BV(2)  /*!< Transmit timeout */
  79
  80         /* Hardware errors */
  81         #define SERRF_PARITYERROR    BV(8)  /*!< Parity error */
  82         #define SERRF_FRAMEERROR     BV(9)  /*!< Stop bit missing */
  83         #define SERRF_NOISEERROR     BV(10) /*!< Noise error */
  84         #define SERRF_RXSROVERRUN    BV(11) /*!< Rx shift register overrun */
  85 #else
  86         #error unknown architecture
  87 #endif
  88 /*\}*/
  89
  90 /*! \name Parity settings for ser_setparity() */
  91 /*\{*/
  92 #define SER_PARITY_NONE  0
  93 #define SER_PARITY_EVEN  2
  94 #define SER_PARITY_ODD   3
  95 /*\}*/
  96
  97 /*!
  98  * \name Serial hw numbers
  99  *
 100  * \{
 101  */
 102 enum
 103 {
 104         #if defined(__AVR_ATmega64__)
 105         SER_UART0,
 106         SER_UART1,
 107         SER_SPI,
 108
 109         #elif defined(__AVR_ATmega103__)
 110         SER_UART0,
 111         SER_SPI,
 112
 113         #elif defined (__m56800__)
 114         SER_UART0,
 115         SER_UART1,
 116
 117         #else
 118                 #error unknown architecture
 119         #endif
 120
 121         SER_CNT       /**< Number of serial ports */
 122 };
 123 /* @} */
 124
 125
 126 struct SerialHardware;
 127
 128 /*! Human-readable serial error descriptions */
 129 extern const char * const serial_errors[8];
 130
 131 /*! Serial handle structure */
 132 struct Serial
 133 {
 134         /*! Physical port number */
 135         unsigned int unit;
 136
 137         bool is_open;
 138
 139         /*!
 140          * \name FIFO transmit and receive buffers.
 141          *
 142          * Declared volatile because handled asinchronously by interrupts.
 143          *
 144          * \{
 145          */
 146         volatile FIFOBuffer txfifo;
 147         volatile FIFOBuffer     rxfifo;
 148         unsigned char txbuffer[CONFIG_SER_TXBUFSIZE];
 149         unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE];
 150         /* \} */
 151
 152 #ifdef CONFIG_SER_RXTIMEOUT
 153         time_t rxtimeout;
 154 #endif
 155 #ifdef CONFIG_SER_TXTIMEOUT
 156         time_t txtimeout;
 157 #endif
 158
 159         /*! Holds the flags defined above.  Will be 0 when no errors have occurred. */
 160         REGISTER uint16_t status;
 161
 162         /*! Low-level interface to hardware. */
 163         struct SerialHardware* hw;
 164
 165 };
 166
 167
 168 /* Function prototypes */
 169 extern int ser_putchar(int c, struct Serial *port);
 170 extern int ser_getchar(struct Serial *port);
 171 extern int ser_getchar_nowait(struct Serial *port);
 172 extern int ser_write(struct Serial *port, const void *buf, size_t len);
 173 extern int ser_read(struct Serial *port, char *buf, size_t size);
 174 extern int ser_print(struct Serial *port, const char *s);
 175 extern int ser_gets(struct Serial *port, char *buf, int size);
 176 extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
 177 extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
 178 extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
 179 extern void ser_setparity(struct Serial *port, int parity);
 180 extern void ser_purge(struct Serial *port);
 181 extern struct Serial *ser_open(unsigned int unit);
 182 extern void ser_close(struct Serial *port);
 183 #if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT)
 184         extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
 185 #endif
 186
 187 /**
 188  * @name Additional functions implemented as macros
 189  *
 190  * @{
 191  */
 192 #define ser_getstatus(h)    ((h)->status)
 193 #define ser_setstatus(h, x) ((h)->status = (x))
 194 /* @} */
 195
 196 #endif /* SER_H */