summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/types.h
blob: 0fbf7003cae129e366f0551b28a217be93e96fe4 (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
/**
 * @file rtems/rtems/types.h
 *
 *  This include file defines the types used by the RTEMS API.
 */

/*  COPYRIGHT (c) 1989-2008.
 *  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.
 *
 *  $Id$
 */

#ifndef _RTEMS_RTEMS_TYPES_H
#define _RTEMS_RTEMS_TYPES_H

/**
 *  @defgroup ClassicTypes Classic API Types
 *
 *  This encapsulates functionality which XXX
 */
/**@{*/

/*
 *  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/tod.h>
#include <rtems/score/watchdog.h>
#include <rtems/rtems/modes.h>
#if defined(RTEMS_MULTIPROCESSING)
#include <rtems/score/mpci.h>
#include <rtems/score/mppkt.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

/** This type defines a single precision float. */
#ifdef RTEMS_DEPRECATED_TYPES
typedef single_precision rtems_single;

/** This type defines a double precision float. */
typedef double_precision rtems_double;

/** This type defines the RTEMS boolean type . */
typedef boolean          rtems_boolean;
#endif

/** This type defines is for Classic API object names. */
typedef uint32_t         rtems_name;

/**
 *  This type defines is for RTEMS object Id.  Although this
 *  type name is specific to the Classic API, the format of
 *  an object Id is the same across all APIs.
 */
typedef Objects_Id       rtems_id;

/**
 *  This defines a value that is an invalid object Id.
 */
#define RTEMS_ID_NONE OBJECTS_ID_NONE

/**
 * This type is the public name for task context area.
 */
typedef Context_Control            rtems_context;

#if (CPU_HARDWARE_FP == TRUE) || (CPU_SOFTWARE_FP == TRUE)
/**
 * This type is the public name for task floating point context area.
 */
typedef Context_Control_fp         rtems_context_fp;
#endif

/**
 * This type is the public name for the architecture specific
 * stack frame built as part of vectoring an interrupt.
 */
typedef CPU_Interrupt_frame        rtems_interrupt_frame;

/**
 *  This type defines the public name for the information
 *  structure returned by the Heap Handler via the Region
 *  Manager.
 */
typedef Heap_Information_block region_information_block;

/**
 *  This type defines the public name for the type that is
 *  used to manage intervals specified by clock ticks.
 */
typedef Watchdog_Interval rtems_interval;

/**
 *  This is the public type used to represent the CPU usage per thread.
 *
 *  @note When using nanosecond granularity timing, RTEMS may internally
 *        use a variety of represenations.
 */
#ifndef __RTEMS_USE_TICKS_CPU_USAGE_STATISTICS__
  typedef struct timespec rtems_thread_cpu_usage_t;
#else
  typedef uint32_t rtems_thread_cpu_usage_t;
#endif


/**
 *  The following record defines the time of control block.  This
 *  control block is used to maintain the current time of day.
 *
 *  @note This is an RTEID (a.k.a. Classic API) style time/date.
 */
typedef struct {
  /** This field is the year, A.D. */
  uint32_t   year;
  /** This field is the month, 1 -> 12 */
  uint32_t   month;
  /** This field is the day, 1 -> 31 */
  uint32_t   day;
  /** This field is the hour, 0 -> 23 */
  uint32_t   hour;
  /** This field is the minute, 0 -> 59 */
  uint32_t   minute;
  /** This field is the second, 0 -> 59 */
  uint32_t   second;
  /** This field is the elapsed ticks between secs */
  uint32_t   ticks;
}   rtems_time_of_day;

/**
 *  This defines the public name for an RTEMS API task mode type.
 */
typedef Modes_Control rtems_mode;

/*
 *  MPCI related entries
 */
#if defined(RTEMS_MULTIPROCESSING)
/**
 * This defines the public name for the set of MPCI packet
 * classes which are internally dispatched to the managers.
 */
typedef MP_packet_Classes          rtems_mp_packet_classes;

/**
 * This defines the public name for the common prefix
 * found at the beginning of each MPCI packet sent between
 * nodes. This can be thought of as an envelope.
 */
typedef MP_packet_Prefix           rtems_packet_prefix;

/**
 * This defines the public name for the type for an indirect pointer
 * to the initialization entry point for an MPCI handler.
 */
typedef MPCI_initialization_entry  rtems_mpci_initialization_entry;

/**
 * This defines the public name for the type for an indirect pointer
 * to the get_packet entry point for an MPCI handler.
 */
typedef MPCI_get_packet_entry      rtems_mpci_get_packet_entry;

/**
 * This defines the public name for the type for an indirect pointer
 * to the return_packet entry point for an MPCI handler.
 */
typedef MPCI_return_packet_entry   rtems_mpci_return_packet_entry;

/**
 * This defines the public name for the type for an indirect pointer
 * to the send_packet entry point for an MPCI handler.
 */
typedef MPCI_send_entry            rtems_mpci_send_packet_entry;

/**
 * This defines the public name for the type for an indirect pointer
 * to the receive entry point for an MPCI handler.
 */
typedef MPCI_receive_entry         rtems_mpci_receive_packet_entry;

/**
 * This defines the public name for the return type from every
 * MPCI handler routine.
 */
typedef MPCI_Entry                 rtems_mpci_entry;

/**
 * This defines the public name for the structure which is used to
 * configure an MPCI handler.
 */
typedef MPCI_Control               rtems_mpci_table;

#endif

#ifdef __cplusplus
}
#endif

/**@}*/

#endif
/* end of include file */