-/*!
+/**
* \file
* <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction. Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License. This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
* Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
* Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * All Rights Reserved.
+ *
* -->
*
* \brief High level serial I/O API
* \author Bernardo Innocenti <bernie@develer.com>
*/
-/*
- * $Log$
- * Revision 1.3 2004/06/02 21:35:24 aleph
- * Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens
- *
- * Revision 1.2 2004/05/23 18:21:53 bernie
- * Trim CVS logs and cleanup header info.
- *
- */
#ifndef DRV_SER_H
#define DRV_SER_H
-#include "compiler.h"
+#include <kern/kfile.h>
#include <mware/fifobuf.h>
-#include "config.h"
-
-/*!
- * \name Serial Error/status flags
- *
- * Some of these flags map directly to the flags
- * in AVR UART Status Register(USR).
- * \todo flags of DSP56k aren't mapped to these flags. Luckily
- * these flags doesn't collide with the DSP56k ones,
- * which are from 0x0100 to 0x8000
- */
-/*\{*/
-#if defined(__AVR__)
- typedef uint8_t serstatus_t;
+#include <cfg/compiler.h>
- /* Software errors */
- #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
- #define SERRF_RXTIMEOUT BV(5) /*!< Receive timeout */
- #define SERRF_TXTIMEOUT BV(6) /*!< Transmit timeout */
+#if OS_HOSTED
+ #include <cfg/macros.h> /* BV() */
- /* Hardware errors */
- #define SERRF_RXSROVERRUN BV(3) /*!< Rx shift register overrun */
- #define SERRF_FRAMEERROR BV(4) /*!< Stop bit missing */
- #define SERRF_PARITYERROR BV(7) /*!< Parity error */
-#elif defined(__m56800__)
typedef uint16_t serstatus_t;
/* Software errors */
- #define SERRF_RXFIFOOVERRUN BV(0) /*!< Rx FIFO buffer overrun */
- #define SERRF_RXTIMEOUT BV(1) /*!< Receive timeout */
- #define SERRF_TXTIMEOUT BV(2) /*!< Transmit timeout */
+ #define SERRF_RXFIFOOVERRUN BV(0) /**< Rx FIFO buffer overrun */
+ #define SERRF_RXTIMEOUT BV(1) /**< Receive timeout */
+ #define SERRF_TXTIMEOUT BV(2) /**< Transmit timeout */
/* Hardware errors */
- #define SERRF_PARITYERROR BV(8) /*!< Parity error */
- #define SERRF_FRAMEERROR BV(9) /*!< Stop bit missing */
- #define SERRF_NOISEERROR BV(10) /*!< Noise error */
- #define SERRF_RXSROVERRUN BV(11) /*!< Rx shift register overrun */
+ #define SERRF_RXSROVERRUN 0 /**< Unsupported in emulated serial port. */
+ #define SERRF_FRAMEERROR 0 /**< Unsupported in emulated serial port. */
+ #define SERRF_PARITYERROR 0 /**< Unsupported in emulated serial port. */
+ #define SERRF_NOISEERROR 0 /**< Unsupported in emulated serial port. */
+
+ enum
+ {
+ SER_UART0,
+ SER_UART1,
+
+ SER_CNT /**< Number of serial ports */
+ };
+
#else
- #error unknown architecture
+ #include CPU_HEADER(ser)
#endif
+
+#include <appconfig.h>
+
+
+
+/**
+ * \name Masks to group TX/RX errors.
+ * \{
+ */
+#define SERRF_RX \
+ ( SERRF_RXFIFOOVERRUN \
+ | SERRF_RXTIMEOUT \
+ | SERRF_RXSROVERRUN \
+ | SERRF_PARITYERROR \
+ | SERRF_FRAMEERROR \
+ | SERRF_NOISEERROR)
+#define SERRF_TX (SERRF_TXTIMEOUT)
/*\}*/
-/*! \name Parity settings for ser_setparity() */
-/*\{*/
-#define SER_PARITY_NONE 0
-#define SER_PARITY_EVEN 2
-#define SER_PARITY_ODD 3
+/**
+ * \name LSB or MSB first data order for SPI driver.
+ * \{
+ */
+#define SER_MSB_FIRST 0
+#define SER_LSB_FIRST 1
/*\}*/
-/*!
- * \name Serial hw numbers
+/**
+ * \name Parity settings for ser_setparity().
*
+ * \note Values are AVR-specific for performance reasons.
+ * Other processors should either decode them or
+ * redefine these macros.
* \{
*/
-enum
-{
- #if defined(__AVR_ATmega64__)
- SER_UART0,
- SER_UART1,
- SER_SPI,
-
- #elif defined(__AVR_ATmega103__)
- SER_UART0,
- SER_SPI,
-
- #elif defined (__m56800__)
- SER_UART0,
- SER_UART1,
-
- #else
- #error unknown architecture
- #endif
-
- SER_CNT /**< Number of serial ports */
-};
-/* @} */
+#define SER_PARITY_NONE 0
+#define SER_PARITY_EVEN 2
+#define SER_PARITY_ODD 3
+/*\}*/
struct SerialHardware;
-/*! Human-readable serial error descriptions */
+/** Human-readable serial error descriptions */
extern const char * const serial_errors[8];
-/*! Serial handle structure */
-struct Serial
+/** Serial handle structure */
+typedef struct Serial
{
- /*! Physical port number */
+ /** Physical port number */
unsigned int unit;
+#ifdef _DEBUG
bool is_open;
+#endif
- /*!
- * \name FIFO transmit and receive buffers.
+ /**
+ * \name Transmit and receive FIFOs.
*
* Declared volatile because handled asinchronously by interrupts.
*
*/
FIFOBuffer txfifo;
FIFOBuffer rxfifo;
- unsigned char txbuffer[CONFIG_SER_TXBUFSIZE];
- unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE];
/* \} */
-#ifdef CONFIG_SER_RXTIMEOUT
- time_t rxtimeout;
+#if CONFIG_SER_RXTIMEOUT != -1
+ ticks_t rxtimeout;
#endif
-#ifdef CONFIG_SER_TXTIMEOUT
- time_t txtimeout;
+#if CONFIG_SER_TXTIMEOUT != -1
+ ticks_t txtimeout;
#endif
- /*! Holds the flags defined above. Will be 0 when no errors have occurred. */
- serstatus_t status;
-
- /*! Low-level interface to hardware. */
+ /** Holds the flags defined above. Will be 0 when no errors have occurred. */
+ volatile serstatus_t status;
+
+ /** Low-level interface to hardware. */
struct SerialHardware* hw;
-};
+} Serial;
+
+typedef struct KFileSerial
+{
+ KFile fd;
+ Serial *ser;
+} KFileSerial;
+
+/**
+ * ID for serial.
+ */
+#define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L')
+INLINE KFileSerial * KFILESERIAL(KFile *fd)
+{
+ ASSERT(fd->_type == KFT_SERIAL);
+ return (KFileSerial *)fd;
+}
+
/* Function prototypes */
-extern int ser_putchar(int c, struct Serial *port);
-extern int ser_getchar(struct Serial *port);
-extern int ser_getchar_nowait(struct Serial *port);
-extern int ser_write(struct Serial *port, const void *buf, size_t len);
-extern int ser_read(struct Serial *port, char *buf, size_t size);
-extern int ser_print(struct Serial *port, const char *s);
-extern int ser_gets(struct Serial *port, char *buf, int size);
-extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo);
-extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3);
-extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
-extern void ser_setparity(struct Serial *port, int parity);
-extern void ser_purge(struct Serial *port);
-extern struct Serial *ser_open(unsigned int unit);
-extern void ser_close(struct Serial *port);
-#if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT)
- extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
-#endif
+//extern int ser_getchar_nowait(struct Serial *port);
+
+void ser_setbaudrate(struct KFileSerial *fd, unsigned long rate);
+void ser_setparity(struct KFileSerial *fd, int parity);
+void ser_settimeouts(struct KFileSerial *fd, mtime_t rxtimeout, mtime_t txtimeout);
+void ser_resync(struct KFileSerial *fd, mtime_t delay);
+int ser_getchar_nowait(struct KFileSerial *fd);
+
+void ser_purgeRx(struct KFileSerial *fd);
+void ser_purgeTx(struct KFileSerial *fd);
+void ser_purge(struct KFileSerial *fd);
+void ser_init(struct KFileSerial *fds, unsigned int unit);
+void spimaster_init(KFileSerial *fds, unsigned int unit);
+
-/*!
+/**
* \name Additional functions implemented as macros
*
* \{
projects / bertos.git / blobdiff