X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fser.h;h=c0f7b8bb036007d9b441129bedbb713c30b04b9d;hb=2535cb94ec2183791128f8bbd109ca69a960cf78;hp=57d66cb0b4aa5556fe699ef8205c8061d8e47fe4;hpb=c845bc596b30994d98543ed1137182a3e13048dd;p=bertos.git diff --git a/drv/ser.h b/drv/ser.h old mode 100755 new mode 100644 index 57d66cb0..c0f7b8bb --- a/drv/ser.h +++ b/drv/ser.h @@ -1,9 +1,34 @@ -/*! +/** * \file * * * \brief High level serial I/O API @@ -12,120 +37,98 @@ * \author Bernardo Innocenti */ -/* - * $Log$ - * 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 #include -#include -#include -#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 - */ -/*\{*/ -#if defined(__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 */ +#if OS_HOSTED + #include /* BV() */ - /* 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__) 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_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. */ + + enum + { + SER_UART0, + SER_UART1, + + SER_CNT /**< Number of serial ports */ + }; + #else - #error unknown architecture + #include CPU_HEADER(ser) #endif + +#include + + + +/** + * \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 Parity settings for ser_setparity() */ -/*\{*/ -#define SER_PARITY_NONE 0 -#define SER_PARITY_EVEN 2 -#define SER_PARITY_ODD 3 +/** + * \name LSB or MSB first data order for SPI driver. + * \{ + */ +#define SER_MSB_FIRST 0 +#define SER_LSB_FIRST 1 /*\}*/ -/*! - * \name Serial hw numbers +/** + * \name Parity settings for ser_setparity(). * + * \note Values are AVR-specific for performance reasons. + * Other processors should either decode them or + * redefine these macros. * \{ */ -enum -{ -#if defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) - SER_UART0, - SER_UART1, - SER_SPI, -#elif defined(__AVR_ATmega103__) || defined(__AVR_ATmega8__) - SER_UART0, - SER_SPI, -#elif defined (__m56800__) - SER_UART0, - SER_UART1, -#else - #error unknown architecture -#endif - - SER_CNT /**< Number of serial ports */ -}; -/* @} */ +#define SER_PARITY_NONE 0 +#define SER_PARITY_EVEN 2 +#define SER_PARITY_ODD 3 +/*\}*/ 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; - DB(bool is_open;) +#ifdef _DEBUG + bool is_open; +#endif - /*! - * \name FIFO transmit and receive buffers. + /** + * \name Transmit and receive FIFOs. * * Declared volatile because handled asinchronously by interrupts. * @@ -133,49 +136,57 @@ struct Serial */ FIFOBuffer txfifo; FIFOBuffer rxfifo; - unsigned char txbuffer[CONFIG_SER_TXBUFSIZE]; - unsigned char rxbuffer[CONFIG_SER_RXBUFSIZE]; /* \} */ #if CONFIG_SER_RXTIMEOUT != -1 - time_t rxtimeout; + ticks_t rxtimeout; #endif #if CONFIG_SER_TXTIMEOUT != -1 - time_t txtimeout; + ticks_t txtimeout; #endif - /*! Holds the flags defined above. Will be 0 when no errors have occurred. */ - serstatus_t status; + /** Holds the flags defined above. Will be 0 when no errors have occurred. */ + volatile serstatus_t status; - /*! Low-level interface to hardware. */ + /** Low-level interface to hardware. */ struct SerialHardware* hw; -}; +} Serial; +typedef struct KFileSerial +{ + KFile fd; + Serial *ser; +} KFileSerial; -/* 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); +/** + * ID for serial. + */ +#define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L') -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_print(struct Serial *port, const char *s); -extern int ser_printf(struct Serial *port, const char *format, ...) FORMAT(__printf__, 2, 3); +INLINE KFileSerial * KFILESERIAL(KFile *fd) +{ + ASSERT(fd->_type == KFT_SERIAL); + return (KFileSerial *)fd; +} + +/* Function prototypes */ +//extern int ser_getchar_nowait(struct Serial *port); -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); +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); -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, time_t rxtimeout, time_t txtimeout); -extern void ser_purge(struct Serial *port); -extern void ser_drain(struct Serial *port); +void ser_purgeRx(struct KFileSerial *fd); +void ser_purgeTx(struct KFileSerial *fd); +void ser_purge(struct KFileSerial *fd); +void ser_init(struct KFileSerial *fds, unsigned int unit); +void spimaster_init(KFileSerial *fds, unsigned int unit); -extern struct Serial *ser_open(unsigned int unit); -extern void ser_close(struct Serial *port); -/*! +/** * \name Additional functions implemented as macros * * \{