Classic

RTEMS Classic API definitions and modules. More...

Modules
	ASR Support
	Attributes
	Barriers
	Cache
	The Cache Manager provides functions to perform maintenance operations for data and instruction caches.
	Chains
	Chain API.
	Classic API Options
	Clocks
	Configuration
	Dual Ported Memory
	Events
	The event manager provides a high performance method of intertask communication and synchronization.
	Fatal
	The Fatal Manager provides functions for fatal system states and or irrecoverable errors.
	Free-Running Counter and Busy Wait Delay
	Free-running counter and busy wait delay functions.
	Input/Output
	Interrupts
	Local Packages
	Local packages.
	Message Queues
	Modes
	Multiprocessing
	Object Class Information
	Partitions
	Rate Monotonic Scheduler
	Red-Black Tree Heap
	Red-Black Tree Heap API.
	Red-Black Trees
	A Red-Black Tree container.
	Regions
	SMP Services
	Semaphores
	Signals
	Status Codes
	Tasks
	Timers
	Timespec
	Timespec API.
	Types
	Types used by Classic API.
	User Extensions
	The User Extensions Manager allows the application developer to augment the executive by allowing them to supply extension routines which are invoked at critical system events.
	Workspace

Files
file	rtems.h

Macros
#define	RTEMS_HAS_HARDWARE_FP   CPU_HARDWARE_FP
	Indicates whether this processor variant has hardware floating point support.
#define	RTEMS_SEARCH_ALL_NODES   OBJECTS_SEARCH_ALL_NODES
	Indicates that a search is across all nodes.
#define	RTEMS_SEARCH_OTHER_NODES   OBJECTS_SEARCH_OTHER_NODES
	Indicates that a search is across all nodes except the one the call is made from.
#define	RTEMS_SEARCH_LOCAL_NODE   OBJECTS_SEARCH_LOCAL_NODE
	Indicates that the search is to be restricted to the local node.
#define	RTEMS_WHO_AM_I   OBJECTS_WHO_AM_I
	Indicates that the caller wants to obtain the name of the currently executing thread. More...
#define	RTEMS_OBJECT_ID_INITIAL_INDEX   OBJECTS_ID_INITIAL_INDEX
	Lowest valid index value for the index portion of an object identifier.
#define	RTEMS_OBJECT_ID_FINAL_INDEX   OBJECTS_ID_FINAL_INDEX
	Maximum valid index value for the index portion of an object identifier.
#define	RTEMS_OBJECT_ID_INITIAL(_api, _class, _node)   OBJECTS_ID_INITIAL(_api, _class, _node)
	Returns the identifier of the object with the lowest valid index value. More...
#define	RTEMS_OBJECT_ID_FINAL   OBJECTS_ID_FINAL
	Maximum valid object identifier.
#define	RTEMS_MINIMUM_STACK_SIZE   STACK_MINIMUM_SIZE
	Minimum stack size which every thread must exceed. More...
#define	RTEMS_CONFIGURED_MINIMUM_STACK_SIZE   0
	Specifies that the task should be created with the configured minimum stack size. More...
#define	RTEMS_NO_TIMEOUT   ((rtems_interval) WATCHDOG_NO_TIMEOUT)
	Constant for indefinite wait. More...
#define	RTEMS_MINIMUM_PACKET_SIZE   MP_PACKET_MINIMUM_PACKET_SIZE
	An MPCI must support packets of at least this size.
#define	RTEMS_MINIMUN_HETERO_CONVERSION   MP_PACKET_MINIMUN_HETERO_CONVERSION
	Defines the count of uint32_t numbers in a packet which must be converted to native format in a heterogeneous system. More...

Functions
const char *	rtems_get_version_string (void)
	Returns the pointer to the RTEMS version string.

Detailed Description

RTEMS Classic API definitions and modules.

Macro Definition Documentation

RTEMS_CONFIGURED_MINIMUM_STACK_SIZE

#define RTEMS_CONFIGURED_MINIMUM_STACK_SIZE   0

Specifies that the task should be created with the configured minimum stack size.

Using this constant when specifying the task stack size indicates that this task is to be created with a stack size of the minimum stack size that was configured by the application. If not explicitly configured by the application, the default configured minimum stack size is the processor dependent value RTEMS_MINIMUM_STACK_SIZE. Since this uses the configured minimum stack size value, you may get a stack size that is smaller or larger than the recommended minimum. This can be used to provide large stacks for all tasks on complex applications or small stacks on applications that are trying to conserve memory.

RTEMS_MINIMUM_STACK_SIZE

#define RTEMS_MINIMUM_STACK_SIZE   STACK_MINIMUM_SIZE

Minimum stack size which every thread must exceed.

It is the minimum stack size recommended for use on this processor. This value is selected by the RTEMS developers conservatively to minimize the risk of blown stacks for most user applications. Using this constant when specifying the task stack size, indicates that the stack size will be at least RTEMS_MINIMUM_STACK_SIZE bytes in size. If the user configured minimum stack size is larger than the recommended minimum, then it will be used.

RTEMS_MINIMUN_HETERO_CONVERSION

#define RTEMS_MINIMUN_HETERO_CONVERSION   MP_PACKET_MINIMUN_HETERO_CONVERSION

Defines the count of uint32_t numbers in a packet which must be converted to native format in a heterogeneous system.

In packets longer than this value, some of the extra data may be a user message buffer which is not automatically endian swapped.

RTEMS_NO_TIMEOUT

#define RTEMS_NO_TIMEOUT   ((rtems_interval) WATCHDOG_NO_TIMEOUT)

Constant for indefinite wait.

This is actually an illegal interval value.

RTEMS_OBJECT_ID_INITIAL

#define RTEMS_OBJECT_ID_INITIAL	(		_api,
			_class,
			_node
	)		OBJECTS_ID_INITIAL(_api, _class, _node)

Returns the identifier of the object with the lowest valid index value.

The object is specified by the API _api, the object class _class and the node _node where the object resides.

RTEMS_WHO_AM_I

#define RTEMS_WHO_AM_I   OBJECTS_WHO_AM_I

Indicates that the caller wants to obtain the name of the currently executing thread.

This constant is only meaningful when obtaining the name of a task.