Changeset bf995cf in rtems-docs


Ignore:
Timestamp:
Mar 9, 2020, 7:46:12 AM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
a9e6a1d
Parents:
ac9d49d
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:46:12)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:15:37)
Message:

c-user: Move "Classic API Configuration"

Update #3836.

Location:
c-user/config
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/index.rst

    rac9d49d rbf995cf  
    1414    intro
    1515    general
    16 
    17 Classic API Configuration
    18 =========================
    19 
    20 This section defines the Classic API related system configuration parameters
    21 supported by ``<rtems/confdefs.h>``.
    22 
    23 .. index:: CONFIGURE_MAXIMUM_BARRIERS
    24 
    25 .. _CONFIGURE_MAXIMUM_BARRIERS:
    26 
    27 CONFIGURE_MAXIMUM_BARRIERS
    28 --------------------------
    29 
    30 CONSTANT:
    31     ``CONFIGURE_MAXIMUM_BARRIERS``
    32 
    33 DATA TYPE:
    34     Unsigned integer (``uint32_t``).
    35 
    36 RANGE:
    37     Zero or positive.
    38 
    39 DEFAULT VALUE:
    40     The default value is 0.
    41 
    42 DESCRIPTION:
    43     ``CONFIGURE_MAXIMUM_BARRIERS`` is the maximum number of Classic API
    44     Barriers that can be concurrently active.
    45 
    46 NOTES:
    47     This object class can be configured in unlimited allocation mode.
    48 
    49 .. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    50 
    51 .. _CONFIGURE_MAXIMUM_MESSAGE_QUEUES:
    52 
    53 CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    54 --------------------------------
    55 
    56 CONSTANT:
    57     ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES``
    58 
    59 DATA TYPE:
    60     Unsigned integer (``uint32_t``).
    61 
    62 RANGE:
    63     Zero or positive.
    64 
    65 DEFAULT VALUE:
    66     The default value is 0.
    67 
    68 DESCRIPTION:
    69     ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES`` is the maximum number of Classic API
    70     Message Queues that can be concurrently active.
    71 
    72 NOTES:
    73     This object class can be configured in unlimited allocation mode.  You have
    74     to account for the memory used to store the messages of each message queue,
    75     see :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
    76 
    77 .. index:: CONFIGURE_MAXIMUM_PARTITIONS
    78 
    79 .. _CONFIGURE_MAXIMUM_PARTITIONS:
    80 
    81 CONFIGURE_MAXIMUM_PARTITIONS
    82 ----------------------------
    83 
    84 CONSTANT:
    85     ``CONFIGURE_MAXIMUM_PARTITIONS``
    86 
    87 DATA TYPE:
    88     Unsigned integer (``uint32_t``).
    89 
    90 RANGE:
    91     Zero or positive.
    92 
    93 DEFAULT VALUE:
    94     The default value is 0.
    95 
    96 DESCRIPTION:
    97     ``CONFIGURE_MAXIMUM_PARTITIONS`` is the maximum number of Classic API
    98     Partitions that can be concurrently active.
    99 
    100 NOTES:
    101     This object class can be configured in unlimited allocation mode.
    102 
    103 .. index:: CONFIGURE_MAXIMUM_PERIODS
    104 
    105 .. _CONFIGURE_MAXIMUM_PERIODS:
    106 
    107 CONFIGURE_MAXIMUM_PERIODS
    108 -------------------------
    109 
    110 CONSTANT:
    111     ``CONFIGURE_MAXIMUM_PERIODS``
    112 
    113 DATA TYPE:
    114     Unsigned integer (``uint32_t``).
    115 
    116 RANGE:
    117     Zero or positive.
    118 
    119 DEFAULT VALUE:
    120     The default value is 0.
    121 
    122 DESCRIPTION:
    123     ``CONFIGURE_MAXIMUM_PERIODS`` is the maximum number of Classic API Periods
    124     that can be concurrently active.
    125 
    126 NOTES:
    127     This object class can be configured in unlimited allocation mode.
    128 
    129 .. index:: CONFIGURE_MAXIMUM_PORTS
    130 
    131 .. _CONFIGURE_MAXIMUM_PORTS:
    132 
    133 CONFIGURE_MAXIMUM_PORTS
    134 -----------------------
    135 
    136 CONSTANT:
    137     ``CONFIGURE_MAXIMUM_PORTS``
    138 
    139 DATA TYPE:
    140     Unsigned integer (``uint32_t``).
    141 
    142 RANGE:
    143     Zero or positive.
    144 
    145 DEFAULT VALUE:
    146     The default value is 0.
    147 
    148 DESCRIPTION:
    149     ``CONFIGURE_MAXIMUM_PORTS`` is the maximum number of Classic API Ports that
    150     can be concurrently active.
    151 
    152 NOTES:
    153     This object class can be configured in unlimited allocation mode.
    154 
    155 .. index:: CONFIGURE_MAXIMUM_REGIONS
    156 
    157 .. _CONFIGURE_MAXIMUM_REGIONS:
    158 
    159 CONFIGURE_MAXIMUM_REGIONS
    160 -------------------------
    161 
    162 CONSTANT:
    163     ``CONFIGURE_MAXIMUM_REGIONS``
    164 
    165 DATA TYPE:
    166     Unsigned integer (``uint32_t``).
    167 
    168 RANGE:
    169     Zero or positive.
    170 
    171 DEFAULT VALUE:
    172     The default value is 0.
    173 
    174 DESCRIPTION:
    175     ``CONFIGURE_MAXIMUM_REGIONS`` is the maximum number of Classic API Regions
    176     that can be concurrently active.
    177 
    178 NOTES:
    179     None.
    180 
    181 .. index:: CONFIGURE_MAXIMUM_SEMAPHORES
    182 
    183 .. _CONFIGURE_MAXIMUM_SEMAPHORES:
    184 
    185 CONFIGURE_MAXIMUM_SEMAPHORES
    186 ----------------------------
    187 
    188 CONSTANT:
    189     ``CONFIGURE_MAXIMUM_SEMAPHORES``
    190 
    191 DATA TYPE:
    192     Unsigned integer (``uint32_t``).
    193 
    194 RANGE:
    195     Zero or positive.
    196 
    197 DEFAULT VALUE:
    198     The default value is 0.
    199 
    200 DESCRIPTION:
    201     ``CONFIGURE_MAXIMUM_SEMAPHORES`` is the maximum number of Classic API
    202     Semaphores that can be concurrently active.
    203 
    204 NOTES:
    205     This object class can be configured in unlimited allocation mode.
    206 
    207     In SMP configurations, the size of a Semaphore Control Block depends on the
    208     scheduler count (see :ref:`ConfigurationSchedulerTable`).  The semaphores
    209     using the :ref:`MrsP` need a ceiling priority per scheduler.
    210 
    211 .. index:: CONFIGURE_MAXIMUM_TASKS
    212 
    213 .. _CONFIGURE_MAXIMUM_TASKS:
    214 
    215 CONFIGURE_MAXIMUM_TASKS
    216 -----------------------
    217 
    218 CONSTANT:
    219     ``CONFIGURE_MAXIMUM_TASKS``
    220 
    221 DATA TYPE:
    222     Unsigned integer (``uint32_t``).
    223 
    224 RANGE:
    225     Zero or positive.
    226 
    227 DEFAULT VALUE:
    228     The default value is ``0``.
    229 
    230 DESCRIPTION:
    231     ``CONFIGURE_MAXIMUM_TASKS`` is the maximum number of Classic API Tasks that
    232     can be concurrently active.
    233 
    234 NOTES:
    235     This object class can be configured in unlimited allocation mode.
    236 
    237     The calculations for the required memory in the RTEMS Workspace for tasks
    238     assume that each task has a minimum stack size and has floating point
    239     support enabled.  The configuration parameter
    240     ``CONFIGURE_EXTRA_TASK_STACKS`` is used to specify task stack requirements
    241     *ABOVE* the minimum size required.  See :ref:`Reserve Task/Thread Stack
    242     Memory Above Minimum` for more information about
    243     ``CONFIGURE_EXTRA_TASK_STACKS``.
    244 
    245     The maximum number of POSIX threads is specified by
    246     :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS <CONFIGURE_MAXIMUM_POSIX_THREADS>`.
    247 
    248     A future enhancement to ``<rtems/confdefs.h>`` could be to eliminate the
    249     assumption that all tasks have floating point enabled. This would require
    250     the addition of a new configuration parameter to specify the number of
    251     tasks which enable floating point support.
    252 
    253 .. index:: CONFIGURE_MAXIMUM_TIMERS
    254 
    255 .. _CONFIGURE_MAXIMUM_TIMERS:
    256 
    257 CONFIGURE_MAXIMUM_TIMERS
    258 ------------------------
    259 
    260 CONSTANT:
    261     ``CONFIGURE_MAXIMUM_TIMERS``
    262 
    263 DATA TYPE:
    264     Unsigned integer (``uint32_t``).
    265 
    266 RANGE:
    267     Zero or positive.
    268 
    269 DEFAULT VALUE:
    270     The default value is 0.
    271 
    272 DESCRIPTION:
    273     ``CONFIGURE_MAXIMUM_TIMERS`` is the maximum number of Classic API Timers
    274     that can be concurrently active.
    275 
    276 NOTES:
    277     This object class can be configured in unlimited allocation mode.
    278 
    279 .. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
    280 
    281 .. _CONFIGURE_MAXIMUM_USER_EXTENSIONS:
    282 
    283 CONFIGURE_MAXIMUM_USER_EXTENSIONS
    284 ---------------------------------
    285 
    286 CONSTANT:
    287     ``CONFIGURE_MAXIMUM_USER_EXTENSIONS``
    288 
    289 DATA TYPE:
    290     Unsigned integer (``uint32_t``).
    291 
    292 RANGE:
    293     Zero or positive.
    294 
    295 DEFAULT VALUE:
    296     The default value is 0.
    297 
    298 DESCRIPTION:
    299     ``CONFIGURE_MAXIMUM_USER_EXTENSIONS`` is the maximum number of Classic API
    300     User Extensions that can be concurrently active.
    301 
    302 NOTES:
    303     This object class can be configured in unlimited allocation mode.
     16    classic-api
    30417
    30518Classic API Initialization Task Configuration
Note: See TracChangeset for help on using the changeset viewer.