source: rtems/cpukit/rtems/include/rtems.h @ 57c676c6

Last change on this file since 57c676c6 was 8054b1c, checked in by Sebastian Huber <sebastian.huber@…>, on Nov 26, 2015 at 1:08:56 PM

Remove <rtems/debug.h>

Close #2477.

  • Property mode set to 100644
File size: 5.5 KB
Line 
1/**
2 * @file
3 *
4 * @defgroup ClassicRTEMS RTEMS Classic API
5 *
6 * @brief RTEMS Classic API
7 *
8 * the Public Interface to the RTEMS Classic API
9 */
10
11/* COPYRIGHT (c) 1989-2008.
12 * On-Line Applications Research Corporation (OAR).
13 *
14 * The license and distribution terms for this file may be
15 * found in the file LICENSE in this distribution or at
16 * http://www.rtems.org/license/LICENSE.
17 */
18
19#ifndef _RTEMS_H
20#define _RTEMS_H
21
22/**
23 * @defgroup ClassicRTEMS RTEMS Classic API
24 *
25 * RTEMS Classic API definitions and modules.
26 */
27/**@{*/
28
29#include <rtems/system.h>
30#include <rtems/rtems/status.h>
31#include <rtems/rtems/types.h>
32
33#include <rtems/config.h>
34#include <rtems/init.h>
35#include <rtems/rtems/options.h>
36#include <rtems/rtems/tasks.h>
37#include <rtems/rtems/intr.h>
38#include <rtems/rtems/barrier.h>
39#include <rtems/rtems/cache.h>
40#include <rtems/rtems/clock.h>
41#include <rtems/extension.h>
42#include <rtems/rtems/timer.h>
43#include <rtems/rtems/sem.h>
44#include <rtems/rtems/message.h>
45#include <rtems/rtems/event.h>
46#include <rtems/rtems/signal.h>
47#include <rtems/rtems/event.h>
48#include <rtems/rtems/object.h>
49#include <rtems/rtems/part.h>
50#include <rtems/rtems/region.h>
51#include <rtems/rtems/dpmem.h>
52#include <rtems/io.h>
53#include <rtems/fatal.h>
54#include <rtems/rtems/ratemon.h>
55#if defined(RTEMS_MULTIPROCESSING)
56#include <rtems/rtems/mp.h>
57#endif
58#include <rtems/rtems/smp.h>
59
60#include <rtems/rtems/support.h>
61
62#ifdef __cplusplus
63extern "C" {
64#endif
65
66/**
67 * @brief Returns the pointer to the RTEMS version string.
68 */
69const char *rtems_get_version_string(void);
70
71/**
72 * @brief Indicates whether this processor variant has hardware floating point
73 * support.
74 */
75#define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP
76
77/**********************************************************************
78 *      CONSTANTS WHICH MAY BE USED IN OBJECT NAME TO ID SEARCHES
79 **********************************************************************/
80
81/**
82 * @brief Indicates that a search is across all nodes.
83 */
84#define RTEMS_SEARCH_ALL_NODES   OBJECTS_SEARCH_ALL_NODES
85
86/**
87 * @brief Indicates that a search is across all nodes except the one the call
88 * is made from.
89 */
90#define RTEMS_SEARCH_OTHER_NODES OBJECTS_SEARCH_OTHER_NODES
91
92/**
93 * @brief Indicates that the search is to be restricted to the local node.
94 */
95#define RTEMS_SEARCH_LOCAL_NODE  OBJECTS_SEARCH_LOCAL_NODE
96
97/**
98 * @brief Indicates that the caller wants to obtain the name of the currently
99 * executing thread.
100 *
101 * This constant is only meaningful when obtaining the name of a task.
102 */
103#define RTEMS_WHO_AM_I           OBJECTS_WHO_AM_I
104
105/**********************************************************************
106 *        Parameters and return Id's for _Objects_Get_next
107 **********************************************************************/
108
109/**
110 * @brief Lowest valid index value for the index portion of an object
111 * identifier.
112 */
113#define RTEMS_OBJECT_ID_INITIAL_INDEX        OBJECTS_ID_INITIAL_INDEX
114
115/**
116 * @brief Maximum valid index value for the index portion of an object
117 * identifier.
118 */
119#define RTEMS_OBJECT_ID_FINAL_INDEX          OBJECTS_ID_FINAL_INDEX
120
121/**
122 * @brief Returns the identifier of the object with the lowest valid index
123 * value.
124 *
125 * The object is specified by the API @a _api, the object class @a _class and
126 * the node @a _node where the object resides.
127 */
128#define RTEMS_OBJECT_ID_INITIAL(_api, _class, _node) \
129   OBJECTS_ID_INITIAL(_api, _class, _node)
130
131/**
132 * @brief Maximum valid object identifier.
133 */
134#define RTEMS_OBJECT_ID_FINAL                OBJECTS_ID_FINAL
135
136/**
137 * @brief Minimum stack size which every thread must exceed.
138 *
139 * It is the minimum stack size recommended for use on this processor. This
140 * value is selected by the RTEMS developers conservatively to minimize the
141 * risk of blown stacks for most user applications. Using this constant when
142 * specifying the task stack size, indicates that the stack size will be at
143 * least RTEMS_MINIMUM_STACK_SIZE bytes in size. If the user configured minimum
144 * stack size is larger than the recommended minimum, then it will be used.
145 */
146#define RTEMS_MINIMUM_STACK_SIZE  STACK_MINIMUM_SIZE
147
148/**
149 * @brief Specifies that the task should be created with the configured minimum
150 * stack size.
151 *
152 * Using this constant when specifying the task stack size indicates that this
153 * task is to be created with a stack size of the minimum stack size that was
154 * configured by the application. If not explicitly configured by the
155 * application, the default configured minimum stack size is the processor
156 * dependent value RTEMS_MINIMUM_STACK_SIZE. Since this uses the configured
157 * minimum stack size value, you may get a stack size that is smaller or larger
158 * than the recommended minimum. This can be used to provide large stacks for
159 * all tasks on complex applications or small stacks on applications that are
160 * trying to conserve memory.
161 */
162#define RTEMS_CONFIGURED_MINIMUM_STACK_SIZE  0
163
164/**
165 * @brief Constant for indefinite wait.
166 *
167 * This is actually an illegal interval value.
168 */
169#define RTEMS_NO_TIMEOUT  WATCHDOG_NO_TIMEOUT
170
171/**
172 * @brief An MPCI must support packets of at least this size.
173 */
174#define RTEMS_MINIMUM_PACKET_SIZE  MP_PACKET_MINIMUM_PACKET_SIZE
175
176/**
177 * @brief Defines the count of @c uint32_t numbers in a packet which must be
178 * converted to native format in a heterogeneous system.
179 *
180 * In packets longer than this value, some of the extra data may be a user
181 * message buffer which is not automatically endian swapped.
182 */
183#define RTEMS_MINIMUN_HETERO_CONVERSION  MP_PACKET_MINIMUN_HETERO_CONVERSION
184
185#ifdef __cplusplus
186}
187#endif
188
189/**@}*/
190
191#endif
192/* end of include file */
Note: See TracBrowser for help on using the repository browser.