diff options
Diffstat (limited to 'c-user/config/classic-api.rst')
| -rw-r--r-- | c-user/config/classic-api.rst | 107 |
1 files changed, 22 insertions, 85 deletions
diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst index 4981918..212f666 100644 --- a/c-user/config/classic-api.rst +++ b/c-user/config/classic-api.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) .. This file is part of the RTEMS quality process and was automatically @@ -73,8 +73,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-message-queues @@ -127,8 +127,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-partitions @@ -179,8 +179,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-periods @@ -231,8 +231,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-ports @@ -283,8 +283,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-regions @@ -335,8 +335,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-semaphores @@ -391,8 +391,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-tasks @@ -461,73 +461,10 @@ The following constraints apply to this configuration option: <https://en.cppreference.com/w/c/types/integer>`_. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. -.. Generated from spec:/acfg/if/max-thread-local-storage-size - -.. raw:: latex - - \clearpage - -.. index:: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE - -.. _CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE: - -CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE -------------------------------------------- - -.. rubric:: CONSTANT: - -``CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE`` - -.. rubric:: OPTION TYPE: - -This configuration option is an integer define. - -.. rubric:: DEFAULT VALUE: - -The default value is 0. - -.. rubric:: DESCRIPTION: - -If the value of this configuration option is greater than zero, then it -defines the maximum thread-local storage size, otherwise the thread-local -storage size is defined by the linker depending on the thread-local storage -objects used by the application in the statically-linked executable. - -.. rubric:: NOTES: - -This configuration option can be used to reserve space for the dynamic linking -of modules with thread-local storage objects. - -If the thread-local storage size defined by the thread-local storage -objects used by the application in the statically-linked executable is greater -than a non-zero value of this configuration option, then a fatal error will -occur during system initialization. - -Use :c:func:`RTEMS_ALIGN_UP` and -:c:macro:`RTEMS_TASK_STORAGE_ALIGNMENT` to adjust the size to meet the -minimum alignment requirement of a thread-local storage area. - -The actual thread-local storage size is determined when the application -executable is linked. The ``rtems-exeinfo`` command line tool included in -the RTEMS Tools can be used to obtain the thread-local storage size and -alignment of an application executable. - -.. rubric:: CONSTRAINTS: - -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 less than or equal to - `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_. - -* The value of the configuration option shall be an integral multiple of - :c:macro:`RTEMS_TASK_STORAGE_ALIGNMENT`. - .. Generated from spec:/acfg/if/max-timers .. raw:: latex @@ -576,8 +513,8 @@ The following constraints apply to this configuration option: memory available to the application. * The value of the configuration option may be defined through - :c:func:`rtems_resource_unlimited` the enable unlimited objects for the - object class, if the value passed to :c:func:`rtems_resource_unlimited` + :ref:`InterfaceRtemsResourceUnlimited` the enable unlimited objects for the + object class, if the value passed to :ref:`InterfaceRtemsResourceUnlimited` satisfies all other constraints of the configuration option. .. Generated from spec:/acfg/if/max-user-extensions @@ -654,15 +591,15 @@ The default value is 0. .. rubric:: DESCRIPTION: The value of this configuration option defines the minimum count of Classic -API Tasks which are constructed by :c:func:`rtems_task_construct`. +API Tasks which are constructed by :ref:`InterfaceRtemsTaskConstruct`. .. rubric:: NOTES: By default, the calculation for the required memory in the RTEMS Workspace for tasks assumes that all Classic API Tasks are created by -:c:func:`rtems_task_create`. This configuration option can be used to +:ref:`InterfaceRtemsTaskCreate`. This configuration option can be used to reduce the required memory for the system-provided task storage areas since -tasks constructed by :c:func:`rtems_task_construct` use a user-provided +tasks constructed by :ref:`InterfaceRtemsTaskConstruct` use a user-provided task storage area. .. rubric:: CONSTRAINTS: |