X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fser.h;h=a41084a75e1be9ae937eae7e81c95a7d94fe943c;hb=f236c8017e2e0398805eedfa05d4b26e7c707a8e;hp=ad643e356c2443418dcf4de1e73c38e0db18d6e3;hpb=0375780817109b6ab5cd4f36ccf80650b2fe77d5;p=bertos.git diff --git a/drv/ser.h b/drv/ser.h index ad643e35..a41084a7 100755 --- a/drv/ser.h +++ b/drv/ser.h @@ -1,9 +1,9 @@ /*! * \file * * * \brief High level serial I/O API @@ -12,44 +12,51 @@ * \author Bernardo Innocenti */ -/* - * $Log$ - * Revision 1.1 2004/05/23 18:10:11 bernie - * Import drv/ modules. - * - * Revision 1.2 2004/04/21 17:38:24 rasky - * New application - * - * Revision 1.16 2004/04/03 18:30:49 aleph - * Move timeout defines in config, private define in .c - * - * Revision 1.15 2004/03/29 17:01:02 aleph - * Add function to set serial parity, fix it when ser_open is used - * - * Revision 1.14 2004/03/29 16:19:33 aleph - * Add ser_cleanup function; Various code improvements - * - * Revision 1.13 2004/03/24 15:22:27 aleph - * Removed subdirs -I, fix header inclusion, move config.h in board_kf, kctrl - * - * Revision 1.12 2004/03/17 17:30:30 bernie - * Add GCC format checks to printf()-like functions. - * - * Revision 1.11 2004/03/16 23:06:42 aleph - * Doc fix - * - * Revision 1.10 2004/03/12 18:46:53 bernie - * ser_read(): New function. - * - * Revision 1.9 2004/03/11 18:11:51 bernie - * Cosmetic fixes - */ -#ifndef SER_H -#define SER_H +/*#* + *#* $Log$ + *#* 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 /*! * \name Serial Error/status flags @@ -61,7 +68,9 @@ * which are from 0x0100 to 0x8000 */ /*\{*/ -#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 */ @@ -71,7 +80,9 @@ #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__) +#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 */ @@ -101,26 +112,22 @@ */ enum { - #if defined(__AVR_ATmega64__) +#if defined(CPU_AVR_ATMEGA64) || defined(CPU_AVR_ATMEGA128) SER_UART0, SER_UART1, SER_SPI, - - #elif defined(__AVR_ATmega103__) +#elif defined(CPU_AVR_ATMEGA103) || defined(CPU_AVR_ATMEGA8) SER_UART0, SER_SPI, - - #elif defined (__m56800__) +#elif CPU_DSP56K SER_UART0, - SER_UART1, - - #else - #error unknown architecture - #endif - - SER_CNT /**< Number of serial ports */ + SER_UART1, +#else + #error unknown architecture +#endif + SER_CNT /*!< Number of serial ports */ }; -/* @} */ +/*\}*/ struct SerialHardware; @@ -134,34 +141,33 @@ struct Serial /*! 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 +#if CONFIG_SER_RXTIMEOUT != -1 time_t rxtimeout; #endif -#ifdef CONFIG_SER_TXTIMEOUT +#if CONFIG_SER_TXTIMEOUT != -1 time_t txtimeout; #endif /*! Holds the flags defined above. Will be 0 when no errors have occurred. */ - REGISTER uint16_t status; - + serstatus_t status; + /*! Low-level interface to hardware. */ struct SerialHardware* hw; - }; @@ -169,28 +175,33 @@ struct Serial 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, time_t rxtimeout, time_t txtimeout); +extern void ser_resync(struct Serial *port, time_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 +/*! + * \name Additional functions implemented as macros * - * @{ + * \{ */ #define ser_getstatus(h) ((h)->status) #define ser_setstatus(h, x) ((h)->status = (x)) -/* @} */ +/* \} */ -#endif /* SER_H */ +#endif /* DRV_SER_H */