X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fser.h;h=5b07fbc1aa5a7adbead7dae6c6847a6578fee744;hb=f52e46baa21748f30f30a9e725edbf90b420ed24;hp=3b3edd5c980fd0b387c8890bae638d0b50fca732;hpb=af9c555446161016fdd76c1cdff96ce76bb6cba2;p=bertos.git diff --git a/drv/ser.h b/drv/ser.h index 3b3edd5c..5b07fbc1 100755 --- a/drv/ser.h +++ b/drv/ser.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \brief High level serial I/O API @@ -14,6 +14,36 @@ /*#* *#* $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. + *#* + *#* Revision 1.24 2006/02/17 22:23:06 bernie + *#* Update POSIX serial emulator. + *#* + *#* Revision 1.23 2005/11/27 23:33:40 bernie + *#* Use appconfig.h instead of cfg/config.h. + *#* + *#* Revision 1.22 2005/11/04 16:20:02 bernie + *#* Fix reference to README.devlib in header. + *#* *#* Revision 1.21 2005/04/11 19:10:27 bernie *#* Include top-level headers from cfg/ subdir. *#* @@ -80,58 +110,67 @@ #include #include -#include #include /* BV() */ +#include +#include -/*! \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 */ -#elif defined(_EMUL) + #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. */ #else #error unknown architecture #endif /*\}*/ -/*! \name Masks to group TX/RX errors. */ -/*\{*/ +/** + * \name Masks to group TX/RX errors. + * \{ + */ #define SERRF_RX \ ( SERRF_RXFIFOOVERRUN \ | SERRF_RXTIMEOUT \ @@ -142,21 +181,28 @@ #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 * * \{ @@ -175,35 +221,33 @@ enum SER_UART0, SER_PUNTALI, SER_BARCODE, -#elif defined(_EMUL) +#elif OS_HOSTED SER_UART0, - #if CONFIG_EMUL_UART1 - SER_UART1, - #endif + SER_UART1, #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. @@ -215,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 */ @@ -253,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 * * \{