source: rtems/cpukit/rtems/include/rtems.h @ 0185851c

Last change on this file since 0185851c was 0185851c, checked in by Joel Sherrill <joel.sherrill@…>, on Aug 8, 2008 at 3:56:13 PM

2008-08-08 Joel Sherrill <joel.sherrill@…>

  • rtems/include/rtems.h, sapi/Makefile.am: Add Add simple helper to get RTEMS version string.
  • sapi/src/getversionstring.c: New file.
  • Property mode set to 100644
File size: 4.0 KB
Line 
1/**
2 * @file  rtems.h
3 */
4 
5/*
6 *  This include file contains information about RTEMS executive that
7 *  is required by the application and is CPU independent.  It includes
8 *  two (2) CPU dependent files to tailor its data structures for a
9 *  particular processor.
10 *
11 *  COPYRIGHT (c) 1989-1999.
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.com/license/LICENSE.
17 *
18 *  $Id$
19 */
20
21#ifndef _RTEMS_H
22#define _RTEMS_H
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28/*
29 *  Unless told otherwise, the RTEMS include files will hide some stuff
30 *  from normal application code.  Defining this crosses a boundary which
31 *  is undesirable since it means your application is using RTEMS features
32 *  which are not included in the formally defined and supported API.
33 *  Define this at your own risk.
34 */
35
36#if (!defined(__RTEMS_VIOLATE_KERNEL_VISIBILITY__)) && (!defined(__RTEMS_INSIDE__))
37#define __RTEMS_APPLICATION__
38#endif
39
40#include <rtems/system.h>
41#include <rtems/rtems/status.h>
42#include <rtems/rtems/types.h>
43
44#include <rtems/config.h>
45#include <rtems/init.h>
46#include <rtems/rtems/options.h>
47#include <rtems/rtems/tasks.h>
48#include <rtems/rtems/intr.h>
49#include <rtems/rtems/cache.h>
50#include <rtems/rtems/clock.h>
51#include <rtems/extension.h>
52#include <rtems/rtems/timer.h>
53#include <rtems/rtems/sem.h>
54#include <rtems/rtems/message.h>
55#include <rtems/rtems/event.h>
56#include <rtems/rtems/signal.h>
57#include <rtems/rtems/event.h>
58#include <rtems/rtems/part.h>
59#include <rtems/rtems/region.h>
60#include <rtems/rtems/dpmem.h>
61#include <rtems/io.h>
62#include <rtems/fatal.h>
63#include <rtems/rtems/ratemon.h>
64#if defined(RTEMS_MULTIPROCESSING)
65#include <rtems/rtems/mp.h>
66#endif
67
68#include <rtems/rtems/support.h>
69#include <rtems/score/sysstate.h>
70
71/*
72 *  Obtain the RTEMS Version String
73 *
74 *  This method may be used to obtain the RTEMS version string.
75 *
76 *  This method returns a pointer to the version string.
77 */
78const char *rtems_get_version_string(void);
79
80#define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP
81
82/*
83 *  The following define the constants which may be used in name searches.
84 */
85
86#define RTEMS_SEARCH_ALL_NODES   OBJECTS_SEARCH_ALL_NODES
87#define RTEMS_SEARCH_OTHER_NODES OBJECTS_SEARCH_OTHER_NODES
88#define RTEMS_SEARCH_LOCAL_NODE  OBJECTS_SEARCH_LOCAL_NODE
89#define RTEMS_WHO_AM_I           OBJECTS_WHO_AM_I
90
91/*
92 * Parameters and return id's for _Objects_Get_next
93 */
94
95#define RTEMS_OBJECT_ID_INITIAL_INDEX        OBJECTS_ID_INITIAL_INDEX
96#define RTEMS_OBJECT_ID_FINAL_INDEX          OBJECTS_ID_FINAL_INDEX
97#define RTEMS_OBJECT_ID_INITIAL(api, class, node) OBJECTS_ID_INITIAL(api, class, node)
98
99#define RTEMS_OBJECT_ID_FINAL                OBJECTS_ID_FINAL
100
101/*
102 *  The following constant defines the minimum stack size which every
103 *  thread must exceed.
104 */
105
106#define RTEMS_MINIMUM_STACK_SIZE  STACK_MINIMUM_SIZE
107
108/*
109 *  Constant for indefinite wait.  (actually an illegal interval)
110 */
111
112#define RTEMS_NO_TIMEOUT  WATCHDOG_NO_TIMEOUT
113
114/*
115 *  An MPCI must support packets of at least this size.
116 */
117
118#define RTEMS_MINIMUM_PACKET_SIZE  MP_PACKET_MINIMUM_PACKET_SIZE
119
120/*
121 *  The following constant defines the number of uint32_t  's
122 *  in a packet which must be converted to native format in a
123 *  heterogeneous system.  In packets longer than
124 *  MP_PACKET_MINIMUN_HETERO_CONVERSION uint32_t  's, some of the "extra" data
125 *  may a user message buffer which is not automatically endian swapped.
126 */
127
128#define RTEMS_MINIMUN_HETERO_CONVERSION  MP_PACKET_MINIMUN_HETERO_CONVERSION
129
130/*
131 *  rtems_object_id_to_name
132 *
133 *  This directive returns the name associated with the specified
134 *  object ID.
135 *
136 *  Input parameters:
137 *    id   - message queue id
138 *
139 *  Output parameters:
140 *    *name            - user defined object name
141 *    RTEMS_SUCCESSFUL - if successful
142 *    error code       - if unsuccessful
143 */
144
145rtems_status_code rtems_object_id_to_name(
146  rtems_id      id,
147  rtems_name   *name
148);
149
150#ifdef __cplusplus
151}
152#endif
153
154#endif
155/* end of include file */
Note: See TracBrowser for help on using the repository browser.