Doc fixes.
[bertos.git] / drv / ser.h
index 06930cb439ff4ea9f2dda2763cfd8b1e3f7e5625..c0f7b8bb036007d9b441129bedbb713c30b04b9d 100644 (file)
--- a/drv/ser.h
+++ b/drv/ser.h
 #include <mware/fifobuf.h>
 #include <cfg/compiler.h>
 
-#include CPU_HEADER(ser)
+#if OS_HOSTED
+       #include <cfg/macros.h> /* BV() */
+
+       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. */
+
+       enum
+       {
+               SER_UART0,
+               SER_UART1,
+
+               SER_CNT  /**< Number of serial ports */
+       };
+
+#else
+       #include CPU_HEADER(ser)
+#endif
 
 #include <appconfig.h>
 
@@ -132,6 +158,12 @@ typedef struct KFileSerial
        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);
@@ -145,6 +177,7 @@ 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);