Move kfile interface to the io/ directory.

[bertos.git] / bertos / drv / ser.h

diff --git a/bertos/drv/ser.h b/bertos/drv/ser.h
index c560aa5c58927d496eb013477ea7921e0ea63154..cd81f5af7b0e2bfa74ad834b2cb60a178b9b8be4 100644 (file)
--- a/bertos/drv/ser.h
+++ b/bertos/drv/ser.h
@@ -27,21 +27,27 @@
  * the GNU General Public License.
  *
  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
+ * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
  *
  * -->
  *
- * \brief High level serial I/O API
+ * \brief High level serial I/O API.
  *
  * \version $Id$
- * \author Bernardo Innocenti <bernie@develer.com>
+ * \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 atmega32 and not atmega8"
  */
 
 #ifndef DRV_SER_H
 #define DRV_SER_H
 
-#include <kern/kfile.h>
-#include <mware/fifobuf.h>
+#include <io/kfile.h>
+#include <struct/fifobuf.h>
 #include <cfg/compiler.h>
 
 #if OS_HOSTED
@@ -55,10 +61,10 @@
        #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
        {
@@ -86,17 +92,17 @@
        | 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().
@@ -112,6 +118,22 @@
 /*\}*/
 
 
+/**
+ * \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 */
@@ -120,6 +142,9 @@ extern const char * const serial_errors[8];
 /** Serial handle structure */
 typedef struct Serial
 {
+       /** Serial have a KFile struct implementation **/
+       KFile fd;
+
        /** Physical port number */
        unsigned int unit;
 
@@ -152,11 +177,6 @@ typedef struct Serial
        struct SerialHardware* hw;
 } Serial;
 
-typedef struct KFileSerial
-{
-       KFile fd;
-       Serial *ser;
-} KFileSerial;
 
 /**
  * ID for serial.
@@ -164,26 +184,26 @@ typedef struct KFileSerial
 #define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L')
 
 
-INLINE KFileSerial * KFILESERIAL(KFile *fd)
+INLINE Serial * SERIAL_CAST(KFile *fd)
 {
        ASSERT(fd->_type == KFT_SERIAL);
-       return (KFileSerial *)fd;
+       return (Serial *)fd;
 }
 
 /* Function prototypes */
 //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_setbaudrate(struct Serial *fd, unsigned long rate);
+void ser_setparity(struct Serial *fd, int parity);
+void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout);
+void ser_resync(struct Serial *fd, mtime_t delay);
+int ser_getchar_nowait(struct Serial *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);
+void ser_purgeRx(struct Serial *fd);
+void ser_purgeTx(struct Serial *fd);
+void ser_purge(struct Serial *fd);
+void ser_init(struct Serial *fds, unsigned int unit);
+void spimaster_init(Serial *fds, unsigned int unit);
 
 
 /**
@@ -191,8 +211,8 @@ void spimaster_init(KFileSerial *fds, unsigned int unit);
  *
  * \{
  */
-#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 */