c-user: Improve refs and formatting in appl config

The formatting is generated through references within the specification.

Update #3994.
This commit is contained in:
Sebastian Huber 2020-07-23 12:45:00 +02:00
parent cbb49c602a
commit db22500e84
14 changed files with 136 additions and 98 deletions

View File

@ -84,7 +84,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the minimum size of a buffer The value of this configuration option defines the minimum size of a buffer
@ -111,7 +111,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``SIZE_MAX``. and less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the size of the cache memory The value of this configuration option defines the size of the cache memory
@ -138,7 +138,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum blocks per The value of this configuration option defines the maximum blocks per
@ -167,7 +167,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum blocks per write The value of this configuration option defines the maximum blocks per write
@ -216,7 +216,7 @@ OPTION TYPE:
This configuration option is an integer define. This configuration option is an integer define.
DEFAULT VALUE: DEFAULT VALUE:
The default value is ``RTEMS_MINIMUM_STACK_SIZE``. The default value is :c:macro:`RTEMS_MINIMUM_STACK_SIZE`.
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following The value of this configuration option shall satisfy all of the following
@ -230,7 +230,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the task stack size of the The value of this configuration option defines the task stack size of the
@ -257,7 +257,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the swapout task maximum block The value of this configuration option defines the swapout task maximum block
@ -284,7 +284,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the swapout task swap period The value of this configuration option defines the swapout task swap period
@ -337,7 +337,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the swapout worker task count. The value of this configuration option defines the swapout worker task count.

View File

@ -71,7 +71,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the IDLE * It shall be small enough so that the IDLE
task stack area calculation carried out by ``<rtems/confdefs.h>`` does not task stack area calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``size_t``. overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
DESCRIPTION: DESCRIPTION:
If If
@ -145,10 +145,10 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``size_t``. not overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
* It shall be aligned according to * It shall be aligned according to
``CPU_INTERRUPT_STACK_ALIGNMENT``. :c:macro:`CPU_INTERRUPT_STACK_ALIGNMENT`.
DESCRIPTION: DESCRIPTION:
If If
@ -259,9 +259,9 @@ DESCRIPTION:
* and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined, * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
then not all memory is made available to the C Program Heap immediately at then not all memory is made available to the C Program Heap immediately at
system initialization time. When :c:func:`malloc()` or other standard memory system initialization time. When :c:func:`malloc` or other standard
allocation functions are unable to allocate memory, they will call the BSP memory allocation functions are unable to allocate memory, they will call the
supplied :c:func:`sbrk()` function to obtain more memory. BSP supplied :c:func:`sbrk` function to obtain more memory.
NOTES: NOTES:
This option should not be defined by the application. Only the BSP knows how This option should not be defined by the application. Only the BSP knows how

View File

@ -331,7 +331,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It may be defined through * It may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for this :c:func:`rtems_resource_unlimited` the enable unlimited objects for this

View File

@ -27,7 +27,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be a valid integer of type The value of this configuration option shall be a valid integer of type
``rtems_task_argument``. :c:type:`rtems_task_argument`.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines task argument of the Classic The value of this configuration option defines task argument of the Classic
@ -50,7 +50,7 @@ OPTION TYPE:
This configuration option is an integer define. This configuration option is an integer define.
DEFAULT VALUE: DEFAULT VALUE:
The default value is ``RTEMS_DEFAULT_ATTRIBUTES``. The default value is :c:macro:`RTEMS_DEFAULT_ATTRIBUTES`.
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be a valid task attribute set. The value of this configuration option shall be a valid task attribute set.
@ -104,8 +104,8 @@ OPTION TYPE:
This configuration option is an integer define. This configuration option is an integer define.
DEFAULT VALUE: DEFAULT VALUE:
In SMP configurations, the default value is ``RTEMS_DEFAULT_MODES``, In SMP configurations, the default value is :c:macro:`RTEMS_DEFAULT_MODES`
otherwise the default value is ``RTEMS_NO_PREEMPT``. otherwise the default value is :c:macro:`RTEMS_NO_PREEMPT`.
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be a valid task mode set. The value of this configuration option shall be a valid task mode set.
@ -135,7 +135,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be a valid integer of type The value of this configuration option shall be a valid integer of type
``rtems_name``. :c:type:`rtems_name`.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the name of the Classic API The value of this configuration option defines the name of the Classic API
@ -195,7 +195,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the task stack size of the The value of this configuration option defines the task stack size of the
@ -229,7 +229,7 @@ NOTES:
The application shall define exactly one of the following configuration The application shall define exactly one of the following configuration
options options
* `CONFIGURE_RTEMS_INIT_TASKS_TABLE`, * ``CONFIGURE_RTEMS_INIT_TASKS_TABLE``,
* :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or

View File

@ -39,7 +39,7 @@ NOTES:
* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
* `CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or * ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER``, or
* :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`,
@ -130,7 +130,7 @@ NOTES:
The application shall define exactly one of the following configuration options The application shall define exactly one of the following configuration options
* `CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, * ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER``,
* :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or
@ -169,7 +169,7 @@ NOTES:
The The
* :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`, * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``,
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and
@ -311,9 +311,9 @@ NOTES:
device file. This device is used to initialize the standard input, output, device file. This device is used to initialize the standard input, output,
and error file descriptors. and error file descriptors.
This device driver reads via :c:func:`getchark`. This device driver reads via :c:func:`rtems_putc`.
This device driver writes via :c:func:`rtems_putc`. This device driver writes via :c:func:`getchark`.
The Termios framework is not used. There is no support to change device The Termios framework is not used. There is no support to change device
settings, e.g. baud, stop bits, parity, etc. settings, e.g. baud, stop bits, parity, etc.
@ -322,7 +322,7 @@ NOTES:
* :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`, * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`
@ -354,14 +354,14 @@ NOTES:
device file. This device is used to initialize the standard input, output, device file. This device is used to initialize the standard input, output,
and error file descriptors. and error file descriptors.
This device driver reads via :c:func:`getchark`. This device driver reads via :c:func:`rtems_putc`.
This device driver writes into a write buffer. The count of characters This device driver writes into a write buffer. The count of characters
written into the write buffer is returned. It might be less than the written into the write buffer is returned. It might be less than the
requested count, in case the write buffer is full. The write is requested count, in case the write buffer is full. The write is
non-blocking and may be called from interrupt context. A dedicated task non-blocking and may be called from interrupt context. A dedicated task
reads from the write buffer and outputs the characters via reads from the write buffer and outputs the characters via
:c:func:`rtems_putc`. This task runs with the least important priority. :c:func:`getchark`. This task runs with the least important priority.
The write buffer size is 2047 characters and it is not configurable. The write buffer size is 2047 characters and it is not configurable.
Use ``fsync( STDOUT_FILENO )`` or ``fdatasync( STDOUT_FILENO )`` to drain the Use ``fsync( STDOUT_FILENO )`` or ``fdatasync( STDOUT_FILENO )`` to drain the
@ -376,7 +376,7 @@ NOTES:
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER``
configuration options are mutually exclusive. configuration options are mutually exclusive.
@ -436,7 +436,7 @@ NOTES:
* :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or
* `CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, * ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER``,
otherwise a compile time error will occur. otherwise a compile time error will occur.
@ -566,15 +566,49 @@ OPTION TYPE:
This configuration option is an integer define. This configuration option is an integer define.
DEFAULT VALUE: DEFAULT VALUE:
This is computed by default, and is set to the number of device drivers This is computed by default, and is set to the number of statically
configured using the ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configured device drivers configured using the following configuration
configuration options. options:
* :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS`
* :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`
* :ref:`CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER`
* :ref:`CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER`
* :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`
* :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following The value of this configuration option shall satisfy all of the following
constraints: constraints:
* It shall be less than or equal to ``SIZE_MAX``. * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
* It shall be greater than or equal than the number of statically configured * It shall be greater than or equal than the number of statically configured
device drivers. device drivers.
@ -587,8 +621,6 @@ DESCRIPTION:
The value of this configuration option defines the number of device drivers. The value of this configuration option defines the number of device drivers.
NOTES: NOTES:
If the application will dynamically install device drivers, then this If the application will dynamically install device drivers, then the
configuration parameter shall be larger than the number of statically configuration option value shall be larger than the number of statically
configured device drivers. Drivers configured using the configured device drivers.
``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration options are
statically installed.

View File

@ -122,7 +122,7 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 16. * It shall be greater than or equal to 16.
* It shall be less than or equal to ``SIZE_MAX``. * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
* It shall be a power of two. * It shall be a power of two.

View File

@ -455,7 +455,8 @@ DEFAULT CONFIGURATION:
DESCRIPTION: DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not In case this configuration option is defined, then the root IMFS does not
support mounting other filesystems (no support for :c:func:`mount`). support mounting other filesystems (no support for
:c:func:`mount`).
NOTES: NOTES:
None. None.
@ -479,8 +480,8 @@ DEFAULT CONFIGURATION:
DESCRIPTION: DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not In case this configuration option is defined, then the root IMFS does not
support reading directories (no support for :c:func:`readdir`). It is still support reading directories (no support for :c:func:`readdir`). It is
possible to open files in a directory. still possible to open files in a directory.
NOTES: NOTES:
None. None.
@ -600,7 +601,8 @@ DEFAULT CONFIGURATION:
DESCRIPTION: DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not In case this configuration option is defined, then the root IMFS does not
support unmounting other filesystems (no support for :c:func:`unmount`). support unmounting other filesystems (no support for
:c:func:`unmount`).
NOTES: NOTES:
None. None.

View File

@ -63,8 +63,8 @@ DESCRIPTION:
NOTES: NOTES:
You can enable this option to reduce the size of the :term:`TCB`. Use this You can enable this option to reduce the size of the :term:`TCB`. Use this
option with care, since it can lead to race conditions and undefined system option with care, since it can lead to race conditions and undefined system
behaviour. For example, :c:data:`errno` is no longer a thread-local variable behaviour. For example, :c:macro:`errno` is no longer a thread-local
if this option is enabled. variable if this option is enabled.
.. index:: CONFIGURE_EXECUTIVE_RAM_SIZE .. index:: CONFIGURE_EXECUTIVE_RAM_SIZE
@ -90,7 +90,7 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 0. * It shall be greater than or equal to 0.
* It shall be less than or equal to ``UINTPTR_MAX``. * It shall be less than or equal to `UINTPTR_MAX <https://en.cppreference.com/w/c/types/integer>`_.
* It shall be less than or equal to a * It shall be less than or equal to a
BSP-specific and application-specific value which depends on the size of the BSP-specific and application-specific value which depends on the size of the
@ -129,7 +129,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the number of bytes the The value of this configuration option defines the number of bytes the
@ -186,7 +186,7 @@ OPTION TYPE:
DEFAULT VALUE: DEFAULT VALUE:
The default value is :ref:`BSP_INTERRUPT_STACK_SIZE` in case it is defined, The default value is :ref:`BSP_INTERRUPT_STACK_SIZE` in case it is defined,
otherwise the default value is ``CPU_STACK_MINIMUM_SIZE``. otherwise the default value is :c:macro:`CPU_STACK_MINIMUM_SIZE`.
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following The value of this configuration option shall satisfy all of the following
@ -197,10 +197,10 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does interrupt stack area calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``size_t``. not overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
* It shall be aligned according to * It shall be aligned according to
``CPU_INTERRUPT_STACK_ALIGNMENT``. :c:macro:`CPU_INTERRUPT_STACK_ALIGNMENT`.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the size of an interrupt stack The value of this configuration option defines the size of an interrupt stack
@ -221,7 +221,8 @@ NOTES:
size may still result in undefined behaviour. size may still result in undefined behaviour.
In releases before RTEMS 5.1 the default value was In releases before RTEMS 5.1 the default value was
:ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` instead of ``CPU_STACK_MINIMUM_SIZE``. :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` instead of
:c:macro:`CPU_STACK_MINIMUM_SIZE`.
.. index:: CONFIGURE_MALLOC_DIRTY .. index:: CONFIGURE_MALLOC_DIRTY
@ -274,7 +275,7 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 0. * It shall be greater than or equal to 0.
* It shall be less than or equal to ``SIZE_MAX``. * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
* It shall be less than or equal to a * It shall be less than or equal to a
BSP-specific and application-specific value which depends on the size of the BSP-specific and application-specific value which depends on the size of the
@ -286,7 +287,7 @@ DESCRIPTION:
NOTES: NOTES:
The default value of three file descriptors allows RTEMS to support standard The default value of three file descriptors allows RTEMS to support standard
input, output, and error I/O streams on ``/dev/console``. input, output, and error I/O streams on :file:`/dev/console`.
.. index:: CONFIGURE_MAXIMUM_PROCESSORS .. index:: CONFIGURE_MAXIMUM_PROCESSORS
@ -306,7 +307,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 1 The value of this configuration option shall be greater than or equal to 1
and less than or equal to ``CPU_MAXIMUM_PROCESSORS``. and less than or equal to :c:macro:`CPU_MAXIMUM_PROCESSORS`.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of The value of this configuration option defines the maximum number of
@ -346,7 +347,7 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 0. * It shall be greater than or equal to 0.
* It shall be less than or equal to ``SIZE_MAX``. * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
* It shall be less than or equal to a * It shall be less than or equal to a
BSP-specific and application-specific value which depends on the size of the BSP-specific and application-specific value which depends on the size of the
@ -393,7 +394,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the number of kilobytes the The value of this configuration option defines the number of kilobytes the
@ -438,7 +439,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the number of bytes reserved The value of this configuration option defines the number of bytes reserved
@ -449,7 +450,7 @@ NOTES:
:ref:`CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES` define only how many message :ref:`CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES` define only how many message
queues can be created by the application. The memory for the message queues can be created by the application. The memory for the message
buffers is configured by this option. For each message queue you have to buffers is configured by this option. For each message queue you have to
reserve some memory for the message buffers. The size dependes on the reserve some memory for the message buffers. The size depends on the
maximum number of pending messages and the maximum size of the messages of maximum number of pending messages and the maximum size of the messages of
a message queue. Use the ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()`` macro a message queue. Use the ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()`` macro
to specify the message buffer memory for each message queue and sum them up to specify the message buffer memory for each message queue and sum them up
@ -470,7 +471,7 @@ NOTES:
RTEMS Workspace size. RTEMS Workspace size.
The following example illustrates how the The following example illustrates how the
`CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()` help macro can be used to assist in ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()`` help macro can be used to assist in
calculating the message buffer memory required. In this example, there are calculating the message buffer memory required. In this example, there are
two message queues used in this application. The first message queue has a two message queues used in this application. The first message queue has a
maximum of 24 pending messages with the message structure defined by the maximum of 24 pending messages with the message structure defined by the
@ -560,7 +561,7 @@ OPTION TYPE:
This configuration option is an integer define. This configuration option is an integer define.
DEFAULT VALUE: DEFAULT VALUE:
The default value is ``CPU_STACK_MINIMUM_SIZE``. The default value is :c:macro:`CPU_STACK_MINIMUM_SIZE`.
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall satisfy all of the following The value of this configuration option shall satisfy all of the following
@ -568,7 +569,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It shall be greater than or equal to a * It shall be greater than or equal to a
BSP-specific and application-specific minimum value. BSP-specific and application-specific minimum value.
@ -646,7 +647,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the length of the timeslice The value of this configuration option defines the length of the timeslice

View File

@ -82,7 +82,7 @@ NOTES:
* :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
* `CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` * ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
otherwise a compile time error in the configuration file will occur. otherwise a compile time error in the configuration file will occur.
@ -111,7 +111,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the IDLE * It shall be small enough so that the IDLE
task stack area calculation carried out by ``<rtems/confdefs.h>`` does not task stack area calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``size_t``. overflow an integer of type `size_t <https://en.cppreference.com/w/c/types/size_t>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the task stack size for an The value of this configuration option defines the task stack size for an

View File

@ -35,11 +35,12 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 0. * It shall be greater than or equal to 0.
* It shall be less than or equal to ``UINT32_MAX``. * It shall be less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
* It shall be small enough so that the * It shall be small enough so that the
MPCI receive server stack area calculation carried out by MPCI receive server stack area calculation carried out by
``<rtems/confdefs.h>`` does not overflow an integer of type ``size_t``. ``<rtems/confdefs.h>`` does not overflow an integer of type
`size_t <https://en.cppreference.com/w/c/types/size_t>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the number of bytes the The value of this configuration option defines the number of bytes the
@ -96,7 +97,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of The value of this configuration option defines the maximum number of
@ -104,7 +105,7 @@ DESCRIPTION:
NOTES: NOTES:
This value corresponds to the total number of objects which can be created This value corresponds to the total number of objects which can be created
with the ``RTEMS_GLOBAL`` attribute. with the :c:macro:`RTEMS_GLOBAL` attribute.
This configuration option is only evaluated if This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined. :ref:`CONFIGURE_MP_APPLICATION` is defined.
@ -127,7 +128,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of nodes in The value of this configuration option defines the maximum number of nodes in
@ -155,7 +156,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of The value of this configuration option defines the maximum number of
@ -221,7 +222,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be greater than or equal to 0 The value of this configuration option shall be greater than or equal to 0
and less than or equal to ``UINT32_MAX``. and less than or equal to `UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the node number of this node The value of this configuration option defines the node number of this node

View File

@ -97,7 +97,7 @@ NOTES:
:ref:`ConfigUnlimitedObjects`. :ref:`ConfigUnlimitedObjects`.
A key value pair is created by :c:func:`pthread_setspecific` if the value A key value pair is created by :c:func:`pthread_setspecific` if the value
is not :c:macro:`NULL`, otherwise it is deleted. is not `NULL <https://en.cppreference.com/w/c/types/NULL>`_, otherwise it is deleted.
.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES .. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
@ -129,7 +129,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It may be defined through * It may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for this :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
@ -174,7 +174,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It shall be zero if the POSIX API is not * It shall be zero if the POSIX API is not
enabled (e.g. RTEMS was built without the ``--enable-posix`` build enabled (e.g. RTEMS was built without the ``--enable-posix`` build
@ -221,7 +221,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It may be defined through * It may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for this :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
@ -236,9 +236,10 @@ NOTES:
This object class can be configured in unlimited allocation mode, see This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`. :ref:`ConfigUnlimitedObjects`.
Named semaphores are created with :c:func:`sem_open()`. Semaphores Named semaphores are created with :c:func:`sem_open`. Semaphores
initialized with :c:func:`sem_init()` are not affected by this configuration initialized with :c:func:`sem_init` are not affected by this
option since the storage space for these semaphores is user-provided. configuration option since the storage space for these semaphores is
user-provided.
.. index:: CONFIGURE_MAXIMUM_POSIX_SHMS .. index:: CONFIGURE_MAXIMUM_POSIX_SHMS
@ -270,7 +271,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the * It shall be small enough so that the
RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does
not overflow an integer of type ``uintptr_t``. not overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It may be defined through * It may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for this :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
@ -315,7 +316,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the maximum number of POSIX The value of this configuration option defines the maximum number of POSIX
@ -408,7 +409,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
* It shall be greater than or equal to a * It shall be greater than or equal to a
BSP-specific and application-specific minimum value. BSP-specific and application-specific minimum value.

View File

@ -61,7 +61,7 @@ VALUE CONSTRAINTS:
* It shall be small enough so that the task * It shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type ``uintptr_t``. overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the thread stack size of the The value of this configuration option defines the thread stack size of the
@ -97,7 +97,7 @@ NOTES:
* :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`, * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
* `CONFIGURE_POSIX_INIT_THREAD_TABLE`, or * ``CONFIGURE_POSIX_INIT_THREAD_TABLE``, or
* :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`

View File

@ -52,7 +52,7 @@ VALUE CONSTRAINTS:
* It shall be greater than or equal to 0. * It shall be greater than or equal to 0.
* It shall be less than or equal to ``SIZE_MAX``. * It shall be less than or equal to `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
* It shall be less than or equal to a * It shall be less than or equal to a
BSP-specific and application-specific value which depends on the size of the BSP-specific and application-specific value which depends on the size of the
@ -150,7 +150,7 @@ VALUE CONSTRAINTS:
* ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )`` * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
* :c:macro:`RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER` * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
* It shall be a list of exactly * It shall be a list of exactly
:ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements. :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements.
@ -293,7 +293,7 @@ DEFAULT VALUE:
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be a valid integer of type The value of this configuration option shall be a valid integer of type
``rtems_name``. :c:type:`rtems_name`.
DESCRIPTION: DESCRIPTION:
The value of this configuration option defines the name of the default The value of this configuration option defines the name of the default
@ -303,7 +303,7 @@ NOTES:
This scheduler configuration option is an advanced configuration option. This scheduler configuration option is an advanced configuration option.
Think twice before you use it. Think twice before you use it.
Schedulers can be identified via c:func:`rtems_scheduler_ident`. Schedulers can be identified via :c:func:`rtems_scheduler_ident`.
Use :c:func:`rtems_build_name` to define the scheduler name. Use :c:func:`rtems_build_name` to define the scheduler name.

View File

@ -43,7 +43,7 @@ NOTES:
* :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT` * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
* `CONFIGURE_TASK_STACK_ALLOCATOR` * ``CONFIGURE_TASK_STACK_ALLOCATOR``
* :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
@ -86,11 +86,12 @@ OPTION TYPE:
This configuration option is an initializer define. This configuration option is an initializer define.
DEFAULT VALUE: DEFAULT VALUE:
The default value is ``NULL``. The default value is `NULL <https://en.cppreference.com/w/c/types/NULL>`_.
VALUE CONSTRAINTS: VALUE CONSTRAINTS:
The value of this configuration option shall be defined to a valid function The value of this configuration option shall be defined to a valid function
pointer of the type ``void ( *initialize )( size_t )`` or to ``NULL``. pointer of the type ``void ( *initialize )( size_t )`` or to
`NULL <https://en.cppreference.com/w/c/types/NULL>`_.
DESCRIPTION: DESCRIPTION:
The value of this configuration option initializes the stack allocator The value of this configuration option initializes the stack allocator
@ -99,7 +100,7 @@ DESCRIPTION:
NOTES: NOTES:
A correctly configured system shall configure the following to be consistent: A correctly configured system shall configure the following to be consistent:
* `CONFIGURE_TASK_STACK_ALLOCATOR_INIT` * ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT``
* :ref:`CONFIGURE_TASK_STACK_ALLOCATOR` * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
@ -138,7 +139,7 @@ NOTES:
* :ref:`CONFIGURE_TASK_STACK_ALLOCATOR` * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
* `CONFIGURE_TASK_STACK_DEALLOCATOR` * ``CONFIGURE_TASK_STACK_DEALLOCATOR``
.. index:: CONFIGURE_TASK_STACK_FROM_ALLOCATOR .. index:: CONFIGURE_TASK_STACK_FROM_ALLOCATOR
.. index:: task stack allocator .. index:: task stack allocator