summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/smp.h
blob: e62084ce866e2dbdc91ee81c95a16c8f8ab62db1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
 * @file rtems/rtems/smp.h
 *
 * @defgroup ClassicSMP Classic API SMP Services
 *
 * @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).
 *
 * 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
#define _RTEMS_RTEMS_SMP_H

#ifdef __cplusplus
extern "C" {
#endif

#include <rtems/score/smp.h>

/**
 *  @defgroup ClassicSMP Classic API SMP Services
 *
 *  @ingroup ClassicRTEMS
 *
 *  This encapsulates functionality which is useful for SMP applications.
 */
/**@{*/

extern uint32_t rtems_configuration_smp_maximum_processors;

/**
 * @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.
 *
 * @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
 *
 * 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.
 *
 * @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
 *
 * 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()

/**@}*/

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */