source/cpukit/doxygen.h

0001 /**
0002  * @file
0003  *
0004  * @ingroup RTEMSImplDoxygen
0005  *
0006  * @brief This header file defines some Doxygen groups.
0007  */
0008
0009 /**
0010  * @defgroup RTEMSAPIIO IO
0011  *
0012  * @ingroup RTEMSAPI
0013  *
0014  * @brief IO
0015  */
0016
0017 /**
0018  * @defgroup RTEMSAPIPrintSupport Print Support
0019  *
0020  * @ingroup RTEMSAPIIO
0021  *
0022  * @brief Print Support
0023  */
0024
0025 /**
0026  * @defgroup RTEMSAPITracing Tracing
0027  *
0028  * @ingroup RTEMSAPI
0029  *
0030  * @brief Tracing
0031  */
0032
0033 /**
0034  * @defgroup RTEMSLegacyBenchmarkDrivers Legacy Benchmark Drivers
0035  *
0036  * @ingroup RTEMSDeviceDrivers
0037  *
0038  * @brief Legacy Benchmark Drivers
0039  */
0040
0041 /**
0042  * @defgroup RTEMSTimeTest27Support Time Test 27 Support
0043  *
0044  * @ingroup RTEMSDeviceDrivers
0045  *
0046  * @brief The Time Test 27 (TM27) support is used to measure the timing of
0047  *   the interrupt processing.
0048  *
0049  * The TMS27 support should provide two software generated interrupt requests,
0050  * one low priority request raised by Cause_tm27_intr() and one higher priority
0051  * request raised by Lower_tm27_intr().  Both requests should be cleared by
0052  * Clear_tm27_intr().  A handler provided by the test should be installed
0053  * through Install_tm27_vector().  This function should initialize the system
0054  * so that the software generated interrupt requests can be raised and cleared.
0055  *
0056  * If the raise functions Cause_tm27_intr() and Lower_tm27_intr() do not
0057  * trigger the interrupt immediately, then the TM27 support shall define
0058  * MUST_WAIT_FOR_INTERRUPT to one, otherwise MUST_WAIT_FOR_INTERRUPT shall be
0059  * defined to zero.
0060  *
0061  * The TM27 support may define TM27_INTERRUPT_VECTOR_DEFAULT to indicate the
0062  * interrupt vector of the interrupt request raised by Cause_tm27_intr().
0063  *
0064  * The TM27 support may define TM27_INTERRUPT_VECTOR_ALTERNATIVE to provide an
0065  * alternative software generated interrupt request which is raised by
0066  * _TM27_Raise_alternative() and cleared by _TM27_Clear_alternative().  Both
0067  * functions shall return an RTEMS status code.  This interrupt vector may be
0068  * used to test the interrupt controller support on targets which do not
0069  * provide generic software generated interrupts.
0070  */
0071
0072 /**
0073  * @defgroup libmisc_mouse Serial Mouse
0074  *
0075  * @ingroup RTEMSDeviceDrivers
0076  *
0077  * @brief Serial Mouse
0078  */
0079