Classic API Configuration

Macros
#define	CONFIGURE_MAXIMUM_BARRIERS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_MESSAGE_QUEUES
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_PARTITIONS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_PERIODS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_PORTS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_REGIONS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_SEMAPHORES
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_TASKS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_TIMERS
	This configuration option is an integer define. More...
#define	CONFIGURE_MAXIMUM_USER_EXTENSIONS
	This configuration option is an integer define. More...
#define	CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE
	This configuration option is an integer define. More...

Detailed Description

This section describes configuration options related to the Classic API.

Macro Definition Documentation

CONFIGURE_MAXIMUM_BARRIERS

#define CONFIGURE_MAXIMUM_BARRIERS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Barriers that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

Definition at line 583 of file appl-config.h.

CONFIGURE_MAXIMUM_MESSAGE_QUEUES

#define CONFIGURE_MAXIMUM_MESSAGE_QUEUES

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Message Queues that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects. You have to account for the memory used to store the messages of each message queue, see CONFIGURE_MESSAGE_BUFFER_MEMORY.

Definition at line 621 of file appl-config.h.

CONFIGURE_MAXIMUM_PARTITIONS

#define CONFIGURE_MAXIMUM_PARTITIONS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Partitions that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

Definition at line 658 of file appl-config.h.

CONFIGURE_MAXIMUM_PERIODS

#define CONFIGURE_MAXIMUM_PERIODS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Periods that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

Definition at line 695 of file appl-config.h.

CONFIGURE_MAXIMUM_PORTS

#define CONFIGURE_MAXIMUM_PORTS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Ports that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

Definition at line 732 of file appl-config.h.

CONFIGURE_MAXIMUM_REGIONS

#define CONFIGURE_MAXIMUM_REGIONS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Regions that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

Definition at line 769 of file appl-config.h.

CONFIGURE_MAXIMUM_SEMAPHORES

#define CONFIGURE_MAXIMUM_SEMAPHORES

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Semaphore that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

In SMP configurations, the size of a Semaphore Control Block depends on the scheduler count (see Configuration Step 3 - Scheduler Table). The semaphores using the Multiprocessor Resource Sharing Protocol (MrsP) need a ceiling priority per scheduler.

Definition at line 815 of file appl-config.h.

CONFIGURE_MAXIMUM_TASKS

#define CONFIGURE_MAXIMUM_TASKS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Tasks that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It shall be small enough so that the task stack space calculation carried out by <rtems/confdefs.h> does not overflow an integer of type uintptr_t.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

The calculations for the required memory in the RTEMS Workspace for tasks assume that each task has a minimum stack size and has floating point support enabled. The configuration option CONFIGURE_EXTRA_TASK_STACKS is used to specify task stack requirements above the minimum size required.

The maximum number of POSIX threads is specified by CONFIGURE_MAXIMUM_POSIX_THREADS.

A future enhancement to <rtems/confdefs.h> could be to eliminate the assumption that all tasks have floating point enabled. This would require the addition of a new configuration parameter to specify the number of tasks which enable floating point support.

Definition at line 871 of file appl-config.h.

CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE

#define CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE

This configuration option is an integer define.

If the value of this configuration option is greater than zero, then it defines the maximum thread-local storage size, otherwise the thread-local storage size is defined by the linker depending on the thread-local storage objects used by the application in the statically-linked executable.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall be greater than or equal to 0 and less than or equal to SIZE_MAX.

Notes

This configuration option can be used to reserve space for the dynamic linking of modules with thread-local storage objects.

If the thread-local storage size defined by the thread-local storage objects used by the application in the statically-linked executable is greater than a non-zero value of this configuration option, then a fatal error will occur during system initialization.

Use RTEMS_ALIGN_UP() and RTEMS_TASK_STORAGE_ALIGNMENT to adjust the size to meet the minimum alignment requirement of a thread-local storage area.

The actual thread-local storage size is determined when the application executable is linked. The rtems-exeinfo command line tool included in the RTEMS Tools can be used to obtain the thread-local storage size and alignment of an application executable.

Definition at line 910 of file appl-config.h.

CONFIGURE_MAXIMUM_TIMERS

#define CONFIGURE_MAXIMUM_TIMERS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API Timers that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.
• It may be defined through rtems_resource_unlimited() the enable unlimited objects for this object class, if the value passed to rtems_resource_unlimited() satisfies all other constraints of this configuration option.

Notes

This object class can be configured in unlimited allocation mode, see Unlimited Objects.

Definition at line 947 of file appl-config.h.

CONFIGURE_MAXIMUM_USER_EXTENSIONS

#define CONFIGURE_MAXIMUM_USER_EXTENSIONS

This configuration option is an integer define.

The value of this configuration option defines the maximum number of Classic API User Extensions that can be concurrently active.

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall satisfy all of the following constraints:

• It shall be greater than or equal to 0.
• It shall be less than or equal to 65535.
• It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.

Notes

This object class cannot be configured in unlimited allocation mode.

Definition at line 977 of file appl-config.h.

CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE

#define CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE

This configuration option is an integer define.

The value of this configuration option defines the minimum count of Classic API Tasks which are constructed by rtems_task_construct().

Default Value

The default value is 0.

Value Constraints

The value of this configuration option shall be greater than or equal to 0 and less than or equal to CONFIGURE_MAXIMUM_TASKS.

Notes

By default, the calculation for the required memory in the RTEMS Workspace for tasks assumes that all Classic API Tasks are created by rtems_task_create(). This configuration option can be used to reduce the required memory for the system-provided task storage areas since tasks constructed by rtems_task_construct() use a user-provided task storage area.

Definition at line 1001 of file appl-config.h.