summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/smp.h
blob: 046c30629029a5294609195e1fa63056a59965f4 (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
/**
 * @file
 *
 * @ingroup ClassicSMP
 *
 * @brief SMP Services API
 */

/*
 * 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.org/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_SMP_H
#define _RTEMS_RTEMS_SMP_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

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

/**
 * @brief Returns the count of processors in the system.
 *
 * On uni-processor configurations a value of one will be returned.
 *
 * On SMP configurations this returns the value of a global variable set during
 * system initialization to indicate the count of utilized processors.  The
 * processor count depends on the physically or virtually available processors
 * and application configuration.  The value will always be less than or equal
 * to the maximum count of application configured processors.
 *
 * @return The count of processors being utilized.
 */
uint32_t rtems_get_processor_count(void);

/** @} */

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */