c-user: Update references to --enable-* configure options.

Also updated list of SMP architectures and added enough lead in
to let users know the source code was the definitive answer.
This commit is contained in:
Joel Sherrill 2022-05-20 08:45:16 -05:00
parent c16c8c6fd4
commit 9ba26e7cb2
4 changed files with 44 additions and 30 deletions

View File

@ -437,9 +437,9 @@ Each processor needs an IDLE task stack and interrupt stack for example.
If there are more processors available than configured, the rest will be If there are more processors available than configured, the rest will be
ignored. ignored.
This configuration option is only evaluated in SMP configurations (e.g. RTEMS This configuration option is only evaluated in SMP configurations of RTEMS
was built with the ``--enable-smp`` build configuration option). In all (e.g. RTEMS was built with the SMP build configuration option enabled).
other configurations it has no effect. In all other configurations it has no effect.
.. rubric:: CONSTRAINTS: .. rubric:: CONSTRAINTS:

View File

@ -23,12 +23,13 @@
Multiprocessing Configuration Multiprocessing Configuration
============================= =============================
This section describes multiprocessing related configuration options. The This section describes multiprocessing related configuration options.
options are only used if RTEMS was built with the ``--enable-multiprocessing`` The options are only used if RTEMS was built when the multiprocessing
build configuration option. Additionally, this class of configuration options build configuration option is enabled. The multiprocessing configuration
are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION` is distinct from the SMP configuration. Additionally, this class of
is defined. The multiprocessing (MPCI) support must not be confused with the configuration options are only applicable if the configuration option
SMP support. :ref:`CONFIGURE_MP_APPLICATION` is defined. The multiprocessing (MPCI)
support must not be confused with the SMP support.
.. Generated from spec:/acfg/if/mp-extra-server-stack .. Generated from spec:/acfg/if/mp-extra-server-stack
@ -115,8 +116,8 @@ options are assumed to be provided.
.. rubric:: NOTES: .. rubric:: NOTES:
This configuration option shall be undefined if the multiprocessing support This configuration option shall be undefined if the multiprocessing support
is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing`` is not enabled (e.g. RTEMS was built without the multiprocessing build
build configuration option). Otherwise a compile time error in the configuration option enabled). Otherwise a compile time error in the
configuration file will occur. configuration file will occur.
.. Generated from spec:/acfg/if/mp-max-global-objects .. Generated from spec:/acfg/if/mp-max-global-objects

View File

@ -25,7 +25,7 @@ POSIX API Configuration
This section describes configuration options related to the POSIX API. Most 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 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`` and timers are only available if RTEMS was built with the enable POSIX
build configuration option. build configuration option.
.. Generated from spec:/acfg/if/max-posix-keys .. Generated from spec:/acfg/if/max-posix-keys
@ -231,8 +231,8 @@ API Queued Signals that can be concurrently active.
Unlimited objects are not available for queued signals. Unlimited objects are not available for queued signals.
Queued signals are only available if RTEMS was built with the Queued signals are only available if RTEMS was built with the POSIX API
``--enable-posix`` build configuration option. build configuration option enabled.
.. rubric:: CONSTRAINTS: .. rubric:: CONSTRAINTS:
@ -470,29 +470,33 @@ API Timers that can be concurrently active.
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`.
Timers are only available if RTEMS was built with the Timers are only available if RTEMS was built with the POSIX API build
``--enable-posix`` build configuration option. configuration option enabled.
.. rubric:: CONSTRAINTS: .. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option: The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero. * The value of the configuration option shall be greater than or equal
to zero.
* The value of the configuration option shall be less than or equal to 65535. * The value of the configuration option shall be less than or equal
to 65535.
* The value of the configuration option shall be less than or equal to a * 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 BSP-specific and application-specific value which depends on the size
memory available to the application. of the memory available to the application.
* The value of the configuration option may be defined through * The value of the configuration option may be defined through
:c:func:`rtems_resource_unlimited` the enable unlimited objects for the :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
object class, if the value passed to :c:func:`rtems_resource_unlimited` object class, if the value passed to :c:func:`rtems_resource_unlimited`
satisfies all other constraints of the configuration option. satisfies all other constraints of the configuration option.
* The value of the configuration option shall be zero if the POSIX API is not * The value of the configuration option shall be zero if the POSIX API
enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True`` build is not
configuration option). Otherwise a compile time error in the configuration 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. file will occur.
.. Generated from spec:/acfg/if/min-posix-thread-stack-size .. Generated from spec:/acfg/if/min-posix-thread-stack-size

View File

@ -13,10 +13,19 @@ Symmetric Multiprocessing (SMP)
Introduction Introduction
============ ============
The Symmetric Multiprocessing (SMP) support of the RTEMS is available on RTEMS Symmetric Multiprocessing (SMP) support is available on a subset
of target architectures supported by RTEMS. Further on some target
architectures, it is only available on a subset of BSPs. The user is
advised to check the BSP specific documentation and RTEMS source code
to verify the status of SMP support for a specific BSP. The following
architectures have support for SMP:
-- AArch64
- ARMv7-A, - ARMv7-A,
- i386,
- PowerPC, - PowerPC,
- RISC-V, and - RISC-V, and
@ -25,8 +34,8 @@ The Symmetric Multiprocessing (SMP) support of the RTEMS is available on
.. warning:: .. warning::
The SMP support is only available if RTEMS was built with the SMP support is only available if RTEMS was built with the
``--enable-smp`` build configuration option. SMP build configuration option enabled.
RTEMS is supposed to be a real-time operating system. What does this mean in RTEMS is supposed to be a real-time operating system. What does this mean in
the context of SMP? The RTEMS interpretation of real-time on SMP is the the context of SMP? The RTEMS interpretation of real-time on SMP is the
@ -580,10 +589,10 @@ Profiling
--------- ---------
To identify the bottlenecks in the system, support for profiling of low-level To identify the bottlenecks in the system, support for profiling of low-level
synchronization is optionally available. The profiling support is a BSP build synchronization is optionally available. The profiling support is
time configuration option (``--enable-profiling``) and is implemented with an an RTEMS build time configuration option and is implemented with an
acceptable overhead, even for production systems. A low-overhead counter for acceptable overhead, even for production systems. A low-overhead counter
short time intervals must be provided by the hardware. for short time intervals must be provided by the hardware.
Profiling reports are generated in XML for most test programs of the RTEMS Profiling reports are generated in XML for most test programs of the RTEMS
testsuite (more than 500 test programs). This gives a good sample set for testsuite (more than 500 test programs). This gives a good sample set for