summaryrefslogtreecommitdiffstats
path: root/c-user/config/classic-api.rst
blob: f0fbe6f27cb9907c579e7f3e6c6db5ca28547c4a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)

.. This file was automatically generated.  Do not edit it manually.
.. Please have a look at
..
.. https://docs.rtems.org/branches/master/eng/req/howto.html
..
.. for information how to maintain and re-generate this file.

Classic API Configuration
=========================

This section describes configuration options related to the Classic API.

.. index:: CONFIGURE_MAXIMUM_BARRIERS

.. _CONFIGURE_MAXIMUM_BARRIERS:

CONFIGURE_MAXIMUM_BARRIERS
--------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_BARRIERS``

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 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 Classic
    API Barriers that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

.. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES

.. _CONFIGURE_MAXIMUM_MESSAGE_QUEUES:

CONFIGURE_MAXIMUM_MESSAGE_QUEUES
--------------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES``

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 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 Classic
    API Message Queues that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.  You have to account for the memory used to
    store the messages of each message queue, see
    :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.

.. index:: CONFIGURE_MAXIMUM_PARTITIONS

.. _CONFIGURE_MAXIMUM_PARTITIONS:

CONFIGURE_MAXIMUM_PARTITIONS
----------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_PARTITIONS``

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 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 Classic
    API Partitions that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

.. index:: CONFIGURE_MAXIMUM_PERIODS

.. _CONFIGURE_MAXIMUM_PERIODS:

CONFIGURE_MAXIMUM_PERIODS
-------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_PERIODS``

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 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 Classic
    API Periods that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

.. index:: CONFIGURE_MAXIMUM_PORTS

.. _CONFIGURE_MAXIMUM_PORTS:

CONFIGURE_MAXIMUM_PORTS
-----------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_PORTS``

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 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 Classic
    API Ports that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

.. index:: CONFIGURE_MAXIMUM_REGIONS

.. _CONFIGURE_MAXIMUM_REGIONS:

CONFIGURE_MAXIMUM_REGIONS
-------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_REGIONS``

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 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 Classic
    API Regions that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

.. index:: CONFIGURE_MAXIMUM_SEMAPHORES

.. _CONFIGURE_MAXIMUM_SEMAPHORES:

CONFIGURE_MAXIMUM_SEMAPHORES
----------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_SEMAPHORES``

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 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 Classic
    API Semaphore that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

    In SMP configurations, the size of a Semaphore Control Block depends on the
    scheduler count (see :ref:`ConfigurationSchedulerTable`).  The semaphores
    using the :ref:`MrsP` need a ceiling priority per scheduler.

.. index:: CONFIGURE_MAXIMUM_TASKS

.. _CONFIGURE_MAXIMUM_TASKS:

CONFIGURE_MAXIMUM_TASKS
-----------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_TASKS``

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 task
      stack space calculation carried out by ``<rtems/confdefs.h>`` does not
      overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.

    * 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 Classic
    API Tasks that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

    The calculations for the required memory in the RTEMS Workspace for tasks
    assume that each task has a minimum stack size and has floating point
    support enabled.  The configuration option :ref:`CONFIGURE_EXTRA_TASK_STACKS` is used
    to specify task stack requirements *above* the minimum size required.

    The maximum number of POSIX threads is specified by
    :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS`.

    A future enhancement to ``<rtems/confdefs.h>`` could be to eliminate the
    assumption that all tasks have floating point enabled. This would require
    the addition of a new configuration parameter to specify the number of
    tasks which enable floating point support.

.. index:: CONFIGURE_MAXIMUM_TIMERS

.. _CONFIGURE_MAXIMUM_TIMERS:

CONFIGURE_MAXIMUM_TIMERS
------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_TIMERS``

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 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 Classic
    API Timers that can be concurrently active.

NOTES:
    This object class can be configured in unlimited allocation mode, see
    :ref:`ConfigUnlimitedObjects`.

.. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS

.. _CONFIGURE_MAXIMUM_USER_EXTENSIONS:

CONFIGURE_MAXIMUM_USER_EXTENSIONS
---------------------------------

CONSTANT:
    ``CONFIGURE_MAXIMUM_USER_EXTENSIONS``

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.

DESCRIPTION:
    The value of this configuration option defines the maximum number of Classic
    API User Extensions that can be concurrently active.

NOTES:
    This object class cannot be configured in unlimited allocation mode.