X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fser.h;h=5b07fbc1aa5a7adbead7dae6c6847a6578fee744;hb=7920ccf2c9be523f680d88ef7d681d09af7da209;hp=9d584a8091d93f703d1809693abbf2690e4b7e89;hpb=7ee3b3c3da60b181d18336e892d8d0920166f5ae;p=bertos.git diff --git a/drv/ser.h b/drv/ser.h index 9d584a80..5b07fbc1 100755 --- a/drv/ser.h +++ b/drv/ser.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \brief High level serial I/O API @@ -12,152 +12,292 @@ * \author Bernardo Innocenti */ -/* - * $Log$ - * Revision 1.2 2004/05/23 18:21:53 bernie - * Trim CVS logs and cleanup header info. - * - */ +/*#* + *#* $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. + *#* + *#* Revision 1.20 2005/01/22 04:20:01 bernie + *#* Reformat. + *#* + *#* Revision 1.19 2005/01/11 18:08:16 aleph + *#* Add missing include + *#* + *#* Revision 1.18 2004/12/08 08:57:17 bernie + *#* Rename time_t to mtime_t. + *#* + *#* Revision 1.17 2004/11/16 21:54:56 bernie + *#* Changes for SC Monoboard support. + *#* + *#* Revision 1.16 2004/10/19 11:48:05 bernie + *#* Reformat. + *#* + *#* Revision 1.15 2004/10/19 08:11:53 bernie + *#* SERRF_TX, SERRF_RX: New macros; Enhance documentation. + *#* + *#* Revision 1.14 2004/10/03 18:43:18 bernie + *#* Fix a nasty bug caused by confusion between old-style and new-style configuration macros. + *#* + *#* Revision 1.13 2004/09/14 21:04:57 bernie + *#* Don't vanely call kdebug.h. + *#* + *#* Revision 1.12 2004/09/06 21:40:50 bernie + *#* Move buffer handling in chip-specific driver. + *#* + *#* Revision 1.11 2004/08/25 14:12:08 rasky + *#* Aggiornato il comment block dei log RCS + *#* + *#* Revision 1.10 2004/08/24 16:20:48 bernie + *#* ser_read(): Make buffer argument void *#* for consistency with ANSI C and ser_write() + *#* + *#* Revision 1.9 2004/08/15 05:32:22 bernie + *#* ser_resync(): New function. + *#* + *#* Revision 1.8 2004/08/02 20:20:29 aleph + *#* Merge from project_ks + *#* + *#* Revision 1.7 2004/07/30 14:15:53 rasky + *#* Nuovo supporto unificato per detect della CPU + *#* + *#* Revision 1.6 2004/07/29 22:57:09 bernie + *#* ser_drain(): New function; Make Serial::is_open a debug-only feature; Switch to new-style CONFIG_* macros. + *#* + *#* Revision 1.5 2004/07/18 21:54:23 bernie + *#* Add ATmega8 support. + *#* + *#* Revision 1.4 2004/06/03 11:27:09 bernie + *#* Add dual-license information. + *#* + *#* Revision 1.3 2004/06/02 21:35:24 aleph + *#* Serial enhancements: interruptible receive handler and 8 bit serial status for AVR; remove volatile attribute to FIFOBuffer, useless for new fifobuf routens + *#* + *#* Revision 1.2 2004/05/23 18:21:53 bernie + *#* Trim CVS logs and cleanup header info. + *#* + *#*/ #ifndef DRV_SER_H #define DRV_SER_H -#include "compiler.h" #include -#include "config.h" +#include +#include /* BV() */ +#include +#include -/*! - * \name Serial Error/status flags - * - * Some of these flags map directly to the flags - * in AVR UART Status Register(USR). - * \todo flags of DSP56k aren't mapped to these flags. Luckily - * these flags doesn't collide with the DSP56k ones, - * which are from 0x0100 to 0x8000 - */ +/** \name Serial Error/status flags. */ /*\{*/ -#if defined(__AVR__) +#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 */ +#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 */ + + /* + * 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 OS_HOSTED + typedef uint16_t serstatus_t; - /* Hardware errors */ - #define SERRF_RXSROVERRUN BV(3) /*!< Rx shift register overrun */ - #define SERRF_FRAMEERROR BV(4) /*!< Stop bit missing */ - #define SERRF_PARITYERROR BV(7) /*!< Parity error */ -#elif defined(__m56800__) /* 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_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_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 Parity settings for ser_setparity() */ -/*\{*/ +/** + * \name Masks to group TX/RX errors. + * \{ + */ +#define SERRF_RX \ + ( SERRF_RXFIFOOVERRUN \ + | SERRF_RXTIMEOUT \ + | SERRF_RXSROVERRUN \ + | SERRF_PARITYERROR \ + | SERRF_FRAMEERROR \ + | SERRF_NOISEERROR) +#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 * * \{ */ enum { - #if defined(__AVR_ATmega64__) +#if CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 SER_UART0, SER_UART1, SER_SPI, - - #elif defined(__AVR_ATmega103__) +#elif CPU_AVR_ATMEGA103 || CPU_AVR_ATMEGA8 SER_UART0, SER_SPI, - - #elif defined (__m56800__) +#elif CPU_DSP56K + // \todo since we now support "fake" multiplexed serials, this should be moved to hw.h + SER_UART0, + SER_PUNTALI, + SER_BARCODE, +#elif OS_HOSTED SER_UART0, SER_UART1, - - #else - #error unknown architecture - #endif - - SER_CNT /**< Number of serial ports */ +#else + #error unknown architecture +#endif + 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 FIFO transmit and receive buffers. + /** + * \name Transmit and receive FIFOs. * * Declared volatile because handled asinchronously by interrupts. * * \{ */ - volatile FIFOBuffer txfifo; - volatile FIFOBuffer rxfifo; - unsigned char txbuffer[CONFIG_SER_TXBUFSIZE]; - unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE]; + FIFOBuffer txfifo; + FIFOBuffer rxfifo; /* \} */ -#ifdef CONFIG_SER_RXTIMEOUT - time_t rxtimeout; +#if CONFIG_SER_RXTIMEOUT != -1 + ticks_t rxtimeout; #endif -#ifdef CONFIG_SER_TXTIMEOUT - time_t txtimeout; +#if CONFIG_SER_TXTIMEOUT != -1 + ticks_t txtimeout; #endif - /*! Holds the flags defined above. Will be 0 when no errors have occurred. */ - REGISTER uint16_t status; + /** 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 */ extern int ser_putchar(int c, struct Serial *port); extern int ser_getchar(struct Serial *port); extern int ser_getchar_nowait(struct Serial *port); + extern int ser_write(struct Serial *port, const void *buf, size_t len); -extern int ser_read(struct Serial *port, char *buf, size_t size); +extern int ser_read(struct Serial *port, void *buf, size_t size); + extern int ser_print(struct Serial *port, const char *s); +extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3); + extern int ser_gets(struct Serial *port, char *buf, int size); extern int ser_gets_echo(struct Serial *port, char *buf, int size, bool echo); -extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3); + extern void ser_setbaudrate(struct Serial *port, unsigned long rate); extern void ser_setparity(struct Serial *port, int parity); +extern void ser_settimeouts(struct Serial *port, mtime_t rxtimeout, mtime_t txtimeout); +extern void ser_resync(struct Serial *port, mtime_t delay); extern void ser_purge(struct Serial *port); +extern void ser_drain(struct Serial *port); + extern struct Serial *ser_open(unsigned int unit); extern void ser_close(struct Serial *port); -#if defined(CONFIG_SER_RXTIMEOUT) || defined(CONFIG_SER_TXTIMEOUT) - extern void ser_settimeouts(struct Serial *port, time_t rxtimeout, time_t txtimeout); -#endif -/*! +/** * \name Additional functions implemented as macros * * \{