Changeset 6c56401 in rtems-docs


Ignore:
Timestamp:
Nov 12, 2017, 3:34:48 AM (2 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
ac0eaff
Parents:
42d50d7
Message:

c-user: Fix index locations.

Update #3229.

Location:
c-user
Files:
36 edited

Legend:

Unmodified
Added
Removed
  • c-user/ada_support.rst

    r42d50d7 r6c56401  
    77.. _ada_support
    88
     9.. index:: Ada
     10
    911Ada Support
    1012************
    11 
    12 .. index:: Ada
    1313
    1414Introduction
     
    2525================================
    2626
    27 The Ada programming natively supports multi-threaded programming 
     27The Ada programming natively supports multi-threaded programming
    2828with its own tasking and concurrency model. Native Ada multi-threaded
    2929applications should work using GNAT/RTEMS with no changes.
     
    9191predict when the Ada compiler or run-time will use a mutex.
    9292
    93 RTEMS has two capabilities which can assist in avoiding this problem. The 
     93RTEMS has two capabilities which can assist in avoiding this problem. The
    9494Classic API Timer Manager allows the creation of Timer Service Routines
    9595which execute in the context of a task rather than the clock tick
     
    9797which is a mechanism to defer the processing of the event from the
    9898hardware interrupt level to a thread.
    99 
  • c-user/barrier_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: barrier
     8
    79Barrier Manager
    810***************
    9 
    10 .. index:: barrier
    1111
    1212Introduction
     
    163163.. _rtems_barrier_create:
    164164
     165.. index:: create a barrier
     166.. index:: rtems_barrier_create
     167
    165168BARRIER_CREATE - Create a barrier
    166169---------------------------------
    167 .. index:: create a barrier
    168 .. index:: rtems_barrier_create
    169170
    170171CALLING SEQUENCE:
     
    238239.. _rtems_barrier_ident:
    239240
    240 BARRIER_IDENT - Get ID of a barrier
    241 -----------------------------------
    242241.. index:: get ID of a barrier
    243242.. index:: obtain ID of a barrier
    244243.. index:: rtems_barrier_ident
     244
     245BARRIER_IDENT - Get ID of a barrier
     246-----------------------------------
    245247
    246248CALLING SEQUENCE:
     
    279281.. _rtems_barrier_delete:
    280282
     283.. index:: delete a barrier
     284.. index:: rtems_barrier_delete
     285
    281286BARRIER_DELETE - Delete a barrier
    282287---------------------------------
    283 .. index:: delete a barrier
    284 .. index:: rtems_barrier_delete
    285288
    286289CALLING SEQUENCE:
     
    321324.. _rtems_barrier_wait:
    322325
    323 BARRIER_OBTAIN - Acquire a barrier
    324 ----------------------------------
    325326.. index:: obtain a barrier
    326327.. index:: lock a barrier
    327328.. index:: rtems_barrier_wait
     329
     330BARRIER_OBTAIN - Acquire a barrier
     331----------------------------------
    328332
    329333CALLING SEQUENCE:
     
    395399.. _rtems_barrier_release:
    396400
    397 BARRIER_RELEASE - Release a barrier
    398 -----------------------------------
    399401.. index:: wait at a barrier
    400402.. index:: release a barrier
    401403.. index:: rtems_barrier_release
     404
     405BARRIER_RELEASE - Release a barrier
     406-----------------------------------
    402407
    403408CALLING SEQUENCE:
  • c-user/board_support_packages.rst

    r42d50d7 r6c56401  
    1010.. index:: Board Support Packages
    1111.. index:: BSPs
     12.. index:: BSP, definition
    1213
    1314Introduction
    1415============
    15 .. index:: BSP, definition
    1616
    1717A board support package (BSP) is a collection of user-provided facilities which
  • c-user/chains.rst

    r42d50d7 r6c56401  
    173173chain. This is an example of a pool of buffers.
    174174
     175.. index:: chain iterate
     176
    175177Iterating a Chain
    176178-----------------
    177 .. index:: chain iterate
    178179
    179180Iterating a chain is a common function. The example shows how to iterate the
     
    220221.. _rtems_chain_initialize:
    221222
     223.. index:: chain initialize
     224.. index:: rtems_chain_initialize
     225
    222226Initialize Chain With Nodes
    223227---------------------------
    224 .. index:: chain initialize
    225 .. index:: rtems_chain_initialize
    226228
    227229CALLING SEQUENCE:
     
    257259.. _rtems_chain_initialize_empty:
    258260
     261.. index:: chain initialize empty
     262.. index:: rtems_chain_initialize_empty
     263
    259264Initialize Empty
    260265----------------
    261 .. index:: chain initialize empty
    262 .. index:: rtems_chain_initialize_empty
    263266
    264267CALLING SEQUENCE:
     
    285288.. _rtems_chain_is_null_node:
    286289
     290.. index:: chain is node null
     291.. index:: rtems_chain_is_null_node
     292
    287293Is Null Node ?
    288294--------------
    289 .. index:: chain is node null
    290 .. index:: rtems_chain_is_null_node
    291295
    292296CALLING SEQUENCE:
     
    310314.. _rtems_chain_head:
    311315
     316.. index:: chain get head
     317.. index:: rtems_chain_head
     318
    312319Head
    313320----
    314 .. index:: chain get head
    315 .. index:: rtems_chain_head
    316321
    317322CALLING SEQUENCE:
     
    334339.. _rtems_chain_tail:
    335340
     341.. index:: chain get tail
     342.. index:: rtems_chain_tail
     343
    336344Tail
    337345----
    338 .. index:: chain get tail
    339 .. index:: rtems_chain_tail
    340346
    341347CALLING SEQUENCE:
     
    358364.. _rtems_chain_are_nodes_equal:
    359365
     366.. index:: chare are nodes equal
     367.. index:: rtems_chain_are_nodes_equal
     368
    360369Are Two Nodes Equal ?
    361370---------------------
    362 .. index:: chare are nodes equal
    363 .. index:: rtems_chain_are_nodes_equal
    364371
    365372CALLING SEQUENCE:
     
    385392.. _rtems_chain_is_empty:
    386393
     394.. index:: chain is chain empty
     395.. index:: rtems_chain_is_empty
     396
    387397Is the Chain Empty
    388398------------------
    389 .. index:: chain is chain empty
    390 .. index:: rtems_chain_is_empty
    391399
    392400CALLING SEQUENCE:
     
    411419.. _rtems_chain_is_first:
    412420
     421.. index:: chain is node the first
     422.. index:: rtems_chain_is_first
     423
    413424Is this the First Node on the Chain ?
    414425-------------------------------------
    415 .. index:: chain is node the first
    416 .. index:: rtems_chain_is_first
    417426
    418427CALLING SEQUENCE:
     
    437446.. _rtems_chain_is_last:
    438447
     448.. index:: chain is node the last
     449.. index:: rtems_chain_is_last
     450
    439451Is this the Last Node on the Chain ?
    440452------------------------------------
    441 .. index:: chain is node the last
    442 .. index:: rtems_chain_is_last
    443453
    444454CALLING SEQUENCE:
     
    463473.. _rtems_chain_has_only_one_node:
    464474
     475.. index:: chain only one node
     476.. index:: rtems_chain_has_only_one_node
     477
    465478Does this Chain have only One Node ?
    466479------------------------------------
    467 .. index:: chain only one node
    468 .. index:: rtems_chain_has_only_one_node
    469480
    470481CALLING SEQUENCE:
     
    489500.. _rtems_chain_node_count_unprotected:
    490501
     502.. index:: chain only one node
     503.. index:: rtems_chain_node_count_unprotected
     504
    491505Returns the node count of the chain (unprotected)
    492506-------------------------------------------------
    493 .. index:: chain only one node
    494 .. index:: rtems_chain_node_count_unprotected
    495507
    496508CALLING SEQUENCE:
     
    513525.. _rtems_chain_is_head:
    514526
     527.. index:: chain is node the head
     528.. index:: rtems_chain_is_head
     529
    515530Is this Node the Chain Head ?
    516531-----------------------------
    517 .. index:: chain is node the head
    518 .. index:: rtems_chain_is_head
    519532
    520533CALLING SEQUENCE:
     
    540553.. _rtems_chain_is_tail:
    541554
     555.. index:: chain is node the tail
     556.. index:: rtems_chain_is_tail
     557
    542558Is this Node the Chain Tail ?
    543559-----------------------------
    544 .. index:: chain is node the tail
    545 .. index:: rtems_chain_is_tail
    546560
    547561CALLING SEQUENCE:
     
    567581.. _rtems_chain_extract:
    568582
     583.. index:: chain extract a node
     584.. index:: rtems_chain_extract
     585
    569586Extract a Node
    570587--------------
    571 .. index:: chain extract a node
    572 .. index:: rtems_chain_extract
    573588
    574589CALLING SEQUENCE:
     
    597612.. _rtems_chain_extract_unprotected:
    598613
     614.. index:: chain extract a node unprotected
     615.. index:: rtems_chain_extract_unprotected
     616
    599617Extract a Node (unprotected)
    600618----------------------------
    601 .. index:: chain extract a node unprotected
    602 .. index:: rtems_chain_extract_unprotected
    603619
    604620CALLING SEQUENCE:
     
    624640.. _rtems_chain_get:
    625641
     642.. index:: chain get first node
     643.. index:: rtems_chain_get
     644
    626645Get the First Node
    627646------------------
    628 .. index:: chain get first node
    629 .. index:: rtems_chain_get
    630647
    631648CALLING SEQUENCE:
     
    656673.. _rtems_chain_get_unprotected:
    657674
     675.. index:: chain get first node
     676.. index:: rtems_chain_get_unprotected
     677
    658678Get the First Node (unprotected)
    659679--------------------------------
    660 .. index:: chain get first node
    661 .. index:: rtems_chain_get_unprotected
    662680
    663681CALLING SEQUENCE:
     
    684702.. _rtems_chain_insert:
    685703
     704.. index:: chain insert a node
     705.. index:: rtems_chain_insert
     706
    686707Insert a Node
    687708-------------
    688 .. index:: chain insert a node
    689 .. index:: rtems_chain_insert
    690709
    691710CALLING SEQUENCE:
     
    716735.. _rtems_chain_insert_unprotected:
    717736
     737.. index:: chain insert a node unprotected
     738.. index:: rtems_chain_insert_unprotected
     739
    718740Insert a Node (unprotected)
    719741---------------------------
    720 .. index:: chain insert a node unprotected
    721 .. index:: rtems_chain_insert_unprotected
    722742
    723743CALLING SEQUENCE:
     
    745765.. _rtems_chain_append:
    746766
     767.. index:: chain append a node
     768.. index:: rtems_chain_append
     769
    747770Append a Node
    748771-------------
    749 .. index:: chain append a node
    750 .. index:: rtems_chain_append
    751772
    752773CALLING SEQUENCE:
     
    776797.. _rtems_chain_append_unprotected:
    777798
     799.. index:: chain append a node unprotected
     800.. index:: rtems_chain_append_unprotected
     801
    778802Append a Node (unprotected)
    779803---------------------------
    780 .. index:: chain append a node unprotected
    781 .. index:: rtems_chain_append_unprotected
    782804
    783805CALLING SEQUENCE:
     
    804826.. _rtems_chain_prepend:
    805827
     828.. index:: prepend node
     829.. index:: rtems_chain_prepend
     830
    806831Prepend a Node
    807832--------------
    808 .. index:: prepend node
    809 .. index:: rtems_chain_prepend
    810833
    811834CALLING SEQUENCE:
     
    835858.. _rtems_chain_prepend_unprotected:
    836859
     860.. index:: prepend node unprotected
     861.. index:: rtems_chain_prepend_unprotected
     862
    837863Prepend a Node (unprotected)
    838864----------------------------
    839 .. index:: prepend node unprotected
    840 .. index:: rtems_chain_prepend_unprotected
    841865
    842866CALLING SEQUENCE:
  • c-user/clock_manager.rst

    r42d50d7 r6c56401  
    93931988*.
    9494
     95.. index:: timeslicing
     96
    9597Clock Tick and Timeslicing
    9698--------------------------
    97 .. index:: timeslicing
    9899
    99100Timeslicing is a task scheduling discipline in which tasks of equal priority
     
    112113if there exists a ready task of equal priority.
    113114
     115.. index:: delays
     116
    114117Delays
    115118------
    116 .. index:: delays
    117119
    118120A sleep timer allows a task to delay for a given interval or up until a given
     
    123125one sleep timer at a time.
    124126
     127.. index:: timeouts
     128
    125129Timeouts
    126130--------
    127 .. index:: timeouts
    128131
    129132Timeouts are a special type of timer automatically created when the timeout
     
    184187and time have been set.
    185188
     189.. index:: rtems_clock_get
     190
    186191Transition Advice for the Obsolete rtems_clock_get
    187192--------------------------------------------------
    188 
    189 .. index:: rtems_clock_get
    190193
    191194The method ``rtems_clock_get`` took an untyped pointer with an
     
    212215.. _rtems_clock_set:
    213216
     217.. index:: set the time of day
     218.. index:: rtems_clock_set
     219
    214220CLOCK_SET - Set date and time
    215221-----------------------------
    216 .. index:: set the time of day
    217 .. index:: rtems_clock_set
    218222
    219223CALLING SEQUENCE:
     
    261265.. _rtems_clock_get_tod:
    262266
     267.. index:: obtain the time of day
     268.. index:: rtems_clock_get_tod
     269
    263270CLOCK_GET_TOD - Get date and time in TOD format
    264271-----------------------------------------------
    265 .. index:: obtain the time of day
    266 .. index:: rtems_clock_get_tod
    267272
    268273CALLING SEQUENCE:
     
    304309.. _rtems_clock_get_tod_timeval:
    305310
     311.. index:: obtain the time of day
     312.. index:: rtems_clock_get_tod_timeval
     313
    306314CLOCK_GET_TOD_TIMEVAL - Get date and time in timeval format
    307315-----------------------------------------------------------
    308 .. index:: obtain the time of day
    309 .. index:: rtems_clock_get_tod_timeval
    310316
    311317CALLING SEQUENCE:
     
    347353.. _rtems_clock_get_seconds_since_epoch:
    348354
     355.. index:: obtain seconds since epoch
     356.. index:: rtems_clock_get_seconds_since_epoch
     357
    349358CLOCK_GET_SECONDS_SINCE_EPOCH - Get seconds since epoch
    350359-------------------------------------------------------
    351 .. index:: obtain seconds since epoch
    352 .. index:: rtems_clock_get_seconds_since_epoch
    353360
    354361CALLING SEQUENCE:
     
    390397.. _rtems_clock_get_ticks_per_second:
    391398
     399.. index:: obtain seconds since epoch
     400.. index:: rtems_clock_get_ticks_per_second
     401
    392402CLOCK_GET_TICKS_PER_SECOND - Get ticks per second
    393403-------------------------------------------------
    394 .. index:: obtain seconds since epoch
    395 .. index:: rtems_clock_get_ticks_per_second
    396404
    397405CALLING SEQUENCE:
     
    419427.. _rtems_clock_get_ticks_since_boot:
    420428
    421 CLOCK_GET_TICKS_SINCE_BOOT - Get current ticks counter value
    422 ------------------------------------------------------------
    423429.. index:: obtain ticks since boot
    424430.. index:: get current ticks counter value
    425431.. index:: rtems_clock_get_ticks_since_boot
     432
     433CLOCK_GET_TICKS_SINCE_BOOT - Get current ticks counter value
     434------------------------------------------------------------
    426435
    427436CALLING SEQUENCE:
     
    453462.. _rtems_clock_tick_later:
    454463
     464.. index:: rtems_clock_tick_later
     465
    455466CLOCK_TICK_LATER - Get tick value in the future
    456467-----------------------------------------------
    457 .. index:: rtems_clock_tick_later
    458468
    459469CALLING SEQUENCE:
     
    478488.. _rtems_clock_tick_later_usec:
    479489
     490.. index:: rtems_clock_tick_later_usec
     491
    480492CLOCK_TICK_LATER_USEC - Get tick value in the future in microseconds
    481493--------------------------------------------------------------------
    482 .. index:: rtems_clock_tick_later_usec
    483494
    484495CALLING SEQUENCE:
     
    503514.. _rtems_clock_tick_before:
    504515
     516.. index:: rtems_clock_tick_before
     517
    505518CLOCK_TICK_BEFORE - Is tick value is before a point in time
    506519-----------------------------------------------------------
    507 .. index:: rtems_clock_tick_before
    508520
    509521CALLING SEQUENCE:
     
    543555.. _rtems_clock_get_uptime:
    544556
    545 CLOCK_GET_UPTIME - Get the time since boot
    546 ------------------------------------------
    547557.. index:: clock get uptime
    548558.. index:: uptime
    549559.. index:: rtems_clock_get_uptime
     560
     561CLOCK_GET_UPTIME - Get the time since boot
     562------------------------------------------
    550563
    551564CALLING SEQUENCE:
     
    578591.. _rtems_clock_get_uptime_timeval:
    579592
    580 CLOCK_GET_UPTIME_TIMEVAL - Get the time since boot in timeval format
    581 --------------------------------------------------------------------
    582593.. index:: clock get uptime interval
    583594.. index:: uptime
    584595.. index:: rtems_clock_get_uptime_timeval
    585596
     597CLOCK_GET_UPTIME_TIMEVAL - Get the time since boot in timeval format
     598--------------------------------------------------------------------
     599
    586600CALLING SEQUENCE:
    587601    .. code-block:: c
     
    608622.. _rtems_clock_get_uptime_seconds:
    609623
    610 CLOCK_GET_UPTIME_SECONDS - Get the seconds since boot
    611 -----------------------------------------------------
    612624.. index:: clock get uptime seconds
    613625.. index:: uptime
    614626.. index:: rtems_clock_get_uptime_seconds
    615627
     628CLOCK_GET_UPTIME_SECONDS - Get the seconds since boot
     629-----------------------------------------------------
     630
    616631CALLING SEQUENCE:
    617632    .. code-block:: c
     
    634649.. _rtems_clock_get_uptime_nanoseconds:
    635650
    636 CLOCK_GET_UPTIME_NANOSECONDS - Get the nanoseconds since boot
    637 -------------------------------------------------------------
    638651.. index:: clock get nanoseconds uptime
    639652.. index:: uptime
    640653.. index:: rtems_clock_get_uptime_nanoseconds
    641654
     655CLOCK_GET_UPTIME_NANOSECONDS - Get the nanoseconds since boot
     656-------------------------------------------------------------
     657
    642658CALLING SEQUENCE:
    643659    .. code-block:: c
  • c-user/configuring_a_system.rst

    r42d50d7 r6c56401  
    77.. _Configuring a System:
    88
     9.. index:: configuring a system
     10
    911Configuring a System
    1012********************
    11 
    12 .. index:: configuring a system
    1313
    1414Introduction
     
    401401.. _Per Object Class Unlimited Object Instances:
    402402
     403.. index:: rtems_resource_unlimited
     404
    403405Per Object Class Unlimited Object Instances
    404406-------------------------------------------
    405 .. index:: rtems_resource_unlimited
    406407
    407408When the number of objects is not known ahead of time, RTEMS provides an
     
    443444
    444445.. _Enable Unlimited Object Instances:
     446.. index:: CONFIGURE_UNLIMITED_OBJECTS
    445447
    446448Enable Unlimited Object Instances
    447449---------------------------------
    448 .. index:: CONFIGURE_UNLIMITED_OBJECTS
    449450
    450451CONSTANT:
     
    518519
    519520.. _Specify Maximum Classic API Tasks:
     521.. index:: CONFIGURE_MAXIMUM_TASKS
    520522
    521523Specify Maximum Classic API Tasks
    522524---------------------------------
    523 .. index:: CONFIGURE_MAXIMUM_TASKS
    524525
    525526CONSTANT:
     
    563564
    564565.. _Specify Maximum Classic API Timers:
     566.. index:: CONFIGURE_MAXIMUM_TIMERS
    565567
    566568Specify Maximum Classic API Timers
    567569----------------------------------
    568 .. index:: CONFIGURE_MAXIMUM_TIMERS
    569570
    570571CONSTANT:
     
    590591
    591592.. _Specify Maximum Classic API Semaphores:
     593.. index:: CONFIGURE_MAXIMUM_SEMAPHORES
    592594
    593595Specify Maximum Classic API Semaphores
    594596--------------------------------------
    595 .. index:: CONFIGURE_MAXIMUM_SEMAPHORES
    596597
    597598CONSTANT:
     
    617618
    618619.. _Specify Maximum Classic API Semaphores usable with MrsP:
     620.. index:: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
    619621
    620622Specify Maximum Classic API Semaphores usable with MrsP
    621623-------------------------------------------------------
    622 .. index:: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
    623624
    624625CONSTANT:
     
    646647
    647648.. _Specify Maximum Classic API Message Queues:
     649.. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    648650
    649651Specify Maximum Classic API Message Queues
    650652------------------------------------------
    651 .. index:: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
    652653
    653654CONSTANT:
     
    673674
    674675.. _Specify Maximum Classic API Barriers:
     676.. index:: CONFIGURE_MAXIMUM_BARRIERS
    675677
    676678Specify Maximum Classic API Barriers
    677679------------------------------------
    678 .. index:: CONFIGURE_MAXIMUM_BARRIERS
    679680
    680681CONSTANT:
     
    700701
    701702.. _Specify Maximum Classic API Periods:
     703.. index:: CONFIGURE_MAXIMUM_PERIODS
    702704
    703705Specify Maximum Classic API Periods
    704706-----------------------------------
    705 .. index:: CONFIGURE_MAXIMUM_PERIODS
    706707
    707708CONSTANT:
     
    727728
    728729.. _Specify Maximum Classic API Partitions:
     730.. index:: CONFIGURE_MAXIMUM_PARTITIONS
    729731
    730732Specify Maximum Classic API Partitions
    731733--------------------------------------
    732 .. index:: CONFIGURE_MAXIMUM_PARTITIONS
    733734
    734735CONSTANT:
     
    754755
    755756.. _Specify Maximum Classic API Regions:
     757.. index:: CONFIGURE_MAXIMUM_REGIONS
    756758
    757759Specify Maximum Classic API Regions
    758760-----------------------------------
    759 .. index:: CONFIGURE_MAXIMUM_REGIONS
    760761
    761762CONSTANT:
     
    781782
    782783.. _Specify Maximum Classic API Ports:
     784.. index:: CONFIGURE_MAXIMUM_PORTS
    783785
    784786Specify Maximum Classic API Ports
    785787---------------------------------
    786 .. index:: CONFIGURE_MAXIMUM_PORTS
    787788
    788789CONSTANT:
     
    808809
    809810.. _Specify Maximum Classic API User Extensions:
     811.. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
    810812
    811813Specify Maximum Classic API User Extensions
    812814-------------------------------------------
    813 .. index:: CONFIGURE_MAXIMUM_USER_EXTENSIONS
    814815
    815816CONSTANT:
     
    844845
    845846.. _Instantiate Classic API Initialization Task Table:
     847.. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
    846848
    847849Instantiate Classic API Initialization Task Table
    848850-------------------------------------------------
    849 .. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
    850851
    851852CONSTANT:
     
    881882
    882883.. _Specifying Classic API Initialization Task Entry Point:
     884.. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
    883885
    884886Specifying Classic API Initialization Task Entry Point
    885887------------------------------------------------------
    886 .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
    887888
    888889CONSTANT:
     
    910911
    911912.. _Specifying Classic API Initialization Task Name:
     913.. index:: CONFIGURE_INIT_TASK_NAME
    912914
    913915Specifying Classic API Initialization Task Name
    914916-----------------------------------------------
    915 .. index:: CONFIGURE_INIT_TASK_NAME
    916917
    917918CONSTANT:
     
    937938
    938939.. _Specifying Classic API Initialization Task Stack Size:
     940.. index:: CONFIGURE_INIT_TASK_STACK_SIZE
    939941
    940942Specifying Classic API Initialization Task Stack Size
    941943-----------------------------------------------------
    942 .. index:: CONFIGURE_INIT_TASK_STACK_SIZE
    943944
    944945CONSTANT:
     
    967968
    968969.. _Specifying Classic API Initialization Task Priority:
     970.. index:: CONFIGURE_INIT_TASK_PRIORITY
    969971
    970972Specifying Classic API Initialization Task Priority
    971973---------------------------------------------------
    972 .. index:: CONFIGURE_INIT_TASK_PRIORITY
    973974
    974975CONSTANT:
     
    994995
    995996.. _Specifying Classic API Initialization Task Attributes:
     997.. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
    996998
    997999Specifying Classic API Initialization Task Attributes
    9981000-----------------------------------------------------
    999 .. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
    10001001
    10011002CONSTANT:
     
    10211022
    10221023.. _Specifying Classic API Initialization Task Modes:
     1024.. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
    10231025
    10241026Specifying Classic API Initialization Task Modes
    10251027------------------------------------------------
    1026 .. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
    10271028
    10281029CONSTANT:
     
    10491050
    10501051.. _Specifying Classic API Initialization Task Arguments:
     1052.. index:: CONFIGURE_INIT_TASK_ARGUMENTS
    10511053
    10521054Specifying Classic API Initialization Task Arguments
    10531055----------------------------------------------------
    1054 .. index:: CONFIGURE_INIT_TASK_ARGUMENTS
    10551056
    10561057CONSTANT:
     
    10761077
    10771078.. _Not Using Generated Initialization Tasks Table:
     1079.. index:: CONFIGURE_HAS_OWN_INIT_TASK_TABLE
    10781080
    10791081Not Using Generated Initialization Tasks Table
    10801082----------------------------------------------
    1081 .. index:: CONFIGURE_HAS_OWN_INIT_TASK_TABLE
    10821083
    10831084CONSTANT:
     
    11141115
    11151116.. _Specify Maximum POSIX API Threads:
     1117.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
    11161118
    11171119Specify Maximum POSIX API Threads
    11181120---------------------------------
    1119 .. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
    11201121
    11211122CONSTANT:
     
    11541155
    11551156.. _Specify Maximum POSIX API Keys:
     1157.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
    11561158
    11571159Specify Maximum POSIX API Keys
    11581160------------------------------
    1159 .. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
    11601161
    11611162CONSTANT:
     
    11831184
    11841185.. _Specify Maximum POSIX API Timers:
     1186.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
    11851187
    11861188Specify Maximum POSIX API Timers
    11871189--------------------------------
    1188 .. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
    11891190
    11901191CONSTANT:
     
    12101211
    12111212.. _Specify Maximum POSIX API Queued Signals:
     1213.. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
    12121214
    12131215Specify Maximum POSIX API Queued Signals
    12141216----------------------------------------
    1215 .. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
    12161217
    12171218CONSTANT:
     
    12371238
    12381239.. _Specify Maximum POSIX API Message Queues:
     1240.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
    12391241
    12401242Specify Maximum POSIX API Message Queues
    12411243----------------------------------------
    1242 .. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
    12431244
    12441245CONSTANT:
     
    12641265
    12651266.. _Specify Maximum POSIX API Semaphores:
     1267.. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
    12661268
    12671269Specify Maximum POSIX API Named Semaphores
    12681270------------------------------------------
    1269 .. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
    12701271
    12711272CONSTANT:
     
    13031304
    13041305.. _Instantiate POSIX API Initialization Thread Table:
     1306.. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
    13051307
    13061308Instantiate POSIX API Initialization Thread Table
    13071309-------------------------------------------------
    1308 .. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
    13091310
    13101311CONSTANT:
     
    13421343
    13431344.. _Specifying POSIX API Initialization Thread Entry Point:
     1345.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    13441346
    13451347Specifying POSIX API Initialization Thread Entry Point
    13461348------------------------------------------------------
    1347 .. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
    13481349
    13491350CONSTANT:
     
    13711372
    13721373.. _Specifying POSIX API Initialization Thread Stack Size:
     1374.. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    13731375
    13741376Specifying POSIX API Initialization Thread Stack Size
    13751377-----------------------------------------------------
    1376 .. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
    13771378
    13781379CONSTANT:
     
    14021403
    14031404.. _Not Using Generated POSIX Initialization Threads Table:
     1405.. index:: CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
    14041406
    14051407Not Using Generated POSIX Initialization Threads Table
    14061408------------------------------------------------------
    1407 .. index:: CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
    14081409
    14091410CONSTANT:
     
    14391440
    14401441.. _Separate or Unified Work Areas:
    1441 
    1442 Separate or Unified Work Areas
    1443 ------------------------------
    14441442.. index:: CONFIGURE_UNIFIED_WORK_AREAS
    14451443.. index:: unified work areas
     
    14481446.. index:: C Program Heap
    14491447
     1448Separate or Unified Work Areas
     1449------------------------------
     1450
    14501451CONSTANT:
    14511452    ``CONFIGURE_UNIFIED_WORK_AREAS``
     
    14821483
    14831484.. _CONFIGURE_MAXIMUM_PROCESSORS:
     1485.. index:: CONFIGURE_MAXIMUM_PROCESSORS
    14841486
    14851487Specify Maximum Processors
    14861488----------------------------------------
    1487 .. index:: CONFIGURE_MAXIMUM_PROCESSORS
    14881489
    14891490CONSTANT:
     
    15151516
    15161517.. _CONFIGURE_MICROSECONDS_PER_TICK:
     1518.. index:: CONFIGURE_MICROSECONDS_PER_TICK
     1519.. index:: tick quantum
    15171520
    15181521Length of Each Clock Tick
    15191522-------------------------
    1520 .. index:: CONFIGURE_MICROSECONDS_PER_TICK
    1521 .. index:: tick quantum
    15221523
    15231524CONSTANT:
     
    15621563
    15631564.. _Specifying Timeslicing Quantum:
     1565.. index:: CONFIGURE_TICKS_PER_TIMESLICE
     1566.. index:: ticks per timeslice
    15641567
    15651568Specifying Timeslicing Quantum
    15661569------------------------------
    1567 .. index:: CONFIGURE_TICKS_PER_TIMESLICE
    1568 .. index:: ticks per timeslice
    15691570
    15701571CONSTANT:
     
    15911592
    15921593.. _Specifying the Number of Thread Priority Levels:
    1593 
    1594 Specifying the Number of Thread Priority Levels
    1595 -----------------------------------------------
    15961594.. index:: CONFIGURE_MAXIMUM_PRIORITY
    15971595.. index:: maximum priority
    15981596.. index:: number of priority levels
     1597
     1598Specifying the Number of Thread Priority Levels
     1599-----------------------------------------------
    15991600
    16001601CONSTANT:
     
    16381639
    16391640.. _CONFIGURE_MAXIMUM_THREAD_NAME_SIZE:
     1641.. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE
     1642.. index:: maximum thread name size
    16401643
    16411644Specifying the Maximum Thread Name Size
    16421645---------------------------------------
    1643 .. index:: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE
    1644 .. index:: maximum thread name size
    16451646
    16461647CONSTANT:
     
    16691670
    16701671.. _Specifying the Minimum Task Size:
     1672.. index:: CONFIGURE_MINIMUM_TASK_STACK_SIZE
     1673.. index:: minimum task stack size
    16711674
    16721675Specifying the Minimum Task Size
    16731676--------------------------------
    1674 .. index:: CONFIGURE_MINIMUM_TASK_STACK_SIZE
    1675 .. index:: minimum task stack size
    16761677
    16771678CONSTANT:
     
    17081709
    17091710.. _Configuring the Size of the Interrupt Stack:
     1711.. index:: CONFIGURE_INTERRUPT_STACK_SIZE
     1712.. index:: interrupt stack size
    17101713
    17111714Configuring the Size of the Interrupt Stack
    17121715-------------------------------------------
    1713 .. index:: CONFIGURE_INTERRUPT_STACK_SIZE
    1714 .. index:: interrupt stack size
    17151716
    17161717CONSTANT:
     
    17431744
    17441745.. _Reserve Task/Thread Stack Memory Above Minimum:
     1746.. index:: CONFIGURE_EXTRA_TASK_STACKS
     1747.. index:: memory for task tasks
    17451748
    17461749Reserve Task/Thread Stack Memory Above Minimum
    17471750----------------------------------------------
    1748 .. index:: CONFIGURE_EXTRA_TASK_STACKS
    1749 .. index:: memory for task tasks
    17501751
    17511752CONSTANT:
     
    17741775
    17751776.. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
    1776 
    1777 Automatically Zeroing the RTEMS Workspace and C Program Heap
    1778 ------------------------------------------------------------
    17791777.. index:: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
    17801778.. index:: clear C Program Heap
     
    17831781.. index:: zero RTEMS Workspace
    17841782
     1783Automatically Zeroing the RTEMS Workspace and C Program Heap
     1784------------------------------------------------------------
     1785
    17851786CONSTANT:
    17861787    ``CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY``
     
    18081809
    18091810.. _Enable The Task Stack Usage Checker:
     1811.. index:: CONFIGURE_STACK_CHECKER_ENABLED
    18101812
    18111813Enable The Task Stack Usage Checker
    18121814-----------------------------------
    1813 .. index:: CONFIGURE_STACK_CHECKER_ENABLED
    18141815
    18151816CONSTANT:
     
    18381839
    18391840.. _CONFIGURE_INITIAL_EXTENSIONS:
     1841.. index:: CONFIGURE_INITIAL_EXTENSIONS
    18401842
    18411843Specify Application Specific User Extensions
    18421844--------------------------------------------
    1843 .. index:: CONFIGURE_INITIAL_EXTENSIONS
    18441845
    18451846CONSTANT:
     
    18761877
    18771878.. _Custom Task Stack Allocator Initialization:
     1879.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
    18781880
    18791881Custom Task Stack Allocator Initialization
    18801882------------------------------------------
    1881 .. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
    18821883
    18831884CONSTANT:
     
    19111912
    19121913.. _Custom Task Stack Allocator:
     1914.. index:: CONFIGURE_TASK_STACK_ALLOCATOR
     1915.. index:: task stack allocator
    19131916
    19141917Custom Task Stack Allocator
    19151918---------------------------
    1916 .. index:: CONFIGURE_TASK_STACK_ALLOCATOR
    1917 
    1918 .. index:: task stack allocator
    19191919
    19201920CONSTANT:
     
    19471947
    19481948.. _Custom Task Stack Deallocator:
     1949.. index:: CONFIGURE_TASK_STACK_DEALLOCATOR
     1950.. index:: task stack deallocator
    19491951
    19501952Custom Task Stack Deallocator
    19511953-----------------------------
    1952 .. index:: CONFIGURE_TASK_STACK_DEALLOCATOR
    1953 .. index:: task stack deallocator
    19541954
    19551955CONSTANT:
     
    19901990
    19911991.. _Calculate Memory for a Single Classic Message API Message Queue:
     1992.. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
     1993.. index:: memory for a single message queue's buffers
    19921994
    19931995Calculate Memory for a Single Classic Message API Message Queue
    19941996---------------------------------------------------------------
    1995 .. index:: CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE
    1996 .. index:: memory for a single message queue's buffers
    19971997
    19981998CONSTANT:
     
    20302030
    20312031.. _Reserve Memory for All Classic Message API Message Queues:
     2032.. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY
     2033.. index:: configure message queue buffer memory
    20322034
    20332035Reserve Memory for All Classic Message API Message Queues
    20342036---------------------------------------------------------
    2035 .. index:: CONFIGURE_MESSAGE_BUFFER_MEMORY
    2036 .. index:: configure message queue buffer memory
    20372037
    20382038CONSTANT:
     
    20852085
    20862086.. _Specify Memory Overhead:
     2087.. index:: CONFIGURE_MEMORY_OVERHEAD
    20872088
    20882089Specify Memory Overhead
    20892090-----------------------
    2090 .. index:: CONFIGURE_MEMORY_OVERHEAD
    20912091
    20922092CONSTANT:
     
    21152115
    21162116.. _Do Not Generate Configuration Information:
     2117.. index:: CONFIGURE_HAS_OWN_CONFIGURATION_TABLE
    21172118
    21182119Do Not Generate Configuration Information
    21192120-----------------------------------------
    2120 .. index:: CONFIGURE_HAS_OWN_CONFIGURATION_TABLE
    21212121
    21222122CONSTANT:
     
    21502150
    21512151.. _Specify Maximum Number of File Descriptors:
     2152.. index:: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
     2153.. index:: maximum file descriptors
    21522154
    21532155Specify Maximum Number of File Descriptors
    21542156------------------------------------------
    2155 .. index:: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
    2156 .. index:: maximum file descriptors
    21572157
    21582158CONSTANT:
     
    21812181
    21822182.. _Disable POSIX Termios Support:
     2183.. index:: CONFIGURE_TERMIOS_DISABLED
    21832184
    21842185Disable POSIX Termios Support
    21852186-----------------------------
    2186 .. index:: CONFIGURE_TERMIOS_DISABLED
    21872187
    21882188CONSTANT:
     
    22112211
    22122212.. _Specify Maximum Termios Ports:
     2213.. index:: CONFIGURE_NUMBER_OF_TERMIOS_PORTS
    22132214
    22142215Specify Maximum Termios Ports
    22152216-----------------------------
    2216 .. index:: CONFIGURE_NUMBER_OF_TERMIOS_PORTS
    22172217
    22182218CONSTANT:
     
    22492249
    22502250.. _Providing Application Specific Mount Table:
     2251.. index:: CONFIGURE_HAS_OWN_MOUNT_TABLE
    22512252
    22522253Providing Application Specific Mount Table
    22532254------------------------------------------
    2254 .. index:: CONFIGURE_HAS_OWN_MOUNT_TABLE
    22552255
    22562256CONSTANT:
     
    22832283
    22842284.. _Configure devFS as Root File System:
     2285.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
    22852286
    22862287Configure devFS as Root File System
    22872288-----------------------------------
    2288 .. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
    22892289
    22902290CONSTANT:
     
    23152315
    23162316.. _Specifying Maximum Devices for devFS:
     2317.. index:: CONFIGURE_MAXIMUM_DEVICES
    23172318
    23182319Specifying Maximum Devices for devFS
    23192320------------------------------------
    2320 .. index:: CONFIGURE_MAXIMUM_DEVICES
    23212321
    23222322CONSTANT:
     
    23462346
    23472347.. _Disable File System Support:
     2348.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
    23482349
    23492350Disable File System Support
    23502351---------------------------
    2351 .. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
    23522352
    23532353CONSTANT:
     
    23752375
    23762376.. _Use a Root IMFS with a Minimalistic Feature Set:
     2377.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
    23772378
    23782379Use a Root IMFS with a Minimalistic Feature Set
    23792380-----------------------------------------------
    2380 .. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
    23812381
    23822382CONSTANT:
     
    24152415
    24162416.. _Specify Block Size for IMFS:
     2417.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
    24172418
    24182419Specify Block Size for IMFS
    24192420---------------------------
    2420 .. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
    24212421
    24222422CONSTANT:
     
    24652465
    24662466.. _Disable Change Owner Support of Root IMFS:
     2467.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
    24672468
    24682469Disable Change Owner Support of Root IMFS
    24692470-----------------------------------------
    2470 .. index:: CONFIGURE_IMFS_DISABLE_CHOWN
    24712471
    24722472CONSTANT:
     
    24892489
    24902490.. _Disable Change Mode Support of Root IMFS:
     2491.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
    24912492
    24922493Disable Change Mode Support of Root IMFS
    24932494----------------------------------------
    2494 .. index:: CONFIGURE_IMFS_DISABLE_CHMOD
    24952495
    24962496CONSTANT:
     
    25132513
    25142514.. _Disable Change Times Support of Root IMFS:
     2515.. index:: CONFIGURE_IMFS_DISABLE_UTIME
    25152516
    25162517Disable Change Times Support of Root IMFS
    25172518-----------------------------------------
    2518 .. index:: CONFIGURE_IMFS_DISABLE_UTIME
    25192519
    25202520CONSTANT:
     
    25372537
    25382538.. _Disable Create Hard Link Support of Root IMFS:
     2539.. index:: CONFIGURE_IMFS_DISABLE_LINK
    25392540
    25402541Disable Create Hard Link Support of Root IMFS
    25412542---------------------------------------------
    2542 .. index:: CONFIGURE_IMFS_DISABLE_LINK
    25432543
    25442544CONSTANT:
     
    25612561
    25622562.. _Disable Create Symbolic Link Support of Root IMFS:
     2563.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
    25632564
    25642565Disable Create Symbolic Link Support of Root IMFS
    25652566-------------------------------------------------
    2566 .. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
    25672567
    25682568CONSTANT:
     
    25852585
    25862586.. _Disable Read Symbolic Link Support of Root IMFS:
     2587.. index:: CONFIGURE_IMFS_DISABLE_READLINK
    25872588
    25882589Disable Read Symbolic Link Support of Root IMFS
    25892590-----------------------------------------------
    2590 .. index:: CONFIGURE_IMFS_DISABLE_READLINK
    25912591
    25922592CONSTANT:
     
    26092609
    26102610.. _Disable Rename Support of Root IMFS:
     2611.. index:: CONFIGURE_IMFS_DISABLE_RENAME
    26112612
    26122613Disable Rename Support of Root IMFS
    26132614-----------------------------------
    2614 .. index:: CONFIGURE_IMFS_DISABLE_RENAME
    26152615
    26162616CONSTANT:
     
    26332633
    26342634.. _Disable Directory Read Support of Root IMFS:
     2635.. index:: CONFIGURE_IMFS_DISABLE_READDIR
    26352636
    26362637Disable Directory Read Support of Root IMFS
    26372638-------------------------------------------
    2638 .. index:: CONFIGURE_IMFS_DISABLE_READDIR
    26392639
    26402640CONSTANT:
     
    26582658
    26592659.. _Disable Mount Support of Root IMFS:
     2660.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
    26602661
    26612662Disable Mount Support of Root IMFS
    26622663----------------------------------
    2663 .. index:: CONFIGURE_IMFS_DISABLE_MOUNT
    26642664
    26652665CONSTANT:
     
    26822682
    26832683.. _Disable Unmount Support of Root IMFS:
     2684.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
    26842685
    26852686Disable Unmount Support of Root IMFS
    26862687------------------------------------
    2687 .. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
    26882688
    26892689CONSTANT:
     
    27062706
    27072707.. _Disable Make Nodes Support of Root IMFS:
     2708.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
    27082709
    27092710Disable Make Nodes Support of Root IMFS
    27102711---------------------------------------
    2711 .. index:: CONFIGURE_IMFS_DISABLE_MKNOD
    27122712
    27132713CONSTANT:
     
    27302730
    27312731.. _Disable Make Files Support of Root IMFS:
     2732.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
    27322733
    27332734Disable Make Files Support of Root IMFS
    27342735---------------------------------------
    2735 .. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
    27362736
    27372737CONSTANT:
     
    27542754
    27552755.. _Disable Remove Nodes Support of Root IMFS:
     2756.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
    27562757
    27572758Disable Remove Nodes Support of Root IMFS
    27582759-----------------------------------------
    2759 .. index:: CONFIGURE_IMFS_DISABLE_RMNOD
    27602760
    27612761CONSTANT:
     
    27862786
    27872787.. _Enable Block Device Cache:
     2788.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
    27882789
    27892790Enable Block Device Cache
    27902791-------------------------
    2791 .. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
    27922792
    27932793CONSTANT:
     
    28142814
    28152815.. _Size of the Cache Memory:
     2816.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
    28162817
    28172818Size of the Cache Memory
    28182819------------------------
    2819 .. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
    28202820
    28212821CONSTANT:
     
    28402840
    28412841.. _Minimum Size of a Buffer:
     2842.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
    28422843
    28432844Minimum Size of a Buffer
    28442845------------------------
    2845 .. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
    28462846
    28472847CONSTANT:
     
    28662866
    28672867.. _Maximum Size of a Buffer:
     2868.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    28682869
    28692870Maximum Size of a Buffer
    28702871------------------------
    2871 .. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
    28722872
    28732873CONSTANT:
     
    28922892
    28932893.. _Swapout Task Swap Period:
     2894.. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
    28942895
    28952896Swapout Task Swap Period
    28962897------------------------
    2897 .. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
    28982898
    28992899CONSTANT:
     
    29182918
    29192919.. _Swapout Task Maximum Block Hold Time:
     2920.. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
    29202921
    29212922Swapout Task Maximum Block Hold Time
    29222923------------------------------------
    2923 .. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
    29242924
    29252925CONSTANT:
     
    29442944
    29452945.. _Swapout Task Priority:
     2946.. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
    29462947
    29472948Swapout Task Priority
    29482949---------------------
    2949 .. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
    29502950
    29512951CONSTANT:
     
    29702970
    29712971.. _Maximum Blocks per Read-Ahead Request:
     2972.. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
    29722973
    29732974Maximum Blocks per Read-Ahead Request
    29742975-------------------------------------
    2975 .. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
    29762976
    29772977CONSTANT:
     
    29982998
    29992999.. _Maximum Blocks per Write Request:
     3000.. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
    30003001
    30013002Maximum Blocks per Write Request
    30023003--------------------------------
    3003 .. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
    30043004
    30053005CONSTANT:
     
    30243024
    30253025.. _Task Stack Size of the Block Device Cache Tasks:
     3026.. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
    30263027
    30273028Task Stack Size of the Block Device Cache Tasks
    30283029-----------------------------------------------
    3029 .. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
    30303030
    30313031CONSTANT:
     
    30503050
    30513051.. _Read-Ahead Task Priority:
     3052.. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    30523053
    30533054Read-Ahead Task Priority
    30543055------------------------
    3055 .. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
    30563056
    30573057CONSTANT:
     
    30763076
    30773077.. _Swapout Worker Task Count:
     3078.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
    30783079
    30793080Swapout Worker Task Count
    30803081-------------------------
    3081 .. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
    30823082
    30833083CONSTANT:
     
    31023102
    31033103.. _Swapout Worker Task Priority:
     3104.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    31043105
    31053106Swapout Worker Task Priority
    31063107----------------------------
    3107 .. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
    31083108
    31093109CONSTANT:
     
    31373137
    31383138.. _Disable BSP Configuration Settings:
     3139.. index:: CONFIGURE_DISABLE_BSP_SETTINGS
    31393140
    31403141Disable BSP Configuration Settings
    31413142----------------------------------
    3142 .. index:: CONFIGURE_DISABLE_BSP_SETTINGS
    31433143
    31443144CONSTANT:
     
    31643164
    31653165.. _Specify BSP Supports sbrk():
     3166.. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    31663167
    31673168Specify BSP Supports sbrk()
    31683169---------------------------
    3169 .. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    31703170
    31713171CONSTANT:
     
    31963196
    31973197.. _Specify BSP Specific Idle Task:
     3198.. index:: BSP_IDLE_TASK_BODY
    31983199
    31993200Specify BSP Specific Idle Task
    32003201------------------------------
    3201 .. index:: BSP_IDLE_TASK_BODY
    32023202
    32033203CONSTANT:
     
    32263226
    32273227.. _Specify BSP Suggested Value for IDLE Task Stack Size:
     3228.. index:: BSP_IDLE_TASK_STACK_SIZE
    32283229
    32293230Specify BSP Suggested Value for IDLE Task Stack Size
    32303231----------------------------------------------------
    3231 .. index:: BSP_IDLE_TASK_STACK_SIZE
    32323232
    32333233CONSTANT:
     
    32643264
    32653265.. _Specify BSP Specific User Extensions:
     3266.. index:: BSP_INITIAL_EXTENSION
    32663267
    32673268Specify BSP Specific User Extensions
    32683269------------------------------------
    3269 .. index:: BSP_INITIAL_EXTENSION
    32703270
    32713271CONSTANT:
     
    32923292
    32933293.. _Specifying BSP Specific Interrupt Stack Size:
     3294.. index:: BSP_INTERRUPT_STACK_SIZE
    32943295
    32953296Specifying BSP Specific Interrupt Stack Size
    32963297--------------------------------------------
    3297 .. index:: BSP_INTERRUPT_STACK_SIZE
    32983298
    32993299CONSTANT:
     
    33203320
    33213321.. _Specifying BSP Specific Maximum Devices:
     3322.. index:: BSP_MAXIMUM_DEVICES
    33223323
    33233324Specifying BSP Specific Maximum Devices
    33243325---------------------------------------
    3325 .. index:: BSP_MAXIMUM_DEVICES
    33263326
    33273327CONSTANT:
     
    33513351
    33523352.. _BSP Recommends RTEMS Workspace be Cleared:
     3353.. index:: BSP_ZERO_WORKSPACE_AUTOMATICALLY
    33533354
    33543355BSP Recommends RTEMS Workspace be Cleared
    33553356-----------------------------------------
    3356 .. index:: BSP_ZERO_WORKSPACE_AUTOMATICALLY
    33573357
    33583358CONSTANT:
     
    33803380
    33813381.. _Specify BSP Prerequisite Drivers:
     3382.. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
    33823383
    33833384Specify BSP Prerequisite Drivers
    33843385--------------------------------
    3385 .. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
    33863386
    33873387CONSTANT:
     
    34203420
    34213421.. _Specify Application Specific Idle Task Body:
     3422.. index:: CONFIGURE_IDLE_TASK_BODY
    34223423
    34233424Specify Application Specific Idle Task Body
    34243425-------------------------------------------
    3425 .. index:: CONFIGURE_IDLE_TASK_BODY
    34263426
    34273427CONSTANT:
     
    34483448
    34493449.. _Specify Idle Task Stack Size:
     3450.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
    34503451
    34513452Specify Idle Task Stack Size
    34523453----------------------------
    3453 .. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
    34543454
    34553455CONSTANT:
     
    34753475
    34763476.. _Specify Idle Task Performs Application Initialization:
     3477.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
    34773478
    34783479Specify Idle Task Performs Application Initialization
    34793480-----------------------------------------------------
    3480 .. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
    34813481
    34823482CONSTANT:
     
    35253525
    35263526.. _Use Deterministic Priority Scheduler:
     3527.. index:: CONFIGURE_SCHEDULER_PRIORITY
    35273528
    35283529Use Deterministic Priority Scheduler
    35293530------------------------------------
    3530 .. index:: CONFIGURE_SCHEDULER_PRIORITY
    35313531
    35323532CONSTANT:
     
    35583558
    35593559.. _Use Simple Priority Scheduler:
     3560.. index:: CONFIGURE_SCHEDULER_SIMPLE
    35603561
    35613562Use Simple Priority Scheduler
    35623563-----------------------------
    3563 .. index:: CONFIGURE_SCHEDULER_SIMPLE
    35643564
    35653565CONSTANT:
     
    35933593
    35943594.. _Use Earliest Deadline First Scheduler:
     3595.. index:: CONFIGURE_SCHEDULER_EDF
    35953596
    35963597Use Earliest Deadline First Scheduler
    35973598-------------------------------------
    3598 .. index:: CONFIGURE_SCHEDULER_EDF
    35993599
    36003600CONSTANT:
     
    36303630
    36313631.. _Use Earliest Deadline First SMP Scheduler:
     3632.. index:: CONFIGURE_SCHEDULER_EDF_SMP
    36323633
    36333634Use Earliest Deadline First Scheduler
    36343635-------------------------------------
    3635 .. index:: CONFIGURE_SCHEDULER_EDF_SMP
    36363636
    36373637CONSTANT:
     
    36573657
    36583658.. _Use Constant Bandwidth Server Scheduler:
     3659.. index:: CONFIGURE_SCHEDULER_CBS
    36593660
    36603661Use Constant Bandwidth Server Scheduler
    36613662---------------------------------------
    3662 .. index:: CONFIGURE_SCHEDULER_CBS
    36633663
    36643664CONSTANT:
     
    36923692
    36933693.. _Use Deterministic Priority SMP Scheduler:
     3694.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
    36943695
    36953696Use Deterministic Priority SMP Scheduler
    36963697----------------------------------------
    3697 .. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
    36983698
    36993699CONSTANT:
     
    37273727
    37283728.. _Use Simple SMP Priority Scheduler:
     3729.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
    37293730
    37303731Use Simple SMP Priority Scheduler
    37313732---------------------------------
    3732 .. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
    37333733
    37343734CONSTANT:
     
    37683768
    37693769.. _Configuring a Scheduler Name:
     3770.. index:: CONFIGURE_SCHEDULER_NAME
    37703771
    37713772Configuring a Scheduler Name
    37723773----------------------------
    3773 .. index:: CONFIGURE_SCHEDULER_NAME
    37743774
    37753775CONSTANT:
     
    38023802
    38033803.. _Configuring a User Provided Scheduler:
     3804.. index:: CONFIGURE_SCHEDULER_USER
    38043805
    38053806Configuring a User Provided Scheduler
    38063807-------------------------------------
    3807 .. index:: CONFIGURE_SCHEDULER_USER
    38083808
    38093809CONSTANT:
     
    40314031
    40324032.. _Specifying the Maximum Number of Device Drivers:
     4033.. index:: CONFIGURE_MAXIMUM_DRIVERS
    40334034
    40344035Specifying the Maximum Number of Device Drivers
    40354036-----------------------------------------------
    4036 .. index:: CONFIGURE_MAXIMUM_DRIVERS
    40374037
    40384038CONSTANT:
     
    40654065
    40664066.. _Enable Console Device Driver:
     4067.. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
    40674068
    40684069Enable Console Device Driver
    40694070----------------------------
    4070 .. index:: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
    40714071
    40724072CONSTANT:
     
    40964096
    40974097.. _Enable Clock Driver:
     4098.. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    40984099
    40994100Enable Clock Driver
    41004101-------------------
    4101 .. index:: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    41024102
    41034103CONSTANT:
     
    41294129
    41304130.. _Enable the Benchmark Timer Driver:
     4131.. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    41314132
    41324133Enable the Benchmark Timer Driver
    41334134---------------------------------
    4134 .. index:: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    41354135
    41364136CONSTANT:
     
    41604160
    41614161.. _Specify Clock and Benchmark Timer Drivers Are Not Needed:
     4162.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
    41624163
    41634164Specify Clock and Benchmark Timer Drivers Are Not Needed
    41644165--------------------------------------------------------
    4165 .. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
    41664166
    41674167CONSTANT:
     
    41914191
    41924192.. _Enable Real-Time Clock Driver:
     4193.. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
    41934194
    41944195Enable Real-Time Clock Driver
    41954196-----------------------------
    4196 .. index:: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER
    41974197
    41984198CONSTANT:
     
    42224222
    42234223.. _Enable the Watchdog Device Driver:
     4224.. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
    42244225
    42254226Enable the Watchdog Device Driver
    42264227---------------------------------
    4227 .. index:: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER
    42284228
    42294229CONSTANT:
     
    42534253
    42544254.. _Enable the Graphics Frame Buffer Device Driver:
     4255.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
    42554256
    42564257Enable the Graphics Frame Buffer Device Driver
    42574258----------------------------------------------
    4258 .. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
    42594259
    42604260CONSTANT:
     
    42844284
    42854285.. _Enable Stub Device Driver:
     4286.. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
    42864287
    42874288Enable Stub Device Driver
    42884289-------------------------
    4289 .. index:: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER
    42904290
    42914291CONSTANT:
     
    43124312
    43134313.. _Specify Application Prerequisite Device Drivers:
     4314.. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
    43144315
    43154316Specify Application Prerequisite Device Drivers
    43164317-----------------------------------------------
    4317 .. index:: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
    43184318
    43194319CONSTANT:
     
    43484348
    43494349.. _Specify Extra Application Device Drivers:
     4350.. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
    43504351
    43514352Specify Extra Application Device Drivers
    43524353----------------------------------------
    4353 .. index:: CONFIGURE_APPLICATION_EXTRA_DRIVERS
    43544354
    43554355CONSTANT:
     
    43774377
    43784378.. _Enable /dev/null Device Driver:
     4379.. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
     4380.. index:: /dev/null
    43794381
    43804382Enable /dev/null Device Driver
    43814383------------------------------
    4382 .. index:: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER
    4383 .. index:: /dev/null
    43844384
    43854385CONSTANT:
     
    44044404
    44054405.. _Enable /dev/zero Device Driver:
     4406.. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
     4407.. index:: /dev/zero
    44064408
    44074409Enable /dev/zero Device Driver
    44084410------------------------------
    4409 .. index:: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER
    4410 .. index:: /dev/zero
    44114411
    44124412CONSTANT:
     
    44314431
    44324432.. _Specifying Application Defined Device Driver Table:
     4433.. index:: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
    44334434
    44344435Specifying Application Defined Device Driver Table
    44354436--------------------------------------------------
    4436 .. index:: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
    44374437
    44384438CONSTANT:
     
    44774477
    44784478.. _Specify Application Will Use Multiprocessing:
     4479.. index:: CONFIGURE_MP_APPLICATION
    44794480
    44804481Specify Application Will Use Multiprocessing
    44814482--------------------------------------------
    4482 .. index:: CONFIGURE_MP_APPLICATION
    44834483
    44844484CONSTANT:
     
    45074507
    45084508.. _Configure Node Number in Multiprocessor Configuration:
     4509.. index:: CONFIGURE_MP_NODE_NUMBER
    45094510
    45104511Configure Node Number in Multiprocessor Configuration
    45114512-----------------------------------------------------
    4512 .. index:: CONFIGURE_MP_NODE_NUMBER
    45134513
    45144514CONSTANT:
     
    45384538
    45394539.. _Configure Maximum Node in Multiprocessor Configuration:
     4540.. index:: CONFIGURE_MP_MAXIMUM_NODES
    45404541
    45414542Configure Maximum Node in Multiprocessor Configuration
    45424543------------------------------------------------------
    4543 .. index:: CONFIGURE_MP_MAXIMUM_NODES
    45444544
    45454545CONSTANT:
     
    45654565
    45664566.. _Configure Maximum Global Objects in Multiprocessor Configuration:
     4567.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    45674568
    45684569Configure Maximum Global Objects in Multiprocessor Configuration
    45694570----------------------------------------------------------------
    4570 .. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
    45714571
    45724572CONSTANT:
     
    45934593
    45944594.. _Configure Maximum Proxies in Multiprocessor Configuration:
     4595.. index:: CONFIGURE_MP_MAXIMUM_PROXIES
    45954596
    45964597Configure Maximum Proxies in Multiprocessor Configuration
    45974598---------------------------------------------------------
    4598 .. index:: CONFIGURE_MP_MAXIMUM_PROXIES
    45994599
    46004600CONSTANT:
     
    46244624
    46254625.. _Configure MPCI in Multiprocessor Configuration:
     4626.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
    46264627
    46274628Configure MPCI in Multiprocessor Configuration
    46284629----------------------------------------------
    4629 .. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
    46304630
    46314631CONSTANT:
     
    46534653
    46544654.. _Do Not Generate Multiprocessor Configuration Table:
     4655.. index:: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
    46554656
    46564657Do Not Generate Multiprocessor Configuration Table
    46574658--------------------------------------------------
    4658 .. index:: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
    46594659
    46604660CONSTANT:
     
    47004700
    47014701.. _Specify Application Includes Ada Code:
     4702.. index:: CONFIGURE_GNAT_RTEMS
    47024703
    47034704Specify Application Includes Ada Code
    47044705-------------------------------------
    4705 .. index:: CONFIGURE_GNAT_RTEMS
    47064706
    47074707CONSTANT:
     
    47294729
    47304730.. _Specify the Maximum Number of Ada Tasks.:
     4731.. index:: CONFIGURE_MAXIMUM_ADA_TASKS
    47314732
    47324733Specify the Maximum Number of Ada Tasks.
    47334734----------------------------------------
    4734 .. index:: CONFIGURE_MAXIMUM_ADA_TASKS
    47354735
    47364736CONSTANT:
     
    47574757
    47584758.. _Specify the Maximum Fake Ada Tasks:
     4759.. index:: CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
    47594760
    47604761Specify the Maximum Fake Ada Tasks
    47614762----------------------------------
    4762 .. index:: CONFIGURE_MAXIMUM_FAKE_ADA_TASKS
    4763 
    4764 CONSTANT:
    4765     .. index:: ``CONFIGURE_MAXIMUM_FAKE_ADA_TASKS``
     4763
     4764CONSTANT:
     4765    ``CONFIGURE_MAXIMUM_FAKE_ADA_TASKS``
    47664766
    47674767DATA TYPE:
     
    48454845
    48464846.. _Specify Application Includes Go Code:
     4847.. index:: CONFIGURE_ENABLE_GO
    48474848
    48484849Specify Application Includes Go Code
    48494850------------------------------------
    4850 .. index:: CONFIGURE_ENABLE_GO
    48514851
    48524852CONSTANT:
     
    48724872
    48734873.. _Specify the maximum number of Go routines:
     4874.. index:: CONFIGURE_MAXIMUM_GOROUTINES
    48744875
    48754876Specify the maximum number of Go routines
    48764877-----------------------------------------
    4877 .. index:: CONFIGURE_MAXIMUM_GOROUTINES
    48784878
    48794879CONSTANT:
     
    48994899
    49004900.. _Specify the maximum number of Go Channels:
     4901.. index:: CONFIGURE_MAXIMUM_GO_CHANNELS
    49014902
    49024903Specify the maximum number of Go Channels
    49034904-----------------------------------------
    4904 .. index:: CONFIGURE_MAXIMUM_GO_CHANNELS
    49054905
    49064906CONSTANT:
     
    49254925Obsolete Configuration Options
    49264926==============================
     4927.. index:: CONFIGURE_BDBUF_BUFFER_COUNT
    49274928
    49284929CONFIGURE_BDBUF_BUFFER_COUNT
    49294930----------------------------
    4930 .. index:: CONFIGURE_BDBUF_BUFFER_COUNT
    49314931
    49324932This configuration option was introduced in RTEMS 4.7.0 and is obsolete since
    49334933RTEMS 4.10.0.
     4934.. index:: CONFIGURE_BDBUF_BUFFER_SIZE
    49344935
    49354936CONFIGURE_BDBUF_BUFFER_SIZE
    49364937---------------------------
    4937 .. index:: CONFIGURE_BDBUF_BUFFER_SIZE
    49384938
    49394939This configuration option was introduced in RTEMS 4.7.0 and is obsolete since
    49404940RTEMS 4.10.0.
     4941.. index:: CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    49414942
    49424943CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    49434944--------------------------------------
    4944 .. index:: CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    49454945
    49464946This configuration option was introduced in RTEMS 4.9.0 and is obsolete since
    49474947RTEMS 5.1.
     4948.. index:: CONFIGURE_HAS_OWN_BDBUF_TABLE
    49484949
    49494950CONFIGURE_HAS_OWN_BDBUF_TABLE
    49504951-----------------------------
    4951 .. index:: CONFIGURE_HAS_OWN_BDBUF_TABLE
    49524952
    49534953This configuration option was introduced in RTEMS 4.7.0 and is obsolete since
    49544954RTEMS 4.10.0.
     4955.. index:: CONFIGURE_MAXIMUM_POSIX_BARRIERS
    49554956
    49564957CONFIGURE_MAXIMUM_POSIX_BARRIERS
    49574958--------------------------------
    4958 .. index:: CONFIGURE_MAXIMUM_POSIX_BARRIERS
    49594959
    49604960This configuration option is obsolete since RTEMS 5.1.
     4961.. index:: CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES
    49614962
    49624963CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES
    49634964-------------------------------------------
    4964 .. index:: CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES
    49654965
    49664966This configuration option is obsolete since RTEMS 5.1.
     4967.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS
    49674968
    49684969CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS
    49694970-------------------------------
    4970 .. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS
    49714971
    49724972This configuration option was introduced in RTEMS 4.10.0 and is obsolete since
    49734973RTEMS 5.1.
     4974.. index:: CONFIGURE_MAXIMUM_POSIX_MUTEXES
    49744975
    49754976CONFIGURE_MAXIMUM_POSIX_MUTEXES
    49764977-------------------------------
    4977 .. index:: CONFIGURE_MAXIMUM_POSIX_MUTEXES
    49784978
    49794979This configuration option is obsolete since RTEMS 5.1.
     4980.. index:: CONFIGURE_MAXIMUM_POSIX_RWLOCKS
    49804981
    49814982CONFIGURE_MAXIMUM_POSIX_RWLOCKS
    49824983-------------------------------
    4983 .. index:: CONFIGURE_MAXIMUM_POSIX_RWLOCKS
    49844984
    49854985This configuration option is obsolete since RTEMS 5.1.
     4986.. index:: CONFIGURE_MAXIMUM_POSIX_SPINLOCKS
    49864987
    49874988CONFIGURE_MAXIMUM_POSIX_SPINLOCKS
    49884989---------------------------------
    4989 .. index:: CONFIGURE_MAXIMUM_POSIX_SPINLOCKS
    49904990
    49914991This configuration option is obsolete since RTEMS 5.1.
     4992.. index:: CONFIGURE_SMP_APPLICATION
    49924993
    49934994CONFIGURE_SMP_APPLICATION
    49944995-------------------------
    4995 .. index:: CONFIGURE_SMP_APPLICATION
    49964996
    49974997This configuration option was introduced in RTEMS 4.11.0 and is obsolete since
    49984998RTEMS 5.1.
     4999.. index:: CONFIGURE_SMP_MAXIMUM_PROCESSORS
    49995000
    50005001CONFIGURE_SMP_MAXIMUM_PROCESSORS
    50015002--------------------------------
    5002 .. index:: CONFIGURE_SMP_MAXIMUM_PROCESSORS
    50035003
    50045004This configuration option was introduced in RTEMS 4.11.0 and is obsolete since
  • c-user/constant_bandwidth_server.rst

    r42d50d7 r6c56401  
    4343Background
    4444==========
     45.. index:: CBS parameters
     46.. index:: rtems_cbs_parameters
    4547
    4648Constant Bandwidth Server Definitions
    4749-------------------------------------
    48 .. index:: CBS parameters
    49 
    50 .. index:: rtems_cbs_parameters
    5150
    5251The Constant Bandwidth Server API enables tasks to communicate with the
     
    7271attached to the servers. The ``rtems_cbs_server_id`` is a type denoting an id
    7372of a server and ``rtems_id`` a type for id of tasks.
     73.. index:: CBS periodic tasks
    7474
    7575Handling Periodic Tasks
    7676-----------------------
    77 .. index:: CBS periodic tasks
    7877
    7978Each task's execution begins with a default background priority (see the
     
    8584change them using the CBS API again. Task now only has to indicate and end of
    8685each period using ``rtems_rate_monotonic_period``.
     86.. index:: CBS overrun handler
    8787
    8888Registering a Callback Function
    8989-------------------------------
    90 .. index:: CBS overrun handler
    9190
    9291In case tasks attached to servers are not aware of their execution time and
     
    114113        rtems_cbs_server_id server_id
    115114    );
     115.. index:: CBS limitations
    116116
    117117Limitations
    118118-----------
    119 .. index:: CBS limitations
    120119
    121120When using this scheduler you have to keep in mind several things:
     
    235234
    236235.. _rtems_cbs_initialize:
     236.. index:: initialize the CBS library
     237.. index:: rtems_cbs_initialize
    237238
    238239CBS_INITIALIZE - Initialize the CBS library
    239240-------------------------------------------
    240 .. index:: initialize the CBS library
    241 .. index:: rtems_cbs_initialize
    242241
    243242CALLING SEQUENCE:
     
    273272
    274273.. _rtems_cbs_cleanup:
     274.. index:: cleanup the CBS library
     275.. index:: rtems_cbs_cleanup
    275276
    276277CBS_CLEANUP - Cleanup the CBS library
    277278-------------------------------------
    278 .. index:: cleanup the CBS library
    279 .. index:: rtems_cbs_cleanup
    280279
    281280CALLING SEQUENCE:
     
    303302
    304303.. _rtems_cbs_create_server:
     304.. index:: create a new bandwidth server
     305.. index:: rtems_cbs_create_server
    305306
    306307CBS_CREATE_SERVER - Create a new bandwidth server
    307308-------------------------------------------------
    308 .. index:: create a new bandwidth server
    309 .. index:: rtems_cbs_create_server
    310309
    311310CALLING SEQUENCE:
     
    351350
    352351.. _rtems_cbs_attach_thread:
     352.. index:: attach a thread to server
     353.. index:: rtems_cbs_attach_thread
    353354
    354355CBS_ATTACH_THREAD - Attach a thread to server
    355356---------------------------------------------
    356 .. index:: attach a thread to server
    357 .. index:: rtems_cbs_attach_thread
    358357
    359358CALLING SEQUENCE:
     
    393392
    394393.. _rtems_cbs_detach_thread:
     394.. index:: detach a thread from server
     395.. index:: rtems_cbs_detach_thread
    395396
    396397CBS_DETACH_THREAD - Detach a thread from server
    397398-----------------------------------------------
    398 .. index:: detach a thread from server
    399 .. index:: rtems_cbs_detach_thread
    400399
    401400CALLING SEQUENCE:
     
    430429
    431430.. _rtems_cbs_destroy_server:
     431.. index:: destroy a bandwidth server
     432.. index:: rtems_cbs_destroy_server
    432433
    433434CBS_DESTROY_SERVER - Destroy a bandwidth server
    434435-----------------------------------------------
    435 .. index:: destroy a bandwidth server
    436 .. index:: rtems_cbs_destroy_server
    437436
    438437CALLING SEQUENCE:
     
    467466
    468467.. _rtems_cbs_get_server_id:
     468.. index:: get an ID of a server
     469.. index:: rtems_cbs_get_server_id
    469470
    470471CBS_GET_SERVER_ID - Get an ID of a server
    471472-----------------------------------------
    472 .. index:: get an ID of a server
    473 .. index:: rtems_cbs_get_server_id
    474473
    475474CALLING SEQUENCE:
     
    498497
    499498.. _rtems_cbs_get_parameters:
     499.. index:: get scheduling parameters of a server
     500.. index:: rtems_cbs_get_parameters
    500501
    501502CBS_GET_PARAMETERS - Get scheduling parameters of a server
    502503----------------------------------------------------------
    503 .. index:: get scheduling parameters of a server
    504 .. index:: rtems_cbs_get_parameters
    505504
    506505CALLING SEQUENCE:
     
    535534
    536535.. _rtems_cbs_set_parameters:
     536.. index:: set scheduling parameters
     537.. index:: rtems_cbs_set_parameters
    537538
    538539CBS_SET_PARAMETERS - Set scheduling parameters
    539540----------------------------------------------
    540 .. index:: set scheduling parameters
    541 .. index:: rtems_cbs_set_parameters
    542541
    543542CALLING SEQUENCE:
     
    574573
    575574.. _rtems_cbs_get_execution_time:
     575.. index:: get elapsed execution time
     576.. index:: rtems_cbs_get_execution_time
    576577
    577578CBS_GET_EXECUTION_TIME - Get elapsed execution time
    578579---------------------------------------------------
    579 .. index:: get elapsed execution time
    580 .. index:: rtems_cbs_get_execution_time
    581580
    582581CALLING SEQUENCE:
     
    612611
    613612.. _rtems_cbs_get_remaining_budget:
     613.. index:: get remaining execution time
     614.. index:: rtems_cbs_get_remaining_budget
    614615
    615616CBS_GET_REMAINING_BUDGET - Get remaining execution time
    616617-------------------------------------------------------
    617 .. index:: get remaining execution time
    618 .. index:: rtems_cbs_get_remaining_budget
    619618
    620619CALLING SEQUENCE:
     
    650649
    651650.. _rtems_cbs_get_approved_budget:
     651.. index:: get scheduler approved execution time
     652.. index:: rtems_cbs_get_approved_budget
    652653
    653654CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time
    654655---------------------------------------------------------------
    655 .. index:: get scheduler approved execution time
    656 .. index:: rtems_cbs_get_approved_budget
    657656
    658657CALLING SEQUENCE:
  • c-user/cpu_usage_statistics.rst

    r42d50d7 r6c56401  
    44.. COMMENT: On-Line Applications Research Corporation (OAR).
    55.. COMMENT: All rights reserved.
     6
     7.. index:: CPU Usage
    68
    79CPU Usage Statistics
     
    110112
    111113.. _rtems_cpu_usage_report:
     114.. index:: rtems_cpu_usage_report
    112115
    113116cpu_usage_report - Report CPU Usage Statistics
     
    134137
    135138.. _rtems_cpu_usage_reset:
     139.. index:: rtems_cpu_usage_reset
    136140
    137141cpu_usage_reset - Reset CPU Usage Statistics
  • c-user/directive_status_codes.rst

    r42d50d7 r6c56401  
    33.. COMMENT: Copyright 2015 embedded brains GmbH
    44.. COMMENT: All rights reserved.
     5
     6.. index:: Status Codes
    57
    68Directive Status Codes
     
    1820
    1921The directives are:
     22
     23.. index:: rtems_status_code
    2024
    2125.. list-table::
     
    8286
    8387.. _rtems_status_text:
     88.. index:: rtems_status_text
    8489
    8590STATUS_TEXT - Returns the enumeration name for a status code
    8691------------------------------------------------------------
    87 .. index:: rtems_status_text
    8892
    8993CALLING SEQUENCE:
  • c-user/dual_ports_memory_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: ports
     8.. index:: dual ported memory
     9
    710Dual-Ported Memory Manager
    811**************************
    9 
    10 .. index:: ports
    11 .. index:: dual ported memory
    1212
    1313Introduction
     
    2828- rtems_port_internal_to_external_ - Convert internal to external address
    2929
    30 Background
    31 ==========
    3230.. index:: dual ported memory, definition
    3331.. index:: external addresses, definition
    3432.. index:: internal addresses, definition
     33
     34Background
     35==========
    3536
    3637A dual-ported memory area (DPMA) is an contiguous block of RAM owned by a
     
    100101
    101102.. _rtems_port_create:
     103.. index:: create a port
     104.. index:: rtems_port_create
    102105
    103106PORT_CREATE - Create a port
    104107---------------------------
    105 .. index:: create a port
    106 .. index:: rtems_port_create
    107108
    108109CALLING SEQUENCE:
     
    153154
    154155.. _rtems_port_ident:
    155 
    156 PORT_IDENT - Get ID of a port
    157 -----------------------------
    158156.. index:: get ID of a port
    159157.. index:: obtain ID of a port
    160158.. index:: rtems_port_ident
     159
     160PORT_IDENT - Get ID of a port
     161-----------------------------
    161162
    162163CALLING SEQUENCE:
     
    194195
    195196.. _rtems_port_delete:
     197.. index:: delete a port
     198.. index:: rtems_port_delete
    196199
    197200PORT_DELETE - Delete a port
    198201---------------------------
    199 .. index:: delete a port
    200 .. index:: rtems_port_delete
    201202
    202203CALLING SEQUENCE:
     
    231232
    232233.. _rtems_port_external_to_internal:
     234.. index:: convert external to internal address
     235.. index:: rtems_port_external_to_internal
    233236
    234237PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address
    235238----------------------------------------------------------------
    236 .. index:: convert external to internal address
    237 .. index:: rtems_port_external_to_internal
    238239
    239240CALLING SEQUENCE:
     
    271272
    272273.. _rtems_port_internal_to_external:
     274.. index:: convert internal to external address
     275.. index:: rtems_port_internal_to_external
    273276
    274277PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address
    275278----------------------------------------------------------------
    276 .. index:: convert internal to external address
    277 .. index:: rtems_port_internal_to_external
    278279
    279280CALLING SEQUENCE:
  • c-user/event_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: events
     8
    79Event Manager
    810*************
    911
    10 .. index:: events
    11 
    1212Introduction
    1313============
     
    2222==========
    2323
    24 Event Sets
    25 ----------
    2624.. index:: event flag, definition
    2725.. index:: event set, definition
    2826.. index:: rtems_event_set
     27
     28Event Sets
     29----------
    2930
    3031An event flag is used by a task (or ISR) to inform another task of the
     
    6061every requested event is posted.
    6162
     63.. index:: event condition, building
     64.. index:: event set, building
     65
    6266Building an Event Set or Condition
    6367----------------------------------
    64 .. index:: event condition, building
    65 .. index:: event set, building
    6668
    6769An event set or condition is built by a bitwise OR of the desired events.  The
     
    182184
    183185.. _rtems_event_send:
     186.. index:: send event set to a task
     187.. index:: rtems_event_send
    184188
    185189EVENT_SEND - Send event set to a task
    186190-------------------------------------
    187 .. index:: send event set to a task
    188 .. index:: rtems_event_send
    189191
    190192CALLING SEQUENCE:
     
    233235
    234236.. _rtems_event_receive:
     237.. index:: receive event condition
     238.. index:: rtems_event_receive
    235239
    236240EVENT_RECEIVE - Receive event condition
    237241---------------------------------------
    238 .. index:: receive event condition
    239 .. index:: rtems_event_receive
    240242
    241243CALLING SEQUENCE:
  • c-user/fatal_error.rst

    r42d50d7 r6c56401  
    66
    77.. _fatal_error_manager:
     8.. index:: fatal errors
    89
    910Fatal Error Manager
    1011*******************
    11 
    12 .. index:: fatal errors
    1312
    1413Introduction
     
    3534==========
    3635
    37 Overview
    38 --------
    39 
    4036.. index:: fatal error detection
    4137.. index:: fatal error processing
    4238.. index:: fatal error user extension
     39
     40Overview
     41--------
    4342
    4443The fatal error manager is called upon detection of an irrecoverable error
     
    389388
    390389.. _Terminate:
     390.. index:: _Terminate
    391391
    392392Announcing a Fatal Error
    393393------------------------
    394 .. index:: _Terminate
    395394
    396395The :c:func:`_Terminate()` internal error handler is invoked when the
     
    444443
    445444.. _rtems_fatal:
    446 
    447 FATAL - Invoke the fatal error
    448 ------------------------------
    449445.. index:: announce fatal error
    450446.. index:: fatal error, announce
    451447.. index:: rtems_fatal
     448
     449FATAL - Invoke the fatal error
     450------------------------------
    452451
    453452CALLING SEQUENCE:
     
    474473
    475474.. _rtems_shutdown_executive:
     475.. index:: shutdown RTEMS
     476.. index:: rtems_shutdown_executive
    476477
    477478SHUTDOWN_EXECUTIVE - Shutdown RTEMS
    478479-----------------------------------
    479 .. index:: shutdown RTEMS
    480 
    481 .. index:: rtems_shutdown_executive
     480
    482481CALLING SEQUENCE:
    483482    .. code-block:: c
     
    506505
    507506.. _rtems_exception_frame_print:
     507.. index:: exception frame
     508.. index:: rtems_exception_frame_print
    508509
    509510EXCEPTION_FRAME_PRINT - Prints the exception frame
    510511--------------------------------------------------
    511 .. index:: exception frame
    512 .. index:: rtems_exception_frame_print
    513512
    514513CALLING SEQUENCE:
     
    530529
    531530.. _rtems_fatal_source_text:
     531.. index:: fatal error
     532.. index:: rtems_fatal_source_text
    532533
    533534FATAL_SOURCE_TEXT - Returns a text for a fatal source
    534535-----------------------------------------------------
    535 .. index:: fatal error
    536 .. index:: rtems_fatal_source_text
    537536
    538537CALLING SEQUENCE:
     
    555554
    556555.. _rtems_internal_error_text:
     556.. index:: fatal error
     557.. index:: rtems_internal_error_text
    557558
    558559INTERNAL_ERROR_TEXT - Returns a text for an internal error code
    559560---------------------------------------------------------------
    560 .. index:: fatal error
    561 .. index:: rtems_internal_error_text
    562561
    563562CALLING SEQUENCE:
     
    580579
    581580.. _rtems_fatal_error_occurred:
    582 
    583 FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
    584 ------------------------------------------------------------------
    585581.. index:: announce fatal error
    586582.. index:: fatal error, announce
    587583.. index:: rtems_fatal_error_occurred
     584
     585FATAL_ERROR_OCCURRED - Invoke the fatal error handler (deprecated)
     586------------------------------------------------------------------
    588587
    589588CALLING SEQUENCE:
  • c-user/initialization.rst

    r42d50d7 r6c56401  
    2323==========
    2424
     25.. index:: initialization tasks
     26
    2527Initialization Tasks
    2628--------------------
    27 .. index:: initialization tasks
    2829
    2930Initialization task(s) are the mechanism by which RTEMS transfers initial
     
    306307
    307308.. _rtems_initialize_executive:
     309.. index:: initialize RTEMS
     310.. index:: start multitasking
     311.. index:: rtems_initialize_executive
    308312
    309313INITIALIZE_EXECUTIVE - Initialize RTEMS
    310314---------------------------------------
    311 .. index:: initialize RTEMS
    312 .. index:: start multitasking
    313 
    314 .. index:: rtems_initialize_executive
     315
    315316CALLING SEQUENCE:
    316317    .. code-block:: c
  • c-user/interrupt_manager.rst

    r42d50d7 r6c56401  
    44.. COMMENT: On-Line Applications Research Corporation (OAR).
    55.. COMMENT: All rights reserved.
     6
     7.. index:: interrupts
    68
    79Interrupt Manager
     
    4547==========
    4648
     49.. index:: interrupt processing
     50
    4751Processing an Interrupt
    4852-----------------------
    49 .. index:: interrupt processing
    5053
    5154The interrupt manager allows the application to connect a function to a
     
    112115outermost ISR terminates will the postponed dispatching occur.
    113116
     117.. index:: interrupt levels
     118
    114119RTEMS Interrupt Levels
    115120----------------------
    116 .. index:: interrupt levels
    117121
    118122Many processors support multiple interrupt levels or priorities.  The exact
     
    123127Supplement document for a specific target processor.
    124128
     129.. index:: disabling interrupts
     130
    125131Disabling of Interrupts by RTEMS
    126132--------------------------------
    127 .. index:: disabling interrupts
    128133
    129134During the execution of directive calls, critical sections of code may be
     
    265270
    266271.. _rtems_interrupt_catch:
    267 
    268 INTERRUPT_CATCH - Establish an ISR
    269 ----------------------------------
    270272.. index:: establish an ISR
    271273.. index:: install an ISR
    272274.. index:: rtems_interrupt_catch
     275
     276INTERRUPT_CATCH - Establish an ISR
     277----------------------------------
    273278
    274279CALLING SEQUENCE:
     
    309314
    310315.. _rtems_interrupt_disable:
     316.. index:: disable interrupts
     317.. index:: rtems_interrupt_disable
    311318
    312319INTERRUPT_DISABLE - Disable Interrupts
    313320--------------------------------------
    314 .. index:: disable interrupts
    315 .. index:: rtems_interrupt_disable
    316321
    317322CALLING SEQUENCE:
     
    347352
    348353.. _rtems_interrupt_enable:
     354.. index:: enable interrupts
     355.. index:: rtems_interrupt_enable
    349356
    350357INTERRUPT_ENABLE - Enable Interrupts
    351358------------------------------------
    352 .. index:: enable interrupts
    353 .. index:: rtems_interrupt_enable
    354359
    355360CALLING SEQUENCE:
     
    382387
    383388.. _rtems_interrupt_flash:
     389.. index:: flash interrupts
     390.. index:: rtems_interrupt_flash
    384391
    385392INTERRUPT_FLASH - Flash Interrupts
    386393----------------------------------
    387 .. index:: flash interrupts
    388 .. index:: rtems_interrupt_flash
    389394
    390395CALLING SEQUENCE:
     
    417422
    418423.. _rtems_interrupt_local_disable:
     424.. index:: disable interrupts
     425.. index:: rtems_interrupt_local_disable
    419426
    420427INTERRUPT_LOCAL_DISABLE - Disable Interrupts on Current Processor
    421428-----------------------------------------------------------------
    422 .. index:: disable interrupts
    423 .. index:: rtems_interrupt_local_disable
    424429
    425430CALLING SEQUENCE:
     
    454459
    455460.. _rtems_interrupt_local_enable:
     461.. index:: enable interrupts
     462.. index:: rtems_interrupt_local_enable
    456463
    457464INTERRUPT_LOCAL_ENABLE - Enable Interrupts on Current Processor
    458465---------------------------------------------------------------
    459 .. index:: enable interrupts
    460 .. index:: rtems_interrupt_local_enable
    461466
    462467CALLING SEQUENCE:
     
    485490
    486491.. _rtems_interrupt_lock_initialize:
     492.. index:: rtems_interrupt_lock_initialize
    487493
    488494INTERRUPT_LOCK_INITIALIZE - Initialize an ISR Lock
    489495--------------------------------------------------
    490 .. index:: rtems_interrupt_lock_initialize
    491496
    492497CALLING SEQUENCE:
     
    513518
    514519.. _rtems_interrupt_lock_acquire:
     520.. index:: rtems_interrupt_lock_acquire
    515521
    516522INTERRUPT_LOCK_ACQUIRE - Acquire an ISR Lock
    517523--------------------------------------------
    518 .. index:: rtems_interrupt_lock_acquire
    519524
    520525CALLING SEQUENCE:
     
    548553
    549554.. _rtems_interrupt_lock_release:
     555.. index:: rtems_interrupt_lock_release
    550556
    551557INTERRUPT_LOCK_RELEASE - Release an ISR Lock
    552558--------------------------------------------
    553 .. index:: rtems_interrupt_lock_release
    554559
    555560CALLING SEQUENCE:
     
    580585
    581586.. _rtems_interrupt_lock_acquire_isr:
     587.. index:: rtems_interrupt_lock_acquire_isr
    582588
    583589INTERRUPT_LOCK_ACQUIRE_ISR - Acquire an ISR Lock from ISR
    584590---------------------------------------------------------
    585 .. index:: rtems_interrupt_lock_acquire_isr
    586591
    587592CALLING SEQUENCE:
     
    618623
    619624.. _rtems_interrupt_lock_release_isr:
     625.. index:: rtems_interrupt_lock_release_isr
    620626
    621627INTERRUPT_LOCK_RELEASE_ISR - Release an ISR Lock from ISR
    622628---------------------------------------------------------
    623 .. index:: rtems_interrupt_lock_release_isr
    624629
    625630CALLING SEQUENCE:
     
    650655
    651656.. _rtems_interrupt_is_in_progress:
     657.. index:: is interrupt in progress
     658.. index:: rtems_interrupt_is_in_progress
    652659
    653660INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress
    654661------------------------------------------------
    655 .. index:: is interrupt in progress
    656 .. index:: rtems_interrupt_is_in_progress
    657662
    658663CALLING SEQUENCE:
  • c-user/io_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: device drivers
     8.. index:: IO Manager
     9
    710I/O Manager
    811***********
    9 
    10 .. index:: device drivers
    11 .. index:: IO Manager
    1212
    1313Introduction
     
    4141==========
    4242
     43.. index:: Device Driver Table
     44
    4345Device Driver Table
    4446-------------------
    45 .. index:: Device Driver Table
    4647
    4748Each application utilizing the RTEMS I/O manager must specify the address of a
     
    7475number of driver slots available to the application.
    7576
     77.. index:: major device number
     78.. index:: minor device number
     79
    7680Major and Minor Device Numbers
    7781------------------------------
    78 .. index:: major device number
    79 .. index:: minor device number
    8082
    8183Each call to the I/O manager must provide a device's major and minor numbers as
     
    9294are used to manipulate device major and minor numbers, respectively.
    9395
     96.. index:: device names
     97
    9498Device Names
    9599------------
    96 .. index:: device names
    97100
    98101The I/O Manager provides facilities to associate a name with a particular
     
    123126driver.
    124127
     128.. index:: runtime driver registration
     129
    125130Runtime Driver Registration
    126131---------------------------
    127 .. index:: runtime driver registration
    128132
    129133Board support package and application developers can select wether a device
     
    145149- Support for runtime loadable driver modules.
    146150
     151.. index:: device driver interface
     152
    147153Device Driver Interface
    148154-----------------------
    149 .. index:: device driver interface
    150155
    151156When an application invokes an I/O manager directive, RTEMS determines which
     
    227232
    228233.. _rtems_io_register_driver:
     234.. index:: register a device driver
     235.. index:: rtems_io_register_driver
    229236
    230237IO_REGISTER_DRIVER - Register a device driver
    231238---------------------------------------------
    232 .. index:: register a device driver
    233 .. index:: rtems_io_register_driver
    234239
    235240CALLING SEQUENCE:
     
    285290
    286291.. _rtems_io_unregister_driver:
     292.. index:: unregister a device driver
     293.. index:: rtems_io_unregister_driver
    287294
    288295IO_UNREGISTER_DRIVER - Unregister a device driver
    289296-------------------------------------------------
    290 .. index:: unregister a device driver
    291 .. index:: rtems_io_unregister_driver
    292297
    293298CALLING SEQUENCE:
     
    318323
    319324.. _rtems_io_initialize:
     325.. index:: initialize a device driver
     326.. index:: rtems_io_initialize
    320327
    321328IO_INITIALIZE - Initialize a device driver
    322329------------------------------------------
    323 .. index:: initialize a device driver
    324 .. index:: rtems_io_initialize
    325330
    326331CALLING SEQUENCE:
     
    361366
    362367.. _rtems_io_register_name:
     368.. index:: register device
     369.. index:: rtems_io_register_name
    363370
    364371IO_REGISTER_NAME - Register a device
    365372------------------------------------
    366 .. index:: register device
    367 .. index:: rtems_io_register_name
    368373
    369374CALLING SEQUENCE:
     
    396401
    397402.. _rtems_io_lookup_name:
     403.. index:: lookup device major and minor number
     404.. index:: rtems_io_lookup_name
    398405
    399406IO_LOOKUP_NAME - Lookup a device
    400407--------------------------------
    401 .. index:: lookup device major and minor number
    402 .. index:: rtems_io_lookup_name
    403408
    404409CALLING SEQUENCE:
     
    431436
    432437.. _rtems_io_open:
     438.. index:: open a devive
     439.. index:: rtems_io_open
    433440
    434441IO_OPEN - Open a device
    435442-----------------------
    436 .. index:: open a devive
    437 .. index:: rtems_io_open
    438443
    439444CALLING SEQUENCE:
     
    469474
    470475.. _rtems_io_close:
     476.. index:: close a device
     477.. index:: rtems_io_close
    471478
    472479IO_CLOSE - Close a device
    473480-------------------------
    474 .. index:: close a device
    475 .. index:: rtems_io_close
    476481
    477482CALLING SEQUENCE:
     
    507512
    508513.. _rtems_io_read:
     514.. index:: read from a device
     515.. index:: rtems_io_read
    509516
    510517IO_READ - Read from a device
    511518----------------------------
    512 .. index:: read from a device
    513 .. index:: rtems_io_read
    514519
    515520CALLING SEQUENCE:
     
    546551
    547552.. _rtems_io_write:
     553.. index:: write to a device
     554.. index:: rtems_io_write
    548555
    549556IO_WRITE - Write to a device
    550557----------------------------
    551 .. index:: write to a device
    552 .. index:: rtems_io_write
    553558
    554559CALLING SEQUENCE:
     
    585590
    586591.. _rtems_io_control:
    587 
    588 IO_CONTROL - Special device services
    589 ------------------------------------
    590592.. index:: special device services
    591593.. index:: IO Control
    592594.. index:: rtems_io_control
     595
     596IO_CONTROL - Special device services
     597------------------------------------
    593598
    594599CALLING SEQUENCE:
  • c-user/key_concepts.rst

    r42d50d7 r6c56401  
    1818.. _objects:
    1919
     20.. index:: objects
     21
    2022Objects
    2123=======
    22 
    23 .. index:: objects
    2424
    2525RTEMS provides directives which can be used to dynamically create, delete, and
     
    3838facilitate efficient object manipulation by the executive.
    3939
     40.. index:: object name
     41.. index:: rtems_name
     42
    4043Object Names
    4144------------
    42 .. index:: object name
    43 .. index:: rtems_name
    4445
    4546An object name is an unsigned thirty-two bit entity associated with the object
    4647by the user.  The data type ``rtems_name`` is used to store object
    47 names... index:: rtems_build_name
     48names.
     49
     50.. index:: rtems_build_name
    4851
    4952Although not required by RTEMS, object names are often composed of four ASCII
     
    8588    }
    8689
    87 Object IDs
    88 ----------
    8990.. index:: object ID
    9091.. index:: object ID composition
    9192.. index:: rtems_id
     93
     94Object IDs
     95----------
    9296
    9397An object ID is a unique unsigned integer value which uniquely identifies an
     
    199203applications.
    200204
     205.. index:: communication and synchronization
     206
    201207Communication and Synchronization
    202208=================================
    203 .. index:: communication and synchronization
    204209
    205210In real-time multitasking applications, the ability for cooperating execution
     
    240245communication and is typically used for exception handling.
    241246
     247.. index:: locking protocols
     248
    242249Locking Protocols
    243250=================
    244 .. index:: locking protocols
    245251
    246252RTEMS supports the four locking protocols
     
    266272
    267273.. _PriorityInversion:
     274.. index:: priority inversion
    268275
    269276Priority Inversion
    270277------------------
    271 .. index:: priority inversion
    272278
    273279Priority inversion is a form of indefinite postponement which is common in
     
    282288
    283289.. _PriorityCeiling:
     290.. index:: priority ceiling protocol
     291.. index:: immediate ceiling priority protocol
    284292
    285293Immediate Ceiling Priority Protocol (ICPP)
    286294------------------------------------------
    287 .. index:: priority ceiling protocol
    288 .. index:: immediate ceiling priority protocol
    289295
    290296Each mutex using the Immediate Ceiling Priority Protocol (ICPP) has a ceiling
     
    308314
    309315.. _PriorityInheritance:
     316.. index:: priority inheritance protocol
    310317
    311318Priority Inheritance Protocol
    312319-----------------------------
    313 .. index:: priority inheritance protocol
    314320
    315321The priority of the mutex owner is raised to the highest priority of all
     
    319325
    320326.. _MrsP:
     327.. index:: Multiprocessor Resource Sharing Protocol (MrsP)
    321328
    322329Multiprocessor Resource Sharing Protocol (MrsP)
    323330-----------------------------------------------
    324 .. index:: Multiprocessor Resource Sharing Protocol (MrsP)
    325331
    326332The Multiprocessor Resource Sharing Protocol (MrsP) is a generalization of the
     
    340346
    341347.. _OMIP:
     348.. index:: O(m) Independence-Preserving Protocol (OMIP)
    342349
    343350O(m) Independence-Preserving Protocol (OMIP)
    344351----------------------------------------------------
    345 .. index:: O(m) Independence-Preserving Protocol (OMIP)
    346352
    347353The :math:`O(m)` Independence-Preserving Protocol (OMIP) is a generalization of
     
    356362available since RTEMS 5.1.
    357363
     364.. index:: thread queues
     365
    358366Thread Queues
    359367=============
    360 .. index:: thread queues
    361368
    362369In case more than one :term:`thread` may wait on a synchronization object, e.g.
     
    416423with :math:`n` being the count of threads already on the queue.
    417424
     425.. index:: time
     426
    418427Time
    419428====
    420 .. index:: time
    421429
    422430The development of responsive real-time applications requires an understanding
     
    506514Less code is a good thing for size, testing and verification.
    507515
     516.. index:: memory management
     517
    508518Memory Management
    509519=================
    510 .. index:: memory management
    511520
    512521RTEMS memory management facilities can be grouped into two classes: dynamic
  • c-user/linker_sets.rst

    r42d50d7 r6c56401  
    66
    77.. _linker_sets:
     8.. index:: linkersets
    89
    910Linker Sets
    1011***********
    11 
    12 .. index:: linkersets
    1312
    1413Introduction
     
    129128
    130129.. _RTEMS_LINKER_SET_BEGIN:
     130.. index:: RTEMS_LINKER_SET_BEGIN
    131131
    132132RTEMS_LINKER_SET_BEGIN - Designator of the linker set begin marker
    133133------------------------------------------------------------------
    134 .. index:: RTEMS_LINKER_SET_BEGIN
    135134
    136135CALLING SEQUENCE:
     
    162161
    163162.. _RTEMS_LINKER_SET_END:
     163.. index:: RTEMS_LINKER_SET_END
    164164
    165165RTEMS_LINKER_SET_END - Designator of the linker set end marker
    166166--------------------------------------------------------------
    167 .. index:: RTEMS_LINKER_SET_END
    168167
    169168CALLING SEQUENCE:
     
    184183
    185184.. _RTEMS_LINKER_SET_SIZE:
     185.. index:: RTEMS_LINKER_SET_SIZE
    186186
    187187RTEMS_LINKER_SET_SIZE - The linker set size in characters
    188188---------------------------------------------------------
    189 .. index:: RTEMS_LINKER_SET_SIZE
    190189
    191190CALLING SEQUENCE:
     
    205204
    206205.. _RTEMS_LINKER_SET_ITEM_COUNT:
     206.. index:: RTEMS_LINKER_SET_ITEM_COUNT
    207207
    208208RTEMS_LINKER_SET_ITEM_COUNT - The linker set item count
    209209---------------------------------------------------------
    210 .. index:: RTEMS_LINKER_SET_ITEM_COUNT
    211210
    212211CALLING SEQUENCE:
     
    225224
    226225.. _RTEMS_LINKER_SET_IS_EMPTY:
     226.. index:: RTEMS_LINKER_SET_IS_EMPTY
    227227
    228228RTEMS_LINKER_SET_IS_EMPTY - Is the linker set empty?
    229229---------------------------------------------------------
    230 .. index:: RTEMS_LINKER_SET_IS_EMPTY
    231230
    232231CALLING SEQUENCE:
     
    246245
    247246.. _RTEMS_LINKER_SET_FOREACH:
     247.. index:: RTEMS_LINKER_SET_FOREACH
    248248
    249249RTEMS_LINKER_SET_FOREACH - Iterate through the linker set items
    250250---------------------------------------------------------
    251 .. index:: RTEMS_LINKER_SET_FOREACH
    252251
    253252CALLING SEQUENCE:
     
    282281
    283282.. _RTEMS_LINKER_ROSET_DECLARE:
     283.. index:: RTEMS_LINKER_ROSET_DECLARE
    284284
    285285RTEMS_LINKER_ROSET_DECLARE - Declares a read-only linker set
    286286------------------------------------------------------------
    287 .. index:: RTEMS_LINKER_ROSET_DECLARE
    288287
    289288CALLING SEQUENCE:
     
    305304
    306305.. _RTEMS_LINKER_ROSET:
     306.. index:: RTEMS_LINKER_ROSET
    307307
    308308RTEMS_LINKER_ROSET - Defines a read-only linker set
    309309---------------------------------------------------
    310 .. index:: RTEMS_LINKER_ROSET
    311310
    312311CALLING SEQUENCE:
     
    328327
    329328.. _RTEMS_LINKER_ROSET_ITEM_DECLARE:
     329.. index:: RTEMS_LINKER_ROSET_ITEM_DECLARE
    330330
    331331RTEMS_LINKER_ROSET_ITEM_DECLARE - Declares a read-only linker set item
    332332----------------------------------------------------------------------
    333 .. index:: RTEMS_LINKER_ROSET_ITEM_DECLARE
    334333
    335334CALLING SEQUENCE:
     
    353352
    354353.. _RTEMS_LINKER_ROSET_ITEM_REFERENCE:
     354.. index:: RTEMS_LINKER_ROSET_ITEM_REFERENCE
    355355
    356356RTEMS_LINKER_ROSET_ITEM_REFERENCE - References a read-only linker set item
    357357--------------------------------------------------------------------------
    358 .. index:: RTEMS_LINKER_ROSET_ITEM_REFERENCE
    359358
    360359CALLING SEQUENCE:
     
    378377
    379378.. _RTEMS_LINKER_ROSET_ITEM:
     379.. index:: RTEMS_LINKER_ROSET_ITEM
    380380
    381381RTEMS_LINKER_ROSET_ITEM - Defines a read-only linker set item
    382382-------------------------------------------------------------
    383 .. index:: RTEMS_LINKER_ROSET_ITEM
    384383
    385384CALLING SEQUENCE:
     
    403402
    404403.. _RTEMS_LINKER_ROSET_ITEM_ORDERED:
     404.. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED
    405405
    406406RTEMS_LINKER_ROSET_ITEM_ORDERED - Defines an ordered read-only linker set item
    407407------------------------------------------------------------------------------
    408 .. index:: RTEMS_LINKER_ROSET_ITEM_ORDERED
    409408
    410409CALLING SEQUENCE:
     
    460459
    461460.. _RTEMS_LINKER_ROSET_CONTENT:
     461.. index:: RTEMS_LINKER_ROSET_CONTENT
    462462
    463463RTEMS_LINKER_ROSET_CONTENT - Marks a declaration as a read-only linker set content
    464464----------------------------------------------------------------------------------
    465 .. index:: RTEMS_LINKER_ROSET_CONTENT
    466465
    467466CALLING SEQUENCE:
     
    482481
    483482.. _RTEMS_LINKER_RWSET_DECLARE:
     483.. index:: RTEMS_LINKER_RWSET_DECLARE
    484484
    485485RTEMS_LINKER_RWSET_DECLARE - Declares a read-write linker set
    486486-------------------------------------------------------------
    487 .. index:: RTEMS_LINKER_RWSET_DECLARE
    488487
    489488CALLING SEQUENCE:
     
    505504
    506505.. _RTEMS_LINKER_RWSET:
     506.. index:: RTEMS_LINKER_RWSET
    507507
    508508RTEMS_LINKER_RWSET - Defines a read-write linker set
    509509----------------------------------------------------
    510 .. index:: RTEMS_LINKER_RWSET
    511510
    512511CALLING SEQUENCE:
     
    528527
    529528.. _RTEMS_LINKER_RWSET_ITEM_DECLARE:
     529.. index:: RTEMS_LINKER_RWSET_ITEM_DECLARE
    530530
    531531RTEMS_LINKER_RWSET_ITEM_DECLARE - Declares a read-write linker set item
    532532-----------------------------------------------------------------------
    533 .. index:: RTEMS_LINKER_RWSET_ITEM_DECLARE
    534533
    535534CALLING SEQUENCE:
     
    553552
    554553.. _RTEMS_LINKER_RWSET_ITEM_REFERENCE:
     554.. index:: RTEMS_LINKER_RWSET_ITEM_REFERENCE
    555555
    556556RTEMS_LINKER_RWSET_ITEM_REFERENCE - References a read-write linker set item
    557557---------------------------------------------------------------------------
    558 .. index:: RTEMS_LINKER_RWSET_ITEM_REFERENCE
    559558
    560559CALLING SEQUENCE:
     
    578577
    579578.. _RTEMS_LINKER_RWSET_ITEM:
     579.. index:: RTEMS_LINKER_RWSET_ITEM
    580580
    581581RTEMS_LINKER_RWSET_ITEM - Defines a read-write linker set item
    582582--------------------------------------------------------------
    583 .. index:: RTEMS_LINKER_RWSET_ITEM
    584583
    585584CALLING SEQUENCE:
     
    603602
    604603.. _RTEMS_LINKER_RWSET_ITEM_ORDERED:
     604.. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED
    605605
    606606RTEMS_LINKER_RWSET_ITEM_ORDERED - Defines an ordered read-write linker set item
    607607-------------------------------------------------------------------------------
    608 .. index:: RTEMS_LINKER_RWSET_ITEM_ORDERED
    609608
    610609CALLING SEQUENCE:
     
    660659
    661660.. _RTEMS_LINKER_RWSET_CONTENT:
     661.. index:: RTEMS_LINKER_RWSET_CONTENT
    662662
    663663RTEMS_LINKER_RWSET_CONTENT - Marks a declaration as a read-write linker set content
    664664-----------------------------------------------------------------------------------
    665 .. index:: RTEMS_LINKER_RWSET_CONTENT
    666665
    667666CALLING SEQUENCE:
  • c-user/message_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: messages
     8.. index:: message queues
     9
    710Message Manager
    811***************
    9 
    10 .. index:: messages
    11 .. index:: message queues
    1212
    1313Introduction
     
    6565the messages as short as possible.
    6666
     67.. index:: message queue attributes
     68
    6769Building a Message Queue Attribute Set
    6870--------------------------------------
    69 .. index:: message queue attributes
    7071
    7172In general, an attribute set is built by a bitwise OR of the desired attribute
     
    221222
    222223.. _rtems_message_queue_create:
     224.. index:: create a message queue
     225.. index:: rtems_message_queue_create
    223226
    224227MESSAGE_QUEUE_CREATE - Create a queue
    225228-------------------------------------
    226 .. index:: create a message queue
    227 .. index:: rtems_message_queue_create
    228229
    229230CALLING SEQUENCE:
     
    308309
    309310.. _rtems_message_queue_ident:
     311.. index:: get ID of a message queue
     312.. index:: rtems_message_queue_ident
    310313
    311314MESSAGE_QUEUE_IDENT - Get ID of a queue
    312315---------------------------------------
    313 .. index:: get ID of a message queue
    314 .. index:: rtems_message_queue_ident
    315316
    316317CALLING SEQUENCE:
     
    361362
    362363.. _rtems_message_queue_delete:
     364.. index:: delete a message queue
     365.. index:: rtems_message_queue_delete
    363366
    364367MESSAGE_QUEUE_DELETE - Delete a queue
    365368-------------------------------------
    366 .. index:: delete a message queue
    367 .. index:: rtems_message_queue_delete
    368369
    369370CALLING SEQUENCE:
     
    419420
    420421.. _rtems_message_queue_send:
     422.. index:: send message to a queue
     423.. index:: rtems_message_queue_send
    421424
    422425MESSAGE_QUEUE_SEND - Put message at rear of a queue
    423426---------------------------------------------------
    424 .. index:: send message to a queue
    425 .. index:: rtems_message_queue_send
    426427
    427428CALLING SEQUENCE:
     
    476477
    477478.. _rtems_message_queue_urgent:
     479.. index:: put message at front of queue
     480.. index:: rtems_message_queue_urgent
    478481
    479482MESSAGE_QUEUE_URGENT - Put message at front of a queue
    480483------------------------------------------------------
    481 .. index:: put message at front of queue
    482 .. index:: rtems_message_queue_urgent
    483484
    484485**CALLING SEQUENCE:**
     
    533534
    534535.. _rtems_message_queue_broadcast:
     536.. index:: broadcast message to a queue
     537.. index:: rtems_message_queue_broadcast
    535538
    536539MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue
    537540---------------------------------------------------------
    538 .. index:: broadcast message to a queue
    539 .. index:: rtems_message_queue_broadcast
    540541
    541542CALLING SEQUENCE:
     
    593594
    594595.. _rtems_message_queue_receive:
     596.. index:: receive message from a queue
     597.. index:: rtems_message_queue_receive
    595598
    596599MESSAGE_QUEUE_RECEIVE - Receive message from a queue
    597600----------------------------------------------------
    598 .. index:: receive message from a queue
    599 .. index:: rtems_message_queue_receive
    600601
    601602CALLING SEQUENCE:
     
    680681
    681682.. _rtems_message_queue_get_number_pending:
     683.. index:: get number of pending messages
     684.. index:: rtems_message_queue_get_number_pending
    682685
    683686MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
    684687----------------------------------------------------------------------------
    685 .. index:: get number of pending messages
    686 .. index:: rtems_message_queue_get_number_pending
    687688
    688689CALLING SEQUENCE:
     
    719720
    720721.. _rtems_message_queue_flush:
     722.. index:: flush messages on a queue
     723.. index:: rtems_message_queue_flush
    721724
    722725MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
    723726---------------------------------------------------
    724 .. index:: flush messages on a queue
    725 .. index:: rtems_message_queue_flush
    726727
    727728CALLING SEQUENCE:
  • c-user/multiprocessing.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: multiprocessing
     8
    79Multiprocessing Manager
    810***********************
    9 
    10 .. index:: multiprocessing
    1111
    1212Introduction
     
    4343  arrived
    4444
     45.. index:: multiprocessing topologies
     46
    4547Background
    4648==========
    47 
    48 .. index:: multiprocessing topologies
    4949
    5050RTEMS makes no assumptions regarding the connection media or topology of a
     
    6969isolated in the MPCI layer.
    7070
     71.. index:: nodes, definition
     72
    7173Nodes
    7274-----
    73 .. index:: nodes, definition
    7475
    7576A processor in a RTEMS system is referred to as a node.  Each node is assigned
     
    8687must be able to route messages based on the node number.
    8788
     89.. index:: global objects, definition
     90
    8891Global Objects
    8992--------------
    90 .. index:: global objects, definition
    9193
    9294All RTEMS objects which are created with the GLOBAL attribute will be known on
     
    100102relocation is not supported by RTEMS.
    101103
     104.. index:: global objects table
     105
    102106Global Object Table
    103107-------------------
    104 .. index:: global objects table
    105108
    106109RTEMS maintains two tables containing object information on every node in a
     
    119122in the system must be informed of the creation or deletion of a global object.
    120123
     124.. index:: MPCI and remote operations
     125
    121126Remote Operations
    122127-----------------
    123 .. index:: MPCI and remote operations
    124128
    125129When an application performs an operation on a remote global object, RTEMS must
     
    176180errors.
    177181
     182.. index:: proxy, definition
     183
    178184Proxies
    179185-------
    180 .. index:: proxy, definition
    181186
    182187A proxy is an RTEMS data structure which resides on a remote node and is used
     
    382387heterogeneous system.
    383388
     389.. index:: heterogeneous multiprocessing
     390
    384391Supporting Heterogeneous Environments
    385392-------------------------------------
    386 .. index:: heterogeneous multiprocessing
    387393
    388394Developing an MPCI layer for a heterogeneous system requires a thorough
     
    477483
    478484.. _rtems_multiprocessing_announce:
     485.. index:: announce arrival of package
     486.. index:: rtems_multiprocessing_announce
    479487
    480488MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
    481489-----------------------------------------------------------
    482 .. index:: announce arrival of package
    483 .. index:: rtems_multiprocessing_announce
    484490
    485491CALLING SEQUENCE:
  • c-user/object_services.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: object manipulation
     8
    79Object Services
    810***************
    9 
    10 .. index:: object manipulation
    1111
    1212Introduction
     
    182182
    183183.. _rtems_build_name:
     184.. index:: build object name
     185.. index:: rtems_build_name
    184186
    185187BUILD_NAME - Build object name from characters
    186188----------------------------------------------
    187 .. index:: build object name
    188 .. index:: rtems_build_name
    189189
    190190CALLING SEQUENCE:
     
    214214
    215215.. _rtems_object_get_classic_name:
    216 
    217 OBJECT_GET_CLASSIC_NAME - Lookup name from id
    218 ---------------------------------------------
    219216.. index:: get name from id
    220217.. index:: obtain name from id
    221218.. index:: rtems_object_get_classic_name
     219
     220OBJECT_GET_CLASSIC_NAME - Lookup name from id
     221---------------------------------------------
    222222
    223223CALLING SEQUENCE:
     
    252252
    253253.. _rtems_object_get_name:
    254 
    255 OBJECT_GET_NAME - Obtain object name as string
    256 ----------------------------------------------
    257254.. index:: get object name as string
    258255.. index:: obtain object name as string
    259256.. index:: rtems_object_get_name
     257
     258OBJECT_GET_NAME - Obtain object name as string
     259----------------------------------------------
    260260
    261261CALLING SEQUENCE:
     
    285285
    286286.. _rtems_object_set_name:
     287.. index:: set object name
     288.. index:: rtems_object_set_name
    287289
    288290OBJECT_SET_NAME - Set object name
    289291---------------------------------
    290 .. index:: set object name
    291 .. index:: rtems_object_set_name
    292292
    293293CALLING SEQUENCE:
     
    332332
    333333.. _rtems_object_id_get_api:
     334.. index:: obtain API from id
     335.. index:: rtems_object_id_get_api
    334336
    335337OBJECT_ID_GET_API - Obtain API from Id
    336338--------------------------------------
    337 .. index:: obtain API from id
    338 .. index:: rtems_object_id_get_api
    339339
    340340CALLING SEQUENCE:
     
    361361
    362362.. _rtems_object_id_get_class:
     363.. index:: obtain class from object id
     364.. index:: rtems_object_id_get_class
    363365
    364366OBJECT_ID_GET_CLASS - Obtain Class from Id
    365367------------------------------------------
    366 .. index:: obtain class from object id
    367 .. index:: rtems_object_id_get_class
    368368
    369369CALLING SEQUENCE:
     
    390390
    391391.. _rtems_object_id_get_node:
     392.. index:: obtain node from object id
     393.. index:: rtems_object_id_get_node
    392394
    393395OBJECT_ID_GET_NODE - Obtain Node from Id
    394396----------------------------------------
    395 .. index:: obtain node from object id
    396 .. index:: rtems_object_id_get_node
    397397
    398398CALLING SEQUENCE:
     
    419419
    420420.. _rtems_object_id_get_index:
     421.. index:: obtain index from object id
     422.. index:: rtems_object_id_get_index
    421423
    422424OBJECT_ID_GET_INDEX - Obtain Index from Id
    423425------------------------------------------
    424 .. index:: obtain index from object id
    425 .. index:: rtems_object_id_get_index
    426426
    427427CALLING SEQUENCE:
     
    448448
    449449.. _rtems_build_id:
     450.. index:: build object id from components
     451.. index:: rtems_build_id
    450452
    451453BUILD_ID - Build Object Id From Components
    452454------------------------------------------
    453 .. index:: build object id from components
    454 .. index:: rtems_build_id
    455455
    456456CALLING SEQUENCE:
     
    482482
    483483.. _rtems_object_id_api_minimum:
     484.. index:: obtain minimum API value
     485.. index:: rtems_object_id_api_minimum
    484486
    485487OBJECT_ID_API_MINIMUM - Obtain Minimum API Value
    486488------------------------------------------------
    487 .. index:: obtain minimum API value
    488 .. index:: rtems_object_id_api_minimum
    489489
    490490CALLING SEQUENCE:
     
    507507
    508508.. _rtems_object_id_api_maximum:
     509.. index:: obtain maximum API value
     510.. index:: rtems_object_id_api_maximum
    509511
    510512OBJECT_ID_API_MAXIMUM - Obtain Maximum API Value
    511513------------------------------------------------
    512 .. index:: obtain maximum API value
    513 .. index:: rtems_object_id_api_maximum
    514514
    515515CALLING SEQUENCE:
     
    532532
    533533.. _rtems_object_api_minimum_class:
     534.. index:: obtain minimum class value
     535.. index:: rtems_object_api_minimum_class
    534536
    535537OBJECT_API_MINIMUM_CLASS - Obtain Minimum Class Value
    536538-----------------------------------------------------
    537 .. index:: obtain minimum class value
    538 .. index:: rtems_object_api_minimum_class
    539539
    540540CALLING SEQUENCE:
     
    563563
    564564.. _rtems_object_api_maximum_class:
     565.. index:: obtain maximum class value
     566.. index:: rtems_object_api_maximum_class
    565567
    566568OBJECT_API_MAXIMUM_CLASS - Obtain Maximum Class Value
    567569-----------------------------------------------------
    568 .. index:: obtain maximum class value
    569 .. index:: rtems_object_api_maximum_class
    570570
    571571CALLING SEQUENCE:
     
    594594
    595595.. _rtems_object_id_api_minimum_class:
     596.. index:: obtain minimum class value for an API
     597.. index:: rtems_object_id_api_minimum_class
    596598
    597599OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API
    598600-------------------------------------------------------------------
    599 .. index:: obtain minimum class value for an API
    600 .. index:: rtems_object_id_api_minimum_class
    601601
    602602CALLING SEQUENCE:
     
    625625
    626626.. _rtems_object_id_api_maximum_class:
     627.. index:: obtain maximum class value for an API
     628.. index:: rtems_object_id_api_maximum_class
    627629
    628630OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API
    629631-------------------------------------------------------------------
    630 .. index:: obtain maximum class value for an API
    631 .. index:: rtems_object_id_api_maximum_class
    632632
    633633CALLING SEQUENCE:
     
    656656
    657657.. _rtems_object_get_api_name:
     658.. index:: obtain API name
     659.. index:: rtems_object_get_api_name
    658660
    659661OBJECT_GET_API_NAME - Obtain API Name
    660662-------------------------------------
    661 .. index:: obtain API name
    662 .. index:: rtems_object_get_api_name
    663663
    664664CALLING SEQUENCE:
     
    688688
    689689.. _rtems_object_get_api_class_name:
     690.. index:: obtain class name
     691.. index:: rtems_object_get_api_class_name
    690692
    691693OBJECT_GET_API_CLASS_NAME - Obtain Class Name
    692694---------------------------------------------
    693 .. index:: obtain class name
    694 .. index:: rtems_object_get_api_class_name
    695695
    696696CALLING SEQUENCE:
     
    724724
    725725.. _rtems_object_get_class_information:
     726.. index:: obtain class information
     727.. index:: rtems_object_get_class_information
    726728
    727729OBJECT_GET_CLASS_INFORMATION - Obtain Class Information
    728730-------------------------------------------------------
    729 .. index:: obtain class information
    730 .. index:: rtems_object_get_class_information
    731731
    732732CALLING SEQUENCE:
  • c-user/overview.rst

    r42d50d7 r6c56401  
    3838document which addresses specific architectural issues that affect RTEMS is
    3939provided for each processor type that is supported.
     40
     41.. index:: Real-time applications
    4042
    4143Real-time Application Systems
     
    7375competing processors are introduced.  The ramifications of multiple processors
    7476complicate each and every characteristic of a real-time system.
     77
     78.. index:: Real-time executive
    7579
    7680Real-time Executive
     
    114118sophisticated real-time applications is significantly reduced.
    115119
     120.. index:: Application architecture
     121
    116122RTEMS Application Architecture
    117123==============================
     
    135141of standard application components which can be used repeatedly in other
    136142real-time projects.
     143
     144.. index:: Internal Architecture
    137145
    138146RTEMS Internal Architecture
  • c-user/partition_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: partitions
     8
    79Partition Manager
    810*****************
    911
    10 .. index:: partitions
    11 
    1212Introduction
    1313============
     
    2929==========
    3030
     31.. index:: partition, definition
     32
    3133Partition Manager Definitions
    3234-----------------------------
    33 .. index:: partition, definition
    3435
    3536A partition is a physically contiguous memory area divided into fixed-size
     
    4647destroy the free buffer chain or the contents of an adjacent allocated buffer.
    4748
     49.. index:: partition attribute set, building
     50
    4851Building a Partition Attribute Set
    4952----------------------------------
    50 .. index:: partition attribute set, building
    5153
    5254In general, an attribute set is built by a bitwise OR of the desired attribute
     
    135137
    136138.. _rtems_partition_create:
     139.. index:: create a partition
     140.. index:: rtems_partition_create
    137141
    138142PARTITION_CREATE - Create a partition
    139143-------------------------------------
    140 .. index:: create a partition
    141 .. index:: rtems_partition_create
    142144
    143145CALLING SEQUENCE:
     
    229231
    230232.. _rtems_partition_ident:
    231 
    232 PARTITION_IDENT - Get ID of a partition
    233 ---------------------------------------
    234233.. index:: get ID of a partition
    235234.. index:: obtain ID of a partition
    236235.. index:: rtems_partition_ident
     236
     237PARTITION_IDENT - Get ID of a partition
     238---------------------------------------
    237239
    238240CALLING SEQUENCE:
     
    283285
    284286.. _rtems_partition_delete:
     287.. index:: delete a partition
     288.. index:: rtems_partition_delete
    285289
    286290PARTITION_DELETE - Delete a partition
    287291-------------------------------------
    288 .. index:: delete a partition
    289 .. index:: rtems_partition_delete
    290292
    291293CALLING SEQUENCE:
     
    332334
    333335.. _rtems_partition_get_buffer:
    334 
    335 PARTITION_GET_BUFFER - Get buffer from a partition
    336 --------------------------------------------------
    337336.. index:: get buffer from partition
    338337.. index:: obtain buffer from partition
    339338.. index:: rtems_partition_get_buffer
     339
     340PARTITION_GET_BUFFER - Get buffer from a partition
     341--------------------------------------------------
    340342
    341343CALLING SEQUENCE:
     
    380382
    381383.. _rtems_partition_return_buffer:
     384.. index:: return buffer to partitition
     385.. index:: rtems_partition_return_buffer
    382386
    383387PARTITION_RETURN_BUFFER - Return buffer to a partition
    384388------------------------------------------------------
    385 .. index:: return buffer to partitition
    386 .. index:: rtems_partition_return_buffer
    387389
    388390CALLING SEQUENCE:
  • c-user/pci_library.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: PCI
     8.. index:: libpci
    79
    810PCI Library
    911***********
    10 
    11 .. index:: libpci
    1212
    1313Introduction
     
    391391been configured for the correct endianness.
    392392
     393.. index:: PCI address translation
     394
    393395PCI address translation
    394396~~~~~~~~~~~~~~~~~~~~~~~
     
    408410    /* Translate CPU accessible address into PCI address (for DMA) */
    409411    static inline int pci_cpu2pci(uint32_t *address, int type);
     412
     413.. index:: PCI Interrupt
    410414
    411415PCI Interrupt
  • c-user/rate_monotonic_manager.rst

    r42d50d7 r6c56401  
    66.. COMMENT: All rights reserved.
    77
     8.. index:: rate mononitonic tasks
     9.. index:: periodic tasks
     10
    811Rate Monotonic Manager
    912**********************
    10 
    11 .. index:: rate mononitonic tasks
    12 .. index:: periodic tasks
    1313
    1414Introduction
     
    134134optimize that task.
    135135
     136.. index:: periodic task, definition
     137
    136138Periodicity Definitions
    137139----------------------------------
    138 .. index:: periodic task, definition
    139140
    140141A periodic task is one which must be executed at a regular interval.  The
     
    166167hard deadline.
    167168
     169.. index:: Rate Monotonic Scheduling Algorithm, definition
     170.. index:: RMS Algorithm, definition
     171
    168172Rate Monotonic Scheduling Algorithm
    169173-----------------------------------
    170 .. index:: Rate Monotonic Scheduling Algorithm, definition
    171 .. index:: RMS Algorithm, definition
    172174
    173175The Rate Monotonic Scheduling Algorithm (RMS) is important to real-time systems
     
    230232schedulability is only guaranteed for the critical task set.
    231233
     234.. index:: RMS schedulability analysis
     235
    232236Schedulability Analysis
    233237-----------------------
    234 
    235 .. index:: RMS schedulability analysis
    236238
    237239RMS allows application designers to ensure that tasks can meet all deadlines under fixed-priority assignment,
     
    262264assumptions can be relaxed and the side-effects accounted for.
    263265
     266.. index:: RMS Processor Utilization Rule
     267
    264268Processor Utilization Rule
    265269^^^^^^^^^^^^^^^^^^^^^^^^^^
    266 .. index:: RMS Processor Utilization Rule
    267270
    268271The Processor Utilization Rule requires that processor utilization be
     
    313316using RMS.
    314317
     318.. index:: RMS First Deadline Rule
     319
    315320First Deadline Rule
    316321^^^^^^^^^^^^^^^^^^^
    317 .. index:: RMS First Deadline Rule
    318322
    319323If a given set of tasks do exceed the processor utilization upper limit imposed
     
    632636
    633637.. _rtems_rate_monotonic_create:
     638.. index:: create a period
     639.. index:: rtems_rate_monotonic_create
    634640
    635641RATE_MONOTONIC_CREATE - Create a rate monotonic period
    636642------------------------------------------------------
    637 .. index:: create a period
    638 .. index:: rtems_rate_monotonic_create
    639643
    640644CALLING SEQUENCE:
     
    672676
    673677.. _rtems_rate_monotonic_ident:
    674 
    675 RATE_MONOTONIC_IDENT - Get ID of a period
    676 -----------------------------------------
    677678.. index:: get ID of a period
    678679.. index:: obtain ID of a period
    679680.. index:: rtems_rate_monotonic_ident
     681
     682RATE_MONOTONIC_IDENT - Get ID of a period
     683-----------------------------------------
    680684
    681685CALLING SEQUENCE:
     
    711715
    712716.. _rtems_rate_monotonic_cancel:
     717.. index:: cancel a period
     718.. index:: rtems_rate_monotonic_cancel
    713719
    714720RATE_MONOTONIC_CANCEL - Cancel a period
    715721---------------------------------------
    716 .. index:: cancel a period
    717 .. index:: rtems_rate_monotonic_cancel
    718722
    719723CALLING SEQUENCE:
     
    753757.. _rtems_rate_monotonic_delete:
    754758.. index:: rtems_rate_monotonic_delete
     759.. index:: delete a period
    755760
    756761RATE_MONOTONIC_DELETE - Delete a rate monotonic period
    757762------------------------------------------------------
    758 .. index:: delete a period
    759763
    760764CALLING SEQUENCE:
     
    791795
    792796.. _rtems_rate_monotonic_period:
    793 
    794 RATE_MONOTONIC_PERIOD - Conclude current/Start next period
    795 ----------------------------------------------------------
    796797.. index:: conclude current period
    797798.. index:: start current period
    798799.. index:: period initiation
    799800.. index:: rtems_rate_monotonic_period
     801
     802RATE_MONOTONIC_PERIOD - Conclude current/Start next period
     803----------------------------------------------------------
    800804
    801805CALLING SEQUENCE:
     
    845849
    846850.. _rtems_rate_monotonic_get_status:
    847 
    848 RATE_MONOTONIC_GET_STATUS - Obtain status from a period
    849 -------------------------------------------------------
    850851.. index:: get status of period
    851852.. index:: obtain status of period
    852853.. index:: rtems_rate_monotonic_get_status
     854
     855RATE_MONOTONIC_GET_STATUS - Obtain status from a period
     856-------------------------------------------------------
    853857
    854858CALLING SEQUENCE:
     
    910914
    911915.. _rtems_rate_monotonic_get_statistics:
    912 
    913 RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
    914 ---------------------------------------------------------------
    915916.. index:: get statistics of period
    916917.. index:: obtain statistics of period
    917918.. index:: rtems_rate_monotonic_get_statistics
     919
     920RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
     921---------------------------------------------------------------
    918922
    919923CALLING SEQUENCE:
     
    979983
    980984.. _rtems_rate_monotonic_reset_statistics:
     985.. index:: reset statistics of period
     986.. index:: rtems_rate_monotonic_reset_statistics
    981987
    982988RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period
    983989---------------------------------------------------------------
    984 .. index:: reset statistics of period
    985 .. index:: rtems_rate_monotonic_reset_statistics
    986990
    987991CALLING SEQUENCE:
     
    10131017
    10141018.. _rtems_rate_monotonic_reset_all_statistics:
     1019.. index:: reset statistics of all periods
     1020.. index:: rtems_rate_monotonic_reset_all_statistics
    10151021
    10161022RATE_MONOTONIC_RESET_ALL_STATISTICS - Reset statistics for all periods
    10171023----------------------------------------------------------------------
    1018 .. index:: reset statistics of all periods
    1019 .. index:: rtems_rate_monotonic_reset_all_statistics
    10201024
    10211025CALLING SEQUENCE:
     
    10391043
    10401044.. _rtems_rate_monotonic_report_statistics:
    1041 
    1042 RATE_MONOTONIC_REPORT_STATISTICS - Print period statistics report
    1043 -----------------------------------------------------------------
    10441045.. index:: print period statistics report
    10451046.. index:: period statistics report
    10461047.. index:: rtems_rate_monotonic_report_statistics
     1048
     1049RATE_MONOTONIC_REPORT_STATISTICS - Print period statistics report
     1050-----------------------------------------------------------------
    10471051
    10481052CALLING SEQUENCE:
  • c-user/red_black_trees.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: Red-Black Trees
     8.. index:: rbtrees
     9
    710Red-Black Trees
    811***************
    9 
    10 .. index:: rbtrees
    1112
    1213Introduction
     
    112113==========
    113114
     115.. index:: rbtree doc
     116
    114117Documentation for the Red-Black Tree Directives
    115118-----------------------------------------------
    116 .. index:: rbtree doc
    117119
    118120Source documentation for the Red-Black Tree API can be found in the generated
  • c-user/region_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: regions
     8
    79Region Manager
    810**************
    911
    10 .. index:: regions
    11 
    1212Introduction
    1313============
     
    3535==========
    3636
     37.. index:: region, definition
     38.. index:: segment, definition
     39
    3740Region Manager Definitions
    3841--------------------------
    39 .. index:: region, definition
    40 .. index:: segment, definition
    4142
    4243A region makes up a physically contiguous memory space with user-defined
     
    6061free) on both sides to produce the largest possible unused block.
    6162
     63.. index:: region attribute set, building
     64
    6265Building an Attribute Set
    6366-------------------------
    64 .. index:: region attribute set, building
    6567
    6668In general, an attribute set is built by a bitwise OR of the desired attribute
     
    224226
    225227.. _rtems_region_create:
     228.. index:: create a region
    226229
    227230REGION_CREATE - Create a region
    228231-------------------------------
    229 .. index:: create a region
     232
    230233CALLING SEQUENCE:
    231234    .. code-block:: c
     
    299302
    300303.. _rtems_region_ident:
    301 
    302 REGION_IDENT - Get ID of a region
    303 ---------------------------------
    304304.. index:: get ID of a region
    305305.. index:: obtain ID of a region
    306306.. index:: rtems_region_ident
     307
     308REGION_IDENT - Get ID of a region
     309---------------------------------
    307310
    308311CALLING SEQUENCE:
     
    341344
    342345.. _rtems_region_delete:
     346.. index:: delete a region
     347.. index:: rtems_region_delete
    343348
    344349REGION_DELETE - Delete a region
    345350-------------------------------
    346 .. index:: delete a region
    347 .. index:: rtems_region_delete
    348351
    349352CALLING SEQUENCE:
     
    382385
    383386.. _rtems_region_extend:
    384 
    385 REGION_EXTEND - Add memory to a region
    386 --------------------------------------
    387387.. index:: add memory to a region
    388388.. index:: region, add memory
    389389.. index:: rtems_region_extend
     390
     391REGION_EXTEND - Add memory to a region
     392--------------------------------------
    390393
    391394CALLING SEQUENCE:
     
    435438
    436439.. _rtems_region_get_segment:
     440.. index:: get segment from region
     441.. index:: rtems_region_get_segment
    437442
    438443REGION_GET_SEGMENT - Get segment from a region
    439444----------------------------------------------
    440 .. index:: get segment from region
    441 .. index:: rtems_region_get_segment
    442445
    443446CALLING SEQUENCE:
     
    521524
    522525.. _rtems_region_return_segment:
     526.. index:: return segment to region
     527.. index:: rtems_region_return_segment
    523528
    524529REGION_RETURN_SEGMENT - Return segment to a region
    525530--------------------------------------------------
    526 .. index:: return segment to region
    527 .. index:: rtems_region_return_segment
    528531
    529532CALLING SEQUENCE:
     
    570573
    571574.. _rtems_region_get_segment_size:
     575.. index:: get size of segment
     576.. index:: rtems_region_get_segment_size
    572577
    573578REGION_GET_SEGMENT_SIZE - Obtain size of a segment
    574579--------------------------------------------------
    575 .. index:: get size of segment
    576 .. index:: rtems_region_get_segment_size
    577580
    578581CALLING SEQUENCE:
     
    612615
    613616.. _rtems_region_resize_segment:
     617.. index:: resize segment
     618.. index:: rtems_region_resize_segment
    614619
    615620REGION_RESIZE_SEGMENT - Change size of a segment
    616621------------------------------------------------
    617 .. index:: resize segment
    618 .. index:: rtems_region_resize_segment
    619622
    620623CALLING SEQUENCE:
  • c-user/rtems_data_types.rst

    r42d50d7 r6c56401  
    44.. COMMENT: On-Line Applications Research Corporation (OAR).
    55.. COMMENT: All rights reserved.
     6
     7.. index:: RTEMS Data Types
     8.. index:: data types
    69
    710RTEMS Data Types
  • c-user/scheduling_concepts.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: scheduling
     8.. index:: task scheduling
     9
    710Scheduling Concepts
    811*******************
    9 
    10 .. index:: scheduling
    11 .. index:: task scheduling
    1212
    1313Introduction
     
    4040- rtems_scheduler_remove_processor_ - Remove processor from a scheduler
    4141
     42.. index:: scheduling algorithms
     43
    4244Scheduling Algorithms
    4345---------------------
    44 
    45 .. index:: scheduling algorithms
    4646
    4747RTEMS provides a plugin framework which allows it to support multiple
     
    6161will use this on uniprocessor systems.
    6262
     63.. index:: priority scheduling
     64
    6365Priority Scheduling
    6466-------------------
    65 .. index:: priority scheduling
    6667
    6768When using priority based scheduling, RTEMS allocates the processor using a
     
    154155This scheduler is only aware of a single core.
    155156
     157.. index:: earliest deadline first scheduling
     158
    156159Earliest Deadline First Scheduler
    157160---------------------------------
    158 .. index:: earliest deadline first scheduling
    159161
    160162This is an alternative scheduler in RTEMS for single core applications.  The
     
    186188``rtems_rate_monotonic_delete`` calls clear the deadlines assigned to the task.
    187189
     190.. index:: constant bandwidth server scheduling
     191
    188192Constant Bandwidth Server Scheduling (CBS)
    189193------------------------------------------
    190 .. index:: constant bandwidth server scheduling
    191194
    192195This is an alternative scheduler in RTEMS for single core applications.  The
     
    265268:math:`O(n)` while :math:`n` is the count of ready tasks.
    266269
     270.. index:: scheduling mechanisms
     271
    267272Scheduling Modification Mechanisms
    268273==================================
    269 
    270 .. index:: scheduling mechanisms
    271274
    272275RTEMS provides four mechanisms which allow the user to alter the task
     
    291294required, overriding the other factors presented in the description.
    292295
     296.. index:: task priority
     297
    293298Task Priority and Scheduling
    294299----------------------------
    295 .. index:: task priority
    296300
    297301The most significant task scheduling modification mechanism is the ability for
     
    302306scheduler is 255.
    303307
     308.. index:: preemption
     309
    304310Preemption
    305311----------
    306 .. index:: preemption
    307312
    308313Another way the user can alter the basic scheduling algorithm is by
     
    315320It only applies once a task has control of the processor.
    316321
     322.. index:: timeslicing
     323.. index:: round robin scheduling
     324
    317325Timeslicing
    318326-----------
    319 .. index:: timeslicing
    320 .. index:: round robin scheduling
    321327
    322328Timeslicing or round-robin scheduling is an additional method which can be used
     
    334340task has not used up its entire timeslice.
    335341
     342.. index:: manual round robin
     343
    336344Manual Round-Robin
    337345------------------
    338 .. index:: manual round robin
    339346
    340347The final mechanism for altering the RTEMS scheduling algorithm is called
     
    346353lose control of the processor.
    347354
     355.. index:: dispatching
     356
    348357Dispatching Tasks
    349358=================
    350 .. index:: dispatching
    351359
    352360The dispatcher is the RTEMS component responsible for allocating the processor
     
    371379was not the last task to utilize the coprocessor.
    372380
     381.. index:: task state transitions
     382
    373383Task State Transitions
    374384======================
    375 .. index:: task state transitions
    376385
    377386Tasks in an RTEMS system must always be in one of the five allowable task
  • c-user/semaphore_manager.rst

    r42d50d7 r6c56401  
    44.. COMMENT: On-Line Applications Research Corporation (OAR).
    55.. COMMENT: All rights reserved.
    6 
    7 Semaphore Manager
    8 *****************
    96
    107.. index:: semaphores
     
    129.. index:: counting semaphores
    1310.. index:: mutual exclusion
     11
     12Semaphore Manager
     13*****************
    1414
    1515Introduction
     
    326326
    327327.. _rtems_semaphore_create:
     328.. index:: create a semaphore
     329.. index:: rtems_semaphore_create
    328330
    329331SEMAPHORE_CREATE - Create a semaphore
    330332-------------------------------------
    331 .. index:: create a semaphore
    332 .. index:: rtems_semaphore_create
    333333
    334334
     
    438438
    439439.. _rtems_semaphore_ident:
     440.. index:: get ID of a semaphore
     441.. index:: obtain ID of a semaphore
     442.. index:: rtems_semaphore_ident
    440443
    441444SEMAPHORE_IDENT - Get ID of a semaphore
    442445---------------------------------------
    443 .. index:: get ID of a semaphore
    444 .. index:: obtain ID of a semaphore
    445 
    446 .. index:: rtems_semaphore_ident
    447446
    448447CALLING SEQUENCE:
     
    491490
    492491.. _rtems_semaphore_delete:
     492.. index:: delete a semaphore
     493.. index:: rtems_semaphore_delete
    493494
    494495SEMAPHORE_DELETE - Delete a semaphore
    495496-------------------------------------
    496 .. index:: delete a semaphore
    497 .. index:: rtems_semaphore_delete
    498497
    499498CALLING SEQUENCE:
     
    547546
    548547.. _rtems_semaphore_obtain:
    549 
    550 SEMAPHORE_OBTAIN - Acquire a semaphore
    551 --------------------------------------
    552548.. index:: obtain a semaphore
    553549.. index:: lock a semaphore
    554550.. index:: rtems_semaphore_obtain
     551
     552SEMAPHORE_OBTAIN - Acquire a semaphore
     553--------------------------------------
    555554
    556555CALLING SEQUENCE:
     
    646645
    647646.. _rtems_semaphore_release:
    648 
    649 SEMAPHORE_RELEASE - Release a semaphore
    650 ---------------------------------------
    651647.. index:: release a semaphore
    652648.. index:: unlock a semaphore
    653649.. index:: rtems_semaphore_release
     650
     651SEMAPHORE_RELEASE - Release a semaphore
     652---------------------------------------
    654653
    655654CALLING SEQUENCE:
     
    707706
    708707.. _rtems_semaphore_flush:
    709 
    710 SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
    711 ----------------------------------------------------------
    712708.. index:: flush a semaphore
    713709.. index:: unblock all tasks waiting on a semaphore
    714710.. index:: rtems_semaphore_flush
     711
     712SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
     713----------------------------------------------------------
    715714
    716715CALLING SEQUENCE:
     
    763762
    764763.. _rtems_semaphore_set_priority:
     764.. index:: set priority by scheduler for a semaphore
     765.. index:: rtems_semaphore_set_priority
    765766
    766767SEMAPHORE_SET_PRIORITY - Set priority by scheduler for a semaphore
    767768------------------------------------------------------------------
    768 .. index:: set priority by scheduler for a semaphore
    769 .. index:: rtems_semaphore_set_priority
    770769
    771770CALLING SEQUENCE:
  • c-user/signal_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: signals
     8
    79Signal Manager
    810**************
    911
    10 .. index:: signals
    11 
    1212Introduction
    1313============
     
    2323==========
    2424
     25.. index:: asynchronous signal routine
     26.. index:: ASR
     27
    2528Signal Manager Definitions
    2629--------------------------
    27 .. index:: asynchronous signal routine
    28 .. index:: ASR
    2930
    3031The signal manager allows a task to optionally define an asynchronous signal
     
    4748been processed by that task's ASR.
    4849
     50.. index:: ASR vs. ISR
     51.. index:: ISR vs. ASR
     52
    4953A Comparison of ASRs and ISRs
    5054-----------------------------
    51 .. index:: ASR vs. ISR
    52 .. index:: ISR vs. ASR
    5355
    5456The format of an ASR is similar to that of an ISR with the following
     
    6769  does not execute as a task and, as a result, does not have a task mode.
    6870
     71.. index:: signal set, building
     72
    6973Building a Signal Set
    7074---------------------
    71 .. index:: signal set, building
    7275
    7376A signal set is built by a bitwise OR of the desired signals.  The set of valid
     
    8386``RTEMS_SIGNAL_6 | RTEMS_SIGNAL_15 | RTEMS_SIGNAL_31``.
    8487
     88.. index:: ASR mode, building
     89
    8590Building an ASR Mode
    8691--------------------
    87 .. index:: ASR mode, building
    8892
    8993In general, an ASR's mode is built by a bitwise OR of the desired mode
     
    176180signal to that task once.
    177181
     182.. index:: rtems_asr
     183
    178184Processing an ASR
    179185-----------------
     
    186192conventions:
    187193
    188 .. index:: rtems_asr
    189 
    190194.. code-block:: c
    191195
     
    209213
    210214.. _rtems_signal_catch:
    211 
    212 SIGNAL_CATCH - Establish an ASR
    213 -------------------------------
    214215.. index:: establish an ASR
    215216.. index:: install an ASR
    216217.. index:: rtems_signal_catch
     218
     219SIGNAL_CATCH - Establish an ASR
     220-------------------------------
    217221
    218222CALLING SEQUENCE:
     
    270274
    271275.. _rtems_signal_send:
     276.. index:: send signal set
     277.. index:: rtems_signal_send
    272278
    273279SIGNAL_SEND - Send signal set to a task
    274280---------------------------------------
    275 .. index:: send signal set
    276 .. index:: rtems_signal_send
    277281
    278282CALLING SEQUENCE:
  • c-user/stack_bounds_checker.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: Stack Bounds Checker
     8.. index:: stack
     9
    710Stack Bounds Checker
    811********************
    9 
    10 .. index:: stack
    1112
    1213Introduction
  • c-user/symmetric_multiprocessing_services.rst

    r42d50d7 r6c56401  
    55.. COMMENT: Copyright (c) 2017 embedded brains GmbH.
    66.. COMMENT: All rights reserved.
     7
     8.. index:: Symmetric Multiprocessing
     9.. index:: SMP
    710
    811Symmetric Multiprocessing (SMP)
     
    125128for small windows in critical sections to be hit.
    126129
     130.. index:: task affinity
     131.. index:: thread affinity
     132
    127133Task Affinity
    128134-------------
    129 .. index:: task affinity
    130 .. index:: thread affinity
    131135
    132136RTEMS provides services to manipulate the affinity of a task. Affinity is used
     
    145149concept implementation.  See https://devel.rtems.org/ticket/2510.
    146150
     151.. index:: task migration
     152.. index:: thread migration
     153
    147154Task Migration
    148155--------------
    149 .. index:: task migration
    150 .. index:: thread migration
    151156
    152157With more than one processor in the system tasks can migrate from one processor
  • c-user/task_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: tasks
     8
    79Task Manager
    810************
    911
    10 .. index:: tasks
    11 
    1212Introduction
    1313============
     
    5757==========
    5858
     59.. index:: task, definition
     60
    5961Task Definition
    6062---------------
    61 .. index:: task, definition
    6263
    6364Many definitions of a task have been proposed in computer literature.
     
    103104context area in the task's TCB.
    104105
     106.. index:: task name
     107
    105108Task Name
    106109---------
    107 .. index:: task name
    108110
    109111By default, the task name is defined by the task object name given to
     
    117119<CONFIGURE_MAXIMUM_THREAD_NAME_SIZE>`.
    118120
     121.. index:: task states
     122
    119123Task States
    120124-----------
    121 .. index:: task states
    122125
    123126A task may exist in one of the following five states:
     
    141144scheduling of a task is based on its current state and priority.
    142145
    143 Task Priority
    144 -------------
    145146.. index:: task priority
    146147.. index:: priority, task
    147148.. index:: rtems_task_priority
     149
     150Task Priority
     151-------------
    148152
    149153A task's priority determines its importance in relation to the other tasks
     
    165169more likely it is to receive processor execution time.
    166170
     171.. index:: task mode
     172.. index:: rtems_task_mode
     173
    167174Task Mode
    168175---------
    169 .. index:: task mode
    170 .. index:: rtems_task_mode
    171176
    172177A task's execution mode is a combination of the following four components:
     
    243248``RTEMS_DEFAULT_MODES`` constant.
    244249
     250.. index:: task arguments
     251.. index:: task prototype
     252
    245253Accessing Task Arguments
    246254------------------------
    247 .. index:: task arguments
    248 .. index:: task prototype
    249255
    250256All RTEMS tasks are invoked with a single argument which is specified when they
     
    264270an index into an array of parameter blocks.
    265271
     272.. index:: floating point
     273
    266274Floating Point Considerations
    267275-----------------------------
    268 .. index:: floating point
    269276
    270277Creating a task with the ``RTEMS_FLOATING_POINT`` attribute flag results in
     
    314321condition.
    315322
     323.. index:: task attributes, building
     324
    316325Building a Task Attribute Set
    317326-----------------------------
    318 .. index:: task attributes, building
    319327
    320328In general, an attribute set is built by a bitwise OR of the desired
     
    348356``RTEMS_GLOBAL | RTEMS_FLOATING_POINT``.
    349357
     358.. index:: task mode, building
     359
    350360Building a Mode and Mask
    351361------------------------
    352 .. index:: task mode, building
    353362
    354363In general, a mode and its corresponding mask is built by a bitwise OR of the
     
    548557against the current system configuration.
    549558
     559.. index:: rtems_task_get_note
     560.. index:: rtems_task_set_note
     561
    550562Transition Advice for Obsolete Notepads
    551563---------------------------------------
    552 
    553 .. index:: rtems_task_get_note
    554 .. index:: rtems_task_set_note
    555564
    556565Task notepads and the associated directives :ref:`rtems_task_get_note` and
     
    565574also possible that thread-local storage (TLS) is an option for some use cases.
    566575
    567 Transition Advice for Obsolete Task Variables
    568 ---------------------------------------------
    569 
    570576.. index:: rtems_task_variable_add
    571577.. index:: rtems_task_variable_get
    572578.. index:: rtems_task_variable_delete
     579
     580Transition Advice for Obsolete Task Variables
     581---------------------------------------------
    573582
    574583Task notepads and the associated directives :ref:`rtems_task_variable_add`,
     
    591600
    592601.. _rtems_task_create:
     602.. index:: create a task
     603.. index:: rtems_task_create
    593604
    594605TASK_CREATE - Create a task
    595606---------------------------
    596 .. index:: create a task
    597 .. index:: rtems_task_create
    598607
    599608CALLING SEQUENCE:
     
    736745
    737746.. _rtems_task_ident:
     747.. index:: get ID of a task
     748.. index:: rtems_task_ident
    738749
    739750TASK_IDENT - Get ID of a task
    740751-----------------------------
    741 .. index:: get ID of a task
    742 .. index:: rtems_task_ident
    743752
    744753CALLING SEQUENCE:
     
    790799
    791800.. _rtems_task_self:
     801.. index:: obtain ID of caller
     802.. index:: rtems_task_self
    792803
    793804TASK_SELF - Obtain ID of caller
    794805-------------------------------
    795 .. index:: obtain ID of caller
    796 .. index:: rtems_task_self
    797806
    798807CALLING SEQUENCE:
     
    816825
    817826.. _rtems_task_start:
     827.. index:: starting a task
     828.. index:: rtems_task_start
    818829
    819830TASK_START - Start a task
    820831-------------------------
    821 .. index:: starting a task
    822 .. index:: rtems_task_start
    823832
    824833CALLING SEQUENCE:
     
    870879
    871880.. _rtems_task_restart:
     881.. index:: restarting a task
     882.. index:: rtems_task_restart
    872883
    873884TASK_RESTART - Restart a task
    874885-----------------------------
    875 .. index:: restarting a task
    876 .. index:: rtems_task_restart
    877886
    878887CALLING SEQUENCE:
     
    932941
    933942.. _rtems_task_delete:
     943.. index:: deleting a task
     944.. index:: rtems_task_delete
    934945
    935946TASK_DELETE - Delete a task
    936947---------------------------
    937 .. index:: deleting a task
    938 .. index:: rtems_task_delete
    939948
    940949CALLING SEQUENCE:
     
    988997
    989998.. _rtems_task_suspend:
     999.. index:: suspending a task
     1000.. index:: rtems_task_suspend
    9901001
    9911002TASK_SUSPEND - Suspend a task
    9921003-----------------------------
    993 .. index:: suspending a task
    994 .. index:: rtems_task_suspend
    9951004
    9961005CALLING SEQUENCE:
     
    10351044
    10361045.. _rtems_task_resume:
     1046.. index:: resuming a task
     1047.. index:: rtems_task_resume
    10371048
    10381049TASK_RESUME - Resume a task
    10391050---------------------------
    1040 .. index:: resuming a task
    1041 .. index:: rtems_task_resume
    10421051
    10431052CALLING SEQUENCE:
     
    10801089
    10811090.. _rtems_task_is_suspended:
     1091.. index:: is task suspended
     1092.. index:: rtems_task_is_suspended
    10821093
    10831094TASK_IS_SUSPENDED - Determine if a task is Suspended
    10841095----------------------------------------------------
    1085 .. index:: is task suspended
    1086 .. index:: rtems_task_is_suspended
    10871096
    10881097CALLING SEQUENCE:
     
    11181127
    11191128.. _rtems_task_set_priority:
    1120 
    1121 TASK_SET_PRIORITY - Set task priority
    1122 -------------------------------------
    11231129.. index:: rtems_task_set_priority
    11241130.. index:: current task priority
     
    11261132.. index:: get task priority
    11271133.. index:: obtain task priority
     1134
     1135TASK_SET_PRIORITY - Set task priority
     1136-------------------------------------
    11281137
    11291138CALLING SEQUENCE:
     
    11821191
    11831192.. _rtems_task_get_priority:
    1184 
    1185 TASK_GET_PRIORITY - Get task priority
    1186 -------------------------------------
    11871193.. index:: rtems_task_get_priority
    11881194.. index:: current task priority
    11891195.. index:: get task priority
    11901196.. index:: obtain task priority
     1197
     1198TASK_GET_PRIORITY - Get task priority
     1199-------------------------------------
    11911200
    11921201CALLING SEQUENCE:
     
    12311240
    12321241.. _rtems_task_mode:
    1233 
    1234 TASK_MODE - Change the current task mode
    1235 ----------------------------------------
    12361242.. index:: current task mode
    12371243.. index:: set task mode
     
    12411247.. index:: obtain task mode
    12421248.. index:: rtems_task_mode
     1249
     1250TASK_MODE - Change the current task mode
     1251----------------------------------------
    12431252
    12441253CALLING SEQUENCE:
     
    13101319
    13111320.. _rtems_task_wake_after:
    1312 
    1313 TASK_WAKE_AFTER - Wake up after interval
    1314 ----------------------------------------
    13151321.. index:: delay a task for an interval
    13161322.. index:: wake up after an interval
    13171323.. index:: rtems_task_wake_after
    13181324
     1325TASK_WAKE_AFTER - Wake up after interval
     1326----------------------------------------
     1327
    13191328CALLING SEQUENCE:
    13201329    .. code-block:: c
     
    13531362
    13541363.. _rtems_task_wake_when:
    1355 
    1356 TASK_WAKE_WHEN - Wake up when specified
    1357 ---------------------------------------
    13581364.. index:: delay a task until a wall time
    13591365.. index:: wake up at a wall time
    13601366.. index:: rtems_task_wake_when
     1367
     1368TASK_WAKE_WHEN - Wake up when specified
     1369---------------------------------------
    13611370
    13621371CALLING SEQUENCE:
     
    16091618
    16101619.. _rtems_task_iterate:
     1620.. index:: iterate over all threads
     1621.. index:: rtems_task_iterate
    16111622
    16121623TASK_ITERATE - Iterate Over Tasks
    16131624---------------------------------
    1614 .. index:: iterate over all threads
    1615 .. index:: rtems_task_iterate
    16161625
    16171626CALLING SEQUENCE:
     
    16511660
    16521661.. _rtems_iterate_over_all_threads:
     1662.. index:: rtems_iterate_over_all_threads
    16531663
    16541664ITERATE_OVER_ALL_THREADS - Iterate Over Tasks
    16551665---------------------------------------------
    1656 .. index:: rtems_iterate_over_all_threads
    16571666
    16581667.. warning::
     
    16901699
    16911700.. _rtems_task_get_note:
     1701.. index:: get task notepad entry
     1702.. index:: rtems_task_get_note
    16921703
    16931704TASK_GET_NOTE - Get task notepad entry
    16941705--------------------------------------
    1695 .. index:: get task notepad entry
    1696 .. index:: rtems_task_get_note
    16971706
    16981707.. warning::
     
    17431752
    17441753.. _rtems_task_set_note:
     1754.. index:: set task notepad entry
     1755.. index:: rtems_task_set_note
    17451756
    17461757TASK_SET_NOTE - Set task notepad entry
    17471758--------------------------------------
    1748 .. index:: set task notepad entry
    1749 .. index:: rtems_task_set_note
    17501759
    17511760.. warning::
     
    17951804
    17961805.. _rtems_task_variable_add:
    1797 
    1798 TASK_VARIABLE_ADD - Associate per task variable
    1799 -----------------------------------------------
    18001806.. index:: per-task variable
    18011807.. index:: task private variable
    18021808.. index:: task private data
    18031809.. index:: rtems_task_variable_add
     1810
     1811TASK_VARIABLE_ADD - Associate per task variable
     1812-----------------------------------------------
    18041813
    18051814.. warning::
     
    18581867
    18591868.. _rtems_task_variable_get:
    1860 
    1861 TASK_VARIABLE_GET - Obtain value of a per task variable
    1862 -------------------------------------------------------
    18631869.. index:: get per-task variable
    18641870.. index:: obtain per-task variable
    18651871.. index:: rtems_task_variable_get
     1872
     1873TASK_VARIABLE_GET - Obtain value of a per task variable
     1874-------------------------------------------------------
    18661875
    18671876.. warning::
     
    19151924
    19161925.. _rtems_task_variable_delete:
    1917 
    1918 TASK_VARIABLE_DELETE - Remove per task variable
    1919 -----------------------------------------------
    19201926.. index:: per-task variable
    19211927.. index:: task private variable
    19221928.. index:: task private data
    19231929.. index:: rtems_task_variable_delete
     1930
     1931TASK_VARIABLE_DELETE - Remove per task variable
     1932-----------------------------------------------
    19241933
    19251934.. warning::
  • c-user/timer_manager.rst

    r42d50d7 r6c56401  
    55.. COMMENT: All rights reserved.
    66
     7.. index:: timers
     8
    79Timer Manager
    810*************
    9 
    10 .. index:: timers
    1111
    1212Introduction
     
    8585This reduces the execution overhead of the Timer Server.
    8686
     87.. index:: rtems_timer_service_routine
     88
    8789Timer Service Routines
    8890----------------------
     
    9092The timer service routine should adhere to C calling conventions and have a
    9193prototype similar to the following:
    92 
    93 .. index:: rtems_timer_service_routine
    9494
    9595.. code-block:: c
     
    196196   \clearpage
    197197.. _rtems_timer_create:
     198.. index:: create a timer
     199.. index:: rtems_timer_create
    198200
    199201TIMER_CREATE - Create a timer
    200202-----------------------------
    201 .. index:: create a timer
    202 .. index:: rtems_timer_create
    203203
    204204CALLING SEQUENCE:
     
    242242
    243243.. _rtems_timer_ident:
     244.. index:: obtain the ID of a timer
     245.. index:: rtems_timer_ident
    244246
    245247TIMER_IDENT - Get ID of a timer
    246248-------------------------------
    247 .. index:: obtain the ID of a timer
    248 .. index:: rtems_timer_ident
    249249
    250250CALLING SEQUENCE:
     
    282282
    283283.. _rtems_timer_cancel:
     284.. index:: cancel a timer
     285.. index:: rtems_timer_cancel
    284286
    285287TIMER_CANCEL - Cancel a timer
    286288-----------------------------
    287 .. index:: cancel a timer
    288 .. index:: rtems_timer_cancel
    289289
    290290CALLING SEQUENCE:
     
    317317
    318318.. _rtems_timer_delete:
     319.. index:: delete a timer
     320.. index:: rtems_timer_delete
    319321
    320322TIMER_DELETE - Delete a timer
    321323-----------------------------
    322 .. index:: delete a timer
    323 .. index:: rtems_timer_delete
    324324
    325325CALLING SEQUENCE:
     
    356356
    357357.. _rtems_timer_fire_after:
     358.. index:: fire a timer after an interval
     359.. index:: rtems_timer_fire_after
    358360
    359361TIMER_FIRE_AFTER - Fire timer after interval
    360362--------------------------------------------
    361 .. index:: fire a timer after an interval
    362 .. index:: rtems_timer_fire_after
    363363
    364364CALLING SEQUENCE:
     
    400400
    401401.. _rtems_timer_fire_when:
     402.. index:: fire a timer at wall time
     403.. index:: rtems_timer_fire_when
    402404
    403405TIMER_FIRE_WHEN - Fire timer when specified
    404406-------------------------------------------
    405 .. index:: fire a timer at wall time
    406 .. index:: rtems_timer_fire_when
    407407
    408408CALLING SEQUENCE:
     
    448448
    449449.. _rtems_timer_initiate_server:
     450.. index:: initiate the Timer Server
     451.. index:: rtems_timer_initiate_server
    450452
    451453TIMER_INITIATE_SERVER - Initiate server for task-based timers
    452454-------------------------------------------------------------
    453 .. index:: initiate the Timer Server
    454 .. index:: rtems_timer_initiate_server
    455455
    456456CALLING SEQUENCE:
     
    493493
    494494.. _rtems_timer_server_fire_after:
     495.. index:: fire task-based a timer after an interval
     496.. index:: rtems_timer_server_fire_after
    495497
    496498TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
    497499--------------------------------------------------------------