*
* -->
*
- * \brief High level serial I/O API
+ * \brief High level serial I/O API.
*
- * \version $Id$
* \author Bernie Innocenti <bernie@codewiz.org>
+ *
+ * $WIZ$ module_name = "ser"
+ * $WIZ$ module_depends = "kfile", "timer"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_ser.h"
+ * $WIZ$ module_hw = "bertos/hw/hw_ser.h"
+ * $WIZ$ module_supports = "not atmega103 and not atmega8"
*/
#ifndef DRV_SER_H
#define DRV_SER_H
-#include <kern/kfile.h>
+#include <io/kfile.h>
#include <struct/fifobuf.h>
#include <cfg/compiler.h>
#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. */
+ #define SERRF_RXSROVERRUN 0 /**< Rx shift register overrun, unsupported in emulated serial port. */
+ #define SERRF_FRAMEERROR 0 /**< Stop bit missing, unsupported in emulated serial port. */
+ #define SERRF_PARITYERROR 0 /**< Parity error, unsupported in emulated serial port. */
+ #define SERRF_NOISEERROR 0 /**< Noise error, unsupported in emulated serial port. */
enum
{
| SERRF_RXSROVERRUN \
| SERRF_PARITYERROR \
| SERRF_FRAMEERROR \
- | SERRF_NOISEERROR)
-#define SERRF_TX (SERRF_TXTIMEOUT)
+ | SERRF_NOISEERROR) /**< All possible rx errors */
+#define SERRF_TX (SERRF_TXTIMEOUT) /**< All possible tx errors */
/*\}*/
/**
* \name LSB or MSB first data order for SPI driver.
- * \{
+ *
+ * $WIZ$ ser_order_bit = "SER_MSB_FIRST", "SER_LSB_FIRST"
*/
#define SER_MSB_FIRST 0
#define SER_LSB_FIRST 1
-/*\}*/
/**
* \name Parity settings for ser_setparity().
/*\}*/
+/**
+ * \def CONFIG_SER_STROBE
+ *
+ * This is a debug facility that can be used to
+ * monitor SER interrupt activity on an external pin.
+ *
+ * To use strobes, redefine the macros SER_STROBE_ON,
+ * SER_STROBE_OFF and SER_STROBE_INIT and set
+ * CONFIG_SER_STROBE to 1.
+ */
+#if !defined(CONFIG_SER_STROBE) || !CONFIG_SER_STROBE
+ #define SER_STROBE_ON do {/*nop*/} while(0)
+ #define SER_STROBE_OFF do {/*nop*/} while(0)
+ #define SER_STROBE_INIT do {/*nop*/} while(0)
+#endif
+
struct SerialHardware;
/** Human-readable serial error descriptions */
*
* \{
*/
-#define ser_getstatus(h) ((h)->status)
-#define ser_setstatus(h, x) ((h)->status = (x))
+#define ser_getstatus(serial) ((serial)->status)
+#define ser_setstatus(serial, new_status) ((serial)->status = (new_status))
/* \} */
#endif /* DRV_SER_H */