diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-31 16:42:43 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-04-01 07:49:15 +0200 |
| commit | 4032c96da9bce3d9a8224ffb06c278206d626241 (patch) | |
| tree | 085b20c38fd9199d428172acdbe6ca6b35dd8605 /c-user/config/posix-api.rst | |
| parent | c-user: Use new template for integer config opts (diff) | |
| download | rtems-docs-4032c96da9bce3d9a8224ffb06c278206d626241.tar.bz2 | |
c-user: Document all configuration options
Close #2806.
Diffstat (limited to 'c-user/config/posix-api.rst')
| -rw-r--r-- | c-user/config/posix-api.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst index 54e8d99..0c84012 100644 --- a/c-user/config/posix-api.rst +++ b/c-user/config/posix-api.rst @@ -235,6 +235,51 @@ NOTES: initialized with :c:func:`sem_init()` are not affected by this configuration option since the storage space for these semaphores is user-provided. +.. index:: CONFIGURE_MAXIMUM_POSIX_SHMS + +.. _CONFIGURE_MAXIMUM_POSIX_SHMS: + +CONFIGURE_MAXIMUM_POSIX_SHMS +---------------------------- + +CONSTANT: + ``CONFIGURE_MAXIMUM_POSIX_SHMS`` + +OPTION TYPE: + This configuration option is an integer define. + +DEFAULT VALUE: + The default value is 0. + +VALUE CONSTRAINTS: + The value of this configuration option shall satisfy all of the following + constraints: + + * It shall be greater than or equal to 0. + + * It 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. + + * It shall be small enough so that the + RTEMS Workspace size calculation carried out by ``<rtems/confdefs.h>`` does + not overflow an integer of type ``uintptr_t``. + + * It may be defined through + :c:func:`rtems_resource_unlimited` the enable unlimited objects for this + object class, if the value passed to :c:func:`rtems_resource_unlimited` + satisfies all other constraints of this configuration option. + +DESCRIPTION: + The value of this configuration option defines the maximum number of POSIX + API Shared Memory objects that can be concurrently active. + +NOTES: + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. + .. index:: CONFIGURE_MAXIMUM_POSIX_THREADS .. _CONFIGURE_MAXIMUM_POSIX_THREADS: |