Changeset 7a414f9 in rtems-docs


Ignore:
Timestamp:
Mar 6, 2020, 1:32:37 PM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
c078afb
Parents:
e3f6819
git-author:
Sebastian Huber <sebastian.huber@…> (03/06/20 13:32:37)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/09/20 06:38:00)
Message:

c-user: Sort configuration options alphabetically

Update #3836.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/configuring_a_system.rst

    re3f6819 r7a414f9  
    10611061supported by ``<rtems/confdefs.h>``.
    10621062
     1063.. index:: CONFIGURE_MAXIMUM_BARRIERS
     1064
     1065.. _CONFIGURE_MAXIMUM_BARRIERS:
     1066
     1067CONFIGURE_MAXIMUM_BARRIERS
     1068--------------------------
     1069
     1070CONSTANT:
     1071    ``CONFIGURE_MAXIMUM_BARRIERS``
     1072
     1073DATA TYPE:
     1074    Unsigned integer (``uint32_t``).
     1075
     1076RANGE:
     1077    Zero or positive.
     1078
     1079DEFAULT VALUE:
     1080    The default value is 0.
     1081
     1082DESCRIPTION:
     1083    ``CONFIGURE_MAXIMUM_BARRIERS`` is the maximum number of Classic API
     1084    Barriers that can be concurrently active.
     1085
     1086NOTES:
     1087    This object class can be configured in unlimited allocation mode.
     1088
     1089.. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
     1090
     1091.. _CONFIGURE_MAXIMUM_MESSAGE_QUEUES:
     1092
     1093CONFIGURE_MAXIMUM_MESSAGE_QUEUES
     1094--------------------------------
     1095
     1096CONSTANT:
     1097    ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES``
     1098
     1099DATA TYPE:
     1100    Unsigned integer (``uint32_t``).
     1101
     1102RANGE:
     1103    Zero or positive.
     1104
     1105DEFAULT VALUE:
     1106    The default value is 0.
     1107
     1108DESCRIPTION:
     1109    ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES`` is the maximum number of Classic API
     1110    Message Queues that can be concurrently active.
     1111
     1112NOTES:
     1113    This object class can be configured in unlimited allocation mode.  You have
     1114    to account for the memory used to store the messages of each message queue,
     1115    see :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
     1116
     1117.. index:: CONFIGURE_MAXIMUM_PARTITIONS
     1118
     1119.. _CONFIGURE_MAXIMUM_PARTITIONS:
     1120
     1121CONFIGURE_MAXIMUM_PARTITIONS
     1122----------------------------
     1123
     1124CONSTANT:
     1125    ``CONFIGURE_MAXIMUM_PARTITIONS``
     1126
     1127DATA TYPE:
     1128    Unsigned integer (``uint32_t``).
     1129
     1130RANGE:
     1131    Zero or positive.
     1132
     1133DEFAULT VALUE:
     1134    The default value is 0.
     1135
     1136DESCRIPTION:
     1137    ``CONFIGURE_MAXIMUM_PARTITIONS`` is the maximum number of Classic API
     1138    Partitions that can be concurrently active.
     1139
     1140NOTES:
     1141    This object class can be configured in unlimited allocation mode.
     1142
     1143.. index:: CONFIGURE_MAXIMUM_PERIODS
     1144
     1145.. _CONFIGURE_MAXIMUM_PERIODS:
     1146
     1147CONFIGURE_MAXIMUM_PERIODS
     1148-------------------------
     1149
     1150CONSTANT:
     1151    ``CONFIGURE_MAXIMUM_PERIODS``
     1152
     1153DATA TYPE:
     1154    Unsigned integer (``uint32_t``).
     1155
     1156RANGE:
     1157    Zero or positive.
     1158
     1159DEFAULT VALUE:
     1160    The default value is 0.
     1161
     1162DESCRIPTION:
     1163    ``CONFIGURE_MAXIMUM_PERIODS`` is the maximum number of Classic API Periods
     1164    that can be concurrently active.
     1165
     1166NOTES:
     1167    This object class can be configured in unlimited allocation mode.
     1168
     1169.. index:: CONFIGURE_MAXIMUM_PORTS
     1170
     1171.. _CONFIGURE_MAXIMUM_PORTS:
     1172
     1173CONFIGURE_MAXIMUM_PORTS
     1174-----------------------
     1175
     1176CONSTANT:
     1177    ``CONFIGURE_MAXIMUM_PORTS``
     1178
     1179DATA TYPE:
     1180    Unsigned integer (``uint32_t``).
     1181
     1182RANGE:
     1183    Zero or positive.
     1184
     1185DEFAULT VALUE:
     1186    The default value is 0.
     1187
     1188DESCRIPTION:
     1189    ``CONFIGURE_MAXIMUM_PORTS`` is the maximum number of Classic API Ports that
     1190    can be concurrently active.
     1191
     1192NOTES:
     1193    This object class can be configured in unlimited allocation mode.
     1194
     1195.. index:: CONFIGURE_MAXIMUM_REGIONS
     1196
     1197.. _CONFIGURE_MAXIMUM_REGIONS:
     1198
     1199CONFIGURE_MAXIMUM_REGIONS
     1200-------------------------
     1201
     1202CONSTANT:
     1203    ``CONFIGURE_MAXIMUM_REGIONS``
     1204
     1205DATA TYPE:
     1206    Unsigned integer (``uint32_t``).
     1207
     1208RANGE:
     1209    Zero or positive.
     1210
     1211DEFAULT VALUE:
     1212    The default value is 0.
     1213
     1214DESCRIPTION:
     1215    ``CONFIGURE_MAXIMUM_REGIONS`` is the maximum number of Classic API Regions
     1216    that can be concurrently active.
     1217
     1218NOTES:
     1219    None.
     1220
     1221.. index:: CONFIGURE_MAXIMUM_SEMAPHORES
     1222
     1223.. _CONFIGURE_MAXIMUM_SEMAPHORES:
     1224
     1225CONFIGURE_MAXIMUM_SEMAPHORES
     1226----------------------------
     1227
     1228CONSTANT:
     1229    ``CONFIGURE_MAXIMUM_SEMAPHORES``
     1230
     1231DATA TYPE:
     1232    Unsigned integer (``uint32_t``).
     1233
     1234RANGE:
     1235    Zero or positive.
     1236
     1237DEFAULT VALUE:
     1238    The default value is 0.
     1239
     1240DESCRIPTION:
     1241    ``CONFIGURE_MAXIMUM_SEMAPHORES`` is the maximum number of Classic API
     1242    Semaphores that can be concurrently active.
     1243
     1244NOTES:
     1245    This object class can be configured in unlimited allocation mode.
     1246
     1247    In SMP configurations, the size of a Semaphore Control Block depends on the
     1248    scheduler count (see :ref:`ConfigurationSchedulerTable`).  The semaphores
     1249    using the :ref:`MrsP` need a ceiling priority per scheduler.
     1250
    10631251.. index:: CONFIGURE_MAXIMUM_TASKS
    10641252
     
    11031291    tasks which enable floating point support.
    11041292
    1105 .. COMMENT: XXX - Add xref to CONFIGURE_MAXIMUM_POSIX_THREADS.
    1106 
    11071293.. index:: CONFIGURE_MAXIMUM_TIMERS
    11081294
     
    11271313    ``CONFIGURE_MAXIMUM_TIMERS`` is the maximum number of Classic API Timers
    11281314    that can be concurrently active.
    1129 
    1130 NOTES:
    1131     This object class can be configured in unlimited allocation mode.
    1132 
    1133 .. index:: CONFIGURE_MAXIMUM_SEMAPHORES
    1134 
    1135 .. _CONFIGURE_MAXIMUM_SEMAPHORES:
    1136 
    1137 CONFIGURE_MAXIMUM_SEMAPHORES
    1138 ----------------------------
    1139 
    1140 CONSTANT:
    1141     ``CONFIGURE_MAXIMUM_SEMAPHORES``
    1142 
    1143 DATA TYPE:
    1144     Unsigned integer (``uint32_t``).
    1145 
    1146 RANGE:
    1147     Zero or positive.
    1148 
    1149 DEFAULT VALUE:
    1150     The default value is 0.
    1151 
    1152 DESCRIPTION:
    1153     ``CONFIGURE_MAXIMUM_SEMAPHORES`` is the maximum number of Classic API
    1154     Semaphores that can be concurrently active.
    1155 
    1156 NOTES:
    1157     This object class can be configured in unlimited allocation mode.
    1158 
    1159     In SMP configurations, the size of a Semaphore Control Block depends on the
    1160     scheduler count (see :ref:`ConfigurationSchedulerTable`).  The semaphores
    1161     using the :ref:`MrsP` need a ceiling priority per scheduler.
    1162 
    1163 .. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    1164 
    1165 .. _CONFIGURE_MAXIMUM_MESSAGE_QUEUES:
    1166 
    1167 CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    1168 --------------------------------
    1169 
    1170 CONSTANT:
    1171     ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES``
    1172 
    1173 DATA TYPE:
    1174     Unsigned integer (``uint32_t``).
    1175 
    1176 RANGE:
    1177     Zero or positive.
    1178 
    1179 DEFAULT VALUE:
    1180     The default value is 0.
    1181 
    1182 DESCRIPTION:
    1183     ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES`` is the maximum number of Classic API
    1184     Message Queues that can be concurrently active.
    1185 
    1186 NOTES:
    1187     This object class can be configured in unlimited allocation mode.  You have
    1188     to account for the memory used to store the messages of each message queue,
    1189     see :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
    1190 
    1191 .. index:: CONFIGURE_MAXIMUM_BARRIERS
    1192 
    1193 .. _CONFIGURE_MAXIMUM_BARRIERS:
    1194 
    1195 CONFIGURE_MAXIMUM_BARRIERS
    1196 --------------------------
    1197 
    1198 CONSTANT:
    1199     ``CONFIGURE_MAXIMUM_BARRIERS``
    1200 
    1201 DATA TYPE:
    1202     Unsigned integer (``uint32_t``).
    1203 
    1204 RANGE:
    1205     Zero or positive.
    1206 
    1207 DEFAULT VALUE:
    1208     The default value is 0.
    1209 
    1210 DESCRIPTION:
    1211     ``CONFIGURE_MAXIMUM_BARRIERS`` is the maximum number of Classic API
    1212     Barriers that can be concurrently active.
    1213 
    1214 NOTES:
    1215     This object class can be configured in unlimited allocation mode.
    1216 
    1217 .. index:: CONFIGURE_MAXIMUM_PERIODS
    1218 
    1219 .. _CONFIGURE_MAXIMUM_PERIODS:
    1220 
    1221 CONFIGURE_MAXIMUM_PERIODS
    1222 -------------------------
    1223 
    1224 CONSTANT:
    1225     ``CONFIGURE_MAXIMUM_PERIODS``
    1226 
    1227 DATA TYPE:
    1228     Unsigned integer (``uint32_t``).
    1229 
    1230 RANGE:
    1231     Zero or positive.
    1232 
    1233 DEFAULT VALUE:
    1234     The default value is 0.
    1235 
    1236 DESCRIPTION:
    1237     ``CONFIGURE_MAXIMUM_PERIODS`` is the maximum number of Classic API Periods
    1238     that can be concurrently active.
    1239 
    1240 NOTES:
    1241     This object class can be configured in unlimited allocation mode.
    1242 
    1243 .. index:: CONFIGURE_MAXIMUM_PARTITIONS
    1244 
    1245 .. _CONFIGURE_MAXIMUM_PARTITIONS:
    1246 
    1247 CONFIGURE_MAXIMUM_PARTITIONS
    1248 ----------------------------
    1249 
    1250 CONSTANT:
    1251     ``CONFIGURE_MAXIMUM_PARTITIONS``
    1252 
    1253 DATA TYPE:
    1254     Unsigned integer (``uint32_t``).
    1255 
    1256 RANGE:
    1257     Zero or positive.
    1258 
    1259 DEFAULT VALUE:
    1260     The default value is 0.
    1261 
    1262 DESCRIPTION:
    1263     ``CONFIGURE_MAXIMUM_PARTITIONS`` is the maximum number of Classic API
    1264     Partitions that can be concurrently active.
    1265 
    1266 NOTES:
    1267     This object class can be configured in unlimited allocation mode.
    1268 
    1269 .. index:: CONFIGURE_MAXIMUM_REGIONS
    1270 
    1271 .. _CONFIGURE_MAXIMUM_REGIONS:
    1272 
    1273 CONFIGURE_MAXIMUM_REGIONS
    1274 -------------------------
    1275 
    1276 CONSTANT:
    1277     ``CONFIGURE_MAXIMUM_REGIONS``
    1278 
    1279 DATA TYPE:
    1280     Unsigned integer (``uint32_t``).
    1281 
    1282 RANGE:
    1283     Zero or positive.
    1284 
    1285 DEFAULT VALUE:
    1286     The default value is 0.
    1287 
    1288 DESCRIPTION:
    1289     ``CONFIGURE_MAXIMUM_REGIONS`` is the maximum number of Classic API Regions
    1290     that can be concurrently active.
    1291 
    1292 NOTES:
    1293     None.
    1294 
    1295 .. index:: CONFIGURE_MAXIMUM_PORTS
    1296 
    1297 .. _CONFIGURE_MAXIMUM_PORTS:
    1298 
    1299 CONFIGURE_MAXIMUM_PORTS
    1300 -----------------------
    1301 
    1302 CONSTANT:
    1303     ``CONFIGURE_MAXIMUM_PORTS``
    1304 
    1305 DATA TYPE:
    1306     Unsigned integer (``uint32_t``).
    1307 
    1308 RANGE:
    1309     Zero or positive.
    1310 
    1311 DEFAULT VALUE:
    1312     The default value is 0.
    1313 
    1314 DESCRIPTION:
    1315     ``CONFIGURE_MAXIMUM_PORTS`` is the maximum number of Classic API Ports that
    1316     can be concurrently active.
    13171315
    13181316NOTES:
     
    13511349Initialization Tasks Table named ``Initialization_tasks`` with a single entry.
    13521350The following parameters control the generation of that table.
     1351
     1352.. index:: CONFIGURE_INIT_TASK_ARGUMENTS
     1353
     1354.. _CONFIGURE_INIT_TASK_ARGUMENTS:
     1355
     1356CONFIGURE_INIT_TASK_ARGUMENTS
     1357-----------------------------
     1358
     1359CONSTANT:
     1360    ``CONFIGURE_INIT_TASK_ARGUMENTS``
     1361
     1362DATA TYPE:
     1363    RTEMS Task Argument (``rtems_task_argument``).
     1364
     1365RANGE:
     1366    Complete range of the type.
     1367
     1368DEFAULT VALUE:
     1369    The default value is 0.
     1370
     1371DESCRIPTION:
     1372    ``CONFIGURE_INIT_TASK_ARGUMENTS`` is the task argument of the single
     1373    initialization task defined by the Classic API Initialization Tasks Table.
     1374
     1375NOTES:
     1376    None.
     1377
     1378.. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
     1379
     1380.. _CONFIGURE_INIT_TASK_ATTRIBUTES:
     1381
     1382CONFIGURE_INIT_TASK_ATTRIBUTES
     1383------------------------------
     1384
     1385CONSTANT:
     1386    ``CONFIGURE_INIT_TASK_ATTRIBUTES``
     1387
     1388DATA TYPE:
     1389    RTEMS Attributes (``rtems_attribute``).
     1390
     1391RANGE:
     1392    Valid task attribute sets.
     1393
     1394DEFAULT VALUE:
     1395    The default value is ``RTEMS_DEFAULT_ATTRIBUTES``.
     1396
     1397DESCRIPTION:
     1398    ``CONFIGURE_INIT_TASK_ATTRIBUTES`` is the task attributes of the single
     1399    initialization task defined by the Classic API Initialization Tasks Table.
     1400
     1401NOTES:
     1402    None.
     1403
     1404.. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
     1405
     1406.. _CONFIGURE_INIT_TASK_ENTRY_POINT:
     1407
     1408CONFIGURE_INIT_TASK_ENTRY_POINT
     1409-------------------------------
     1410
     1411CONSTANT:
     1412    ``CONFIGURE_INIT_TASK_ENTRY_POINT``
     1413
     1414DATA TYPE:
     1415    Task entry function pointer (``rtems_task_entry``).
     1416
     1417RANGE:
     1418    Valid task entry function pointer.
     1419
     1420DEFAULT VALUE:
     1421    The default value is ``Init``.
     1422
     1423DESCRIPTION:
     1424    ``CONFIGURE_INIT_TASK_ENTRY_POINT`` is the entry point (a.k.a. function
     1425    name) of the single initialization task defined by the Classic API
     1426    Initialization Tasks Table.
     1427
     1428NOTES:
     1429    The user must implement the function ``Init`` or the function name provided
     1430    in this configuration parameter.
     1431
     1432.. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
     1433
     1434.. _CONFIGURE_INIT_TASK_INITIAL_MODES:
     1435
     1436CONFIGURE_INIT_TASK_INITIAL_MODES
     1437---------------------------------
     1438
     1439CONSTANT:
     1440    ``CONFIGURE_INIT_TASK_INITIAL_MODES``
     1441
     1442DATA TYPE:
     1443    RTEMS Mode (``rtems_mode``).
     1444
     1445RANGE:
     1446    Valid task mode sets.
     1447
     1448DEFAULT VALUE:
     1449    The default value is ``RTEMS_NO_PREEMPT``.
     1450
     1451DESCRIPTION:
     1452    ``CONFIGURE_INIT_TASK_INITIAL_MODES`` is the initial execution mode of the
     1453    single initialization task defined by the Classic API Initialization Tasks
     1454    Table.
     1455
     1456NOTES:
     1457    None.
     1458
     1459.. index:: CONFIGURE_INIT_TASK_NAME
     1460
     1461.. _CONFIGURE_INIT_TASK_NAME:
     1462
     1463CONFIGURE_INIT_TASK_NAME
     1464------------------------
     1465
     1466CONSTANT:
     1467    ``CONFIGURE_INIT_TASK_NAME``
     1468
     1469DATA TYPE:
     1470    RTEMS Name (``rtems_name``).
     1471
     1472RANGE:
     1473    Any value.
     1474
     1475DEFAULT VALUE:
     1476    The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``.
     1477
     1478DESCRIPTION:
     1479    ``CONFIGURE_INIT_TASK_NAME`` is the name of the single initialization task
     1480    defined by the Classic API Initialization Tasks Table.
     1481
     1482NOTES:
     1483    None.
     1484
     1485.. index:: CONFIGURE_INIT_TASK_PRIORITY
     1486
     1487.. _CONFIGURE_INIT_TASK_PRIORITY:
     1488
     1489CONFIGURE_INIT_TASK_PRIORITY
     1490----------------------------
     1491
     1492CONSTANT:
     1493    ``CONFIGURE_INIT_TASK_PRIORITY``
     1494
     1495DATA TYPE:
     1496    RTEMS Task Priority (``rtems_task_priority``).
     1497
     1498RANGE:
     1499    One (1) to the maximum user priority value of the scheduler.
     1500
     1501DEFAULT VALUE:
     1502    The default value is 1, which is the highest priority in the Classic API.
     1503
     1504DESCRIPTION:
     1505    ``CONFIGURE_INIT_TASK_PRIORITY`` is the initial priority of the single
     1506    initialization task defined by the Classic API Initialization Tasks Table.
     1507
     1508NOTES:
     1509    None.
     1510
     1511.. index:: CONFIGURE_INIT_TASK_STACK_SIZE
     1512
     1513.. _CONFIGURE_INIT_TASK_STACK_SIZE:
     1514
     1515CONFIGURE_INIT_TASK_STACK_SIZE
     1516------------------------------
     1517
     1518CONSTANT:
     1519    ``CONFIGURE_INIT_TASK_STACK_SIZE``
     1520
     1521DATA TYPE:
     1522    Unsigned integer (``size_t``).
     1523
     1524RANGE:
     1525    Zero or positive.
     1526
     1527DEFAULT VALUE:
     1528    The default value is RTEMS_MINIMUM_STACK_SIZE.
     1529
     1530DESCRIPTION:
     1531    ``CONFIGURE_INIT_TASK_STACK_SIZE`` is the stack size of the single
     1532    initialization task defined by the Classic API Initialization Tasks Table.
     1533
     1534NOTES:
     1535    If the stack size specified is greater than the configured minimum, it must
     1536    be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
     1537    Task/Thread Stack Memory Above Minimum` for more information about
     1538    ``CONFIGURE_EXTRA_TASK_STACKS``.
    13531539
    13541540.. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
     
    13871573    A compile time error will be generated if the user does not configure any
    13881574    initialization tasks or threads.
    1389 
    1390 .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
    1391 
    1392 .. _CONFIGURE_INIT_TASK_ENTRY_POINT:
    1393 
    1394 CONFIGURE_INIT_TASK_ENTRY_POINT
    1395 -------------------------------
    1396 
    1397 CONSTANT:
    1398     ``CONFIGURE_INIT_TASK_ENTRY_POINT``
    1399 
    1400 DATA TYPE:
    1401     Task entry function pointer (``rtems_task_entry``).
    1402 
    1403 RANGE:
    1404     Valid task entry function pointer.
    1405 
    1406 DEFAULT VALUE:
    1407     The default value is ``Init``.
    1408 
    1409 DESCRIPTION:
    1410     ``CONFIGURE_INIT_TASK_ENTRY_POINT`` is the entry point (a.k.a. function
    1411     name) of the single initialization task defined by the Classic API
    1412     Initialization Tasks Table.
    1413 
    1414 NOTES:
    1415     The user must implement the function ``Init`` or the function name provided
    1416     in this configuration parameter.
    1417 
    1418 .. index:: CONFIGURE_INIT_TASK_NAME
    1419 
    1420 .. _CONFIGURE_INIT_TASK_NAME:
    1421 
    1422 CONFIGURE_INIT_TASK_NAME
    1423 ------------------------
    1424 
    1425 CONSTANT:
    1426     ``CONFIGURE_INIT_TASK_NAME``
    1427 
    1428 DATA TYPE:
    1429     RTEMS Name (``rtems_name``).
    1430 
    1431 RANGE:
    1432     Any value.
    1433 
    1434 DEFAULT VALUE:
    1435     The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``.
    1436 
    1437 DESCRIPTION:
    1438     ``CONFIGURE_INIT_TASK_NAME`` is the name of the single initialization task
    1439     defined by the Classic API Initialization Tasks Table.
    1440 
    1441 NOTES:
    1442     None.
    1443 
    1444 .. index:: CONFIGURE_INIT_TASK_STACK_SIZE
    1445 
    1446 .. _CONFIGURE_INIT_TASK_STACK_SIZE:
    1447 
    1448 CONFIGURE_INIT_TASK_STACK_SIZE
    1449 ------------------------------
    1450 
    1451 CONSTANT:
    1452     ``CONFIGURE_INIT_TASK_STACK_SIZE``
    1453 
    1454 DATA TYPE:
    1455     Unsigned integer (``size_t``).
    1456 
    1457 RANGE:
    1458     Zero or positive.
    1459 
    1460 DEFAULT VALUE:
    1461     The default value is RTEMS_MINIMUM_STACK_SIZE.
    1462 
    1463 DESCRIPTION:
    1464     ``CONFIGURE_INIT_TASK_STACK_SIZE`` is the stack size of the single
    1465     initialization task defined by the Classic API Initialization Tasks Table.
    1466 
    1467 NOTES:
    1468     If the stack size specified is greater than the configured minimum, it must
    1469     be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
    1470     Task/Thread Stack Memory Above Minimum` for more information about
    1471     ``CONFIGURE_EXTRA_TASK_STACKS``.
    1472 
    1473 .. index:: CONFIGURE_INIT_TASK_PRIORITY
    1474 
    1475 .. _CONFIGURE_INIT_TASK_PRIORITY:
    1476 
    1477 CONFIGURE_INIT_TASK_PRIORITY
    1478 ----------------------------
    1479 
    1480 CONSTANT:
    1481     ``CONFIGURE_INIT_TASK_PRIORITY``
    1482 
    1483 DATA TYPE:
    1484     RTEMS Task Priority (``rtems_task_priority``).
    1485 
    1486 RANGE:
    1487     One (1) to the maximum user priority value of the scheduler.
    1488 
    1489 DEFAULT VALUE:
    1490     The default value is 1, which is the highest priority in the Classic API.
    1491 
    1492 DESCRIPTION:
    1493     ``CONFIGURE_INIT_TASK_PRIORITY`` is the initial priority of the single
    1494     initialization task defined by the Classic API Initialization Tasks Table.
    1495 
    1496 NOTES:
    1497     None.
    1498 
    1499 
    1500 .. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
    1501 
    1502 .. _CONFIGURE_INIT_TASK_ATTRIBUTES:
    1503 
    1504 CONFIGURE_INIT_TASK_ATTRIBUTES
    1505 ------------------------------
    1506 
    1507 CONSTANT:
    1508     ``CONFIGURE_INIT_TASK_ATTRIBUTES``
    1509 
    1510 DATA TYPE:
    1511     RTEMS Attributes (``rtems_attribute``).
    1512 
    1513 RANGE:
    1514     Valid task attribute sets.
    1515 
    1516 DEFAULT VALUE:
    1517     The default value is ``RTEMS_DEFAULT_ATTRIBUTES``.
    1518 
    1519 DESCRIPTION:
    1520     ``CONFIGURE_INIT_TASK_ATTRIBUTES`` is the task attributes of the single
    1521     initialization task defined by the Classic API Initialization Tasks Table.
    1522 
    1523 NOTES:
    1524     None.
    1525 
    1526 .. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
    1527 
    1528 .. _CONFIGURE_INIT_TASK_INITIAL_MODES:
    1529 
    1530 CONFIGURE_INIT_TASK_INITIAL_MODES
    1531 ---------------------------------
    1532 
    1533 CONSTANT:
    1534     ``CONFIGURE_INIT_TASK_INITIAL_MODES``
    1535 
    1536 DATA TYPE:
    1537     RTEMS Mode (``rtems_mode``).
    1538 
    1539 RANGE:
    1540     Valid task mode sets.
    1541 
    1542 DEFAULT VALUE:
    1543     The default value is ``RTEMS_NO_PREEMPT``.
    1544 
    1545 DESCRIPTION:
    1546     ``CONFIGURE_INIT_TASK_INITIAL_MODES`` is the initial execution mode of the
    1547     single initialization task defined by the Classic API Initialization Tasks
    1548     Table.
    1549 
    1550 NOTES:
    1551     None.
    1552 
    1553 .. index:: CONFIGURE_INIT_TASK_ARGUMENTS
    1554 
    1555 .. _CONFIGURE_INIT_TASK_ARGUMENTS:
    1556 
    1557 CONFIGURE_INIT_TASK_ARGUMENTS
    1558 -----------------------------
    1559 
    1560 CONSTANT:
    1561     ``CONFIGURE_INIT_TASK_ARGUMENTS``
    1562 
    1563 DATA TYPE:
    1564     RTEMS Task Argument (``rtems_task_argument``).
    1565 
    1566 RANGE:
    1567     Complete range of the type.
    1568 
    1569 DEFAULT VALUE:
    1570     The default value is 0.
    1571 
    1572 DESCRIPTION:
    1573     ``CONFIGURE_INIT_TASK_ARGUMENTS`` is the task argument of the single
    1574     initialization task defined by the Classic API Initialization Tasks Table.
    1575 
    1576 NOTES:
    1577     None.
    15781575
    15791576POSIX API Configuration
     
    18331830a single entry.  The following parameters control the generation of that table.
    18341831
     1832.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
     1833
     1834.. _CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT:
     1835
     1836CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
     1837---------------------------------------
     1838
     1839CONSTANT:
     1840    ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT``
     1841
     1842DATA TYPE:
     1843    POSIX thread function pointer (``void *(*entry_point)(void *)``).
     1844
     1845RANGE:
     1846    Undefined or a valid POSIX thread function pointer.
     1847
     1848DEFAULT VALUE:
     1849    The default value is ``POSIX_Init``.
     1850
     1851DESCRIPTION:
     1852    ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT`` is the entry point
     1853    (a.k.a. function name) of the single initialization thread defined by the
     1854    POSIX API Initialization Threads Table.
     1855
     1856NOTES:
     1857    The user must implement the function ``POSIX_Init`` or the function name
     1858    provided in this configuration parameter.
     1859
     1860.. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
     1861
     1862.. _CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE:
     1863
     1864CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
     1865--------------------------------------
     1866
     1867CONSTANT:
     1868    ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE``
     1869
     1870DATA TYPE:
     1871    Unsigned integer (``size_t``).
     1872
     1873RANGE:
     1874    Zero or positive.
     1875
     1876DEFAULT VALUE:
     1877    The default value is 2 \* RTEMS_MINIMUM_STACK_SIZE.
     1878
     1879DESCRIPTION:
     1880    ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE`` is the stack size of the single
     1881    initialization thread defined by the POSIX API Initialization Threads
     1882    Table.
     1883
     1884NOTES:
     1885    If the stack size specified is greater than the configured minimum, it must
     1886    be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
     1887    Task/Thread Stack Memory Above Minimum` for more information about
     1888    ``CONFIGURE_EXTRA_TASK_STACKS``.
     1889
    18351890.. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
    18361891
     
    18711926    initialization tasks or threads.
    18721927
    1873 .. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    1874 
    1875 .. _CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT:
    1876 
    1877 CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    1878 ---------------------------------------
    1879 
    1880 CONSTANT:
    1881     ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT``
    1882 
    1883 DATA TYPE:
    1884     POSIX thread function pointer (``void *(*entry_point)(void *)``).
    1885 
    1886 RANGE:
    1887     Undefined or a valid POSIX thread function pointer.
    1888 
    1889 DEFAULT VALUE:
    1890     The default value is ``POSIX_Init``.
    1891 
    1892 DESCRIPTION:
    1893     ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT`` is the entry point
    1894     (a.k.a. function name) of the single initialization thread defined by the
    1895     POSIX API Initialization Threads Table.
    1896 
    1897 NOTES:
    1898     The user must implement the function ``POSIX_Init`` or the function name
    1899     provided in this configuration parameter.
    1900 
    1901 .. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    1902 
    1903 .. _CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE:
    1904 
    1905 CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    1906 --------------------------------------
    1907 
    1908 CONSTANT:
    1909     ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE``
    1910 
    1911 DATA TYPE:
    1912     Unsigned integer (``size_t``).
    1913 
    1914 RANGE:
    1915     Zero or positive.
    1916 
    1917 DEFAULT VALUE:
    1918     The default value is 2 \* RTEMS_MINIMUM_STACK_SIZE.
    1919 
    1920 DESCRIPTION:
    1921     ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE`` is the stack size of the single
    1922     initialization thread defined by the POSIX API Initialization Threads
    1923     Table.
    1924 
    1925 NOTES:
    1926     If the stack size specified is greater than the configured minimum, it must
    1927     be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
    1928     Task/Thread Stack Memory Above Minimum` for more information about
    1929     ``CONFIGURE_EXTRA_TASK_STACKS``.
    1930 
    19311928Task Stack Allocator Configuration
    19321929==================================
     
    19371934overflows are detected in hardware.
    19381935
     1936.. index:: CONFIGURE_TASK_STACK_ALLOCATOR
     1937.. index:: task stack allocator
     1938
     1939.. _CONFIGURE_TASK_STACK_ALLOCATOR:
     1940
     1941CONFIGURE_TASK_STACK_ALLOCATOR
     1942------------------------------
     1943
     1944CONSTANT:
     1945    ``CONFIGURE_TASK_STACK_ALLOCATOR``
     1946
     1947DATA TYPE:
     1948    Function pointer.
     1949
     1950RANGE:
     1951    Undefined or valid function pointer.
     1952
     1953DEFAULT VALUE:
     1954    The default value is ``_Workspace_Allocate``, which indicates that task
     1955    stacks will be allocated from the RTEMS Workspace.
     1956
     1957DESCRIPTION:
     1958    ``CONFIGURE_TASK_STACK_ALLOCATOR`` may point to a user provided routine to
     1959    allocate task stacks.
     1960
     1961NOTES:
     1962    A correctly configured system must configure the following to be consistent:
     1963
     1964- ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT``
     1965
     1966- ``CONFIGURE_TASK_STACK_ALLOCATOR``
     1967
     1968- ``CONFIGURE_TASK_STACK_DEALLOCATOR``
     1969
    19391970.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
    19401971
     
    19611992    method for an application or BSP specific task stack allocation
    19621993    implementation.
    1963 
    1964 NOTES:
    1965     A correctly configured system must configure the following to be consistent:
    1966 
    1967 - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT``
    1968 
    1969 - ``CONFIGURE_TASK_STACK_ALLOCATOR``
    1970 
    1971 - ``CONFIGURE_TASK_STACK_DEALLOCATOR``
    1972 
    1973 .. index:: CONFIGURE_TASK_STACK_ALLOCATOR
    1974 .. index:: task stack allocator
    1975 
    1976 .. _CONFIGURE_TASK_STACK_ALLOCATOR:
    1977 
    1978 CONFIGURE_TASK_STACK_ALLOCATOR
    1979 ------------------------------
    1980 
    1981 CONSTANT:
    1982     ``CONFIGURE_TASK_STACK_ALLOCATOR``
    1983 
    1984 DATA TYPE:
    1985     Function pointer.
    1986 
    1987 RANGE:
    1988     Undefined or valid function pointer.
    1989 
    1990 DEFAULT VALUE:
    1991     The default value is ``_Workspace_Allocate``, which indicates that task
    1992     stacks will be allocated from the RTEMS Workspace.
    1993 
    1994 DESCRIPTION:
    1995     ``CONFIGURE_TASK_STACK_ALLOCATOR`` may point to a user provided routine to
    1996     allocate task stacks.
    19971994
    19981995NOTES:
     
    20462043:ref:`CONFIGURE_MAXIMUM_MESSAGE_QUEUES` and
    20472044:ref:`CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES`.
    2048 
    2049 .. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
    2050 .. index:: memory for a single message queue's buffers
    2051 
    2052 .. _CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE:
    2053 
    2054 CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
    2055 -----------------------------------
    2056 
    2057 CONSTANT:
    2058     ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per)``
    2059 
    2060 DATA TYPE:
    2061     Unsigned integer (``size_t``).
    2062 
    2063 RANGE:
    2064     Positive.
    2065 
    2066 DEFAULT VALUE:
    2067     The default value is None.
    2068 
    2069 DESCRIPTION:
    2070     This is a helper macro which is used to assist in computing the total
    2071     amount of memory required for message buffers.  Each message queue will
    2072     have its own configuration with maximum message size and maximum number of
    2073     pending messages.
    2074 
    2075     The interface for this macro is as follows:
    2076 
    2077     .. code-block:: c
    2078 
    2079         CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per)
    2080 
    2081     Where ``max_messages`` is the maximum number of pending messages and
    2082     ``size_per`` is the size in bytes of the user message.
    2083 
    2084 NOTES:
    2085     This macro is only used in support of :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
    20862045
    20872046.. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY
     
    21282087                         500, sizeof(other_message_type) \
    21292088                     )
     2089
     2090.. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
     2091.. index:: memory for a single message queue's buffers
     2092
     2093.. _CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE:
     2094
     2095CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
     2096-----------------------------------
     2097
     2098CONSTANT:
     2099    ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per)``
     2100
     2101DATA TYPE:
     2102    Unsigned integer (``size_t``).
     2103
     2104RANGE:
     2105    Positive.
     2106
     2107DEFAULT VALUE:
     2108    The default value is None.
     2109
     2110DESCRIPTION:
     2111    This is a helper macro which is used to assist in computing the total
     2112    amount of memory required for message buffers.  Each message queue will
     2113    have its own configuration with maximum message size and maximum number of
     2114    pending messages.
     2115
     2116    The interface for this macro is as follows:
     2117
     2118    .. code-block:: c
     2119
     2120        CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per)
     2121
     2122    Where ``max_messages`` is the maximum number of pending messages and
     2123    ``size_per`` is the size in bytes of the user message.
     2124
     2125NOTES:
     2126    This macro is only used in support of :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
    21302127
    21312128Filesystem Configuration
     
    21732170* :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO`
    21742171
    2175 .. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
    2176 
    2177 .. _CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM:
    2178 
    2179 CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
    2180 --------------------------------------
    2181 
    2182 CONSTANT:
    2183     ``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM``
    2184 
    2185 DATA TYPE:
    2186     Boolean feature macro.
    2187 
    2188 RANGE:
    2189     Defined or undefined.
    2190 
    2191 DEFAULT VALUE:
    2192     This is not defined by default. If no other root file system configuration
    2193     parameters are specified, the IMFS will be used as the root file system.
    2194 
    2195 DESCRIPTION:
    2196     This configuration parameter is defined if the application wishes to use
    2197     the device-only filesytem as the root file system.
    2198 
    2199 NOTES:
    2200     The device-only filesystem supports only device nodes and is smaller in
    2201     executable code size than the full IMFS and miniIMFS.
    2202 
    2203     The devFS is comparable in functionality to the pseudo-filesystem name
    2204     space provided before RTEMS release 4.5.0.
    2205 
    2206 .. index:: CONFIGURE_MAXIMUM_DEVICES
    2207 
    2208 .. _CONFIGURE_MAXIMUM_DEVICES:
    2209 
    2210 CONFIGURE_MAXIMUM_DEVICES
    2211 -------------------------
    2212 
    2213 CONSTANT:
    2214     ``CONFIGURE_MAXIMUM_DEVICES``
    2215 
    2216 DATA TYPE:
    2217     Unsigned integer (``uint32_t``).
    2218 
    2219 RANGE:
    2220     Positive.
    2221 
    2222 DEFAULT VALUE:
    2223     If ``BSP_MAXIMUM_DEVICES`` is defined, then the default value is
    2224     ``BSP_MAXIMUM_DEVICES``, otherwise the default value is 4.
    2225 
    2226 DESCRIPTION:
    2227     ``CONFIGURE_MAXIMUM_DEVICES`` is defined to the number of individual
    2228     devices that may be registered in the device file system (devFS).
    2229 
    2230 NOTES:
    2231     This option is specific to the device file system (devFS) and should not be
    2232     confused with the ``CONFIGURE_MAXIMUM_DRIVERS`` option.  This parameter
    2233     only impacts the devFS and thus is only used by ``<rtems/confdefs.h>`` when
    2234     ``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM`` is specified.
    2235 
    22362172.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
    22372173
     
    22622198    None.
    22632199
    2264 .. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
    2265 
    2266 .. _CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM:
    2267 
    2268 CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
    2269 -----------------------------------------
    2270 
    2271 CONSTANT:
    2272     ``CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM``
     2200.. index:: CONFIGURE_IMFS_ENABLE_MKFIFO
     2201
     2202.. _CONFIGURE_IMFS_ENABLE_MKFIFO:
     2203
     2204CONFIGURE_IMFS_ENABLE_MKFIFO
     2205----------------------------
     2206
     2207CONSTANT:
     2208    ``CONFIGURE_IMFS_ENABLE_MKFIFO``
    22732209
    22742210DATA TYPE:
     
    22822218
    22832219DESCRIPTION:
    2284     In case this configuration option is defined, then the following
    2285     configuration options will be defined as well
    2286 
    2287     - ``CONFIGURE_IMFS_DISABLE_CHMOD``,
    2288 
    2289     - ``CONFIGURE_IMFS_DISABLE_CHOWN``,
    2290 
    2291     - ``CONFIGURE_IMFS_DISABLE_UTIME``,
    2292 
    2293     - ``CONFIGURE_IMFS_DISABLE_LINK``,
    2294 
    2295     - ``CONFIGURE_IMFS_DISABLE_SYMLINK``,
    2296 
    2297     - ``CONFIGURE_IMFS_DISABLE_READLINK``,
    2298 
    2299     - ``CONFIGURE_IMFS_DISABLE_RENAME``, and
    2300 
    2301     - ``CONFIGURE_IMFS_DISABLE_UNMOUNT``.
     2220    In case this configuration option is defined, then the support to make FIFOs
     2221    is enabled in the root IMFS.
     2222
     2223.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
     2224
     2225.. _CONFIGURE_IMFS_DISABLE_CHMOD:
     2226
     2227CONFIGURE_IMFS_DISABLE_CHMOD
     2228----------------------------
     2229
     2230CONSTANT:
     2231    ``CONFIGURE_IMFS_DISABLE_CHMOD``
     2232
     2233DATA TYPE:
     2234    Boolean feature macro.
     2235
     2236RANGE:
     2237    Defined or undefined.
     2238
     2239DEFAULT VALUE:
     2240    This is not defined by default.
     2241
     2242DESCRIPTION:
     2243    In case this configuration option is defined, then the support to change
     2244    the mode is disabled in the root IMFS.
     2245
     2246.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
     2247
     2248.. _CONFIGURE_IMFS_DISABLE_CHOWN:
     2249
     2250CONFIGURE_IMFS_DISABLE_CHOWN
     2251----------------------------
     2252
     2253CONSTANT:
     2254    ``CONFIGURE_IMFS_DISABLE_CHOWN``
     2255
     2256DATA TYPE:
     2257    Boolean feature macro.
     2258
     2259RANGE:
     2260    Defined or undefined.
     2261
     2262DEFAULT VALUE:
     2263    This is not defined by default.
     2264
     2265DESCRIPTION:
     2266    In case this configuration option is defined, then the support to change
     2267    the owner is disabled in the root IMFS.
     2268
     2269.. index:: CONFIGURE_IMFS_DISABLE_LINK
     2270
     2271.. _CONFIGURE_IMFS_DISABLE_LINK:
     2272
     2273CONFIGURE_IMFS_DISABLE_LINK
     2274---------------------------
     2275
     2276CONSTANT:
     2277    ``CONFIGURE_IMFS_DISABLE_LINK``
     2278
     2279DATA TYPE:
     2280    Boolean feature macro.
     2281
     2282RANGE:
     2283    Defined or undefined.
     2284
     2285DEFAULT VALUE:
     2286    This is not defined by default.
     2287
     2288DESCRIPTION:
     2289    In case this configuration option is defined, then the support to create
     2290    hard links is disabled in the root IMFS.
     2291
     2292.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
     2293
     2294.. _CONFIGURE_IMFS_DISABLE_MKNOD:
     2295
     2296CONFIGURE_IMFS_DISABLE_MKNOD
     2297----------------------------
     2298
     2299CONSTANT:
     2300    ``CONFIGURE_IMFS_DISABLE_MKNOD``
     2301
     2302DATA TYPE:
     2303    Boolean feature macro.
     2304
     2305RANGE:
     2306    Defined or undefined.
     2307
     2308DEFAULT VALUE:
     2309    This is not defined by default.
     2310
     2311DESCRIPTION:
     2312    In case this configuration option is defined, then the support to make
     2313    directories, devices, regular files and FIFOs is disabled in the root IMFS.
     2314
     2315.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
     2316
     2317.. _CONFIGURE_IMFS_DISABLE_MKNOD_FILE:
     2318
     2319CONFIGURE_IMFS_DISABLE_MKNOD_FILE
     2320---------------------------------
     2321
     2322CONSTANT:
     2323    ``CONFIGURE_IMFS_DISABLE_MKNOD_FILE``
     2324
     2325DATA TYPE:
     2326    Boolean feature macro.
     2327
     2328RANGE:
     2329    Defined or undefined.
     2330
     2331DEFAULT VALUE:
     2332    This is not defined by default.
     2333
     2334DESCRIPTION:
     2335    In case this configuration option is defined, then the support to make
     2336    regular files is disabled in the root IMFS.
     2337
     2338.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
     2339
     2340.. _CONFIGURE_IMFS_DISABLE_MOUNT:
     2341
     2342CONFIGURE_IMFS_DISABLE_MOUNT
     2343----------------------------
     2344
     2345CONSTANT:
     2346    ``CONFIGURE_IMFS_DISABLE_MOUNT``
     2347
     2348DATA TYPE:
     2349    Boolean feature macro.
     2350
     2351RANGE:
     2352    Defined or undefined.
     2353
     2354DEFAULT VALUE:
     2355    This is not defined by default.
     2356
     2357DESCRIPTION:
     2358    In case this configuration option is defined, then the support to mount
     2359    other file systems is disabled in the root IMFS.
     2360
     2361.. index:: CONFIGURE_IMFS_DISABLE_READDIR
     2362
     2363.. _CONFIGURE_IMFS_DISABLE_READDIR:
     2364
     2365CONFIGURE_IMFS_DISABLE_READDIR
     2366------------------------------
     2367
     2368CONSTANT:
     2369    ``CONFIGURE_IMFS_DISABLE_READDIR``
     2370
     2371DATA TYPE:
     2372    Boolean feature macro.
     2373
     2374RANGE:
     2375    Defined or undefined.
     2376
     2377DEFAULT VALUE:
     2378    This is not defined by default.
     2379
     2380DESCRIPTION:
     2381    In case this configuration option is defined, then the support to read a
     2382    directory is disabled in the root IMFS.  It is still possible to open nodes
     2383    in a directory.
     2384
     2385.. index:: CONFIGURE_IMFS_DISABLE_READLINK
     2386
     2387.. _CONFIGURE_IMFS_DISABLE_READLINK:
     2388
     2389CONFIGURE_IMFS_DISABLE_READLINK
     2390-------------------------------
     2391
     2392CONSTANT:
     2393    ``CONFIGURE_IMFS_DISABLE_READLINK``
     2394
     2395DATA TYPE:
     2396    Boolean feature macro.
     2397
     2398RANGE:
     2399    Defined or undefined.
     2400
     2401DEFAULT VALUE:
     2402    This is not defined by default.
     2403
     2404DESCRIPTION:
     2405    In case this configuration option is defined, then the support to read
     2406    symbolic links is disabled in the root IMFS.
     2407
     2408.. index:: CONFIGURE_IMFS_DISABLE_RENAME
     2409
     2410.. _CONFIGURE_IMFS_DISABLE_RENAME:
     2411
     2412CONFIGURE_IMFS_DISABLE_RENAME
     2413-----------------------------
     2414
     2415CONSTANT:
     2416    ``CONFIGURE_IMFS_DISABLE_RENAME``
     2417
     2418DATA TYPE:
     2419    Boolean feature macro.
     2420
     2421RANGE:
     2422    Defined or undefined.
     2423
     2424DEFAULT VALUE:
     2425    This is not defined by default.
     2426
     2427DESCRIPTION:
     2428    In case this configuration option is defined, then the support to rename
     2429    nodes is disabled in the root IMFS.
     2430
     2431.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
     2432
     2433.. _CONFIGURE_IMFS_DISABLE_RMNOD:
     2434
     2435CONFIGURE_IMFS_DISABLE_RMNOD
     2436----------------------------
     2437
     2438CONSTANT:
     2439    ``CONFIGURE_IMFS_DISABLE_RMNOD``
     2440
     2441DATA TYPE:
     2442    Boolean feature macro.
     2443
     2444RANGE:
     2445    Defined or undefined.
     2446
     2447DEFAULT VALUE:
     2448    This is not defined by default.
     2449
     2450DESCRIPTION:
     2451    In case this configuration option is defined, then the support to remove
     2452    nodes is disabled in the root IMFS.
     2453
     2454.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
     2455
     2456.. _CONFIGURE_IMFS_DISABLE_SYMLINK:
     2457
     2458CONFIGURE_IMFS_DISABLE_SYMLINK
     2459------------------------------
     2460
     2461CONSTANT:
     2462    ``CONFIGURE_IMFS_DISABLE_SYMLINK``
     2463
     2464DATA TYPE:
     2465    Boolean feature macro.
     2466
     2467RANGE:
     2468    Defined or undefined.
     2469
     2470DEFAULT VALUE:
     2471    This is not defined by default.
     2472
     2473DESCRIPTION:
     2474    In case this configuration option is defined, then the support to create
     2475    symbolic links is disabled in the root IMFS.
     2476
     2477.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
     2478
     2479.. _CONFIGURE_IMFS_DISABLE_UNMOUNT:
     2480
     2481CONFIGURE_IMFS_DISABLE_UNMOUNT
     2482------------------------------
     2483
     2484CONSTANT:
     2485    ``CONFIGURE_IMFS_DISABLE_UNMOUNT``
     2486
     2487DATA TYPE:
     2488    Boolean feature macro.
     2489
     2490RANGE:
     2491    Defined or undefined.
     2492
     2493DEFAULT VALUE:
     2494    This is not defined by default.
     2495
     2496DESCRIPTION:
     2497    In case this configuration option is defined, then the support to unmount
     2498    file systems is disabled in the root IMFS.
     2499
     2500.. index:: CONFIGURE_IMFS_DISABLE_UTIME
     2501
     2502.. _CONFIGURE_IMFS_DISABLE_UTIME:
     2503
     2504CONFIGURE_IMFS_DISABLE_UTIME
     2505----------------------------
     2506
     2507CONSTANT:
     2508    ``CONFIGURE_IMFS_DISABLE_UTIME``
     2509
     2510DATA TYPE:
     2511    Boolean feature macro.
     2512
     2513RANGE:
     2514    Defined or undefined.
     2515
     2516DEFAULT VALUE:
     2517    This is not defined by default.
     2518
     2519DESCRIPTION:
     2520    In case this configuration option is defined, then the support to change
     2521    times is disabled in the root IMFS.
    23022522
    23032523.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
     
    23502570      bytes.
    23512571
    2352 .. index:: CONFIGURE_IMFS_DISABLE_CHOWN
    2353 
    2354 .. _CONFIGURE_IMFS_DISABLE_CHOWN:
    2355 
    2356 CONFIGURE_IMFS_DISABLE_CHOWN
    2357 ----------------------------
    2358 
    2359 CONSTANT:
    2360     ``CONFIGURE_IMFS_DISABLE_CHOWN``
     2572.. index:: CONFIGURE_MAXIMUM_DEVICES
     2573
     2574.. _CONFIGURE_MAXIMUM_DEVICES:
     2575
     2576CONFIGURE_MAXIMUM_DEVICES
     2577-------------------------
     2578
     2579CONSTANT:
     2580    ``CONFIGURE_MAXIMUM_DEVICES``
     2581
     2582DATA TYPE:
     2583    Unsigned integer (``uint32_t``).
     2584
     2585RANGE:
     2586    Positive.
     2587
     2588DEFAULT VALUE:
     2589    If ``BSP_MAXIMUM_DEVICES`` is defined, then the default value is
     2590    ``BSP_MAXIMUM_DEVICES``, otherwise the default value is 4.
     2591
     2592DESCRIPTION:
     2593    ``CONFIGURE_MAXIMUM_DEVICES`` is defined to the number of individual
     2594    devices that may be registered in the device file system (devFS).
     2595
     2596NOTES:
     2597    This option is specific to the device file system (devFS) and should not be
     2598    confused with the ``CONFIGURE_MAXIMUM_DRIVERS`` option.  This parameter
     2599    only impacts the devFS and thus is only used by ``<rtems/confdefs.h>`` when
     2600    ``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM`` is specified.
     2601
     2602.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
     2603
     2604.. _CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM:
     2605
     2606CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
     2607--------------------------------------
     2608
     2609CONSTANT:
     2610    ``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM``
     2611
     2612DATA TYPE:
     2613    Boolean feature macro.
     2614
     2615RANGE:
     2616    Defined or undefined.
     2617
     2618DEFAULT VALUE:
     2619    This is not defined by default. If no other root file system configuration
     2620    parameters are specified, the IMFS will be used as the root file system.
     2621
     2622DESCRIPTION:
     2623    This configuration parameter is defined if the application wishes to use
     2624    the device-only filesytem as the root file system.
     2625
     2626NOTES:
     2627    The device-only filesystem supports only device nodes and is smaller in
     2628    executable code size than the full IMFS and miniIMFS.
     2629
     2630    The devFS is comparable in functionality to the pseudo-filesystem name
     2631    space provided before RTEMS release 4.5.0.
     2632
     2633.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
     2634
     2635.. _CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM:
     2636
     2637CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
     2638-----------------------------------------
     2639
     2640CONSTANT:
     2641    ``CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM``
    23612642
    23622643DATA TYPE:
     
    23702651
    23712652DESCRIPTION:
    2372     In case this configuration option is defined, then the support to change
    2373     the owner is disabled in the root IMFS.
    2374 
    2375 .. index:: CONFIGURE_IMFS_DISABLE_CHMOD
    2376 
    2377 .. _CONFIGURE_IMFS_DISABLE_CHMOD:
    2378 
    2379 CONFIGURE_IMFS_DISABLE_CHMOD
    2380 ----------------------------
    2381 
    2382 CONSTANT:
    2383     ``CONFIGURE_IMFS_DISABLE_CHMOD``
    2384 
    2385 DATA TYPE:
    2386     Boolean feature macro.
    2387 
    2388 RANGE:
    2389     Defined or undefined.
    2390 
    2391 DEFAULT VALUE:
    2392     This is not defined by default.
    2393 
    2394 DESCRIPTION:
    2395     In case this configuration option is defined, then the support to change
    2396     the mode is disabled in the root IMFS.
    2397 
    2398 .. index:: CONFIGURE_IMFS_DISABLE_UTIME
    2399 
    2400 .. _CONFIGURE_IMFS_DISABLE_UTIME:
    2401 
    2402 CONFIGURE_IMFS_DISABLE_UTIME
    2403 ----------------------------
    2404 
    2405 CONSTANT:
    2406     ``CONFIGURE_IMFS_DISABLE_UTIME``
    2407 
    2408 DATA TYPE:
    2409     Boolean feature macro.
    2410 
    2411 RANGE:
    2412     Defined or undefined.
    2413 
    2414 DEFAULT VALUE:
    2415     This is not defined by default.
    2416 
    2417 DESCRIPTION:
    2418     In case this configuration option is defined, then the support to change
    2419     times is disabled in the root IMFS.
    2420 
    2421 .. index:: CONFIGURE_IMFS_DISABLE_LINK
    2422 
    2423 .. _CONFIGURE_IMFS_DISABLE_LINK:
    2424 
    2425 CONFIGURE_IMFS_DISABLE_LINK
    2426 ---------------------------
    2427 
    2428 CONSTANT:
    2429     ``CONFIGURE_IMFS_DISABLE_LINK``
    2430 
    2431 DATA TYPE:
    2432     Boolean feature macro.
    2433 
    2434 RANGE:
    2435     Defined or undefined.
    2436 
    2437 DEFAULT VALUE:
    2438     This is not defined by default.
    2439 
    2440 DESCRIPTION:
    2441     In case this configuration option is defined, then the support to create
    2442     hard links is disabled in the root IMFS.
    2443 
    2444 .. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
    2445 
    2446 .. _CONFIGURE_IMFS_DISABLE_SYMLINK:
    2447 
    2448 CONFIGURE_IMFS_DISABLE_SYMLINK
    2449 ------------------------------
    2450 
    2451 CONSTANT:
    2452     ``CONFIGURE_IMFS_DISABLE_SYMLINK``
    2453 
    2454 DATA TYPE:
    2455     Boolean feature macro.
    2456 
    2457 RANGE:
    2458     Defined or undefined.
    2459 
    2460 DEFAULT VALUE:
    2461     This is not defined by default.
    2462 
    2463 DESCRIPTION:
    2464     In case this configuration option is defined, then the support to create
    2465     symbolic links is disabled in the root IMFS.
    2466 
    2467 .. index:: CONFIGURE_IMFS_DISABLE_READLINK
    2468 
    2469 .. _CONFIGURE_IMFS_DISABLE_READLINK:
    2470 
    2471 CONFIGURE_IMFS_DISABLE_READLINK
    2472 -------------------------------
    2473 
    2474 CONSTANT:
    2475     ``CONFIGURE_IMFS_DISABLE_READLINK``
    2476 
    2477 DATA TYPE:
    2478     Boolean feature macro.
    2479 
    2480 RANGE:
    2481     Defined or undefined.
    2482 
    2483 DEFAULT VALUE:
    2484     This is not defined by default.
    2485 
    2486 DESCRIPTION:
    2487     In case this configuration option is defined, then the support to read
    2488     symbolic links is disabled in the root IMFS.
    2489 
    2490 .. index:: CONFIGURE_IMFS_DISABLE_RENAME
    2491 
    2492 .. _CONFIGURE_IMFS_DISABLE_RENAME:
    2493 
    2494 CONFIGURE_IMFS_DISABLE_RENAME
    2495 -----------------------------
    2496 
    2497 CONSTANT:
    2498     ``CONFIGURE_IMFS_DISABLE_RENAME``
    2499 
    2500 DATA TYPE:
    2501     Boolean feature macro.
    2502 
    2503 RANGE:
    2504     Defined or undefined.
    2505 
    2506 DEFAULT VALUE:
    2507     This is not defined by default.
    2508 
    2509 DESCRIPTION:
    2510     In case this configuration option is defined, then the support to rename
    2511     nodes is disabled in the root IMFS.
    2512 
    2513 .. index:: CONFIGURE_IMFS_DISABLE_READDIR
    2514 
    2515 .. _CONFIGURE_IMFS_DISABLE_READDIR:
    2516 
    2517 CONFIGURE_IMFS_DISABLE_READDIR
    2518 ------------------------------
    2519 
    2520 CONSTANT:
    2521     ``CONFIGURE_IMFS_DISABLE_READDIR``
    2522 
    2523 DATA TYPE:
    2524     Boolean feature macro.
    2525 
    2526 RANGE:
    2527     Defined or undefined.
    2528 
    2529 DEFAULT VALUE:
    2530     This is not defined by default.
    2531 
    2532 DESCRIPTION:
    2533     In case this configuration option is defined, then the support to read a
    2534     directory is disabled in the root IMFS.  It is still possible to open nodes
    2535     in a directory.
    2536 
    2537 .. index:: CONFIGURE_IMFS_DISABLE_MOUNT
    2538 
    2539 .. _CONFIGURE_IMFS_DISABLE_MOUNT:
    2540 
    2541 CONFIGURE_IMFS_DISABLE_MOUNT
    2542 ----------------------------
    2543 
    2544 CONSTANT:
    2545     ``CONFIGURE_IMFS_DISABLE_MOUNT``
    2546 
    2547 DATA TYPE:
    2548     Boolean feature macro.
    2549 
    2550 RANGE:
    2551     Defined or undefined.
    2552 
    2553 DEFAULT VALUE:
    2554     This is not defined by default.
    2555 
    2556 DESCRIPTION:
    2557     In case this configuration option is defined, then the support to mount
    2558     other file systems is disabled in the root IMFS.
    2559 
    2560 .. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
    2561 
    2562 .. _CONFIGURE_IMFS_DISABLE_UNMOUNT:
    2563 
    2564 CONFIGURE_IMFS_DISABLE_UNMOUNT
    2565 ------------------------------
    2566 
    2567 CONSTANT:
    2568     ``CONFIGURE_IMFS_DISABLE_UNMOUNT``
    2569 
    2570 DATA TYPE:
    2571     Boolean feature macro.
    2572 
    2573 RANGE:
    2574     Defined or undefined.
    2575 
    2576 DEFAULT VALUE:
    2577     This is not defined by default.
    2578 
    2579 DESCRIPTION:
    2580     In case this configuration option is defined, then the support to unmount
    2581     file systems is disabled in the root IMFS.
    2582 
    2583 .. index:: CONFIGURE_IMFS_DISABLE_MKNOD
    2584 
    2585 .. _CONFIGURE_IMFS_DISABLE_MKNOD:
    2586 
    2587 CONFIGURE_IMFS_DISABLE_MKNOD
    2588 ----------------------------
    2589 
    2590 CONSTANT:
    2591     ``CONFIGURE_IMFS_DISABLE_MKNOD``
    2592 
    2593 DATA TYPE:
    2594     Boolean feature macro.
    2595 
    2596 RANGE:
    2597     Defined or undefined.
    2598 
    2599 DEFAULT VALUE:
    2600     This is not defined by default.
    2601 
    2602 DESCRIPTION:
    2603     In case this configuration option is defined, then the support to make
    2604     directories, devices, regular files and FIFOs is disabled in the root IMFS.
    2605 
    2606 .. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
    2607 
    2608 .. _CONFIGURE_IMFS_DISABLE_MKNOD_FILE:
    2609 
    2610 CONFIGURE_IMFS_DISABLE_MKNOD_FILE
    2611 ---------------------------------
    2612 
    2613 CONSTANT:
    2614     ``CONFIGURE_IMFS_DISABLE_MKNOD_FILE``
    2615 
    2616 DATA TYPE:
    2617     Boolean feature macro.
    2618 
    2619 RANGE:
    2620     Defined or undefined.
    2621 
    2622 DEFAULT VALUE:
    2623     This is not defined by default.
    2624 
    2625 DESCRIPTION:
    2626     In case this configuration option is defined, then the support to make
    2627     regular files is disabled in the root IMFS.
    2628 
    2629 .. index:: CONFIGURE_IMFS_DISABLE_RMNOD
    2630 
    2631 .. _CONFIGURE_IMFS_DISABLE_RMNOD:
    2632 
    2633 CONFIGURE_IMFS_DISABLE_RMNOD
    2634 ----------------------------
    2635 
    2636 CONSTANT:
    2637     ``CONFIGURE_IMFS_DISABLE_RMNOD``
    2638 
    2639 DATA TYPE:
    2640     Boolean feature macro.
    2641 
    2642 RANGE:
    2643     Defined or undefined.
    2644 
    2645 DEFAULT VALUE:
    2646     This is not defined by default.
    2647 
    2648 DESCRIPTION:
    2649     In case this configuration option is defined, then the support to remove
    2650     nodes is disabled in the root IMFS.
    2651 
    2652 .. index:: CONFIGURE_IMFS_ENABLE_MKFIFO
    2653 
    2654 .. _CONFIGURE_IMFS_ENABLE_MKFIFO:
    2655 
    2656 CONFIGURE_IMFS_ENABLE_MKFIFO
    2657 ----------------------------
    2658 
    2659 CONSTANT:
    2660     ``CONFIGURE_IMFS_ENABLE_MKFIFO``
    2661 
    2662 DATA TYPE:
    2663     Boolean feature macro.
    2664 
    2665 RANGE:
    2666     Defined or undefined.
    2667 
    2668 DEFAULT VALUE:
    2669     This is not defined by default.
    2670 
    2671 DESCRIPTION:
    2672     In case this configuration option is defined, then the support to make FIFOs
    2673     is enabled in the root IMFS.
     2653    In case this configuration option is defined, then the following
     2654    configuration options will be defined as well
     2655
     2656    - ``CONFIGURE_IMFS_DISABLE_CHMOD``,
     2657
     2658    - ``CONFIGURE_IMFS_DISABLE_CHOWN``,
     2659
     2660    - ``CONFIGURE_IMFS_DISABLE_UTIME``,
     2661
     2662    - ``CONFIGURE_IMFS_DISABLE_LINK``,
     2663
     2664    - ``CONFIGURE_IMFS_DISABLE_SYMLINK``,
     2665
     2666    - ``CONFIGURE_IMFS_DISABLE_READLINK``,
     2667
     2668    - ``CONFIGURE_IMFS_DISABLE_RENAME``, and
     2669
     2670    - ``CONFIGURE_IMFS_DISABLE_UNMOUNT``.
    26742671
    26752672Block Device Cache Configuration
     
    27312728    None.
    27322729
     2730.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
     2731
     2732.. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
     2733
     2734CONFIGURE_BDBUF_BUFFER_MAX_SIZE
     2735-------------------------------
     2736
     2737CONSTANT:
     2738    ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
     2739
     2740DATA TYPE:
     2741    Unsigned integer (``uint32_t``).
     2742
     2743RANGE:
     2744    It must be positive and an integral multiple of the buffer minimum size.
     2745
     2746DEFAULT VALUE:
     2747    The default value is 4096 bytes.
     2748
     2749DESCRIPTION:
     2750    Defines the maximum size of a buffer in bytes.
     2751
     2752NOTES:
     2753    None.
     2754
    27332755.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
    27342756
     
    27522774DESCRIPTION:
    27532775    Defines the minimum size of a buffer in bytes.
    2754 
    2755 NOTES:
    2756     None.
    2757 
    2758 .. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    2759 
    2760 .. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
    2761 
    2762 CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    2763 -------------------------------
    2764 
    2765 CONSTANT:
    2766     ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
    2767 
    2768 DATA TYPE:
    2769     Unsigned integer (``uint32_t``).
    2770 
    2771 RANGE:
    2772     It must be positive and an integral multiple of the buffer minimum size.
    2773 
    2774 DEFAULT VALUE:
    2775     The default value is 4096 bytes.
    2776 
    2777 DESCRIPTION:
    2778     Defines the maximum size of a buffer in bytes.
    2779 
    2780 NOTES:
    2781     None.
    2782 
    2783 .. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
    2784 
    2785 .. _CONFIGURE_SWAPOUT_SWAP_PERIOD:
    2786 
    2787 CONFIGURE_SWAPOUT_SWAP_PERIOD
    2788 -----------------------------
    2789 
    2790 CONSTANT:
    2791     ``CONFIGURE_SWAPOUT_SWAP_PERIOD``
    2792 
    2793 DATA TYPE:
    2794     Unsigned integer (``uint32_t``).
    2795 
    2796 RANGE:
    2797     Positive.
    2798 
    2799 DEFAULT VALUE:
    2800     The default value is 250 milliseconds.
    2801 
    2802 DESCRIPTION:
    2803     Defines the swapout task swap period in milliseconds.
    2804 
    2805 NOTES:
    2806     None.
    2807 
    2808 .. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
    2809 
    2810 .. _CONFIGURE_SWAPOUT_BLOCK_HOLD:
    2811 
    2812 CONFIGURE_SWAPOUT_BLOCK_HOLD
    2813 ----------------------------
    2814 
    2815 CONSTANT:
    2816     ``CONFIGURE_SWAPOUT_BLOCK_HOLD``
    2817 
    2818 DATA TYPE:
    2819     Unsigned integer (``uint32_t``).
    2820 
    2821 RANGE:
    2822     Positive.
    2823 
    2824 DEFAULT VALUE:
    2825     The default value is 1000 milliseconds.
    2826 
    2827 DESCRIPTION:
    2828     Defines the swapout task maximum block hold time in milliseconds.
    2829 
    2830 NOTES:
    2831     None.
    2832 
    2833 .. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
    2834 
    2835 .. _CONFIGURE_SWAPOUT_TASK_PRIORITY:
    2836 
    2837 CONFIGURE_SWAPOUT_TASK_PRIORITY
    2838 -------------------------------
    2839 
    2840 CONSTANT:
    2841     ``CONFIGURE_SWAPOUT_TASK_PRIORITY``
    2842 
    2843 DATA TYPE:
    2844     Task priority (``rtems_task_priority``).
    2845 
    2846 RANGE:
    2847     Valid task priority.
    2848 
    2849 DEFAULT VALUE:
    2850     The default value is 15.
    2851 
    2852 DESCRIPTION:
    2853     Defines the swapout task priority.
    28542776
    28552777NOTES:
     
    29082830    None.
    29092831
     2832.. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
     2833
     2834.. _CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY:
     2835
     2836CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
     2837----------------------------------------
     2838
     2839CONSTANT:
     2840    ``CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY``
     2841
     2842DATA TYPE:
     2843    Task priority (``rtems_task_priority``).
     2844
     2845RANGE:
     2846    Valid task priority.
     2847
     2848DEFAULT VALUE:
     2849    The default value is 15.
     2850
     2851DESCRIPTION:
     2852    Defines the read-ahead task priority.
     2853
     2854NOTES:
     2855    None.
     2856
    29102857.. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
    29112858
     
    29332880    None.
    29342881
    2935 .. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    2936 
    2937 .. _CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY:
    2938 
    2939 CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    2940 ----------------------------------------
    2941 
    2942 CONSTANT:
    2943     ``CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY``
     2882.. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
     2883
     2884.. _CONFIGURE_SWAPOUT_BLOCK_HOLD:
     2885
     2886CONFIGURE_SWAPOUT_BLOCK_HOLD
     2887----------------------------
     2888
     2889CONSTANT:
     2890    ``CONFIGURE_SWAPOUT_BLOCK_HOLD``
     2891
     2892DATA TYPE:
     2893    Unsigned integer (``uint32_t``).
     2894
     2895RANGE:
     2896    Positive.
     2897
     2898DEFAULT VALUE:
     2899    The default value is 1000 milliseconds.
     2900
     2901DESCRIPTION:
     2902    Defines the swapout task maximum block hold time in milliseconds.
     2903
     2904NOTES:
     2905    None.
     2906
     2907.. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
     2908
     2909.. _CONFIGURE_SWAPOUT_SWAP_PERIOD:
     2910
     2911CONFIGURE_SWAPOUT_SWAP_PERIOD
     2912-----------------------------
     2913
     2914CONSTANT:
     2915    ``CONFIGURE_SWAPOUT_SWAP_PERIOD``
     2916
     2917DATA TYPE:
     2918    Unsigned integer (``uint32_t``).
     2919
     2920RANGE:
     2921    Positive.
     2922
     2923DEFAULT VALUE:
     2924    The default value is 250 milliseconds.
     2925
     2926DESCRIPTION:
     2927    Defines the swapout task swap period in milliseconds.
     2928
     2929NOTES:
     2930    None.
     2931
     2932.. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
     2933
     2934.. _CONFIGURE_SWAPOUT_TASK_PRIORITY:
     2935
     2936CONFIGURE_SWAPOUT_TASK_PRIORITY
     2937-------------------------------
     2938
     2939CONSTANT:
     2940    ``CONFIGURE_SWAPOUT_TASK_PRIORITY``
    29442941
    29452942DATA TYPE:
     
    29532950
    29542951DESCRIPTION:
    2955     Defines the read-ahead task priority.
     2952    Defines the swapout task priority.
     2953
     2954NOTES:
     2955    None.
     2956
     2957.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
     2958
     2959.. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY:
     2960
     2961CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
     2962--------------------------------------
     2963
     2964CONSTANT:
     2965    ``CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY``
     2966
     2967DATA TYPE:
     2968    Task priority (``rtems_task_priority``).
     2969
     2970RANGE:
     2971    Valid task priority.
     2972
     2973DEFAULT VALUE:
     2974    The default value is 15.
     2975
     2976DESCRIPTION:
     2977    Defines the swapout worker task priority.
    29562978
    29572979NOTES:
     
    29793001DESCRIPTION:
    29803002    Defines the swapout worker task count.
    2981 
    2982 NOTES:
    2983     None.
    2984 
    2985 .. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    2986 
    2987 .. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY:
    2988 
    2989 CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    2990 --------------------------------------
    2991 
    2992 CONSTANT:
    2993     ``CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY``
    2994 
    2995 DATA TYPE:
    2996     Task priority (``rtems_task_priority``).
    2997 
    2998 RANGE:
    2999     Valid task priority.
    3000 
    3001 DEFAULT VALUE:
    3002     The default value is 15.
    3003 
    3004 DESCRIPTION:
    3005     Defines the swapout worker task priority.
    30063003
    30073004NOTES:
     
    32853282    None.
    32863283
    3287 .. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
    3288 
    3289 .. _CONFIGURE_IDLE_TASK_STACK_SIZE:
    3290 
    3291 CONFIGURE_IDLE_TASK_STACK_SIZE
    3292 ------------------------------
    3293 
    3294 CONSTANT:
    3295     ``CONFIGURE_IDLE_TASK_STACK_SIZE``
    3296 
    3297 DATA TYPE:
    3298     Unsigned integer (``size_t``).
    3299 
    3300 RANGE:
    3301     Undefined or positive.
    3302 
    3303 DEFAULT VALUE:
    3304     The default value is RTEMS_MINIMUM_STACK_SIZE.
    3305 
    3306 DESCRIPTION:
    3307     ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is set to the desired stack size for the
    3308     IDLE task.
    3309 
    3310 NOTES:
    3311     None.
    3312 
    33133284.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
    33143285
     
    33443315
    33453316    The IDLE task must run at the lowest priority of all tasks in the system.
     3317
     3318.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
     3319
     3320.. _CONFIGURE_IDLE_TASK_STACK_SIZE:
     3321
     3322CONFIGURE_IDLE_TASK_STACK_SIZE
     3323------------------------------
     3324
     3325CONSTANT:
     3326    ``CONFIGURE_IDLE_TASK_STACK_SIZE``
     3327
     3328DATA TYPE:
     3329    Unsigned integer (``size_t``).
     3330
     3331RANGE:
     3332    Undefined or positive.
     3333
     3334DEFAULT VALUE:
     3335    The default value is RTEMS_MINIMUM_STACK_SIZE.
     3336
     3337DESCRIPTION:
     3338    ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is set to the desired stack size for the
     3339    IDLE task.
     3340
     3341NOTES:
     3342    None.
    33463343
    33473344General Scheduler Configuration
     
    39563953Note that network device drivers are not configured in the Device Driver Table.
    39573954
    3958 .. index:: CONFIGURE_MAXIMUM_DRIVERS
    3959 
    3960 .. _CONFIGURE_MAXIMUM_DRIVERS:
    3961 
    3962 CONFIGURE_MAXIMUM_DRIVERS
    3963 -------------------------
    3964 
    3965 CONSTANT:
    3966 
    3967     ``CONFIGURE_MAXIMUM_DRIVERS``
    3968 
    3969 DATA TYPE:
    3970     Unsigned integer (``uint32_t``).
    3971 
    3972 RANGE:
    3973     Zero or positive.
    3974 
    3975 DEFAULT VALUE:
    3976     This is computed by default, and is set to the number of device drivers
    3977     configured using the ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER``
    3978     configuration parameters.
    3979 
    3980 DESCRIPTION:
    3981     ``CONFIGURE_MAXIMUM_DRIVERS`` is defined as the number of device drivers
    3982     per node.
    3983 
    3984 NOTES:
    3985     If the application will dynamically install device drivers, then this
    3986     configuration parameter must be larger than the number of statically
    3987     configured device drivers. Drivers configured using the
    3988     ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration parameters are
    3989     statically installed.
     3955.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
     3956
     3957.. _CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER:
     3958
     3959CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
     3960------------------------------------------------
     3961
     3962CONSTANT:
     3963    ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER``
     3964
     3965DATA TYPE:
     3966    Boolean feature macro.
     3967
     3968RANGE:
     3969    Defined or undefined.
     3970
     3971DEFAULT VALUE:
     3972    This is not defined by default.
     3973
     3974DESCRIPTION:
     3975    ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is defined when the
     3976    application does *NOT* want the Clock Device Driver and is *NOT* using the
     3977    Timer Driver.  The inclusion or exclusion of the Clock Driver must be
     3978    explicit in user applications.
     3979
     3980NOTES:
     3981    This configuration parameter is intended to prevent the common user error
     3982    of using the Hello World example as the baseline for an application and
     3983    leaving out a clock tick source.
     3984
     3985.. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
     3986
     3987.. _CONFIGURE_APPLICATION_EXTRA_DRIVERS:
     3988
     3989CONFIGURE_APPLICATION_EXTRA_DRIVERS
     3990-----------------------------------
     3991
     3992CONSTANT:
     3993    ``CONFIGURE_APPLICATION_EXTRA_DRIVERS``
     3994
     3995DATA TYPE:
     3996    device driver entry structures
     3997
     3998RANGE:
     3999    Undefined or set of device driver entry structures
     4000
     4001DEFAULT VALUE:
     4002    This is not defined by default.
     4003
     4004DESCRIPTION:
     4005    ``CONFIGURE_APPLICATION_EXTRA_DRIVERS`` is defined if the application has
     4006    device drivers it needs to include in the Device Driver Table.  This should
     4007    be defined to the set of device driver entries that will be placed in the
     4008    table at the *END* of the Device Driver Table.
     4009
     4010NOTES:
     4011    None.
     4012
     4013.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
     4014
     4015.. _CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER:
     4016
     4017CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
     4018----------------------------------------
     4019
     4020CONSTANT:
     4021    ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER``
     4022
     4023DATA TYPE:
     4024    Boolean feature macro.
     4025
     4026RANGE:
     4027    Defined or undefined.
     4028
     4029DEFAULT VALUE:
     4030    This is not defined by default.
     4031
     4032DESCRIPTION:
     4033    ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`` is defined if the application
     4034    wishes to include the Clock Device Driver.
     4035
     4036NOTES:
     4037    This device driver is responsible for providing a regular interrupt which
     4038    invokes a clock tick directive.
     4039
     4040    If neither the Clock Driver not Benchmark Timer is enabled and the
     4041    configuration parameter
     4042    ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a
     4043    compile time error will occur.
    39904044
    39914045.. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
     
    40294083
    40304084    configuration options are mutually exclusive.
     4085
     4086.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
     4087
     4088.. _CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER:
     4089
     4090CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
     4091-----------------------------------------------
     4092
     4093CONSTANT:
     4094    ``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER``
     4095
     4096DATA TYPE:
     4097    Boolean feature macro.
     4098
     4099RANGE:
     4100    Defined or undefined.
     4101
     4102DEFAULT VALUE:
     4103    This is not defined by default.
     4104
     4105DESCRIPTION:
     4106    ``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER`` is defined if the
     4107    application wishes to include the BSP's Frame Buffer Device Driver.
     4108
     4109NOTES:
     4110    Most BSPs do not include support for a Frame Buffer Device Driver. This is
     4111    because many boards do not include the required hardware.
     4112
     4113    If this is defined and the BSP does not have this device driver, then the
     4114    user will get a link time error for an undefined symbol.
     4115
     4116.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
     4117.. index:: /dev/null
     4118
     4119.. _CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER:
     4120
     4121CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
     4122---------------------------------------
     4123
     4124CONSTANT:
     4125    ``CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER``
     4126
     4127DATA TYPE:
     4128    Boolean feature macro.
     4129
     4130RANGE:
     4131    Defined or undefined.
     4132
     4133DEFAULT VALUE:
     4134    This is not defined by default.
     4135
     4136DESCRIPTION:
     4137    This configuration variable is specified to enable ``/dev/null`` device driver.
     4138
     4139NOTES:
     4140    This device driver is supported by all BSPs.
     4141
     4142.. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
     4143
     4144.. _CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER:
     4145
     4146CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
     4147--------------------------------------
     4148
     4149CONSTANT:
     4150    ``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER``
     4151
     4152DATA TYPE:
     4153    Boolean feature macro.
     4154
     4155RANGE:
     4156    Defined or undefined.
     4157
     4158DEFAULT VALUE:
     4159    This is not defined by default.
     4160
     4161DESCRIPTION:
     4162    ``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER`` is defined if the application
     4163    wishes to include the Real-Time Clock Driver.
     4164
     4165NOTES:
     4166    Most BSPs do not include support for a real-time clock. This is because
     4167    many boards do not include the required hardware.
     4168
     4169    If this is defined and the BSP does not have this device driver, then the
     4170    user will get a link time error for an undefined symbol.
    40314171
    40324172.. index:: CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER
     
    41294269    configuration options are mutually exclusive.
    41304270
    4131 .. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    4132 
    4133 .. _CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER:
    4134 
    4135 CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
     4271.. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
     4272
     4273.. _CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER:
     4274
     4275CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
     4276---------------------------------------
     4277
     4278CONSTANT:
     4279    ``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER``
     4280
     4281DATA TYPE:
     4282    Boolean feature macro.
     4283
     4284RANGE:
     4285    Defined or undefined.
     4286
     4287DEFAULT VALUE:
     4288    This is not defined by default.
     4289
     4290DESCRIPTION:
     4291    ``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER`` is defined if the application
     4292    wishes to include the Stub Device Driver.
     4293
     4294NOTES:
     4295    This device driver simply provides entry points that return successful and
     4296    is primarily a test fixture. It is supported by all BSPs.
     4297
     4298.. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
     4299
     4300.. _CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER:
     4301
     4302CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    41364303----------------------------------------
    41374304
    41384305CONSTANT:
    4139     ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER``
     4306    ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER``
    41404307
    41414308DATA TYPE:
     
    41494316
    41504317DESCRIPTION:
    4151     ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`` is defined if the application
    4152     wishes to include the Clock Device Driver.
    4153 
    4154 NOTES:
    4155     This device driver is responsible for providing a regular interrupt which
    4156     invokes a clock tick directive.
    4157 
     4318    ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`` is defined if the application
     4319    wishes to include the Timer Driver.  This device driver is used to
     4320    benchmark execution times by the RTEMS Timing Test Suites.
     4321
     4322NOTES:
    41584323    If neither the Clock Driver not Benchmark Timer is enabled and the
    41594324    configuration parameter
     
    41614326    compile time error will occur.
    41624327
    4163 .. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    4164 
    4165 .. _CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER:
    4166 
    4167 CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    4168 ----------------------------------------
    4169 
    4170 CONSTANT:
    4171     ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER``
     4328.. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
     4329
     4330.. _CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER:
     4331
     4332CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
     4333-------------------------------------------
     4334
     4335CONSTANT:
     4336    ``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER``
    41724337
    41734338DATA TYPE:
     
    41814346
    41824347DESCRIPTION:
    4183     ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`` is defined if the application
    4184     wishes to include the Timer Driver.  This device driver is used to
    4185     benchmark execution times by the RTEMS Timing Test Suites.
    4186 
    4187 NOTES:
    4188     If neither the Clock Driver not Benchmark Timer is enabled and the
    4189     configuration parameter
    4190     ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a
    4191     compile time error will occur.
    4192 
    4193 .. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
    4194 
    4195 .. _CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER:
    4196 
    4197 CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
    4198 ------------------------------------------------
    4199 
    4200 CONSTANT:
    4201     ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER``
    4202 
    4203 DATA TYPE:
    4204     Boolean feature macro.
    4205 
    4206 RANGE:
    4207     Defined or undefined.
    4208 
    4209 DEFAULT VALUE:
    4210     This is not defined by default.
    4211 
    4212 DESCRIPTION:
    4213     ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is defined when the
    4214     application does *NOT* want the Clock Device Driver and is *NOT* using the
    4215     Timer Driver.  The inclusion or exclusion of the Clock Driver must be
    4216     explicit in user applications.
    4217 
    4218 NOTES:
    4219     This configuration parameter is intended to prevent the common user error
    4220     of using the Hello World example as the baseline for an application and
    4221     leaving out a clock tick source.
    4222 
    4223 .. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
    4224 
    4225 .. _CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER:
    4226 
    4227 CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
    4228 --------------------------------------
    4229 
    4230 CONSTANT:
    4231     ``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER``
    4232 
    4233 DATA TYPE:
    4234     Boolean feature macro.
    4235 
    4236 RANGE:
    4237     Defined or undefined.
    4238 
    4239 DEFAULT VALUE:
    4240     This is not defined by default.
    4241 
    4242 DESCRIPTION:
    4243     ``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER`` is defined if the application
    4244     wishes to include the Real-Time Clock Driver.
    4245 
    4246 NOTES:
    4247     Most BSPs do not include support for a real-time clock. This is because
    4248     many boards do not include the required hardware.
     4348    ``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER`` is defined if the
     4349    application wishes to include the Watchdog Driver.
     4350
     4351NOTES:
     4352    Most BSPs do not include support for a watchdog device driver. This is
     4353    because many boards do not include the required hardware.
    42494354
    42504355    If this is defined and the BSP does not have this device driver, then the
    42514356    user will get a link time error for an undefined symbol.
    42524357
    4253 .. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
    4254 
    4255 .. _CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER:
    4256 
    4257 CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
    4258 -------------------------------------------
    4259 
    4260 CONSTANT:
    4261     ``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER``
     4358.. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
     4359.. index:: /dev/zero
     4360
     4361.. _CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER:
     4362
     4363CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
     4364---------------------------------------
     4365
     4366CONSTANT:
     4367    ``CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER``
    42624368
    42634369DATA TYPE:
     
    42714377
    42724378DESCRIPTION:
    4273     ``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER`` is defined if the
    4274     application wishes to include the Watchdog Driver.
    4275 
    4276 NOTES:
    4277     Most BSPs do not include support for a watchdog device driver. This is
    4278     because many boards do not include the required hardware.
    4279 
    4280     If this is defined and the BSP does not have this device driver, then the
    4281     user will get a link time error for an undefined symbol.
    4282 
    4283 .. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
    4284 
    4285 .. _CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER:
    4286 
    4287 CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
    4288 -----------------------------------------------
    4289 
    4290 CONSTANT:
    4291     ``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER``
    4292 
    4293 DATA TYPE:
    4294     Boolean feature macro.
    4295 
    4296 RANGE:
    4297     Defined or undefined.
    4298 
    4299 DEFAULT VALUE:
    4300     This is not defined by default.
    4301 
    4302 DESCRIPTION:
    4303     ``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER`` is defined if the
    4304     application wishes to include the BSP's Frame Buffer Device Driver.
    4305 
    4306 NOTES:
    4307     Most BSPs do not include support for a Frame Buffer Device Driver. This is
    4308     because many boards do not include the required hardware.
    4309 
    4310     If this is defined and the BSP does not have this device driver, then the
    4311     user will get a link time error for an undefined symbol.
    4312 
    4313 .. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
    4314 
    4315 .. _CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER:
    4316 
    4317 CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
    4318 ---------------------------------------
    4319 
    4320 CONSTANT:
    4321     ``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER``
    4322 
    4323 DATA TYPE:
    4324     Boolean feature macro.
    4325 
    4326 RANGE:
    4327     Defined or undefined.
    4328 
    4329 DEFAULT VALUE:
    4330     This is not defined by default.
    4331 
    4332 DESCRIPTION:
    4333     ``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER`` is defined if the application
    4334     wishes to include the Stub Device Driver.
    4335 
    4336 NOTES:
    4337     This device driver simply provides entry points that return successful and
    4338     is primarily a test fixture. It is supported by all BSPs.
     4379    This configuration variable is specified to enable ``/dev/zero`` device driver.
     4380
     4381NOTES:
     4382    This device driver is supported by all BSPs.
    43394383
    43404384.. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
     
    43714415    driver configured via this configuration parameter.
    43724416
    4373 .. COMMENT: XXX Add example
    4374 
    4375 .. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
    4376 
    4377 .. _CONFIGURE_APPLICATION_EXTRA_DRIVERS:
    4378 
    4379 CONFIGURE_APPLICATION_EXTRA_DRIVERS
    4380 -----------------------------------
    4381 
    4382 CONSTANT:
    4383     ``CONFIGURE_APPLICATION_EXTRA_DRIVERS``
    4384 
    4385 DATA TYPE:
    4386     device driver entry structures
    4387 
    4388 RANGE:
    4389     Undefined or set of device driver entry structures
    4390 
    4391 DEFAULT VALUE:
    4392     This is not defined by default.
    4393 
    4394 DESCRIPTION:
    4395     ``CONFIGURE_APPLICATION_EXTRA_DRIVERS`` is defined if the application has
    4396     device drivers it needs to include in the Device Driver Table.  This should
    4397     be defined to the set of device driver entries that will be placed in the
    4398     table at the *END* of the Device Driver Table.
    4399 
    4400 NOTES:
    4401     None.
    4402 
    4403 .. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
    4404 .. index:: /dev/null
    4405 
    4406 .. _CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER:
    4407 
    4408 CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
    4409 ---------------------------------------
    4410 
    4411 CONSTANT:
    4412     ``CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER``
    4413 
    4414 DATA TYPE:
    4415     Boolean feature macro.
    4416 
    4417 RANGE:
    4418     Defined or undefined.
    4419 
    4420 DEFAULT VALUE:
    4421     This is not defined by default.
    4422 
    4423 DESCRIPTION:
    4424     This configuration variable is specified to enable ``/dev/null`` device driver.
    4425 
    4426 NOTES:
    4427     This device driver is supported by all BSPs.
    4428 
    4429 .. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
    4430 .. index:: /dev/zero
    4431 
    4432 .. _CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER:
    4433 
    4434 CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
    4435 ---------------------------------------
    4436 
    4437 CONSTANT:
    4438     ``CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER``
    4439 
    4440 DATA TYPE:
    4441     Boolean feature macro.
    4442 
    4443 RANGE:
    4444     Defined or undefined.
    4445 
    4446 DEFAULT VALUE:
    4447     This is not defined by default.
    4448 
    4449 DESCRIPTION:
    4450     This configuration variable is specified to enable ``/dev/zero`` device driver.
    4451 
    4452 NOTES:
    4453     This device driver is supported by all BSPs.
     4417.. index:: CONFIGURE_MAXIMUM_DRIVERS
     4418
     4419.. _CONFIGURE_MAXIMUM_DRIVERS:
     4420
     4421CONFIGURE_MAXIMUM_DRIVERS
     4422-------------------------
     4423
     4424CONSTANT:
     4425
     4426    ``CONFIGURE_MAXIMUM_DRIVERS``
     4427
     4428DATA TYPE:
     4429    Unsigned integer (``uint32_t``).
     4430
     4431RANGE:
     4432    Zero or positive.
     4433
     4434DEFAULT VALUE:
     4435    This is computed by default, and is set to the number of device drivers
     4436    configured using the ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER``
     4437    configuration parameters.
     4438
     4439DESCRIPTION:
     4440    ``CONFIGURE_MAXIMUM_DRIVERS`` is defined as the number of device drivers
     4441    per node.
     4442
     4443NOTES:
     4444    If the application will dynamically install device drivers, then this
     4445    configuration parameter must be larger than the number of statically
     4446    configured device drivers. Drivers configured using the
     4447    ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration parameters are
     4448    statically installed.
    44544449
    44554450Multiprocessing Configuration
     
    44934488    ``--enable-multiprocessing`` build configuration option.
    44944489
     4490.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
     4491
     4492.. _CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS:
     4493
     4494CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
     4495-----------------------------------
     4496
     4497CONSTANT:
     4498    ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS``
     4499
     4500DATA TYPE:
     4501    Unsigned integer (``uint32_t``).
     4502
     4503RANGE:
     4504    Positive.
     4505
     4506DEFAULT VALUE:
     4507    The default value is 32.
     4508
     4509DESCRIPTION:
     4510    ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS`` is the maximum number of
     4511    concurrently active global objects in a multiprocessor system.
     4512
     4513NOTES:
     4514    This value corresponds to the total number of objects which can be created
     4515    with the ``RTEMS_GLOBAL`` attribute.
     4516
     4517.. index:: CONFIGURE_MP_MAXIMUM_NODES
     4518
     4519.. _CONFIGURE_MP_MAXIMUM_NODES:
     4520
     4521CONFIGURE_MP_MAXIMUM_NODES
     4522--------------------------
     4523
     4524CONSTANT:
     4525    ``CONFIGURE_MP_MAXIMUM_NODES``
     4526
     4527DATA TYPE:
     4528    Unsigned integer (``uint32_t``).
     4529
     4530RANGE:
     4531    Positive.
     4532
     4533DEFAULT VALUE:
     4534    The default value is 2.
     4535
     4536DESCRIPTION:
     4537    ``CONFIGURE_MP_MAXIMUM_NODES`` is the maximum number of nodes in a
     4538    multiprocessor system.
     4539
     4540NOTES:
     4541    None.
     4542
     4543.. index:: CONFIGURE_MP_MAXIMUM_PROXIES
     4544
     4545.. _CONFIGURE_MP_MAXIMUM_PROXIES:
     4546
     4547CONFIGURE_MP_MAXIMUM_PROXIES
     4548----------------------------
     4549
     4550CONSTANT:
     4551    ``CONFIGURE_MP_MAXIMUM_PROXIES``
     4552
     4553DATA TYPE:
     4554    Unsigned integer (``uint32_t``).
     4555
     4556RANGE:
     4557    Undefined or positive.
     4558
     4559DEFAULT VALUE:
     4560    The default value is 32.
     4561
     4562DESCRIPTION:
     4563    ``CONFIGURE_MP_MAXIMUM_PROXIES`` is the maximum number of concurrently
     4564    active thread/task proxies on this node in a multiprocessor system.
     4565
     4566NOTES:
     4567    Since a proxy is used to represent a remote task/thread which is blocking
     4568    on this node. This configuration parameter reflects the maximum number of
     4569    remote tasks/threads which can be blocked on objects on this node.
     4570
     4571.. COMMENT: XXX - add xref to proxy discussion in MP chapter
     4572
     4573.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
     4574
     4575.. _CONFIGURE_MP_MPCI_TABLE_POINTER:
     4576
     4577CONFIGURE_MP_MPCI_TABLE_POINTER
     4578-------------------------------
     4579
     4580CONSTANT:
     4581    ``CONFIGURE_MP_MPCI_TABLE_POINTER``
     4582
     4583DATA TYPE:
     4584    pointer to ``rtems_mpci_table``
     4585
     4586RANGE:
     4587    undefined or valid pointer
     4588
     4589DEFAULT VALUE:
     4590    This is not defined by default.
     4591
     4592DESCRIPTION:
     4593    ``CONFIGURE_MP_MPCI_TABLE_POINTER`` is the pointer to the MPCI
     4594    Configuration Table.  The default value of this field is``&MPCI_table``.
     4595
     4596NOTES:
     4597    RTEMS provides a Shared Memory MPCI Device Driver which can be used on any
     4598    Multiprocessor System assuming the BSP provides the proper set of
     4599    supporting methods.
     4600
    44954601.. index:: CONFIGURE_MP_NODE_NUMBER
    44964602
     
    45224628    ``NODE_NUMBER`` set to different values. The test programs behave
    45234629    differently based upon their node number.
    4524 
    4525 .. index:: CONFIGURE_MP_MAXIMUM_NODES
    4526 
    4527 .. _CONFIGURE_MP_MAXIMUM_NODES:
    4528 
    4529 CONFIGURE_MP_MAXIMUM_NODES
    4530 --------------------------
    4531 
    4532 CONSTANT:
    4533     ``CONFIGURE_MP_MAXIMUM_NODES``
    4534 
    4535 DATA TYPE:
    4536     Unsigned integer (``uint32_t``).
    4537 
    4538 RANGE:
    4539     Positive.
    4540 
    4541 DEFAULT VALUE:
    4542     The default value is 2.
    4543 
    4544 DESCRIPTION:
    4545     ``CONFIGURE_MP_MAXIMUM_NODES`` is the maximum number of nodes in a
    4546     multiprocessor system.
    4547 
    4548 NOTES:
    4549     None.
    4550 
    4551 .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    4552 
    4553 .. _CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS:
    4554 
    4555 CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    4556 -----------------------------------
    4557 
    4558 CONSTANT:
    4559     ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS``
    4560 
    4561 DATA TYPE:
    4562     Unsigned integer (``uint32_t``).
    4563 
    4564 RANGE:
    4565     Positive.
    4566 
    4567 DEFAULT VALUE:
    4568     The default value is 32.
    4569 
    4570 DESCRIPTION:
    4571     ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS`` is the maximum number of
    4572     concurrently active global objects in a multiprocessor system.
    4573 
    4574 NOTES:
    4575     This value corresponds to the total number of objects which can be created
    4576     with the ``RTEMS_GLOBAL`` attribute.
    4577 
    4578 .. index:: CONFIGURE_MP_MAXIMUM_PROXIES
    4579 
    4580 .. _CONFIGURE_MP_MAXIMUM_PROXIES:
    4581 
    4582 CONFIGURE_MP_MAXIMUM_PROXIES
    4583 ----------------------------
    4584 
    4585 CONSTANT:
    4586     ``CONFIGURE_MP_MAXIMUM_PROXIES``
    4587 
    4588 DATA TYPE:
    4589     Unsigned integer (``uint32_t``).
    4590 
    4591 RANGE:
    4592     Undefined or positive.
    4593 
    4594 DEFAULT VALUE:
    4595     The default value is 32.
    4596 
    4597 DESCRIPTION:
    4598     ``CONFIGURE_MP_MAXIMUM_PROXIES`` is the maximum number of concurrently
    4599     active thread/task proxies on this node in a multiprocessor system.
    4600 
    4601 NOTES:
    4602     Since a proxy is used to represent a remote task/thread which is blocking
    4603     on this node. This configuration parameter reflects the maximum number of
    4604     remote tasks/threads which can be blocked on objects on this node.
    4605 
    4606 .. COMMENT: XXX - add xref to proxy discussion in MP chapter
    4607 
    4608 .. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
    4609 
    4610 .. _CONFIGURE_MP_MPCI_TABLE_POINTER:
    4611 
    4612 CONFIGURE_MP_MPCI_TABLE_POINTER
    4613 -------------------------------
    4614 
    4615 CONSTANT:
    4616     ``CONFIGURE_MP_MPCI_TABLE_POINTER``
    4617 
    4618 DATA TYPE:
    4619     pointer to ``rtems_mpci_table``
    4620 
    4621 RANGE:
    4622     undefined or valid pointer
    4623 
    4624 DEFAULT VALUE:
    4625     This is not defined by default.
    4626 
    4627 DESCRIPTION:
    4628     ``CONFIGURE_MP_MPCI_TABLE_POINTER`` is the pointer to the MPCI
    4629     Configuration Table.  The default value of this field is``&MPCI_table``.
    4630 
    4631 NOTES:
    4632     RTEMS provides a Shared Memory MPCI Device Driver which can be used on any
    4633     Multiprocessor System assuming the BSP provides the proper set of
    4634     supporting methods.
    46354630
    46364631PCI Library Configuration
     
    46894684=============================
    46904685
     4686.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
     4687
     4688.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
     4689
     4690CONFIGURE_RECORD_EXTENSIONS_ENABLED
     4691-----------------------------------
     4692
     4693CONSTANT:
     4694    ``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
     4695
     4696DATA TYPE:
     4697    Boolean feature macro.
     4698
     4699RANGE:
     4700    Defined or undefined.
     4701
     4702DEFAULT VALUE:
     4703    This is not defined by default.
     4704
     4705DESCRIPTION:
     4706    If defined and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
     4707    <CONFIGURE_RECORD_PER_PROCESSOR_ITEMS>` is also defined properly, then the
     4708    record extensions are enabled.
     4709
     4710NOTES:
     4711    The record extensions capture thread create, start, restart, delete,
     4712    switch, begin, exitted and terminate events.
     4713
    46914714.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
    46924715
     
    47154738NOTES:
    47164739    None.
    4717 
    4718 .. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
    4719 
    4720 .. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
    4721 
    4722 CONFIGURE_RECORD_EXTENSIONS_ENABLED
    4723 -----------------------------------
    4724 
    4725 CONSTANT:
    4726     ``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
    4727 
    4728 DATA TYPE:
    4729     Boolean feature macro.
    4730 
    4731 RANGE:
    4732     Defined or undefined.
    4733 
    4734 DEFAULT VALUE:
    4735     This is not defined by default.
    4736 
    4737 DESCRIPTION:
    4738     If defined and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
    4739     <CONFIGURE_RECORD_PER_PROCESSOR_ITEMS>` is also defined properly, then the
    4740     record extensions are enabled.
    4741 
    4742 NOTES:
    4743     The record extensions capture thread create, start, restart, delete,
    4744     switch, begin, exitted and terminate events.
    47454740
    47464741.. _ConfigAda:
Note: See TracChangeset for help on using the changeset viewer.