diff options
Diffstat (limited to '')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/smp.h | 46 |
1 files changed, 24 insertions, 22 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/smp.h b/cpukit/rtems/include/rtems/rtems/smp.h index cf2ae8e30b..e62084ce86 100644 --- a/cpukit/rtems/include/rtems/rtems/smp.h +++ b/cpukit/rtems/include/rtems/rtems/smp.h @@ -1,19 +1,21 @@ /** * @file rtems/rtems/smp.h * - * This include file provides the application interface - * to SMP information and services. + * @defgroup ClassicSMP Classic API SMP Services * - * Most of the SMP interface is hidden from the application - * and exists between the BSP and RTEMS. + * @ingroup ClassicRTEMS + * @brief SMP information and services. + * + * Most of the SMP interface is hidden from the application + * and exists between the BSP and RTEMS. */ -/* COPYRIGHT (c) 1989-2011. - * On-Line Applications Research Corporation (OAR). +/* COPYRIGHT (c) 1989-2011. + * On-Line Applications Research Corporation (OAR). * - * The license and distribution terms for this file may be - * found in the file LICENSE in this distribution or at - * http://www.rtems.com/license/LICENSE. + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.com/license/LICENSE. */ #ifndef _RTEMS_RTEMS_SMP_H @@ -37,35 +39,35 @@ extern "C" { extern uint32_t rtems_configuration_smp_maximum_processors; /** - * @brief Obtain Number of Cores in System + * @brief Obtain Number of Cores in System * - * This method returns the number of CPU cores that are currently in - * the system. This will always be less than or equal to the number - * of maximum number of cores which were configured. + * This method returns the number of CPU cores that are currently in + * the system. This will always be less than or equal to the number + * of maximum number of cores which were configured. * - * @return This method returns the number of cores in this system. + * @retval This method returns the number of cores in this system. */ #define rtems_smp_get_number_of_processors() \ (_SMP_Processor_count) /** - * @brief Obtain Maximum Cores Configured + * @brief Obtain Maximum Cores Configured * - * This method returns the number of CPU cores that were configured - * in the system. The actual number of cores will always be less than - * or equal to the number of maximum number of cores which were configured. + * This method returns the number of CPU cores that were configured + * in the system. The actual number of cores will always be less than + * or equal to the number of maximum number of cores which were configured. * - * @return This method returns the number of cores configured. + * @retval This method returns the number of cores configured. */ #define rtems_configuration_get_smp_maximum_processors() \ (rtems_configuration_smp_maximum_processors) /** - * @brief Obtain Current Core Number + * @brief Obtain Current Core Number * - * This method returns the id of the current CPU core. + * This method returns the id of the current CPU core. * - * @return This method returns the id of the current CPU core. + * @retval This method returns the id of the current CPU core. */ #define rtems_smp_get_current_processor() \ bsp_smp_processor_id() |