-/*!
+/**
* \file
* <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction. Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License. This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
* Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
* Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
* -->
/*#*
*#* $Log$
+ *#* Revision 1.2 2006/07/19 12:56:26 bernie
+ *#* Convert to new Doxygen style.
+ *#*
*#* Revision 1.1 2005/04/12 01:37:50 bernie
*#* Import into DevLib.
*#*
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 */
- #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_RXSROVERRUN BV(3) /**< Rx shift register overrun */
+ #define SERRF_FRAMEERROR BV(4) /**< Stop bit missing */
+ #define SERRF_PARITYERROR BV(7) /**< Parity error */
#else
#error unknown architecture
#endif
/*\}*/
-/*!
+/**
* \name Serial hw numbers
*
* \{
#else
#error unknown architecture
#endif
- SER_CNT /*!< Number of serial ports */
+ SER_CNT /**< Number of serial ports */
};
/*\}*/
#endif
-/*! \name Parity settings for ser_setparity() */
+/** \name Parity settings for ser_setparity() */
/*\{*/
#define SER_PARITY_NONE 0
#define SER_PARITY_EVEN 2
/*\}*/
-/*! Serial handle structure */
+/** Serial handle structure */
struct Serial;
/* Function prototypes */
extern struct Serial *_ser_open(void);
extern void _ser_close(void);
-/*!
+/**
* \name Functions implemented as macros
*
* \{