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>
39 * $WIZ$ module_name = "ser"
40 * $WIZ$ module_depends = "kfile", "timer"
41 * $WIZ$ module_configuration = "bertos/cfg/cfg_ser.h"
47 #include <kern/kfile.h>
48 #include <struct/fifobuf.h>
49 #include <cfg/compiler.h>
52 #include <cfg/macros.h> /* BV() */
54 typedef uint16_t serstatus_t;
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 */
62 #define SERRF_RXSROVERRUN 0 /**< Unsupported in emulated serial port. */
63 #define SERRF_FRAMEERROR 0 /**< Unsupported in emulated serial port. */
64 #define SERRF_PARITYERROR 0 /**< Unsupported in emulated serial port. */
65 #define SERRF_NOISEERROR 0 /**< Unsupported in emulated serial port. */
72 SER_CNT /**< Number of serial ports */
76 #include CPU_HEADER(ser)
79 #include "cfg/cfg_ser.h"
84 * \name Masks to group TX/RX errors.
88 ( SERRF_RXFIFOOVERRUN \
94 #define SERRF_TX (SERRF_TXTIMEOUT)
98 * \name LSB or MSB first data order for SPI driver.
100 * $WIZ$ ser_order_bit = "SER_MSB_FIRST", "SER_LSB_FIRST"
102 #define SER_MSB_FIRST 0
103 #define SER_LSB_FIRST 1
106 * \name Parity settings for ser_setparity().
108 * \note Values are AVR-specific for performance reasons.
109 * Other processors should either decode them or
110 * redefine these macros.
113 #define SER_PARITY_NONE 0
114 #define SER_PARITY_EVEN 2
115 #define SER_PARITY_ODD 3
119 struct SerialHardware;
121 /** Human-readable serial error descriptions */
122 extern const char * const serial_errors[8];
124 /** Serial handle structure */
125 typedef struct Serial
127 /** Serial have a KFile struct implementation **/
130 /** Physical port number */
138 * \name Transmit and receive FIFOs.
140 * Declared volatile because handled asinchronously by interrupts.
148 #if CONFIG_SER_RXTIMEOUT != -1
151 #if CONFIG_SER_TXTIMEOUT != -1
155 /** Holds the flags defined above. Will be 0 when no errors have occurred. */
156 volatile serstatus_t status;
158 /** Low-level interface to hardware. */
159 struct SerialHardware* hw;
166 #define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L')
169 INLINE Serial * SERIAL_CAST(KFile *fd)
171 ASSERT(fd->_type == KFT_SERIAL);
175 /* Function prototypes */
176 //extern int ser_getchar_nowait(struct Serial *port);
178 void ser_setbaudrate(struct Serial *fd, unsigned long rate);
179 void ser_setparity(struct Serial *fd, int parity);
180 void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout);
181 void ser_resync(struct Serial *fd, mtime_t delay);
182 int ser_getchar_nowait(struct Serial *fd);
184 void ser_purgeRx(struct Serial *fd);
185 void ser_purgeTx(struct Serial *fd);
186 void ser_purge(struct Serial *fd);
187 void ser_init(struct Serial *fds, unsigned int unit);
188 void spimaster_init(Serial *fds, unsigned int unit);
192 * \name Additional functions implemented as macros
196 #define ser_getstatus(h) ((h)->status)
197 #define ser_setstatus(h, x) ((h)->status = (x))
200 #endif /* DRV_SER_H */