X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fser.h;h=5b07fbc1aa5a7adbead7dae6c6847a6578fee744;hb=7920ccf2c9be523f680d88ef7d681d09af7da209;hp=c06493dbb5e94ad3e20c4f315c8aa538f6693cf6;hpb=c3c1136c1705a700f3f8ac8b67d8024c6e4d507d;p=bertos.git

diff --git a/drv/ser.h b/drv/ser.h
index c06493db..5b07fbc1 100755
--- a/drv/ser.h
+++ b/drv/ser.h
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
@@ -14,6 +14,24 @@
 
 /*#*
  *#* $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.
+ *#*
+ *#* 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.
  *#*
@@ -96,60 +114,63 @@
 #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).
 	 */
-	#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 */
+	#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. */
+	#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
 /*\}*/
 
-/** Mask to group all RX errors. */
+/**
+ * \name Masks to group TX/RX errors.
+ * \{
+ */
 #define SERRF_RX \
 	( SERRF_RXFIFOOVERRUN \
 	| SERRF_RXTIMEOUT \
@@ -157,25 +178,31 @@
 	| 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().
  *
  * \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
  *
  * \{
@@ -200,27 +227,27 @@ enum
 #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.
@@ -232,18 +259,18 @@ 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. */
+	/** Holds the flags defined above.  Will be 0 when no errors have occurred. */
 	serstatus_t status;
 
-	/*! Low-level interface to hardware. */
+	/** Low-level interface to hardware. */
 	struct SerialHardware* hw;
-};
+} Serial;
 
 
 /* Function prototypes */
@@ -270,7 +297,7 @@ 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
  *
  * \{