RTEMS: cpukit/include/rtems/config.h File Reference

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
Macros | Typedefs | Functions
config.h File Reference

Table of User Defined Configuration Parameters. More...

`#include <rtems/score/object.h>`
`#include <rtems/score/isr.h>`
`#include <rtems/score/memory.h>`
`#include <rtems/score/smp.h>`
`#include <rtems/score/stack.h>`
`#include <rtems/score/userextdata.h>`
`#include <rtems/score/threadidledata.h>`
`#include <rtems/score/watchdogticks.h>`
`#include <rtems/score/wkspacedata.h>`
`#include <rtems/rtems/config.h>`
`#include <rtems/extension.h>`

Go to the source code of this file.

## Macros
#define | RTEMS_UNLIMITED_OBJECTS OBJECTS_UNLIMITED_OBJECTS
#define | rtems_resource_unlimited(resource) ( resource | RTEMS_UNLIMITED_OBJECTS )
#define | rtems_resource_is_unlimited(resource) _Objects_Is_unlimited(resource)
#define | rtems_resource_maximum_per_allocation(resource) _Objects_Maximum_per_allocation(resource)
#define | rtems_configuration_get_unified_work_area() (_Workspace_Is_unified)
#define | rtems_configuration_get_stack_allocator_avoids_work_space() (_Stack_Allocator_avoids_workspace)
| Return if the stack allocator avoids the work space.
#define | rtems_configuration_get_work_space_size()
#define | rtems_configuration_get_microseconds_per_tick() (_Watchdog_Microseconds_per_tick)
#define | rtems_configuration_get_milliseconds_per_tick() (_Watchdog_Microseconds_per_tick / 1000)
#define | rtems_configuration_get_nanoseconds_per_tick() (_Watchdog_Nanoseconds_per_tick)
#define | rtems_configuration_get_ticks_per_timeslice() (_Watchdog_Ticks_per_timeslice)
#define | rtems_configuration_get_idle_task() (_Thread_Idle_entry)
#define | rtems_configuration_get_idle_task_stack_size() (_Thread_Idle_stack_size)
#define | rtems_configuration_get_interrupt_stack_size() ((size_t) _ISR_Stack_size)
#define | rtems_configuration_get_stack_allocate_init_hook() (_Stack_Allocator_initialize)
#define | rtems_configuration_get_stack_allocate_hook() (_Stack_Allocator_allocate)
#define | rtems_configuration_get_stack_free_hook() (_Stack_Allocator_free)
#define | rtems_configuration_get_stack_allocate_for_idle_hook() (_Stack_Allocator_allocate_for_idle)
#define | rtems_configuration_get_do_zero_of_workspace() _Memory_Zero_before_use
#define | rtems_configuration_get_number_of_initial_extensions() ((uint32_t) _User_extensions_Initial_count)
#define | rtems_configuration_get_user_extension_table() (&_User_extensions_Initial_extensions[ 0 ])
#define | rtems_configuration_get_user_multiprocessing_table() NULL
#define | rtems_configuration_get_maximum_processors() (_SMP_Processor_configured_maximum)
| Returns the configured maximum count of processors.

## Typedefs
typedef Stack_Allocator_initialize | rtems_stack_allocate_init_hook
| The stack allocator initialization handler.
typedef Stack_Allocator_allocate | rtems_stack_allocate_hook
| Stack allocator allocate handler.
typedef Stack_Allocator_free | rtems_stack_free_hook
| Stack allocator free handler.

## Functions
uintptr_t | rtems_configuration_get_stack_space_size (void)
uint32_t | rtems_configuration_get_maximum_extensions (void)

## Detailed Description

Table of User Defined Configuration Parameters.

This include file contains the table of user defined configuration parameters.

## Macro Definition Documentation

## ◆ rtems_configuration_get_do_zero_of_workspace

#define rtems_configuration_get_do_zero_of_workspace | ( |  | ) | _Memory_Zero_before_use

This macro assists in accessing the field which indicates whether RTEMS is responsible for zeroing the Executive Workspace.

## ◆ rtems_configuration_get_maximum_processors

#define rtems_configuration_get_maximum_processors | ( |  | ) | (_SMP_Processor_configured_maximum)

Returns the configured maximum count of processors.

The actual number of processors available for the application will be less than or equal to the configured maximum count of processors.

On single-processor configurations this is a compile time constant which evaluates to one.

Returns
  The configured maximum count of processors.

## ◆ rtems_configuration_get_stack_allocator_avoids_work_space

#define rtems_configuration_get_stack_allocator_avoids_work_space | ( |  | ) | (_Stack_Allocator_avoids_workspace)

Return if the stack allocator avoids the work space.

Return values

  true | The stack allocator must not allocate the thread stacks from the RTEMS Workspace
  false | The stack allocator should allocate the thread stacks from the RTEMS Workspace.

## ◆ rtems_configuration_get_work_space_size

#define rtems_configuration_get_work_space_size | ( |  | ) |

Value:
(_Workspace_Size + \
(rtems_configuration_get_stack_allocator_avoids_work_space() ? \
0 : rtems_configuration_get_stack_space_size()))
_Workspace_Size
const uintptr_t _Workspace_Size
The workspace size in bytes.
rtems_configuration_get_stack_allocator_avoids_work_space
#define rtems_configuration_get_stack_allocator_avoids_work_space()
Return if the stack allocator avoids the work space.
Definition: config.h:92

## Typedef Documentation

## ◆ rtems_stack_allocate_hook

typedef Stack_Allocator_allocate rtems_stack_allocate_hook

Stack allocator allocate handler.

Parameters

  stack_size | The size of the stack area to allocate in bytes.

Return values

  NULL | Not enough memory.
  other | Pointer to begin of stack area.

## ◆ rtems_stack_allocate_init_hook

typedef Stack_Allocator_initialize rtems_stack_allocate_init_hook

The stack allocator initialization handler.

Parameters

  stack_space_size | The size of the stack space in bytes.

## ◆ rtems_stack_free_hook

typedef Stack_Allocator_free rtems_stack_free_hook

Stack allocator free handler.

Parameters

  ] | addr A pointer to previously allocated stack area or NULL.