4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
34 * \brief High level serial I/O API.
37 * \author Bernie Innocenti <bernie@codewiz.org>
41 * "depends" : ["kfile", "timer"],
42 * "configuration" : "bertos/cfg/cfg_ser.h"
49 #include <kern/kfile.h>
50 #include <struct/fifobuf.h>
51 #include <cfg/compiler.h>
54 #include <cfg/macros.h> /* BV() */
56 typedef uint16_t serstatus_t;
59 #define SERRF_RXFIFOOVERRUN BV(0) /**< Rx FIFO buffer overrun */
60 #define SERRF_RXTIMEOUT BV(1) /**< Receive timeout */
61 #define SERRF_TXTIMEOUT BV(2) /**< Transmit timeout */
64 #define SERRF_RXSROVERRUN 0 /**< Unsupported in emulated serial port. */
65 #define SERRF_FRAMEERROR 0 /**< Unsupported in emulated serial port. */
66 #define SERRF_PARITYERROR 0 /**< Unsupported in emulated serial port. */
67 #define SERRF_NOISEERROR 0 /**< Unsupported in emulated serial port. */
74 SER_CNT /**< Number of serial ports */
78 #include CPU_HEADER(ser)
81 #include "cfg/cfg_ser.h"
86 * \name Masks to group TX/RX errors.
90 ( SERRF_RXFIFOOVERRUN \
96 #define SERRF_TX (SERRF_TXTIMEOUT)
100 * \name LSB or MSB first data order for SPI driver.
103 * "ser_order_bit" : ["SER_MSB_FIRST", "SER_LSB_FIRST"]
106 #define SER_MSB_FIRST 0
107 #define SER_LSB_FIRST 1
110 * \name Parity settings for ser_setparity().
112 * \note Values are AVR-specific for performance reasons.
113 * Other processors should either decode them or
114 * redefine these macros.
117 #define SER_PARITY_NONE 0
118 #define SER_PARITY_EVEN 2
119 #define SER_PARITY_ODD 3
123 struct SerialHardware;
125 /** Human-readable serial error descriptions */
126 extern const char * const serial_errors[8];
128 /** Serial handle structure */
129 typedef struct Serial
131 /** Serial have a KFile struct implementation **/
134 /** Physical port number */
142 * \name Transmit and receive FIFOs.
144 * Declared volatile because handled asinchronously by interrupts.
152 #if CONFIG_SER_RXTIMEOUT != -1
155 #if CONFIG_SER_TXTIMEOUT != -1
159 /** Holds the flags defined above. Will be 0 when no errors have occurred. */
160 volatile serstatus_t status;
162 /** Low-level interface to hardware. */
163 struct SerialHardware* hw;
170 #define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L')
173 INLINE Serial * SERIAL_CAST(KFile *fd)
175 ASSERT(fd->_type == KFT_SERIAL);
179 /* Function prototypes */
180 //extern int ser_getchar_nowait(struct Serial *port);
182 void ser_setbaudrate(struct Serial *fd, unsigned long rate);
183 void ser_setparity(struct Serial *fd, int parity);
184 void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout);
185 void ser_resync(struct Serial *fd, mtime_t delay);
186 int ser_getchar_nowait(struct Serial *fd);
188 void ser_purgeRx(struct Serial *fd);
189 void ser_purgeTx(struct Serial *fd);
190 void ser_purge(struct Serial *fd);
191 void ser_init(struct Serial *fds, unsigned int unit);
192 void spimaster_init(Serial *fds, unsigned int unit);
196 * \name Additional functions implemented as macros
200 #define ser_getstatus(h) ((h)->status)
201 #define ser_setstatus(h, x) ((h)->status = (x))
204 #endif /* DRV_SER_H */