Classic API Initialization Task Configuration

Macros
#define	CONFIGURE_INIT_TASK_ARGUMENTS
	This configuration option is an integer define.
#define	CONFIGURE_INIT_TASK_ATTRIBUTES
	This configuration option is an integer define.
#define	CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
	This configuration option is an integer define.
#define	CONFIGURE_INIT_TASK_ENTRY_POINT
	This configuration option is an initializer define.
#define	CONFIGURE_INIT_TASK_INITIAL_MODES
	This configuration option is an integer define.
#define	CONFIGURE_INIT_TASK_NAME
	This configuration option is an integer define.
#define	CONFIGURE_INIT_TASK_PRIORITY
	This configuration option is an integer define.
#define	CONFIGURE_INIT_TASK_STACK_SIZE
	This configuration option is an integer define.
#define	CONFIGURE_RTEMS_INIT_TASKS_TABLE
	This configuration option is a boolean feature define.

Detailed Description

This section describes configuration options related to the Classic API initialization task.

Macro Definition Documentation

CONFIGURE_INIT_TASK_ARGUMENTS

#define CONFIGURE_INIT_TASK_ARGUMENTS

This configuration option is an integer define.

The value of this configuration option defines task argument of the Classic API initialization task.

Default Value

The default value is 0.

Constraints

The value of the configuration option shall be convertible to an integer of type rtems_task_argument.

CONFIGURE_INIT_TASK_ATTRIBUTES

#define CONFIGURE_INIT_TASK_ATTRIBUTES

This configuration option is an integer define.

The value of this configuration option defines the task attributes of the Classic API initialization task.

Default Value

The default value is RTEMS_DEFAULT_ATTRIBUTES.

Constraints

The value of the configuration option shall be a valid task attribute set.

CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE

#define CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE

This configuration option is an integer define.

The value of this configuration option defines the task storage size of the Classic API initialization task.

Default Value

This configuration option has no default value. If it is not specified, then the Classic API initialization task will be created with the stack size defined by the CONFIGURE_INIT_TASK_STACK_SIZE configuration option.

Constraints

The following constraints apply to this configuration option:

• The value of the configuration option shall be greater than or equal to CONFIGURE_MINIMUM_TASK_STACK_SIZE.
• The value of the configuration option shall be defined using RTEMS_TASK_STORAGE_SIZE().

Notes

If this configuration option is specified, then

• a task storage area of the specified size is statically allocated by <rtems/confdefs.h> for the Classic API initialization task,
• the Classic API initialization task is constructed by rtems_task_construct() instead of using rtems_task_create(),
• the maximum thread-local storage size defined by CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE is used for the Classic API initialization task,
• the Classic API initialization task should be accounted for in CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE, and
• the task storage area used for the Classic API initialization task is not reclaimed by the system if the task is deleted.

The

• CONFIGURE_INIT_TASK_STACK_SIZE and
• CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE

configuration options are mutually exclusive.

CONFIGURE_INIT_TASK_ENTRY_POINT

#define CONFIGURE_INIT_TASK_ENTRY_POINT

This configuration option is an initializer define.

The value of this configuration option initializes the entry point of the Classic API initialization task.

Default Value

The default value is Init.

Constraints

The value of the configuration option shall be defined to a valid function pointer of the type void ( *entry_point )( rtems_task_argument ).

Notes

The application shall provide the function referenced by this configuration option.

CONFIGURE_INIT_TASK_INITIAL_MODES

#define CONFIGURE_INIT_TASK_INITIAL_MODES

This configuration option is an integer define.

The value of this configuration option defines the initial execution mode of the Classic API initialization task.

Default Value

In SMP configurations, the default value is RTEMS_DEFAULT_MODES otherwise the default value is RTEMS_NO_PREEMPT.

Constraints

The value of the configuration option shall be a valid task mode set.

CONFIGURE_INIT_TASK_NAME

#define CONFIGURE_INIT_TASK_NAME

This configuration option is an integer define.

The value of this configuration option defines the name of the Classic API initialization task.

Default Value

The default value is rtems_build_name( 'U', 'I', '1', ' ' ).

Constraints

The value of the configuration option shall be convertible to an integer of type rtems_name.

Notes

Use rtems_build_name() to define the task name.

CONFIGURE_INIT_TASK_PRIORITY

#define CONFIGURE_INIT_TASK_PRIORITY

This configuration option is an integer define.

The value of this configuration option defines the initial priority of the Classic API initialization task.

Default Value

The default value is 1.

Constraints

The value of the configuration option shall be a valid Classic API task priority. The set of valid task priorities depends on the scheduler configuration.

CONFIGURE_INIT_TASK_STACK_SIZE

#define CONFIGURE_INIT_TASK_STACK_SIZE

This configuration option is an integer define.

The value of this configuration option defines the task stack size of the Classic API initialization task.

Default Value

The default value is CONFIGURE_MINIMUM_TASK_STACK_SIZE.

Constraints

The following constraints apply to this configuration option:

• The value of the configuration option shall be greater than or equal to CONFIGURE_MINIMUM_TASK_STACK_SIZE.
• The value of the configuration option 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.

Notes

The

• CONFIGURE_INIT_TASK_STACK_SIZE and
• CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE

configuration options are mutually exclusive.

CONFIGURE_RTEMS_INIT_TASKS_TABLE

#define CONFIGURE_RTEMS_INIT_TASKS_TABLE

This configuration option is a boolean feature define.

In case this configuration option is defined, then exactly one Classic API initialization task is configured.

Default Configuration

If this configuration option is undefined, then the described feature is not enabled.

Notes

The application shall define at least one of the following configuration options

• CONFIGURE_RTEMS_INIT_TASKS_TABLE,
• CONFIGURE_POSIX_INIT_THREAD_TABLE, or
• CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION

otherwise a compile time error in the configuration file will occur.

The Classic API initialization task performs the Global Construction.