summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/types.h
blob: ae121e06f45019c3afae133e2afe6c97ccb97e0e (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/**
 * @file
 *
 * @defgroup ClassicTypes Types
 *
 * @ingroup ClassicRTEMS
 * @brief Types used by Classic API.
 */

/* COPYRIGHT (c) 1989-2009.
 * 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_TYPES_H
#define _RTEMS_RTEMS_TYPES_H

/*
 *  RTEMS basic type definitions
 */

#include <stdint.h>
#include <rtems/score/heap.h>
#include <rtems/score/object.h>
#include <rtems/score/priority.h>
#include <rtems/score/watchdog.h>
#include <rtems/rtems/modes.h>
#if defined(RTEMS_MULTIPROCESSING)
#include <rtems/score/mpci.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup ClassicRTEMS
 */
/**@{**/

#ifdef RTEMS_DEPRECATED_TYPES
/**
 * @brief Single precision float type.
 *
 * @deprecated Use @c float instead.
 */
typedef single_precision rtems_single;

/**
 * @brief Double precision float type.
 *
 * @deprecated Use @c double instead.
 */
typedef double_precision rtems_double;

/**
 * @brief RTEMS boolean type.
 *
 * @deprecated Use @c bool instead
 */
typedef boolean          rtems_boolean;
#endif

/**
 * @brief Classic API @ref ClassicRTEMSSubSecObjectNames "object name" type.
 *
 * Contains the name of a Classic API object. It is an unsigned 32-bit integer
 * which can be treated as a numeric value or initialized using
 * rtems_build_name() to contain four ASCII characters.
 */
typedef uint32_t         rtems_name;

/**
 * @brief Used to manage and manipulate
 * @ref ClassicRTEMSSubSecObjectIdentifiers "RTEMS object identifiers".
 */
typedef Objects_Id       rtems_id;

/**
 * @brief Invalid object identifier value.
 *
 * No object can have this identifier value.
 */
#define RTEMS_ID_NONE OBJECTS_ID_NONE

/**
 * @brief Public name for task context area.
 */
typedef Context_Control            rtems_context;

#if (CPU_HARDWARE_FP == TRUE) || (CPU_SOFTWARE_FP == TRUE)
/**
 * @brief Public name for task floating point context area.
 */
typedef Context_Control_fp         rtems_context_fp;
#endif

/**
 * @brief Defines the format of the interrupt stack frame as it appears to a
 * user ISR.
 *
 * This data structure may not be defined on all ports
 */
typedef CPU_Interrupt_frame        rtems_interrupt_frame;

/**
 * @brief Information structure returned by the Heap Handler via the Region
 * Manager.
 */
typedef Heap_Information_block region_information_block;

/**
 * @brief Used to manage and manipulate intervals specified by
 * @ref ClassicRTEMSSecTime "clock ticks".
 */
typedef Watchdog_Interval rtems_interval;

/**
 * @brief Represents the CPU usage per thread.
 *
 * When using nanoseconds granularity timing, RTEMS may internally use a
 * variety of representations.
 */
#ifndef __RTEMS_USE_TICKS_FOR_STATISTICS__
  typedef struct timespec rtems_thread_cpu_usage_t;
#else
  typedef uint32_t rtems_thread_cpu_usage_t;
#endif

/**
 * @brief Data structure to manage and manipulate calendar
 * @ref ClassicRTEMSSecTime "time".
 */
typedef struct {
  /**
   * @brief Year, A.D.
   */
  uint32_t   year;
  /**
   * @brief Month, 1 .. 12.
   */
  uint32_t   month;
  /**
   * @brief Day, 1 .. 31.
   */
  uint32_t   day;
  /**
   * @brief Hour, 0 .. 23.
   */
  uint32_t   hour;
  /**
   * @brief Minute, 0 .. 59.
   */
  uint32_t   minute;
  /**
   * @brief Second, 0 .. 59.
   */
  uint32_t   second;
  /**
   * @brief Elapsed ticks between seconds.
   */
  uint32_t   ticks;
}   rtems_time_of_day;

/**
 * @brief Task mode type.
 */
typedef Modes_Control rtems_mode;

/*
 *  MPCI related entries
 */
#if defined(RTEMS_MULTIPROCESSING)
/**
 * @brief Set of MPCI packet classes which are internally dispatched to the
 * managers.
 */
typedef MP_packet_Classes          rtems_mp_packet_classes;

/**
 * @brief Prefix found at the beginning of each MPCI packet sent between nodes.
 */
typedef MP_packet_Prefix           rtems_packet_prefix;

/**
 * @brief Indirect pointer to the initialization entry point for an MPCI
 * handler.
 */
typedef MPCI_initialization_entry  rtems_mpci_initialization_entry;

/**
 * @brief Indirect pointer to the get_packet entry point for an MPCI handler.
 */
typedef MPCI_get_packet_entry      rtems_mpci_get_packet_entry;

/**
 * @brief Indirect pointer to the return_packet entry point for an MPCI
 * handler.
 */
typedef MPCI_return_packet_entry   rtems_mpci_return_packet_entry;

/**
 * @brief Indirect pointer to the send_packet entry point for an MPCI handler.
 */
typedef MPCI_send_entry            rtems_mpci_send_packet_entry;

/**
 * @brief Indirect pointer to the receive entry point for an MPCI handler.
 */
typedef MPCI_receive_entry         rtems_mpci_receive_packet_entry;

/**
 * @brief Return type from every MPCI handler routine.
 */
typedef MPCI_Entry                 rtems_mpci_entry;

/**
 * @brief Structure which is used to configure an MPCI handler.
 */
typedef MPCI_Control               rtems_mpci_table;

#endif

/** @} */

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */