RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

doxygen: Use @anchor for appl config options

Browse Source 
The application configuration options are documented in
"cpukit/doxygen/appl-config.h".  Since the application configuration
option defines are also present in multiple test program sources, the
"#OPTION" references cannot be mapped to a unique definition.  Add an
anchor for each option and reference it to avoid the issues with the
multiple definitions.

Update #3994.
This commit is contained in:
Sebastian Huber
2023-02-06 11:09:27 +01:00
parent c508a3329e
commit 1f8b26a809
18 changed files with 678 additions and 368 deletions
Download Patch File Download Diff File Expand all files Collapse all files

762
cpukit/doxygen/appl-config.h
View File

File diff suppressed because it is too large Load Diff

2
cpukit/include/rtems/bspIo.h
View File

@@ -78,7 +78,7 @@ extern "C" {
*
* The directives may be used to print debug and test information. The kernel
* character input/output support should work even if no Console Driver is
* configured, see #CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER. The kernel
* configured, see @ref CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER. The kernel
* character input and output device is provided by the BSP. Applications may
* change the device.
*/

60
cpukit/include/rtems/config.h
View File

@@ -152,8 +152,8 @@ extern "C" {
* RTEMS Workspace for this application, otherwise false.
*
* @par Notes
* The setting is defined by the
* #CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE application configuration
* The setting is defined by the @ref
* CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE application configuration
* option.
*
* @par Constraints
@@ -353,7 +353,7 @@ const char *rtems_get_version_string( void );
* during system initialization for this application, otherwise false.
*
* @par Notes
* The setting is defined by the #CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
* The setting is defined by the @ref CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
* application configuration option.
*
* @par Constraints
@@ -377,8 +377,8 @@ const char *rtems_get_version_string( void );
* @return Returns the IDLE task stack size in bytes of this application.
*
* @par Notes
* The IDLE task stack size is defined by the #CONFIGURE_IDLE_TASK_STACK_SIZE
* application configuration option.
* The IDLE task stack size is defined by the @ref
* CONFIGURE_IDLE_TASK_STACK_SIZE application configuration option.
*
* @par Constraints
* @parblock
@@ -401,8 +401,8 @@ const char *rtems_get_version_string( void );
* @return Returns the IDLE task body of this application.
*
* @par Notes
* The IDLE task body is defined by the #CONFIGURE_IDLE_TASK_BODY application
* configuration option.
* The IDLE task body is defined by the @ref CONFIGURE_IDLE_TASK_BODY
* application configuration option.
*
* @par Constraints
* @parblock
@@ -425,8 +425,8 @@ const char *rtems_get_version_string( void );
* @return Returns the interrupt stack size in bytes of this application.
*
* @par Notes
* The interrupt stack size is defined by the #CONFIGURE_INTERRUPT_STACK_SIZE
* application configuration option.
* The interrupt stack size is defined by the @ref
* CONFIGURE_INTERRUPT_STACK_SIZE application configuration option.
*
* @par Constraints
* @parblock
@@ -452,7 +452,7 @@ const char *rtems_get_version_string( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_USER_EXTENSIONS
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_USER_EXTENSIONS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
@@ -482,7 +482,7 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* @parblock
* The actual number of processors available to the application is returned by
* rtems_scheduler_get_processor_maximum() which less than or equal to the
* configured maximum number of processors (#CONFIGURE_MAXIMUM_PROCESSORS).
* configured maximum number of processors (@ref CONFIGURE_MAXIMUM_PROCESSORS).
*
* In uniprocessor configurations, this macro is a compile time constant which
* evaluates to one.
@@ -512,8 +512,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* this application.
*
* @par Notes
* The number of microseconds per clock tick is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
* The number of microseconds per clock tick is defined by the @ref
* CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock
@@ -539,8 +539,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* this application.
*
* @par Notes
* The number of milliseconds per clock tick is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
* The number of milliseconds per clock tick is defined by the @ref
* CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock
@@ -566,8 +566,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* this application.
*
* @par Notes
* The number of nanoseconds per clock tick is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
* The number of nanoseconds per clock tick is defined by the @ref
* CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock
@@ -593,8 +593,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* application.
*
* @par Notes
* The number of initial extensions is defined by the
* #CONFIGURE_INITIAL_EXTENSIONS application configuration option and related
* The number of initial extensions is defined by the @ref
* CONFIGURE_INITIAL_EXTENSIONS application configuration option and related
* options.
*
* @par Constraints
@@ -621,8 +621,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* stack of each IDLE task configured for this application.
*
* @par Notes
* The task stack allocator allocate hook for idle tasks is defined by the
* #CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE application configuration option.
* The task stack allocator allocate hook for idle tasks is defined by the @ref
* CONFIGURE_TASK_STACK_ALLOCATOR_FOR_IDLE application configuration option.
*
* @par Constraints
* @parblock
@@ -648,8 +648,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* application.
*
* @par Notes
* The task stack allocator allocate hook is defined by the
* #CONFIGURE_TASK_STACK_ALLOCATOR application configuration option.
* The task stack allocator allocate hook is defined by the @ref
* CONFIGURE_TASK_STACK_ALLOCATOR application configuration option.
*
* @par Constraints
* @parblock
@@ -674,8 +674,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* this application.
*
* @par Notes
* The task stack allocator initialization hook is defined by the
* #CONFIGURE_TASK_STACK_ALLOCATOR_INIT application configuration option.
* The task stack allocator initialization hook is defined by the @ref
* CONFIGURE_TASK_STACK_ALLOCATOR_INIT application configuration option.
*
* @par Constraints
* @parblock
@@ -701,8 +701,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* application.
*
* @par Notes
* The task stack allocator free hook is defined by the
* #CONFIGURE_TASK_STACK_DEALLOCATOR application configuration option.
* The task stack allocator free hook is defined by the @ref
* CONFIGURE_TASK_STACK_DEALLOCATOR application configuration option.
*
* @par Constraints
* @parblock
@@ -726,8 +726,8 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* application.
*
* @par Notes
* The clock ticks per timeslice is defined by the
* #CONFIGURE_TICKS_PER_TIMESLICE application configuration option.
* The clock ticks per timeslice is defined by the @ref
* CONFIGURE_TICKS_PER_TIMESLICE application configuration option.
*
* @par Constraints
* @parblock
@@ -753,7 +753,7 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
* configured to be unified for this application, otherwise false.
*
* @par Notes
* The setting is defined by the #CONFIGURE_UNIFIED_WORK_AREAS application
* The setting is defined by the @ref CONFIGURE_UNIFIED_WORK_AREAS application
* configuration option.
*
* @par Constraints

16
cpukit/include/rtems/extension.h
View File

@@ -140,7 +140,7 @@ rtems_status_code rtems_extension_delete( rtems_id id );
* may be in an undefined and corrupt state.
*
* It is recommended to register fatal extensions through initial extension
* sets, see #CONFIGURE_INITIAL_EXTENSIONS.
* sets, see @ref CONFIGURE_INITIAL_EXTENSIONS.
* @endparblock
*/
typedef User_extensions_fatal_extension rtems_fatal_extension;
@@ -230,7 +230,7 @@ rtems_status_code rtems_extension_ident( rtems_name name, rtems_id *id );
* @ingroup RTEMSAPIClassicUserExt
*
* @brief The extensions table contains a set of extensions which may be
* registered in the system through the #CONFIGURE_INITIAL_EXTENSIONS
* registered in the system through the @ref CONFIGURE_INITIAL_EXTENSIONS
* application configuration option or the rtems_extension_create()
* directive.
*/
@@ -271,8 +271,8 @@ typedef User_extensions_Table rtems_extensions_table;
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create an
* extension set. The number of extension sets available to the application
* is configured through the #CONFIGURE_MAXIMUM_USER_EXTENSIONS application
* configuration option.
* is configured through the @ref CONFIGURE_MAXIMUM_USER_EXTENSIONS
* application configuration option.
*
* @par Notes
* @parblock
@@ -286,8 +286,8 @@ typedef User_extensions_Table rtems_extensions_table;
* are invoked upon the next system event supporting an extension.
*
* An alternative to dynamically created extension sets are initial extensions,
* see #CONFIGURE_INITIAL_EXTENSIONS. Initial extensions are recommended for
* extension sets which provide a fatal error extension.
* see @ref CONFIGURE_INITIAL_EXTENSIONS. Initial extensions are recommended
* for extension sets which provide a fatal error extension.
*
* For control and maintenance of the extension set, RTEMS allocates a ESCB
* from the local ESCB free pool and initializes it.
@@ -306,8 +306,8 @@ typedef User_extensions_Table rtems_extensions_table;
* cause the calling task to be preempted.
*
* * The number of extension sets available to the application is configured
* through the #CONFIGURE_MAXIMUM_USER_EXTENSIONS application configuration
* option.
* through the @ref CONFIGURE_MAXIMUM_USER_EXTENSIONS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_extension_create(

4
cpukit/include/rtems/io.h
View File

@@ -98,7 +98,7 @@ typedef rtems_status_code rtems_device_driver;
*
* @par Notes
* The major number of a device is determined by rtems_io_register_driver() and
* the application configuration (see #CONFIGURE_MAXIMUM_DRIVERS) .
* the application configuration (see @ref CONFIGURE_MAXIMUM_DRIVERS) .
*/
typedef uint32_t rtems_device_major_number;
@@ -207,7 +207,7 @@ typedef struct {
* @retval ::RTEMS_INVALID_ADDRESS The device driver address table was empty.
*
* @retval ::RTEMS_INVALID_NUMBER The device major number of the device was out
* of range, see #CONFIGURE_MAXIMUM_DRIVERS.
* of range, see @ref CONFIGURE_MAXIMUM_DRIVERS.
*
* @retval ::RTEMS_TOO_MANY The system was unable to obtain a device major
* number.

4
cpukit/include/rtems/rtems/barrier.h
View File

@@ -137,7 +137,7 @@ extern "C" {
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* barrier. The number of barriers available to the application is
* configured through the #CONFIGURE_MAXIMUM_BARRIERS application
* configured through the @ref CONFIGURE_MAXIMUM_BARRIERS application
* configuration option.
*
* @par Notes
@@ -157,7 +157,7 @@ extern "C" {
* cause the calling task to be preempted.
*
* * The number of barriers available to the application is configured through
* the #CONFIGURE_MAXIMUM_BARRIERS application configuration option.
* the @ref CONFIGURE_MAXIMUM_BARRIERS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS

8
cpukit/include/rtems/rtems/clock.h
View File

@@ -116,8 +116,8 @@ struct bintime;
* before 2100-01-01:00:00.000000000Z. The latest valid time of day accepted
* by the POSIX clock_settime() is 2400-01-01T00:00:00.999999999Z.
*
* The specified time is based on the configured clock tick rate, see the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
* The specified time is based on the configured clock tick rate, see the @ref
* CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* Setting the time forward will fire all CLOCK_REALTIME timers which are
* scheduled at a time point before or at the time set by the directive. This
@@ -853,8 +853,8 @@ rtems_status_code rtems_clock_get_seconds_since_epoch(
* application.
*
* @par Notes
* The number of clock ticks per second is defined indirectly by the
* #CONFIGURE_MICROSECONDS_PER_TICK configuration option.
* The number of clock ticks per second is defined indirectly by the @ref
* CONFIGURE_MICROSECONDS_PER_TICK configuration option.
*
* @par Constraints
* @parblock

60
cpukit/include/rtems/rtems/config.h
View File

@@ -80,7 +80,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Tasks
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_TASKS.
* See @ref CONFIGURE_MAXIMUM_TASKS.
*/
uint32_t maximum_tasks;
@@ -94,7 +94,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Timers
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_TIMERS.
* See @ref CONFIGURE_MAXIMUM_TIMERS.
*/
uint32_t maximum_timers;
@@ -102,7 +102,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Semaphores
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_SEMAPHORES.
* See @ref CONFIGURE_MAXIMUM_SEMAPHORES.
*/
uint32_t maximum_semaphores;
@@ -110,7 +110,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Message Queues
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_MESSAGE_QUEUES.
* See @ref CONFIGURE_MAXIMUM_MESSAGE_QUEUES.
*/
uint32_t maximum_message_queues;
@@ -118,7 +118,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Partitions
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_PARTITIONS.
* See @ref CONFIGURE_MAXIMUM_PARTITIONS.
*/
uint32_t maximum_partitions;
@@ -126,7 +126,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Regions
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_REGIONS.
* See @ref CONFIGURE_MAXIMUM_REGIONS.
*/
uint32_t maximum_regions;
@@ -134,7 +134,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Dual-Ported
* Memories configured for this application.
*
* See #CONFIGURE_MAXIMUM_PORTS.
* See @ref CONFIGURE_MAXIMUM_PORTS.
*/
uint32_t maximum_ports;
@@ -142,7 +142,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Rate Monotonic
* Periods configured for this application.
*
* See #CONFIGURE_MAXIMUM_PERIODS.
* See @ref CONFIGURE_MAXIMUM_PERIODS.
*/
uint32_t maximum_periods;
@@ -150,7 +150,7 @@ typedef struct {
* @brief This member contains the maximum number of Classic API Barriers
* configured for this application.
*
* See #CONFIGURE_MAXIMUM_BARRIERS.
* See @ref CONFIGURE_MAXIMUM_BARRIERS.
*/
uint32_t maximum_barriers;
@@ -158,7 +158,7 @@ typedef struct {
* @brief This member contains the number of Classic API Initialization Tasks
* configured for this application.
*
* See #CONFIGURE_RTEMS_INIT_TASKS_TABLE.
* See @ref CONFIGURE_RTEMS_INIT_TASKS_TABLE.
*/
uint32_t number_of_initialization_tasks;
@@ -166,7 +166,7 @@ typedef struct {
* @brief This member contains the pointer to Classic API Initialization Tasks
* Table of this application.
*
* See #CONFIGURE_RTEMS_INIT_TASKS_TABLE.
* See @ref CONFIGURE_RTEMS_INIT_TASKS_TABLE.
*/
const rtems_initialization_tasks_table *User_initialization_tasks_table;
} rtems_api_configuration_table;
@@ -183,7 +183,7 @@ typedef struct {
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_BARRIERS
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_BARRIERS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
@@ -210,7 +210,7 @@ uint32_t rtems_configuration_get_maximum_barriers( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_MESSAGE_QUEUES
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_MESSAGE_QUEUES
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
@@ -237,7 +237,7 @@ uint32_t rtems_configuration_get_maximum_message_queues( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_PARTITIONS
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_PARTITIONS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
@@ -264,9 +264,9 @@ uint32_t rtems_configuration_get_maximum_partitions( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_PERIODS application
* configuration option. See also rtems_resource_is_unlimited() and
* rtems_resource_maximum_per_allocation().
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_PERIODS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
* @par Constraints
* @parblock
@@ -291,9 +291,9 @@ uint32_t rtems_configuration_get_maximum_periods( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_PORTS application
* configuration option. See also rtems_resource_is_unlimited() and
* rtems_resource_maximum_per_allocation().
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_PORTS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
* @par Constraints
* @parblock
@@ -318,9 +318,9 @@ uint32_t rtems_configuration_get_maximum_ports( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_REGIONS application
* configuration option. See also rtems_resource_is_unlimited() and
* rtems_resource_maximum_per_allocation().
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_REGIONS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
* @par Constraints
* @parblock
@@ -345,7 +345,7 @@ uint32_t rtems_configuration_get_maximum_regions( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_SEMAPHORES
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_SEMAPHORES
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
@@ -372,9 +372,9 @@ uint32_t rtems_configuration_get_maximum_semaphores( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_TASKS application
* configuration option. See also rtems_resource_is_unlimited() and
* rtems_resource_maximum_per_allocation().
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_TASKS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
* @par Constraints
* @parblock
@@ -399,9 +399,9 @@ uint32_t rtems_configuration_get_maximum_tasks( void );
* configured for this application.
*
* @par Notes
* The resource number is defined by the #CONFIGURE_MAXIMUM_TIMERS application
* configuration option. See also rtems_resource_is_unlimited() and
* rtems_resource_maximum_per_allocation().
* The resource number is defined by the @ref CONFIGURE_MAXIMUM_TIMERS
* application configuration option. See also rtems_resource_is_unlimited()
* and rtems_resource_maximum_per_allocation().
*
* @par Constraints
* @parblock

4
cpukit/include/rtems/rtems/dpmem.h
View File

@@ -114,7 +114,7 @@ extern "C" {
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* port. The number of port available to the application is configured
* through the #CONFIGURE_MAXIMUM_PORTS application configuration option.
* through the @ref CONFIGURE_MAXIMUM_PORTS application configuration option.
*
* @par Notes
* @parblock
@@ -138,7 +138,7 @@ extern "C" {
* cause the calling task to be preempted.
*
* * The number of ports available to the application is configured through the
* #CONFIGURE_MAXIMUM_PORTS application configuration option.
* @ref CONFIGURE_MAXIMUM_PORTS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS

28
cpukit/include/rtems/rtems/message.h
View File

@@ -212,14 +212,14 @@ typedef struct {
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* message queue. The number of message queue available to the application
* is configured through the #CONFIGURE_MAXIMUM_MESSAGE_QUEUES application
* configuration option.
* is configured through the @ref CONFIGURE_MAXIMUM_MESSAGE_QUEUES
* application configuration option.
*
* @retval ::RTEMS_TOO_MANY In multiprocessing configurations, there was no
* inactive global object available to create a global message queue. The
* number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
*
* @retval ::RTEMS_INVALID_NUMBER The product of ``count`` and
* ``max_message_size`` is greater than the maximum storage size.
@@ -260,16 +260,16 @@ typedef struct {
* message to remote nodes. This may preempt the calling task.
*
* * The number of message queues available to the application is configured
* through the #CONFIGURE_MAXIMUM_MESSAGE_QUEUES application configuration
* option.
* through the @ref CONFIGURE_MAXIMUM_MESSAGE_QUEUES application
* configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
* Workspace.
*
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_message_queue_create(
@@ -342,8 +342,8 @@ rtems_status_code rtems_message_queue_create(
* runtime memory allocators. This can simplify the application architecture
* as well as any analysis that may be required.
*
* The value for #CONFIGURE_MESSAGE_BUFFER_MEMORY should not include memory for
* message queues constructed by rtems_message_queue_construct().
* The value for @ref CONFIGURE_MESSAGE_BUFFER_MEMORY should not include memory
* for message queues constructed by rtems_message_queue_construct().
* @endparblock
*
* @par Constraints
@@ -362,16 +362,16 @@ rtems_status_code rtems_message_queue_create(
* message to remote nodes. This may preempt the calling task.
*
* * The number of message queues available to the application is configured
* through the #CONFIGURE_MAXIMUM_MESSAGE_QUEUES application configuration
* option.
* through the @ref CONFIGURE_MAXIMUM_MESSAGE_QUEUES application
* configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
* Workspace.
*
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_message_queue_construct(

10
cpukit/include/rtems/rtems/part.h
View File

@@ -168,13 +168,13 @@ extern "C" {
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* partition. The number of partitions available to the application is
* configured through the #CONFIGURE_MAXIMUM_PARTITIONS application
* configured through the @ref CONFIGURE_MAXIMUM_PARTITIONS application
* configuration option.
*
* @retval ::RTEMS_TOO_MANY In multiprocessing configurations, there was no
* inactive global object available to create a global semaphore. The number
* of global objects available to the application is configured through the
* #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option.
* @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option.
*
* @par Notes
* @parblock
@@ -220,7 +220,7 @@ extern "C" {
* message to remote nodes. This may preempt the calling task.
*
* * The number of partitions available to the application is configured
* through the #CONFIGURE_MAXIMUM_PARTITIONS application configuration
* through the @ref CONFIGURE_MAXIMUM_PARTITIONS application configuration
* option.
*
* * Where the object class corresponding to the directive is configured to use
@@ -228,8 +228,8 @@ extern "C" {
* Workspace.
*
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_partition_create(

5
cpukit/include/rtems/rtems/ratemon.h
View File

@@ -245,7 +245,8 @@ struct rtems_printer;
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* period. The number of periods available to the application is configured
* through the #CONFIGURE_MAXIMUM_PERIODS application configuration option.
* through the @ref CONFIGURE_MAXIMUM_PERIODS application configuration
* option.
*
* @par Notes
* @parblock
@@ -269,7 +270,7 @@ struct rtems_printer;
* cause the calling task to be preempted.
*
* * The number of periods available to the application is configured through
* the #CONFIGURE_MAXIMUM_PERIODS application configuration option.
* the @ref CONFIGURE_MAXIMUM_PERIODS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS

5
cpukit/include/rtems/rtems/region.h
View File

@@ -195,7 +195,8 @@ rtems_status_code rtems_region_get_segment_size(
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* region. The number of regions available to the application is configured
* through the #CONFIGURE_MAXIMUM_REGIONS application configuration option.
* through the @ref CONFIGURE_MAXIMUM_REGIONS application configuration
* option.
*
* @retval ::RTEMS_INVALID_SIZE The ``page_size`` parameter was invalid.
*
@@ -219,7 +220,7 @@ rtems_status_code rtems_region_get_segment_size(
* cause the calling task to be preempted.
*
* * The number of regions available to the application is configured through
* the #CONFIGURE_MAXIMUM_REGIONS application configuration option.
* the @ref CONFIGURE_MAXIMUM_REGIONS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS

4
cpukit/include/rtems/rtems/scheduler.h
View File

@@ -383,8 +383,8 @@ uint32_t rtems_scheduler_get_processor( void );
*
* Where the system was built with SMP support enabled, this directive returns
* the minimum of the processors (physically or virtually) available at the
* target and the configured processor maximum (see
* #CONFIGURE_MAXIMUM_PROCESSORS). Not all processors in the range from
* target and the configured processor maximum (see @ref
* CONFIGURE_MAXIMUM_PROCESSORS). Not all processors in the range from
* processor index zero to the last processor index (which is the processor
* maximum minus one) may be configured to be used by a scheduler or may be
* online (online processors have a scheduler assigned).

10
cpukit/include/rtems/rtems/sem.h
View File

@@ -203,13 +203,13 @@ extern "C" {
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* semaphore. The number of semaphores available to the application is
* configured through the #CONFIGURE_MAXIMUM_SEMAPHORES application
* configured through the @ref CONFIGURE_MAXIMUM_SEMAPHORES application
* configuration option.
*
* @retval ::RTEMS_TOO_MANY In multiprocessing configurations, there was no
* inactive global object available to create a global semaphore. The number
* of global objects available to the application is configured through the
* #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option.
* @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option.
*
* @retval ::RTEMS_INVALID_PRIORITY The ``priority_ceiling`` parameter was
* invalid.
@@ -243,7 +243,7 @@ extern "C" {
* message to remote nodes. This may preempt the calling task.
*
* * The number of semaphores available to the application is configured
* through the #CONFIGURE_MAXIMUM_SEMAPHORES application configuration
* through the @ref CONFIGURE_MAXIMUM_SEMAPHORES application configuration
* option.
*
* * Where the object class corresponding to the directive is configured to use
@@ -251,8 +251,8 @@ extern "C" {
* Workspace.
*
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_semaphore_create(

8
cpukit/include/rtems/rtems/support.h
View File

@@ -115,8 +115,8 @@ static inline bool rtems_is_name_valid( rtems_name name )
* value.
*
* @par Notes
* The number of clock ticks per second is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
* The number of clock ticks per second is defined by the @ref
* CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock
@@ -166,8 +166,8 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @return Returns the number of clock ticks for the milliseconds value.
*
* @par Notes
* The number of clock ticks per second is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
* The number of clock ticks per second is defined by the @ref
* CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock

49
cpukit/include/rtems/rtems/tasks.h
View File

@@ -160,8 +160,8 @@ typedef struct {
* alignment of an application executable.
*
* The application may configure the maximum thread-local storage size for all
* threads explicitly through the #CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
* configuration option.
* threads explicitly through the @ref
* CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE configuration option.
*/
size_t maximum_thread_local_storage_size;
@@ -325,8 +325,8 @@ rtems_task_priority _RTEMS_Maximum_priority( void );
* 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 (see #CONFIGURE_MINIMUM_TASK_STACK_SIZE) is larger than
* the recommended minimum, then it will be used.
* minimum stack size (see @ref CONFIGURE_MINIMUM_TASK_STACK_SIZE) is larger
* than the recommended minimum, then it will be used.
*/
#define RTEMS_MINIMUM_STACK_SIZE STACK_MINIMUM_SIZE
@@ -454,8 +454,8 @@ typedef bool( *rtems_task_visitor )( rtems_tcb *, void * );
* The **stack size** of the task is specified in ``stack_size``. If the
* requested stack size is less than the configured minimum stack size, then
* RTEMS will use the configured minimum as the stack size for this task. The
* configured minimum stack size is defined by the
* #CONFIGURE_MINIMUM_TASK_STACK_SIZE application configuration option. In
* configured minimum stack size is defined by the @ref
* CONFIGURE_MINIMUM_TASK_STACK_SIZE application configuration option. In
* addition to being able to specify the task stack size as a integer, there
* are two constants which may be specified:
*
@@ -583,12 +583,12 @@ typedef bool( *rtems_task_visitor )( rtems_tcb *, void * );
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* task. The number of tasks available to the application is configured
* through the #CONFIGURE_MAXIMUM_TASKS application configuration option.
* through the @ref CONFIGURE_MAXIMUM_TASKS application configuration option.
*
* @retval ::RTEMS_TOO_MANY In multiprocessing configurations, there was no
* inactive global object available to create a global task. The number of
* global objects available to the application is configured through the
* #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option.
* global objects available to the application is configured through the @ref
* CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option.
*
* @retval ::RTEMS_UNSATISFIED There was not enough memory to allocate the task
* storage area. The task storage area contains the task stack, the
@@ -615,7 +615,7 @@ typedef bool( *rtems_task_visitor )( rtems_tcb *, void * );
* The task stack size shall account for an target processor dependent
* interrupt stack frame which may be placed on the stack of the interrupted
* task while servicing an interrupt. The stack checker may be used to monitor
* the stack usage, see #CONFIGURE_STACK_CHECKER_ENABLED.
* the stack usage, see @ref CONFIGURE_STACK_CHECKER_ENABLED.
*
* For control and maintenance of the task, RTEMS allocates a TCB from the
* local TCB free pool and initializes it.
@@ -644,15 +644,15 @@ typedef bool( *rtems_task_visitor )( rtems_tcb *, void * );
* message to remote nodes. This may preempt the calling task.
*
* * The number of tasks available to the application is configured through the
* #CONFIGURE_MAXIMUM_TASKS application configuration option.
* @ref CONFIGURE_MAXIMUM_TASKS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
* Workspace.
*
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_task_create(
@@ -690,12 +690,13 @@ rtems_status_code rtems_task_create(
* @retval ::RTEMS_INVALID_SIZE The thread-local storage size is greater than
* the maximum thread-local storage size specified in the task configuration.
* The thread-local storage size is determined by the thread-local variables
* used by the application and #CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE.
* used by the application and @ref
* CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE.
*
* @retval ::RTEMS_INVALID_SIZE The task storage area was too small to provide
* a task stack of the configured minimum size, see
* #CONFIGURE_MINIMUM_TASK_STACK_SIZE. The task storage area contains the
* task stack, the thread-local storage, and the floating-point context on
* a task stack of the configured minimum size, see @ref
* CONFIGURE_MINIMUM_TASK_STACK_SIZE. The task storage area contains the task
* stack, the thread-local storage, and the floating-point context on
* architectures with a separate floating-point context.
*
* @retval ::RTEMS_TOO_MANY There was no inactive task object available to
@@ -736,11 +737,11 @@ rtems_status_code rtems_task_create(
*
* The stack space estimate done by <rtems/confdefs.h> assumes that all tasks
* are created by rtems_task_create(). The estimate can be adjusted to take
* user-provided task storage areas into account through the
* #CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE application
* configuration option.
* user-provided task storage areas into account through the @ref
* CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE application configuration
* option.
*
* The #CONFIGURE_MAXIMUM_TASKS should include tasks constructed by
* The @ref CONFIGURE_MAXIMUM_TASKS should include tasks constructed by
* rtems_task_construct().
* @endparblock
*
@@ -760,15 +761,15 @@ rtems_status_code rtems_task_create(
* message to remote nodes. This may preempt the calling task.
*
* * The number of tasks available to the application is configured through the
* #CONFIGURE_MAXIMUM_TASKS application configuration option.
* @ref CONFIGURE_MAXIMUM_TASKS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
* Workspace.
*
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
* through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application
* configuration option.
* @endparblock
*/
rtems_status_code rtems_task_construct(

7
cpukit/include/rtems/rtems/timer.h
View File

@@ -284,7 +284,8 @@ typedef rtems_timer_service_routine ( *rtems_timer_service_routine_entry )( rtem
*
* @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
* timer. The number of timers available to the application is configured
* through the #CONFIGURE_MAXIMUM_TIMERS application configuration option.
* through the @ref CONFIGURE_MAXIMUM_TIMERS application configuration
* option.
*
* @par Notes
* @parblock
@@ -308,7 +309,7 @@ typedef rtems_timer_service_routine ( *rtems_timer_service_routine_entry )( rtem
* cause the calling task to be preempted.
*
* * The number of timers available to the application is configured through
* the #CONFIGURE_MAXIMUM_TIMERS application configuration option.
* the @ref CONFIGURE_MAXIMUM_TIMERS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
@@ -600,7 +601,7 @@ rtems_status_code rtems_timer_fire_when(
* * The directive may be called from within task context.
*
* * The number of timers available to the application is configured through
* the #CONFIGURE_MAXIMUM_TIMERS application configuration option.
* the @ref CONFIGURE_MAXIMUM_TIMERS application configuration option.
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS