summaryrefslogtreecommitdiffstats
path: root/ada_user/rtems_data_types.rst
blob: 121c820757827a32b17980ca66c1a026a79f42c0 (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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
RTEMS Data Types
################

Introduction
============

This chapter contains a complete list of the RTEMS primitive
data types in alphabetical order.  This is intended to be
an overview and the user is encouraged to look at the appropriate
chapters in the manual for more information about the
usage of the various data types.

List of Data Types
==================

The following is a complete list of the RTEMS primitive
data types in alphabetical order:

- .. index:: rtems_address

  ``rtems.address`` is the data type used to manage
  addresses.  It is equivalent to
  the System.Address data type.

- .. index:: rtems_asr

  ``rtems.asr`` is the return type for an
  RTEMS ASR.

- .. index:: rtems_asr_entry

  ``rtems.asr_entry`` is the address of
  the entry point to an RTEMS ASR.

- .. index:: rtems_attribute

  ``rtems.attribute`` is the data type used
  to manage the attributes for RTEMS objects.  It is primarily
  used as an argument to object create routines to specify
  characteristics of the new object.

- .. index:: rtems_boolean

  ``rtems.boolean`` may only take on the
  values of ``TRUE`` and ``FALSE``.
  This type is deprecated. Use "bool" instead.

- .. index:: rtems_context

  ``rtems.context`` is the CPU dependent
  data structure used to manage the integer and system
  register portion of each task’s context.

- .. index:: rtems_context_fp

  ``rtems.context_fp`` is the CPU dependent
  data structure used to manage the floating point portion of
  each task’s context.

- .. index:: rtems_device_driver

  ``rtems.device_driver`` is the
  return type for a RTEMS device driver routine.

- .. index:: rtems_device_driver_entry

  ``rtems.device_driver_entry`` is the
  entry point to a RTEMS device driver routine.

- .. index:: rtems_device_major_number

  ``rtems.device_major_number`` is the
  data type used to manage device major numbers.

- .. index:: rtems_device_minor_number

  ``rtems.device_minor_number`` is the
  data type used to manage device minor numbers.

- .. index:: rtems_double

  ``rtems.double`` is the RTEMS data
  type that corresponds to double precision floating point
  on the target hardware.
  This type is deprecated. Use "double" instead.

- .. index:: rtems_event_set

  ``rtems.event_set`` is the data
  type used to manage and manipulate RTEMS event sets
  with the Event Manager.

- .. index:: rtems_extension

  ``rtems.extension`` is the return type
  for RTEMS user extension routines.

- .. index:: rtems_fatal_extension

  ``rtems.fatal_extension`` is the
  entry point for a fatal error user extension handler routine.

- .. index:: rtems_id

  ``rtems.id`` is the data type used
  to manage and manipulate RTEMS object IDs.

- .. index:: rtems_interrupt_frame

  ``rtems.interrupt_frame`` is the
  data structure that 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.

- .. index:: rtems_interrupt_level

  ``rtems.interrupt_level`` is the
  data structure used with the ``rtems.interrupt_disable``,``rtems.interrupt_enable``, and``rtems.interrupt_flash`` routines.  This
  data type is CPU dependent and usually corresponds to
  the contents of the processor register containing
  the interrupt mask level.

- .. index:: rtems_interval

  ``rtems.interval`` is the data
  type used to manage and manipulate time intervals.
  Intervals are non-negative integers used to measure
  the length of time in clock ticks.

- .. index:: rtems_isr

  ``rtems.isr`` is the return type
  of a function implementing an RTEMS ISR.

- .. index:: rtems_isr_entry

  ``rtems.isr_entry`` is the address of
  the entry point to an RTEMS ISR.  It is equivalent to the
  entry point of the function implementing the ISR.

- .. index:: rtems_mp_packet_classes

  ``rtems.mp_packet_classes`` is the
  enumerated type which specifies the categories of
  multiprocessing messages.  For example, one of the
  classes is for messages that must be processed by
  the Task Manager.

- .. index:: rtems_mode

  ``rtems.mode`` is the data type
  used to manage and dynamically manipulate the execution
  mode of an RTEMS task.

- .. index:: rtems_mpci_entry

  ``rtems.mpci_entry`` is the return type
  of an RTEMS MPCI routine.

- .. index:: rtems_mpci_get_packet_entry

  ``rtems.mpci_get_packet_entry`` is the address of
  the entry point to the get packet routine for an MPCI implementation.

- .. index:: rtems_mpci_initialization_entry

  ``rtems.mpci_initialization_entry`` is the address of
  the entry point to the initialization routine for an MPCI implementation.

- .. index:: rtems_mpci_receive_packet_entry

  ``rtems.mpci_receive_packet_entry`` is the address of
  the entry point to the receive packet routine for an MPCI implementation.

- .. index:: rtems_mpci_return_packet_entry

  ``rtems.mpci_return_packet_entry`` is the address of
  the entry point to the return packet routine for an MPCI implementation.

- .. index:: rtems_mpci_send_packet_entry

  ``rtems.mpci_send_packet_entry`` is the address of
  the entry point to the send packet routine for an MPCI implementation.

- .. index:: rtems_mpci_table

  ``rtems.mpci_table`` is the data structure
  containing the configuration information for an MPCI.

- .. index:: rtems_name

  ``rtems.name`` is the data type used to
  contain the name of a Classic API object.  It is an unsigned
  thirty-two bit integer which can be treated as a numeric
  value or initialized using ``rtems.build_name`` to
  contain four ASCII characters.

- .. index:: rtems_option

  ``rtems.option`` is the data type
  used to specify which behavioral options the caller desires.
  It is commonly used with potentially blocking directives to specify
  whether the caller is willing to block or return immediately with an error
  indicating that the resource was not available.

- .. index:: rtems_packet_prefix

  ``rtems.packet_prefix`` is the data structure
  that defines the first bytes in every packet sent between nodes
  in an RTEMS multiprocessor system.  It contains routing information
  that is expected to be used by the MPCI layer.

- .. index:: rtems_signal_set

  ``rtems.signal_set`` is the data
  type used to manage and manipulate RTEMS signal sets
  with the Signal Manager.

- .. index:: int8_t

  ``int8_t`` is the C99 data type that corresponds to signed eight
  bit integers.  This data type is defined by RTEMS in a manner that
  ensures it is portable across different target processors.

- .. index:: int16_t

  ``int16_t`` is the C99 data type that corresponds to signed
  sixteen bit integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

- .. index:: int32_t

  ``int32_t`` is the C99 data type that corresponds to signed
  thirty-two bit integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

- .. index:: int64_t

  ``int64_t`` is the C99 data type that corresponds to signed
  sixty-four bit integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

- .. index:: rtems_single

  ``rtems.single`` is the RTEMS data
  type that corresponds to single precision floating point
  on the target hardware.
  This type is deprecated. Use "float" instead.

- .. index:: rtems_status_codes

  ``rtems.status_codes`` is the return type for most
  RTEMS services.  This is an enumerated type of approximately twenty-five
  values.  In general, when a service returns a particular status code, it
  indicates that a very specific error condition has occurred.

- .. index:: rtems_task

  ``rtems.task`` is the return type for an
  RTEMS Task.

- .. index:: rtems_task_argument

  ``rtems.task_argument`` is the data
  type for the argument passed to each RTEMS task. In RTEMS 4.7
  and older, this is an unsigned thirty-two bit integer.  In
  RTEMS 4.8 and newer, this is based upon the C99 type ``uintptr_t``
  which is guaranteed to be an integer large enough to hold a
  pointer on the target architecture.

- .. index:: rtems_task_begin_extension

  ``rtems.task_begin_extension`` is the
  entry point for a task beginning execution user extension handler routine.

- .. index:: rtems_task_create_extension

  ``rtems.task_create_extension`` is the
  entry point for a task creation execution user extension handler routine.

- .. index:: rtems_task_delete_extension

  ``rtems.task_delete_extension`` is the
  entry point for a task deletion user extension handler routine.

- .. index:: rtems_task_entry

  ``rtems.task_entry`` is the address of
  the entry point to an RTEMS ASR.  It is equivalent to the
  entry point of the function implementing the ASR.

- .. index:: rtems_task_exitted_extension

  ``rtems.task_exitted_extension`` is the
  entry point for a task exitted user extension handler routine.

- .. index:: rtems_task_priority

  ``rtems.task_priority`` is the data type
  used to manage and manipulate task priorities.

- .. index:: rtems_task_restart_extension

  ``rtems.task_restart_extension`` is the
  entry point for a task restart user extension handler routine.

- .. index:: rtems_task_start_extension

  ``rtems.task_start_extension`` is the
  entry point for a task start user extension handler routine.

- .. index:: rtems_task_switch_extension

  ``rtems.task_switch_extension`` is the
  entry point for a task context switch user extension handler routine.

- .. index:: rtems_tcb

  ``rtems.tcb`` is the data structure associated
  with each task in an RTEMS system.

- .. index:: rtems_time_of_day

  ``rtems.time_of_day`` is the data structure
  used to manage and manipulate calendar time in RTEMS.

- .. index:: rtems_timer_service_routine

  ``rtems.timer_service_routine`` is the
  return type for an RTEMS Timer Service Routine.

- .. index:: rtems_timer_service_routine_entry

  ``rtems.timer_service_routine_entry`` is the address of
  the entry point to an RTEMS TSR.  It is equivalent to the
  entry point of the function implementing the TSR.

- .. index:: rtems_vector_number

  ``rtems.vector_number`` is the data
  type used to manage and manipulate interrupt vector numbers.

- .. index:: uint8_t

  ``uint8_t`` is the C99 data type that corresponds to unsigned
  eight bit integers.  This data type is defined by RTEMS in a manner that
  ensures it is portable across different target processors.

- .. index:: uint16_t

  ``uint16_t`` is the C99 data type that corresponds to unsigned
  sixteen bit integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

- .. index:: uint32_t

  ``uint32_t`` is the C99 data type that corresponds to unsigned
  thirty-two bit integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

- .. index:: uint64_t

  ``uint64_t`` is the C99 data type that corresponds to unsigned
  sixty-four bit integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

- .. index:: uintptr_t

  ``uintptr_t`` is the C99 data type that corresponds to the
  unsigned integer type that is of sufficient size to represent addresses
  as unsigned integers.  This data type is defined by RTEMS in a manner
  that ensures it is portable across different target processors.

.. COMMENT: COPYRIGHT (c) 1988-2008.

.. COMMENT: On-Line Applications Research Corporation (OAR).

.. COMMENT: All rights reserved.