-/*!
+/**
* \file
* <!--
* Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
* Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
* -->
*
* \brief High level serial I/O API
/*#*
*#* $Log$
+ *#* Revision 1.36 2007/01/29 11:30:30 batt
+ *#* Reimplement ser_clearstatus as a macro.
+ *#*
+ *#* Revision 1.35 2007/01/27 20:47:12 batt
+ *#* Add clear status.
+ *#*
+ *#* Revision 1.34 2006/11/20 15:07:40 batt
+ *#* Revert unneeded locked functions.
+ *#*
+ *#* Revision 1.33 2006/11/17 17:03:58 batt
+ *#* Implement ser_setstatus and ser_getstatus as functions to avoid race conditions.
+ *#*
+ *#* Revision 1.32 2006/11/17 16:01:12 batt
+ *#* Serial status MUST be volatile.
+ *#*
+ *#* Revision 1.31 2006/09/13 18:22:48 bernie
+ *#* Typo.
+ *#*
+ *#* Revision 1.30 2006/09/13 18:21:23 bernie
+ *#* Add configurable SPI pin mapping.
+ *#*
+ *#* Revision 1.29 2006/09/13 13:59:11 bernie
+ *#* Documentation fixes.
+ *#*
+ *#* Revision 1.28 2006/07/21 10:58:00 batt
+ *#* Use timer_clock() instead of obsolete timer_ticks().
+ *#*
+ *#* Revision 1.27 2006/07/19 12:56:26 bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.26 2006/05/18 00:39:13 bernie
+ *#* Add struct Serial friendly typedef.
+ *#*
+ *#* Revision 1.25 2006/02/17 22:28:00 bernie
+ *#* Rename ser_emul.c to ser_posix.c.
+ *#*
+ *#* Revision 1.24 2006/02/17 22:23:06 bernie
+ *#* Update POSIX serial emulator.
+ *#*
+ *#* Revision 1.23 2005/11/27 23:33:40 bernie
+ *#* Use appconfig.h instead of cfg/config.h.
+ *#*
+ *#* Revision 1.22 2005/11/04 16:20:02 bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.21 2005/04/11 19:10:27 bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.20 2005/01/22 04:20:01 bernie
+ *#* Reformat.
+ *#*
+ *#* Revision 1.19 2005/01/11 18:08:16 aleph
+ *#* Add missing include
+ *#*
+ *#* Revision 1.18 2004/12/08 08:57:17 bernie
+ *#* Rename time_t to mtime_t.
+ *#*
+ *#* Revision 1.17 2004/11/16 21:54:56 bernie
+ *#* Changes for SC Monoboard support.
+ *#*
*#* Revision 1.16 2004/10/19 11:48:05 bernie
*#* Reformat.
*#*
#define DRV_SER_H
#include <mware/fifobuf.h>
-#include <compiler.h>
-#include <config.h>
+#include <cfg/compiler.h>
+#include <cfg/macros.h> /* BV() */
+#include <cfg/os.h>
+#include <appconfig.h>
-/*! \name Serial Error/status flags. */
+/** \name Serial Error/status flags. */
/*\{*/
#if CPU_AVR
typedef uint8_t serstatus_t;
/* 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 */
+ #define SERRF_RXFIFOOVERRUN BV(0) /**< Rx FIFO buffer overrun */
+ #define SERRF_RXTIMEOUT BV(5) /**< Receive timeout */
+ #define SERRF_TXTIMEOUT BV(6) /**< Transmit timeout */
/*
* Hardware errors.
- * These flags map directly to the AVR UART Status Register (USR).
+ * These flags map directly to the AVR UART Status Register (USR).
*/
- #define SERRF_RXSROVERRUN BV(3) /*!< Rx shift register overrun */
- #define SERRF_FRAMEERROR BV(4) /*!< Stop bit missing */
- #define SERRF_PARITYERROR BV(7) /*!< Parity error */
- #define SERRF_NOISEERROR 0 /*!< Unsupported */
+ #define SERRF_RXSROVERRUN BV(3) /**< Rx shift register overrun */
+ #define SERRF_FRAMEERROR BV(4) /**< Stop bit missing */
+ #define SERRF_PARITYERROR BV(7) /**< Parity error */
+ #define SERRF_NOISEERROR 0 /**< Unsupported */
#elif CPU_DSP56K
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.
* These flags map directly to the SCI Control Register.
*/
- #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_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 */
+#elif OS_HOSTED
+ 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 */
+
+ /* Hardware errors */
+ #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. */
+
#else
#error unknown architecture
#endif
/*\}*/
-/*! \name Masks to group TX/RX errors. */
-/*\{*/
-#define SERRF_RX (SERRF_RXFIFOOVERRUN \
+/**
+ * \name Masks to group TX/RX errors.
+ * \{
+ */
+#define SERRF_RX \
+ ( SERRF_RXFIFOOVERRUN \
| SERRF_RXTIMEOUT \
| SERRF_RXSROVERRUN \
| SERRF_PARITYERROR \
#define SERRF_TX (SERRF_TXTIMEOUT)
/*\}*/
+/**
+ * \name LSB or MSB first data order, used with SPI AVR serial
+ * \{
+ */
+#define SER_MSB_FIRST 0
+#define SER_LSB_FIRST 1
+/*\}*/
-/*!
+/**
* \name Parity settings for ser_setparity().
*
* \note Values are AVR-specific for performance reasons.
* Other processors should either decode them or
* redefine these macros.
+ * \{
*/
-/*\{*/
#define SER_PARITY_NONE 0
#define SER_PARITY_EVEN 2
#define SER_PARITY_ODD 3
/*\}*/
-/*!
+/**
* \name Serial hw numbers
*
* \{
*/
enum
{
-#if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128
+#if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 || CPU_AVR_ATMEGA1281
SER_UART0,
SER_UART1,
SER_SPI,
SER_UART0,
SER_SPI,
#elif CPU_DSP56K
+ // \todo since we now support "fake" multiplexed serials, this should be moved to hw.h
+ SER_UART0,
+ SER_PUNTALI,
+ SER_BARCODE,
+#elif OS_HOSTED
SER_UART0,
SER_UART1,
#else
#error unknown architecture
#endif
- SER_CNT /*!< Number of serial ports */
+ SER_CNT /**< Number of serial ports */
};
/*\}*/
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 Transmit and receive FIFOs.
*
* Declared volatile because handled asinchronously by interrupts.
/* \} */
#if CONFIG_SER_RXTIMEOUT != -1
- time_t rxtimeout;
+ ticks_t rxtimeout;
#endif
#if CONFIG_SER_TXTIMEOUT != -1
- time_t txtimeout;
+ ticks_t txtimeout;
#endif
- /*! Holds the flags defined above. Will be 0 when no errors have occurred. */
- serstatus_t status;
+ /** Holds the flags defined above. Will be 0 when no errors have occurred. */
+ volatile serstatus_t status;
- /*! Low-level interface to hardware. */
+ /** Low-level interface to hardware. */
struct SerialHardware* hw;
-};
+} Serial;
/* Function prototypes */
extern void ser_setbaudrate(struct Serial *port, unsigned long rate);
extern void ser_setparity(struct Serial *port, int parity);
-extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout);
-extern void ser_resync(struct Serial *port, time_t delay);
+extern void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout);
+extern void ser_resync(struct Serial *port, mtime_t delay);
extern void ser_purge(struct Serial *port);
extern void ser_drain(struct Serial *port);
extern struct Serial *ser_open(unsigned int unit);
extern void ser_close(struct Serial *port);
-/*!
+/**
* \name Additional functions implemented as macros
*
* \{
*/
#define ser_getstatus(h) ((h)->status)
#define ser_setstatus(h, x) ((h)->status = (x))
+#define ser_clearstatus(h) ser_setstatus(h, 0)
/* \} */
#endif /* DRV_SER_H */