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.
9 * \brief High level serial I/O API
12 * \author Bernardo Innocenti <bernie@develer.com>
17 * Revision 1.4 2004/06/03 11:27:09 bernie
18 * Add dual-license information.
20 * Revision 1.3 2004/06/02 21:35:24 aleph
21 * Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
23 * Revision 1.2 2004/05/23 18:21:53 bernie
24 * Trim CVS logs and cleanup header info.
31 #include <mware/fifobuf.h>
35 * \name Serial Error/status flags
37 * Some of these flags map directly to the flags
38 * in AVR UART Status Register(USR).
39 * \todo flags of DSP56k aren't mapped to these flags. Luckily
40 * these flags doesn't collide with the DSP56k ones,
41 * which are from 0x0100 to 0x8000
45 typedef uint8_t serstatus_t;
48 #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
49 #define SERRF_RXTIMEOUT BV(5) /*!< Receive timeout */
50 #define SERRF_TXTIMEOUT BV(6) /*!< Transmit timeout */
53 #define SERRF_RXSROVERRUN BV(3) /*!< Rx shift register overrun */
54 #define SERRF_FRAMEERROR BV(4) /*!< Stop bit missing */
55 #define SERRF_PARITYERROR BV(7) /*!< Parity error */
56 #elif defined(__m56800__)
57 typedef uint16_t serstatus_t;
60 #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
61 #define SERRF_RXTIMEOUT BV(1) /*!< Receive timeout */
62 #define SERRF_TXTIMEOUT BV(2) /*!< Transmit timeout */
65 #define SERRF_PARITYERROR BV(8) /*!< Parity error */
66 #define SERRF_FRAMEERROR BV(9) /*!< Stop bit missing */
67 #define SERRF_NOISEERROR BV(10) /*!< Noise error */
68 #define SERRF_RXSROVERRUN BV(11) /*!< Rx shift register overrun */
70 #error unknown architecture
74 /*! \name Parity settings for ser_setparity() */
76 #define SER_PARITY_NONE 0
77 #define SER_PARITY_EVEN 2
78 #define SER_PARITY_ODD 3
82 * \name Serial hw numbers
88 #if defined(__AVR_ATmega64__)
93 #elif defined(__AVR_ATmega103__)
97 #elif defined (__m56800__)
102 #error unknown architecture
105 SER_CNT /**< Number of serial ports */
110 struct SerialHardware;
112 /*! Human-readable serial error descriptions */
113 extern const char * const serial_errors[8];
115 /*! Serial handle structure */
118 /*! Physical port number */
124 * \name FIFO transmit and receive buffers.
126 * Declared volatile because handled asinchronously by interrupts.
132 unsigned char txbuffer[CONFIG_SER_TXBUFSIZE];
133 unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE];
136 #ifdef CONFIG_SER_RXTIMEOUT
139 #ifdef CONFIG_SER_TXTIMEOUT
143 /*! Holds the flags defined above. Will be 0 when no errors have occurred. */
146 /*! Low-level interface to hardware. */
147 struct SerialHardware* hw;
151 /* Function prototypes */
152 extern int ser_putchar(int c, struct Serial *port);
153 extern int ser_getchar(struct Serial *port);
154 extern int ser_getchar_nowait(struct Serial *port);
155 extern int ser_write(struct Serial *port, const void *buf, size_t len);
156 extern int ser_read(struct Serial *port, char *buf, size_t size);
157 extern int ser_print(struct Serial *port, const char *s);
158 extern int ser_gets(struct Serial *port, char *buf, int size);
159 extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
160 extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
161 extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
162 extern void ser_setparity(struct Serial *port, int parity);
163 extern void ser_purge(struct Serial *port);
164 extern struct Serial *ser_open(unsigned int unit);
165 extern void ser_close(struct Serial *port);
166 #if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT)
167 extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
171 * \name Additional functions implemented as macros
175 #define ser_getstatus(h) ((h)->status)
176 #define ser_setstatus(h, x) ((h)->status = (x))
179 #endif /* DRV_SER_H */