RTEMS  5.0.0
Data Structures | Macros | Typedefs | Functions | Variables
config.h File Reference

Table of User Defined Configuration Parameters. More...

#include <rtems/score/object.h>
#include <rtems/score/isr.h>
#include <rtems/score/watchdogticks.h>
#include <rtems/rtems/config.h>
#include <rtems/posix/config.h>
#include <rtems/extension.h>

Go to the source code of this file.

Data Structures

struct  rtems_configuration_table
 

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()   (Configuration.unified_work_area)
 
#define rtems_configuration_get_stack_allocator_avoids_work_space()   (Configuration.stack_allocator_avoids_work_space)
 
#define rtems_configuration_get_stack_space_size()   (Configuration.stack_space_size)
 
#define rtems_configuration_get_work_space_size()
 
#define rtems_configuration_get_microseconds_per_tick()   (Configuration.microseconds_per_tick)
 
#define rtems_configuration_get_milliseconds_per_tick()   (Configuration.microseconds_per_tick / 1000)
 
#define rtems_configuration_get_nanoseconds_per_tick()   (_Watchdog_Nanoseconds_per_tick)
 
#define rtems_configuration_get_ticks_per_timeslice()   (Configuration.ticks_per_timeslice)
 
#define rtems_configuration_get_idle_task()   (Configuration.idle_task)
 
#define rtems_configuration_get_idle_task_stack_size()   (Configuration.idle_task_stack_size)
 
#define rtems_configuration_get_interrupt_stack_size()   ((size_t) _ISR_Stack_size)
 
#define rtems_configuration_get_stack_allocate_init_hook()   (Configuration.stack_allocate_init_hook)
 
#define rtems_configuration_get_stack_allocate_hook()   (Configuration.stack_allocate_hook)
 
#define rtems_configuration_get_stack_free_hook()   (Configuration.stack_free_hook)
 
#define rtems_configuration_get_do_zero_of_workspace()   (Configuration.do_zero_of_workspace)
 
#define rtems_configuration_get_number_of_initial_extensions()   (Configuration.number_of_initial_extensions)
 
#define rtems_configuration_get_user_extension_table()   (Configuration.User_extension_table)
 
#define rtems_configuration_get_user_multiprocessing_table()   NULL
 
#define rtems_configuration_is_smp_enabled()   false
 Returns true if the SMP mode of operation is enabled, and false otherwise. More...
 
#define rtems_configuration_get_maximum_processors()   1
 Returns the configured maximum count of processors. More...
 
#define rtems_configuration_get_rtems_api_configuration()   (&Configuration_RTEMS_API)
 
#define rtems_configuration_get_posix_api_configuration()   (&Configuration_POSIX_API)
 

Typedefs

typedef void(* rtems_stack_allocate_init_hook) (size_t stack_space_size)
 Task stack allocator initialization hook. More...
 
typedef void *(* rtems_stack_allocate_hook) (size_t stack_size)
 Task stack allocator hook. More...
 
typedef void(* rtems_stack_free_hook) (void *addr)
 Task stack deallocator hook. More...
 

Functions

uint32_t rtems_configuration_get_maximum_extensions (void)
 

Variables

const rtems_configuration_table Configuration
 

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 ( )    (Configuration.do_zero_of_workspace)

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 ( )    1

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_work_space_size

#define rtems_configuration_get_work_space_size ( )
Value:
(rtems_configuration_get_stack_allocator_avoids_work_space() ? \
0 : rtems_configuration_get_stack_space_size()))
uintptr_t work_space_size
Definition: config.h:123
const rtems_configuration_table Configuration

◆ rtems_configuration_is_smp_enabled

#define rtems_configuration_is_smp_enabled ( )    false

Returns true if the SMP mode of operation is enabled, and false otherwise.

In uni-processor configurations this is a compile-time constant which evaluates to false.

Return values
trueSMP mode of operation is enabled.
falseOtherwise.

Typedef Documentation

◆ rtems_stack_allocate_hook

typedef void*(* rtems_stack_allocate_hook) (size_t stack_size)

Task stack allocator hook.

Parameters
[in]stack_sizeis the Size of the task stack in bytes.
Return values
NULLNot enough memory.
otherPointer to task stack.

◆ rtems_stack_allocate_init_hook

typedef void(* rtems_stack_allocate_init_hook) (size_t stack_space_size)

Task stack allocator initialization hook.

Parameters
[in]stack_space_sizeis the size of the stack space in bytes.

◆ rtems_stack_free_hook

typedef void(* rtems_stack_free_hook) (void *addr)

Task stack deallocator hook.

Parameters
[in]addris a pointer to previously allocated task stack.

Variable Documentation

◆ Configuration

const rtems_configuration_table Configuration

This is the configuration table generated by confdefs.h.