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 README.devlib for information.
9 * \brief High level serial I/O API
12 * \author Bernardo Innocenti <bernie@develer.com>
17 *#* Revision 1.24 2006/02/17 22:23:06 bernie
18 *#* Update POSIX serial emulator.
20 *#* Revision 1.23 2005/11/27 23:33:40 bernie
21 *#* Use appconfig.h instead of cfg/config.h.
23 *#* Revision 1.22 2005/11/04 16:20:02 bernie
24 *#* Fix reference to README.devlib in header.
26 *#* Revision 1.21 2005/04/11 19:10:27 bernie
27 *#* Include top-level headers from cfg/ subdir.
29 *#* Revision 1.20 2005/01/22 04:20:01 bernie
32 *#* Revision 1.19 2005/01/11 18:08:16 aleph
33 *#* Add missing include
35 *#* Revision 1.18 2004/12/08 08:57:17 bernie
36 *#* Rename time_t to mtime_t.
38 *#* Revision 1.17 2004/11/16 21:54:56 bernie
39 *#* Changes for SC Monoboard support.
41 *#* Revision 1.16 2004/10/19 11:48:05 bernie
44 *#* Revision 1.15 2004/10/19 08:11:53 bernie
45 *#* SERRF_TX, SERRF_RX: New macros; Enhance documentation.
47 *#* Revision 1.14 2004/10/03 18:43:18 bernie
48 *#* Fix a nasty bug caused by confusion between old-style and new-style configuration macros.
50 *#* Revision 1.13 2004/09/14 21:04:57 bernie
51 *#* Don't vanely call kdebug.h.
53 *#* Revision 1.12 2004/09/06 21:40:50 bernie
54 *#* Move buffer handling in chip-specific driver.
56 *#* Revision 1.11 2004/08/25 14:12:08 rasky
57 *#* Aggiornato il comment block dei log RCS
59 *#* Revision 1.10 2004/08/24 16:20:48 bernie
60 *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write()
62 *#* Revision 1.9 2004/08/15 05:32:22 bernie
63 *#* ser_resync(): New function.
65 *#* Revision 1.8 2004/08/02 20:20:29 aleph
66 *#* Merge from project_ks
68 *#* Revision 1.7 2004/07/30 14:15:53 rasky
69 *#* Nuovo supporto unificato per detect della CPU
71 *#* Revision 1.6 2004/07/29 22:57:09 bernie
72 *#* ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros.
74 *#* Revision 1.5 2004/07/18 21:54:23 bernie
75 *#* Add ATmega8 support.
77 *#* Revision 1.4 2004/06/03 11:27:09 bernie
78 *#* Add dual-license information.
80 *#* Revision 1.3 2004/06/02 21:35:24 aleph
81 *#* Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
83 *#* Revision 1.2 2004/05/23 18:21:53 bernie
84 *#* Trim CVS logs and cleanup header info.
90 #include <mware/fifobuf.h>
91 #include <cfg/compiler.h>
92 #include <cfg/macros.h> /* BV() */
93 #include <cfg/arch_config.h> /* ARCH_EMUL */
94 #include <appconfig.h>
96 /*! \name Serial Error/status flags. */
99 typedef uint8_t serstatus_t;
101 /* Software errors */
102 #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
103 #define SERRF_RXTIMEOUT BV(5) /*!< Receive timeout */
104 #define SERRF_TXTIMEOUT BV(6) /*!< Transmit timeout */
108 * These flags map directly to the AVR UART Status Register (USR).
110 #define SERRF_RXSROVERRUN BV(3) /*!< Rx shift register overrun */
111 #define SERRF_FRAMEERROR BV(4) /*!< Stop bit missing */
112 #define SERRF_PARITYERROR BV(7) /*!< Parity error */
113 #define SERRF_NOISEERROR 0 /*!< Unsupported */
115 typedef uint16_t serstatus_t;
117 /* Software errors */
118 #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
119 #define SERRF_RXTIMEOUT BV(1) /*!< Receive timeout */
120 #define SERRF_TXTIMEOUT BV(2) /*!< Transmit timeout */
124 * These flags map directly to the SCI Control Register.
126 #define SERRF_PARITYERROR BV(8) /*!< Parity error */
127 #define SERRF_FRAMEERROR BV(9) /*!< Stop bit missing */
128 #define SERRF_NOISEERROR BV(10) /*!< Noise error */
129 #define SERRF_RXSROVERRUN BV(11) /*!< Rx shift register overrun */
130 #elif ARCH & ARCH_EMUL
131 typedef uint16_t serstatus_t;
133 /* Software errors */
134 #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
135 #define SERRF_RXTIMEOUT BV(1) /*!< Receive timeout */
136 #define SERRF_TXTIMEOUT BV(2) /*!< Transmit timeout */
138 /* Hardware errors */
139 #define SERRF_RXSROVERRUN 0 /*!< Unsupported in emulated serial port. */
140 #define SERRF_FRAMEERROR 0 /*!< Unsupported in emulated serial port. */
141 #define SERRF_PARITYERROR 0 /*!< Unsupported in emulated serial port. */
142 #define SERRF_NOISEERROR 0 /*!< Unsupported in emulated serial port. */
145 #error unknown architecture
149 /** Mask to group all RX errors. */
151 ( SERRF_RXFIFOOVERRUN \
153 | SERRF_RXSROVERRUN \
154 | SERRF_PARITYERROR \
158 /** Mask to group all TX errors. */
159 #define SERRF_TX (SERRF_TXTIMEOUT)
163 * \name Parity settings for ser_setparity().
165 * \note Values are AVR-specific for performance reasons.
166 * Other processors should either decode them or
167 * redefine these macros.
170 #define SER_PARITY_NONE 0
171 #define SER_PARITY_EVEN 2
172 #define SER_PARITY_ODD 3
176 * \name Serial hw numbers
182 #if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
186 #elif CPU_AVR_ATMEGA103 || CPU_AVR_ATMEGA8
190 // \todo since we now support "fake" multiplexed serials, this should be moved to hw.h
194 #elif ARCH & ARCH_EMUL
198 #error unknown architecture
200 SER_CNT /*!< Number of serial ports */
205 struct SerialHardware;
207 /*! Human-readable serial error descriptions */
208 extern const char * const serial_errors[8];
210 /*! Serial handle structure */
213 /*! Physical port number */
221 * \name Transmit and receive FIFOs.
223 * Declared volatile because handled asinchronously by interrupts.
231 #if CONFIG_SER_RXTIMEOUT != -1
234 #if CONFIG_SER_TXTIMEOUT != -1
238 /*! Holds the flags defined above. Will be 0 when no errors have occurred. */
241 /*! Low-level interface to hardware. */
242 struct SerialHardware* hw;
246 /* Function prototypes */
247 extern int ser_putchar(int c, struct Serial *port);
248 extern int ser_getchar(struct Serial *port);
249 extern int ser_getchar_nowait(struct Serial *port);
251 extern int ser_write(struct Serial *port, const void *buf, size_t len);
252 extern int ser_read(struct Serial *port, void *buf, size_t size);
254 extern int ser_print(struct Serial *port, const char *s);
255 extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
257 extern int ser_gets(struct Serial *port, char *buf, int size);
258 extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
260 extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
261 extern void ser_setparity(struct Serial *port, int parity);
262 extern void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout);
263 extern void ser_resync(struct Serial *port, mtime_t delay);
264 extern void ser_purge(struct Serial *port);
265 extern void ser_drain(struct Serial *port);
267 extern struct Serial *ser_open(unsigned int unit);
268 extern void ser_close(struct Serial *port);
271 * \name Additional functions implemented as macros
275 #define ser_getstatus(h) ((h)->status)
276 #define ser_setstatus(h, x) ((h)->status = (x))
279 #endif /* DRV_SER_H */