From fb36c32ff79658cf002784f32b7b075f8390bef6 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 11 Aug 2022 09:41:51 +0200 Subject: appl-config.h: Regenerate --- cpukit/doxygen/appl-config.h | 1375 +++++++++++++++++++----------------------- 1 file changed, 615 insertions(+), 760 deletions(-) diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index 71e7dc43f3..358eae14ac 100644 --- a/cpukit/doxygen/appl-config.h +++ b/cpukit/doxygen/appl-config.h @@ -1,18 +1,9 @@ /* SPDX-License-Identifier: BSD-2-Clause */ -/** - * @file - * - * @ingroup RTEMSApplConfig - * - * @brief This header file provides interfaces of the - * application configuration - */ - /* * Copyright (C) 2019, 2022 embedded brains GmbH (http://www.embedded-brains.de) * Copyright (C) 2010 Gedare Bloom - * Copyright (C) 1988, 2021 On-Line Applications Research Corporation (OAR) + * Copyright (C) 1988, 2022 On-Line Applications Research Corporation (OAR) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -103,14 +94,15 @@ * @par Default Value * The default value is 4096. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be an integral multiple of #CONFIGURE_BDBUF_BUFFER_MIN_SIZE. + * * The value of the configuration option shall be an integral multiple of + * #CONFIGURE_BDBUF_BUFFER_MIN_SIZE. * @endparblock */ #define CONFIGURE_BDBUF_BUFFER_MAX_SIZE @@ -126,14 +118,14 @@ * @par Default Value * The default value is 512. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock */ @@ -150,14 +142,14 @@ * @par Default Value * The default value is 32768. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to SIZE_MAX. * @endparblock */ @@ -174,14 +166,14 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock * @@ -203,14 +195,14 @@ * @par Default Value * The default value is 16. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock */ @@ -226,8 +218,8 @@ * @par Default Value * The default value is 15. * - * @par Value Constraints - * The value of this configuration option shall be a valid Classic API task + * @par 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. */ @@ -244,19 +236,20 @@ * @par Default Value * The default value is #RTEMS_MINIMUM_STACK_SIZE. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE. + * * The value of the configuration option shall be greater than or equal to + * #CONFIGURE_MINIMUM_TASK_STACK_SIZE. * - * * 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. + * * The value of the configuration option 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 ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * @endparblock */ @@ -273,14 +266,14 @@ * @par Default Value * The default value is 1000. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock */ @@ -297,14 +290,14 @@ * @par Default Value * The default value is 250. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock */ @@ -320,8 +313,8 @@ * @par Default Value * The default value is 15. * - * @par Value Constraints - * The value of this configuration option shall be a valid Classic API task + * @par 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. */ @@ -338,14 +331,14 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock */ @@ -362,8 +355,8 @@ * @par Default Value * The default value is 15. * - * @par Value Constraints - * The value of this configuration option shall be a valid Classic API task + * @par 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. */ @@ -371,225 +364,6 @@ /** @} */ -/* Generated from spec:/acfg/if/group-bsp */ - -/** - * @defgroup RTEMSApplConfigBSPRelatedConfigurationOptions \ - * BSP Related Configuration Options - * - * @ingroup RTEMSApplConfig - * - * This section describes configuration options related to the BSP. Some - * configuration options may have a BSP-specific setting which is defined by - * ````. The BSP-specific settings can be disabled by the - * #CONFIGURE_DISABLE_BSP_SETTINGS configuration option. - * - * @{ - */ - -/* Generated from spec:/acfg/if/bsp-idle-task-body */ - -/** - * @brief This configuration option is an initializer define. - * - * If - * - * * this configuration option is defined by the BSP - * - * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined, - * - * then the value of this configuration option defines the default value of - * #CONFIGURE_IDLE_TASK_BODY. - * - * @par Default Value - * The default value is BSP-specific. - * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function - * pointer of the type ``void *( *idle_body )( uintptr_t )``. - * - * @par Notes - * As it has knowledge of the specific CPU model, system controller logic, and - * peripheral buses, a BSP-specific IDLE task may be capable of turning - * components off to save power during extended periods of no task activity. - */ -#define BSP_IDLE_TASK_BODY - -/* Generated from spec:/acfg/if/bsp-idle-task-stack-size */ - -/** - * @brief This configuration option is an integer define. - * - * If - * - * * this configuration option is defined by the BSP - * - * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined, - * - * then the value of this configuration option defines the default value of - * #CONFIGURE_IDLE_TASK_STACK_SIZE. - * - * @par Default Value - * The default value is BSP-specific. - * - * @par Value Constraints - * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: - * - * * It shall be greater than or equal to a BSP-specific and - * application-specific minimum value. - * - * * It shall be small enough so that the IDLE task stack area calculation - * carried out by ```` does not overflow an integer of type - * size_t. - * @endparblock - */ -#define BSP_IDLE_TASK_STACK_SIZE - -/* Generated from spec:/acfg/if/bsp-initial-extension */ - -/** - * @brief This configuration option is an initializer define. - * - * If - * - * * this configuration option is defined by the BSP - * - * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined, - * - * then the value of this configuration option is used to initialize the table - * of initial user extensions. - * - * @par Default Value - * The default value is BSP-specific. - * - * @par Value Constraints - * The value of this configuration option shall be a list of initializers for - * structures of type ::rtems_extensions_table. - * - * @par Notes - * The value of this configuration option is placed after the entries of all - * other initial user extensions. - */ -#define BSP_INITIAL_EXTENSION - -/* Generated from spec:/acfg/if/bsp-interrupt-stack-size */ - -/** - * @brief This configuration option is an integer define. - * - * If - * - * * this configuration option is defined by the BSP - * - * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined, - * - * then the value of this configuration option defines the default value of - * #CONFIGURE_INTERRUPT_STACK_SIZE. - * - * @par Default Value - * The default value is BSP-specific. - * - * @par Value Constraints - * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: - * - * * It shall be greater than or equal to a BSP-specific and - * application-specific minimum value. - * - * * It shall be small enough so that the interrupt stack area calculation - * carried out by ```` does not overflow an integer of type - * size_t. - * - * * It shall be aligned according to #CPU_INTERRUPT_STACK_ALIGNMENT. - * @endparblock - */ -#define BSP_INTERRUPT_STACK_SIZE - -/* Generated from spec:/acfg/if/bsp-prerequisite-drivers */ - -/** - * @brief This configuration option is an initializer define. - * - * If - * - * * this configuration option is defined by the BSP - * - * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined, - * - * then the value of this configuration option is used to add BSP-provided - * prerequisite drivers to the Device Driver Table. - * - * @par Default Value - * The default value is BSP-specific. - * - * @par Value Constraints - * The value of this configuration option shall be a list of initializers for - * structures of type ::rtems_extensions_table. - * - * @par Notes - * The value of this configuration option is placed before the entries of all - * other initial user extensions (including - * #CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS). - */ -#define CONFIGURE_BSP_PREREQUISITE_DRIVERS - -/* Generated from spec:/acfg/if/disable-bsp-settings */ - -/** - * @brief This configuration option is a boolean feature define. - * - * In case this configuration option is defined, then the following BSP related - * configuration options are undefined: - * - * * #BSP_IDLE_TASK_BODY - * - * * #BSP_IDLE_TASK_STACK_SIZE - * - * * #BSP_INITIAL_EXTENSION - * - * * #BSP_INTERRUPT_STACK_SIZE - * - * * #CONFIGURE_BSP_PREREQUISITE_DRIVERS - * - * * #CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK - * - * @par Default Configuration - * If this configuration option is undefined, then the described feature is not - * enabled. - */ -#define CONFIGURE_DISABLE_BSP_SETTINGS - -/* Generated from spec:/acfg/if/malloc-bsp-supports-sbrk */ - -/** - * @brief This configuration option is a boolean feature define. - * - * If - * - * * this configuration option is defined by the BSP - * - * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined, - * - * then not all memory is made available to the C Program Heap immediately at - * system initialization time. When malloc() or other standard memory - * allocation functions are unable to allocate memory, they will call the BSP - * supplied sbrk() function to obtain more memory. - * - * @par Default Configuration - * If this configuration option is undefined, then the described feature is not - * enabled. - * - * @par Notes - * This option should not be defined by the application. Only the BSP knows how - * it allocates memory to the C Program Heap. - */ -#define CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK - -/** @} */ - /* Generated from spec:/acfg/if/group-classic */ /** @@ -613,23 +387,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -650,23 +425,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -688,23 +464,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -725,23 +502,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -762,23 +540,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -799,23 +578,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -836,23 +616,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -882,27 +663,29 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * - * * It may be defined through rtems_resource_unlimited() the enable unlimited - * objects for the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -940,17 +723,18 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to SIZE_MAX. * - * * It shall be an integral multiple of #RTEMS_TASK_STORAGE_ALIGNMENT. + * * The value of the configuration option shall be an integral multiple of + * #RTEMS_TASK_STORAGE_ALIGNMENT. * @endparblock * * @par Notes @@ -985,23 +769,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -1022,18 +807,19 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -1052,14 +838,15 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to #CONFIGURE_MAXIMUM_TASKS. + * * The value of the configuration option shall be less than or equal to + * #CONFIGURE_MAXIMUM_TASKS. * @endparblock * * @par Notes @@ -1098,8 +885,8 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints - * The value of this configuration option shall be convertible to an integer of + * @par Constraints + * The value of the configuration option shall be convertible to an integer of * type ::rtems_task_argument. */ #define CONFIGURE_INIT_TASK_ARGUMENTS @@ -1115,8 +902,8 @@ * @par Default Value * The default value is #RTEMS_DEFAULT_ATTRIBUTES. * - * @par Value Constraints - * The value of this configuration option shall be a valid task attribute set. + * @par Constraints + * The value of the configuration option shall be a valid task attribute set. */ #define CONFIGURE_INIT_TASK_ATTRIBUTES @@ -1133,14 +920,15 @@ * then the Classic API initialization task will be created with the stack size * defined by the #CONFIGURE_INIT_TASK_STACK_SIZE configuration option. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE. + * * The value of the configuration option shall be greater than or equal to + * #CONFIGURE_MINIMUM_TASK_STACK_SIZE. * - * * It shall be defined using RTEMS_TASK_STORAGE_SIZE(). + * * The value of the configuration option shall be defined using + * RTEMS_TASK_STORAGE_SIZE(). * @endparblock * * @par Notes @@ -1185,8 +973,8 @@ * @par Default Value * The default value is ``Init``. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void ( *entry_point )( rtems_task_argument )``. * * @par Notes @@ -1207,8 +995,8 @@ * In SMP configurations, the default value is #RTEMS_DEFAULT_MODES otherwise * the default value is #RTEMS_NO_PREEMPT. * - * @par Value Constraints - * The value of this configuration option shall be a valid task mode set. + * @par Constraints + * The value of the configuration option shall be a valid task mode set. */ #define CONFIGURE_INIT_TASK_INITIAL_MODES @@ -1223,8 +1011,8 @@ * @par Default Value * The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``. * - * @par Value Constraints - * The value of this configuration option shall be convertible to an integer of + * @par Constraints + * The value of the configuration option shall be convertible to an integer of * type ::rtems_name. * * @par Notes @@ -1243,8 +1031,8 @@ * @par Default Value * The default value is 1. * - * @par Value Constraints - * The value of this configuration option shall be a valid Classic API task + * @par 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. */ @@ -1261,15 +1049,16 @@ * @par Default Value * The default value is #CONFIGURE_MINIMUM_TASK_STACK_SIZE. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE. + * * The value of the configuration option shall be greater than or equal to + * #CONFIGURE_MINIMUM_TASK_STACK_SIZE. * - * * It shall be small enough so that the task stack space calculation carried - * out by ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * @endparblock * @@ -1373,8 +1162,8 @@ * @par Default Value * The default value is the empty list. * - * @par Value Constraints - * The value of this configuration option shall be a list of initializers for + * @par Constraints + * The value of the configuration option shall be a list of initializers for * structures of type ::rtems_driver_address_table. * * @par Notes @@ -1745,8 +1534,8 @@ * @par Default Value * The default value is the empty list. * - * @par Value Constraints - * The value of this configuration option shall be a list of initializers for + * @par Constraints + * The value of the configuration option shall be a list of initializers for * structures of type ::rtems_driver_address_table. * * @par Notes @@ -1771,8 +1560,8 @@ * @par Default Value * The default value is 140. * - * @par Value Constraints - * The value of this configuration option shall be a valid Classic API task + * @par 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. * @@ -1850,23 +1639,24 @@ * * * #CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS * - * * #CONFIGURE_BSP_PREREQUISITE_DRIVERS + * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined + * and the BSP provides #CONFIGURE_BSP_PREREQUISITE_DRIVERS, then the + * BSP-provided prerequisite device drivers are also taken into account. * @endparblock * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be less than or equal to SIZE_MAX. * - * * It shall be greater than or equal than the number of statically configured - * device drivers. + * * The value of the configuration option shall be greater than or equal than + * the number of statically configured device drivers. * - * * 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -1978,21 +1768,21 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to 16. + * * The value of the configuration option shall be greater than or equal to + * 16. * - * * It shall be less than or equal to SIZE_MAX. * - * * It shall be a power of two. + * * The value of the configuration option shall be a power of two. * - * * 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -2445,8 +2235,8 @@ * @par Default Value * The default value is 128. * - * @par Value Constraints - * The value of this configuration option shall be equal to 16, 32, 64, 128, + * @par Constraints + * The value of the configuration option shall be equal to 16, 32, 64, 128, * 256, or 512. * * @par Notes @@ -2610,6 +2400,37 @@ */ #define CONFIGURE_DIRTY_MEMORY +/* Generated from spec:/acfg/if/disable-bsp-settings */ + +/** + * @brief This configuration option is a boolean feature define. + * + * In case this configuration option is defined, then the optional BSP provided + * settings listed below are disabled. + * + * The optional BSP provided default values for the following application + * configuration options are disabled: + * + * * #CONFIGURE_IDLE_TASK_BODY + * + * * #CONFIGURE_IDLE_TASK_STACK_SIZE + * + * * #CONFIGURE_INTERRUPT_STACK_SIZE + * + * The optional BSP provided initial extension set is disabled (see initial + * extension sets). The optional BSP provided prerequisite IO device drivers + * are disabled (see Device Driver Configuration). The optional BSP provided + * support for sbrk() is disabled. + * + * This configuration option provides an all or nothing choice with respect to + * the optional BSP provided settings. + * + * @par Default Configuration + * If this configuration option is undefined, then the described feature is not + * enabled. + */ +#define CONFIGURE_DISABLE_BSP_SETTINGS + /* Generated from spec:/acfg/if/disable-newlib-reentrancy */ /** @@ -2643,19 +2464,19 @@ * stack space size is calculated by ```` based on the values * configuration options. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINTPTR_MAX. * - * * 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -2676,15 +2497,16 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be small enough so that the task stack space calculation carried - * out by ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * @endparblock * @@ -2706,8 +2528,8 @@ * @par Default Value * The default value is the empty list. * - * @par Value Constraints - * The value of this configuration option shall be a list of initializers for + * @par Constraints + * The value of the configuration option shall be a list of initializers for * structures of type ::rtems_extensions_table. * * @par Notes @@ -2726,22 +2548,25 @@ * stack in bytes. * * @par Default Value - * The default value is #BSP_INTERRUPT_STACK_SIZE in case it is defined, - * otherwise the default value is #CPU_STACK_MINIMUM_SIZE. + * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined + * and #BSP_INTERRUPT_STACK_SIZE is provided by the BSP, then the default value + * is defined by #BSP_INTERRUPT_STACK_SIZE, otherwise the default value is + * #CPU_STACK_MINIMUM_SIZE. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to a BSP-specific and - * application-specific minimum value. + * * The value of the configuration option shall be greater than or equal to a + * BSP-specific and application-specific minimum value. * - * * It shall be small enough so that the interrupt stack area calculation - * carried out by ```` does not overflow an integer of type - * size_t. + * * The value of the configuration option shall be small enough so that the + * interrupt stack area calculation carried out by ```` + * does not overflow an integer of type size_t. * - * * It shall be aligned according to #CPU_INTERRUPT_STACK_ALIGNMENT. + * * The value of the configuration option shall be aligned according to + * #CPU_INTERRUPT_STACK_ALIGNMENT. * @endparblock * * @par Notes @@ -2797,19 +2622,19 @@ * @par Default Value * The default value is 3. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to SIZE_MAX. * - * * 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -2832,14 +2657,15 @@ * @par Default Value * The default value is 1. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to one. + * * The value of the configuration option shall be greater than or equal to + * one. * - * * It shall be less than or equal to #CPU_MAXIMUM_PROCESSORS. + * * The value of the configuration option shall be less than or equal to + * #CPU_MAXIMUM_PROCESSORS. * @endparblock * * @par Notes @@ -2847,8 +2673,8 @@ * If there are more processors available than configured, the rest will be * ignored. * - * This configuration option is only evaluated in SMP configurations (e.g. - * RTEMS was built with the ``--enable-smp`` build configuration option). In + * This configuration option is only evaluated in SMP configurations of RTEMS + * (e.g. RTEMS was built with the SMP build configuration option enabled). In * all other configurations it has no effect. * @endparblock */ @@ -2865,19 +2691,19 @@ * @par Default Value * The default value is 16. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to SIZE_MAX. * - * * 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -2905,20 +2731,21 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * 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. + * * The value of the configuration option 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 RTEMS Workspace size calculation - * carried out by ```` does not overflow an integer of type - * uintptr_t. + * * The value of the configuration option shall be small enough so that the + * RTEMS Workspace size calculation carried out by ```` + * does not overflow an integer of type uintptr_t. * @endparblock * * @par Notes @@ -2941,20 +2768,21 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * 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. + * * The value of the configuration option 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 RTEMS Workspace size calculation - * carried out by ```` does not overflow an integer of type - * uintptr_t. + * * The value of the configuration option shall be small enough so that the + * RTEMS Workspace size calculation carried out by ```` + * does not overflow an integer of type uintptr_t. * @endparblock * * @par Notes @@ -3033,14 +2861,15 @@ * @par Default Value * The default value is 10000. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to a value defined by the Clock Driver. + * * The value of the configuration option shall be greater than or equal to a + * value defined by the Clock Driver. * - * * It shall be less than or equal to a value defined by the Clock Driver. + * * The value of the configuration option shall be less than or equal to a + * value defined by the Clock Driver. * * * The resulting clock ticks per second should be an integer. * @endparblock @@ -3067,17 +2896,17 @@ * @par Default Value * The default value is #CPU_STACK_MINIMUM_SIZE. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be small enough so that the task stack space calculation carried - * out by ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * - * * It shall be greater than or equal to a BSP-specific and - * application-specific minimum value. + * * The value of the configuration option shall be greater than or equal to a + * BSP-specific and application-specific minimum value. * @endparblock * * @par Notes @@ -3139,14 +2968,14 @@ * @par Default Value * The default value is 50. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock * @@ -3198,8 +3027,8 @@ * @par Default Value * The default value is 8. * - * @par Value Constraints - * The value of this configuration option shall meet the constraints of all + * @par Constraints + * The value of the configuration option shall meet the constraints of all * object classes to which it is applied. * * @par Notes @@ -3300,11 +3129,13 @@ * The value of this configuration option initializes the IDLE thread body. * * @par Default Value - * If #BSP_IDLE_TASK_BODY is defined, then this will be the default value, - * otherwise the default value is ``_CPU_Thread_Idle_body``. + * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined + * and #BSP_IDLE_TASK_BODY is provided by the BSP, then the default value is + * defined by #BSP_IDLE_TASK_BODY, otherwise the default value is + * ``_CPU_Thread_Idle_body``. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void *( *idle_body )( uintptr_t )``. * * @par Notes @@ -3315,6 +3146,11 @@ * * IDLE threads can be used to initialize the application, see configuration * option #CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION. + * + * The BSP may have knowledge of the specific CPU model, system controller + * logic, and peripheral buses, so a BSP-specific IDLE task may be capable of + * turning components off to save power during extended periods of no task + * activity. * @endparblock */ #define CONFIGURE_IDLE_TASK_BODY @@ -3369,19 +3205,22 @@ * IDLE task. * * @par Default Value - * The default value is #CONFIGURE_MINIMUM_TASK_STACK_SIZE. + * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined + * and #BSP_IDLE_TASK_STACK_SIZE is provided by the BSP, then the default value + * is defined by #BSP_IDLE_TASK_STACK_SIZE, otherwise the default value is + * defined by the #CONFIGURE_MINIMUM_TASK_STACK_SIZE configuration option. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to a BSP-specific and - * application-specific minimum value. + * * The value of the configuration option shall be greater than or equal to a + * BSP-specific and application-specific minimum value. * - * * It shall be small enough so that the IDLE task stack area calculation - * carried out by ```` does not overflow an integer of type - * size_t. + * * The value of the configuration option shall be small enough so that the + * IDLE task stack area calculation carried out by ```` + * does not overflow an integer of type size_t. * @endparblock * * @par Notes @@ -3400,12 +3239,13 @@ * * @ingroup RTEMSApplConfig * - * This section describes multiprocessing related configuration options. The - * options are only used if RTEMS was built with the - * ``--enable-multiprocessing`` build configuration option. Additionally, this - * class of configuration options are only applicable if the configuration - * option #CONFIGURE_MP_APPLICATION is defined. The multiprocessing (MPCI) - * support must not be confused with the SMP support. + * This section describes multiprocessing related configuration options. The + * options are only used if RTEMS was built when the multiprocessing build + * configuration option is enabled. The multiprocessing configuration is + * distinct from the SMP configuration. Additionally, this class of + * configuration options are only applicable if the configuration option + * #CONFIGURE_MP_APPLICATION is defined. The multiprocessing (MPCI) support + * must not be confused with the SMP support. * * @{ */ @@ -3422,19 +3262,19 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * - * * It shall be small enough so that the MPCI receive server stack area - * calculation carried out by ```` does not overflow an - * integer of type `` does not overflow an integer of type size_t. * @endparblock * @@ -3459,9 +3299,9 @@ * * @par Notes * This configuration option shall be undefined if the multiprocessing support - * is not enabled (e.g. RTEMS was built without the - * ``--enable-multiprocessing`` build configuration option). Otherwise a - * compile time error in the configuration file will occur. + * is not enabled (e.g. RTEMS was built without the multiprocessing build + * configuration option enabled). Otherwise a compile time error in the + * configuration file will occur. */ #define CONFIGURE_MP_APPLICATION @@ -3476,14 +3316,14 @@ * @par Default Value * The default value is 32. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock * @@ -3509,14 +3349,14 @@ * @par Default Value * The default value is 2. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock * @@ -3538,14 +3378,14 @@ * @par Default Value * The default value is 32. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock * @@ -3573,8 +3413,8 @@ * @par Default Value * The default value is ``&MPCI_table``. * - * @par Value Constraints - * The value of this configuration option shall be a pointer to + * @par Constraints + * The value of the configuration option shall be a pointer to * ::rtems_mpci_table. * * @par Notes @@ -3600,14 +3440,14 @@ * @par Default Value * The default value is ``NODE_NUMBER``. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to UINT32_MAX. * @endparblock * @@ -3635,8 +3475,8 @@ * * This section describes configuration options related to the POSIX API. Most * POSIX API objects are available by default since RTEMS 5.1. The queued - * signals and timers are only available if RTEMS was built with the - * ``--enable-posix`` build configuration option. + * signals and timers are only available if RTEMS was built with the enable + * POSIX build configuration option. * * @{ */ @@ -3652,23 +3492,24 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -3687,26 +3528,27 @@ * value pairs used by POSIX API Keys that can be concurrently active. * * @par Default Value - * The default value is #CONFIGURE_MAXIMUM_POSIX_KEYS * - * #CONFIGURE_MAXIMUM_TASKS + #CONFIGURE_MAXIMUM_POSIX_THREADS. + * The default value is #CONFIGURE_MAXIMUM_POSIX_KEYS * ( + * #CONFIGURE_MAXIMUM_TASKS + #CONFIGURE_MAXIMUM_POSIX_THREADS ). * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -3733,27 +3575,29 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 RTEMS Workspace size calculation - * carried out by ```` does not overflow an integer of type - * uintptr_t. + * * The value of the configuration option shall be small enough so that the + * RTEMS Workspace size calculation carried out by ```` + * does not overflow an integer of type uintptr_t. * - * * It may be defined through rtems_resource_unlimited() the enable unlimited - * objects for the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -3775,32 +3619,34 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * 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. + * * The value of the configuration option 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 RTEMS Workspace size calculation - * carried out by ```` does not overflow an integer of type - * uintptr_t. + * * The value of the configuration option shall be small enough so that the + * RTEMS Workspace size calculation carried out by ```` + * does not overflow an integer of type uintptr_t. * - * * It shall be zero if the POSIX API is not enabled (e.g. RTEMS was built - * without the ``RTEMS_POSIX_API = True`` build configuration option). - * Otherwise a compile time error in the configuration file will occur. + * * The value of the configuration option shall be zero if the POSIX API is + * not enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True`` + * build configuration option). Otherwise a compile time error in the + * configuration file will occur. * @endparblock * * @par Notes * @parblock * Unlimited objects are not available for queued signals. * - * Queued signals are only available if RTEMS was built with the - * ``--enable-posix`` build configuration option. + * Queued signals are only available if RTEMS was built with the POSIX API + * build configuration option enabled. * @endparblock */ #define CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS @@ -3816,27 +3662,29 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 RTEMS Workspace size calculation - * carried out by ```` does not overflow an integer of type - * uintptr_t. + * * The value of the configuration option shall be small enough so that the + * RTEMS Workspace size calculation carried out by ```` + * does not overflow an integer of type uintptr_t. * - * * It may be defined through rtems_resource_unlimited() the enable unlimited - * objects for the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -3863,27 +3711,29 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 RTEMS Workspace size calculation - * carried out by ```` does not overflow an integer of type - * uintptr_t. + * * The value of the configuration option shall be small enough so that the + * RTEMS Workspace size calculation carried out by ```` + * does not overflow an integer of type uintptr_t. * - * * It may be defined through rtems_resource_unlimited() the enable unlimited - * objects for the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * @endparblock * * @par Notes @@ -3904,21 +3754,23 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * @endparblock * @@ -3953,27 +3805,29 @@ * @par Default Value * The default value is 0. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to 65535. + * * The value of the configuration option 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. + * * The value of the configuration option 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 the object class, if the value passed to - * rtems_resource_unlimited() satisfies all other constraints of the - * configuration option. + * * The value of the configuration option may be defined through + * rtems_resource_unlimited() the enable unlimited objects for the object + * class, if the value passed to rtems_resource_unlimited() satisfies all + * other constraints of the configuration option. * - * * It shall be zero if the POSIX API is not enabled (e.g. RTEMS was built - * without the ``RTEMS_POSIX_API = True`` build configuration option). - * Otherwise a compile time error in the configuration file will occur. + * * The value of the configuration option shall be zero if the POSIX API is + * not enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True`` + * build configuration option). Otherwise a compile time error in the + * configuration file will occur. * @endparblock * * @par Notes @@ -3982,8 +3836,8 @@ * href="https://docs.rtems.org/branches/master/c-user/config/intro.html#unlimited-objects">Unlimited * Objects. * - * Timers are only available if RTEMS was built with the ``--enable-posix`` - * build configuration option. + * Timers are only available if RTEMS was built with the POSIX API build + * configuration option enabled. * @endparblock */ #define CONFIGURE_MAXIMUM_POSIX_TIMERS @@ -4000,17 +3854,17 @@ * The default value is two times the value of * #CONFIGURE_MINIMUM_TASK_STACK_SIZE. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be small enough so that the task stack space calculation carried - * out by ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * - * * It shall be greater than or equal to a BSP-specific and - * application-specific minimum value. + * * The value of the configuration option shall be greater than or equal to a + * BSP-specific and application-specific minimum value. * @endparblock */ #define CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE @@ -4042,8 +3896,8 @@ * @par Default Value * The default value is ``POSIX_Init``. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void *( *entry_point )( void * )``. * * @par Notes @@ -4063,15 +3917,16 @@ * @par Default Value * The default value is #CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE. + * * The value of the configuration option shall be greater than or equal to + * #CONFIGURE_MINIMUM_TASK_STACK_SIZE. * - * * It shall be small enough so that the task stack space calculation carried - * out by ```` does not overflow an integer of type `` does + * not overflow an integer of type uintptr_t. * @endparblock */ @@ -4154,19 +4009,19 @@ * @par Default Value * The default value is #CONFIGURE_MAXIMUM_TASKS. * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be greater than or equal to zero. + * * The value of the configuration option shall be greater than or equal to + * zero. * - * * It shall be less than or equal to SIZE_MAX. * - * * 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. + * * The value of the configuration option 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. * @endparblock * * @par Notes @@ -4207,8 +4062,8 @@ * @par Default Value * The default value is 255. * - * @par Value Constraints - * The value of this configuration option shall be equal to 3, 7, 31, 63, 127, + * @par Constraints + * The value of the configuration option shall be equal to 3, 7, 31, 63, 127, * or 255. * * @par Notes @@ -4245,12 +4100,12 @@ * The default value of this configuration option is computed so that the * default scheduler is assigned to each configured processor (up to 32). * - * @par Value Constraints + * @par Constraints * @parblock - * The value of this configuration option shall satisfy all of the following - * constraints: + * The following constraints apply to this configuration option: * - * * It shall be a list of the following macros: + * * The value of the configuration option shall be a list of the following + * macros: * * * ``RTEMS_SCHEDULER_ASSIGN( scheduler_index, attributes )`` * @@ -4414,8 +4269,8 @@ * Priority Scheduler. * @endparblock * - * @par Value Constraints - * The value of this configuration option shall be convertible to an integer of + * @par Constraints + * The value of the configuration option shall be convertible to an integer of * type ::rtems_name. * * @par Notes @@ -4743,8 +4598,8 @@ * The default value is ``_Workspace_Allocate``, which indicates that task * stacks will be allocated from the RTEMS Workspace. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void *( *allocate )( size_t )``. * * @par Notes @@ -4793,8 +4648,8 @@ * indicates that IDLE task stacks will be allocated from an area statically * allocated by ````. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void *( *allocate )( uint32_t, size_t )``. * * @par Notes @@ -4817,8 +4672,8 @@ * The default value is NULL. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void ( *initialize )( size_t )`` or to NULL. * @@ -4848,8 +4703,8 @@ * The default value is ``_Workspace_Free``, which indicates that task stacks * will be allocated from the RTEMS Workspace. * - * @par Value Constraints - * The value of this configuration option shall be defined to a valid function + * @par Constraints + * The value of the configuration option shall be defined to a valid function * pointer of the type ``void ( *deallocate )( void * )``. * * @par Notes @@ -4877,8 +4732,8 @@ * @par Default Value * The default value is a macro which supports the system heap allocator. * - * @par Value Constraints - * The value of this configuration option shall be defined to a macro which + * @par Constraints + * The value of the configuration option shall be defined to a macro which * accepts exactly one parameter and returns an unsigned integer. The * parameter will be an allocation size and the macro shall return this size * plus the overhead of the allocator to manage an allocation request for this -- cgit v1.2.3