Exclude file with Qt-style documentation.

[bertos.git] / drv / ser.h

diff --git a/drv/ser.h b/drv/ser.h
index f9ff2ddd639afe3e032eed2431be38f4fd845fae..5b07fbc1aa5a7adbead7dae6c6847a6578fee744 100755 (executable)
--- a/drv/ser.h
+++ b/drv/ser.h
@@ -14,6 +14,18 @@
 
 /*#*
  *#* $Log$
+ *#* 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.
  *#*
@@ -155,7 +167,10 @@
 #endif
 /*\}*/
 
-/** Mask to group all RX errors. */
+/**
+ * \name Masks to group TX/RX errors.
+ * \{
+ */
 #define SERRF_RX \
        ( SERRF_RXFIFOOVERRUN \
        | SERRF_RXTIMEOUT \
@@ -163,10 +178,16 @@
        | SERRF_PARITYERROR \
        | SERRF_FRAMEERROR \
        | SERRF_NOISEERROR)
-
-/** Mask to group all TX errors. */
 #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().
@@ -174,8 +195,8 @@
  * \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
@@ -238,10 +259,10 @@ typedef struct Serial
        /* \} */
 
 #if CONFIG_SER_RXTIMEOUT != -1
-       mtime_t rxtimeout;
+       ticks_t rxtimeout;
 #endif
 #if CONFIG_SER_TXTIMEOUT != -1
-       mtime_t txtimeout;
+       ticks_t txtimeout;
 #endif
 
        /** Holds the flags defined above.  Will be 0 when no errors have occurred. */