Changeset 20515fc in rtems


Ignore:
Timestamp:
Mar 27, 1998, 6:53:17 PM (23 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
a30359bb
Parents:
1f020c6
Message:

Nodes, menus, etc are automatically generated now

Location:
doc/user
Files:
24 edited

Legend:

Unmodified
Added
Removed
  • doc/user/Makefile

    r1f020c6 r20515fc  
    1919part.texi preface.texi region.texi rtmon.texi schedule.texi sem.texi \
    2020signal.texi task.texi timer.texi userext.texi $(COMMON_FILES)
     21
     22GENERATED_FILES=overview.texi concepts.texi init.texi task.texi \
     23    intr.texi clock.texi timer.texi sem.texi msg.texi \
     24    event.texi signal.texi part.texi region.texi \
     25    dpmem.texi io.texi fatal.texi schedule.texi rtmon.texi \
     26    bsp.texi userext.texi conf.texi mp.texi
    2127
    2228all:
     
    5864        rm -f *.o $(PROG) *.txt core *.html
    5965        rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE)
    60         rm -f c_user c_user-* _*
     66        rm -f c_user c_user-* _* $(GENERATED_FILES)
    6167
     68#preface.texi: preface.t
     69#       $(BMENU) -p "Top" \
     70#           -u "Top" \
     71#           -n "Overview" ${*}.t
     72
     73overview.texi: overview.t
     74        $(BMENU) -p "Preface" \
     75            -u "Top" \
     76            -n "Key Concepts" ${*}.t
     77
     78concepts.texi: concepts.t
     79        $(BMENU) -p "Overview Manual Organization" \
     80            -u "Top" \
     81            -n "Initialization Manager" ${*}.t
     82
     83init.texi: init.t
     84        $(BMENU) -p "Key Concepts Memory Management" \
     85            -u "Top" \
     86            -n "Task Manager" ${*}.t
     87
     88task.texi: task.t
     89        $(BMENU) -p "Initialization Manager SHUTDOWN_EXECUTIVE - Shutdown RTEMS" \
     90            -u "Top" \
     91            -n "Interrupt Manager" ${*}.t
     92
     93intr.texi: intr.t
     94        $(BMENU) -p "Task Manager TASK_WAKE_WHEN - Wake up when specified" \
     95            -u "Top" \
     96            -n "Clock Manager" ${*}.t
     97
     98clock.texi: clock.t
     99        $(BMENU) \
     100         -p "Interrupt Manager INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress" \
     101            -u "Top" \
     102            -n "Timer Manager" ${*}.t
     103
     104timer.texi: timer.t
     105        $(BMENU) -p "Clock Manager CLOCK_TICK - Announce a clock tick" \
     106            -u "Top" \
     107            -n "Semaphore Manager" ${*}.t
     108
     109sem.texi: sem.t
     110        $(BMENU) -p "Timer Manager TIMER_RESET - Reset an interval timer" \
     111            -u "Top" \
     112            -n "Message Manager" ${*}.t
     113
     114msg.texi: msg.t
     115        $(BMENU) -p "Semaphore Manager SEMAPHORE_RELEASE - Release a semaphore" \
     116            -u "Top" \
     117            -n "Event Manager" ${*}.t
     118
     119event.texi: event.t
     120        $(BMENU) \
     121        -p "Message Manager MESSAGE_QUEUE_FLUSH - Flush all messages on a queue" \
     122            -u "Top" \
     123            -n "Signal Manager" ${*}.t
     124
     125signal.texi: signal.t
     126        $(BMENU) -p "Event Manager EVENT_RECEIVE - Receive event condition" \
     127            -u "Top" \
     128            -n "Partition Manager" ${*}.t
     129
     130part.texi: part.t
     131        $(BMENU) -p "Signal Manager SIGNAL_SEND - Send signal set to a task" \
     132            -u "Top" \
     133            -n "Region Manager" ${*}.t
     134
     135region.texi: region.t
     136        $(BMENU) \
     137-p "Partition Manager PARTITION_RETURN_BUFFER - Return buffer to a partition" \
     138            -u "Top" \
     139            -n "Dual-Ported Memory Manager" ${*}.t
     140
     141dpmem.texi: dpmem.t
     142        $(BMENU) \
     143          -p "Region Manager REGION_GET_SEGMENT_SIZE - Obtain size of a segment" \
     144            -u "Top" \
     145            -n "I/O Manager" ${*}.t
     146
     147io.texi: io.t
     148        $(BMENU) -p "Dual-Ported Memory Manager PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address" \
     149            -u "Top" \
     150            -n "Fatal Error Manager" ${*}.t
     151
     152fatal.texi: fatal.t
     153        $(BMENU) -p "I/O Manager IO_CONTROL - Special device services" \
     154            -u "Top" \
     155            -n "Scheduling Concepts" ${*}.t
     156
     157schedule.texi: schedule.t
     158        $(BMENU) \
     159-p "Fatal Error Manager FATAL_ERROR_OCCURRED - Invoke the fatal error handler" \
     160            -u "Top" \
     161            -n "Rate Monotonic Manager" ${*}.t
     162
     163rtmon.texi: rtmon.t
     164        $(BMENU) -p "Scheduling Concepts Task State Transitions" \
     165            -u "Top" \
     166            -n "Board Support Packages" ${*}.t
     167
     168bsp.texi: bsp.t
     169        $(BMENU) -p "Rate Monotonic Manager RATE_MONOTONIC_GET_STATUS - Obtain status information on period" \
     170            -u "Top" \
     171            -n "User Extensions Manager" ${*}.t
     172
     173userext.texi: userext.t
     174        $(BMENU) -p "Board Support Packages Heterogeneous Systems" \
     175            -u "Top" \
     176            -n "Configuring a System" ${*}.t
     177
     178conf.texi: conf.t
     179        $(BMENU) -p "User Extensions Manager EXTENSION_DELETE - Delete a extension set" \
     180            -u "Top" \
     181            -n "Multiprocessing Manager" ${*}.t
     182
     183mp.texi: mp.t
     184        $(BMENU) -p "Configuring a System Sizing the RTEMS RAM Workspace" \
     185            -u "Top" \
     186            -n "Directive Status Codes" ${*}.t
     187
  • doc/user/bsp.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Board Support Packages, Board Support Packages Introduction, RATE_MONOTONIC_GET_STATUS - Obtain status information on period, Top
    11 @end ifinfo
    129@chapter Board Support Packages
    13 @ifinfo
    14 @menu
    15 * Board Support Packages Introduction::
    16 * Board Support Packages Reset and Initialization::
    17 * Board Support Packages Device Drivers::
    18 * Board Support Packages User Extensions::
    19 * Board Support Packages Multiprocessor Communications Interface (MPCI)::
    20 @end menu
    21 @end ifinfo
    22 
    23 @ifinfo
    24 @node Board Support Packages Introduction, Board Support Packages Reset and Initialization, Board Support Packages, Board Support Packages
    25 @end ifinfo
     10
    2611@section Introduction
    2712
     
    3419reset and initialization and, if needed, a clock tick.
    3520
    36 @ifinfo
    37 @node Board Support Packages Reset and Initialization, Interrupt Stack Requirements, Board Support Packages Introduction, Board Support Packages
    38 @end ifinfo
    3921@section Reset and Initialization
    40 @ifinfo
    41 @menu
    42 * Interrupt Stack Requirements::
    43 * Processors with a Separate Interrupt Stack::
    44 * Processors without a Separate Interrupt Stack::
    45 @end menu
    46 @end ifinfo
    4722
    4823An RTEMS based application is initiated or
     
    12297application's set of tasks.
    12398
    124 @ifinfo
    125 @node Interrupt Stack Requirements, Processors with a Separate Interrupt Stack, Board Support Packages Reset and Initialization, Board Support Packages Reset and Initialization
    126 @end ifinfo
    12799@subsection Interrupt Stack Requirements
    128100
     
    148120or equal to the constant @code{@value{RPREFIX}MINIMUM_STACK_SIZE}.
    149121
    150 @ifinfo
    151 @node Processors with a Separate Interrupt Stack, Processors without a Separate Interrupt Stack, Interrupt Stack Requirements, Board Support Packages Reset and Initialization
    152 @end ifinfo
    153122@subsection Processors with a Separate Interrupt Stack
    154123
     
    166135the worst case stack usage by any combination of nested ISRs.
    167136
    168 @ifinfo
    169 @node Processors without a Separate Interrupt Stack, Board Support Packages Device Drivers, Processors with a Separate Interrupt Stack, Board Support Packages Reset and Initialization
    170 @end ifinfo
    171137@subsection Processors without a Separate Interrupt Stack
    172138
     
    184150interrupt stack in hardware.
    185151
    186 @ifinfo
    187 @node Board Support Packages Device Drivers, Clock Tick Device Driver, Processors without a Separate Interrupt Stack, Board Support Packages
    188 @end ifinfo
    189152@section Device Drivers
    190 @ifinfo
    191 @menu
    192 * Clock Tick Device Driver::
    193 @end menu
    194 @end ifinfo
    195153
    196154Device drivers consist of control software for
     
    207165I/O Manager chapter.
    208166
    209 @ifinfo
    210 @node Clock Tick Device Driver, Board Support Packages User Extensions, Board Support Packages Device Drivers, Board Support Packages Device Drivers
    211 @end ifinfo
    212167@subsection Clock Tick Device Driver
    213168
     
    245200clock tick ISRs.
    246201
    247 @ifinfo
    248 @node Board Support Packages User Extensions, Board Support Packages Multiprocessor Communications Interface (MPCI), Clock Tick Device Driver, Board Support Packages
    249 @end ifinfo
    250202@section User Extensions
    251203
     
    281233User Extensions chapter.
    282234
    283 @ifinfo
    284 @node Board Support Packages Multiprocessor Communications Interface (MPCI), Tightly-Coupled Systems, Board Support Packages User Extensions, Board Support Packages
    285 @end ifinfo
    286235@section Multiprocessor Communications Interface (MPCI)
    287 @ifinfo
    288 @menu
    289 * Tightly-Coupled Systems::
    290 * Loosely-Coupled Systems::
    291 * Systems with Mixed Coupling::
    292 * Heterogeneous Systems::
    293 @end menu
    294 @end ifinfo
    295236
    296237RTEMS requires that an MPCI layer be provided when a
     
    305246Multiprocessing Manager chapter.
    306247
    307 @ifinfo
    308 @node Tightly-Coupled Systems, Loosely-Coupled Systems, Board Support Packages Multiprocessor Communications Interface (MPCI), Board Support Packages Multiprocessor Communications Interface (MPCI)
    309 @end ifinfo
    310248@subsection Tightly-Coupled Systems
    311249
     
    332270technique is the overhead associated with polling.
    333271
    334 @ifinfo
    335 @node Loosely-Coupled Systems, Systems with Mixed Coupling, Tightly-Coupled Systems, Board Support Packages Multiprocessor Communications Interface (MPCI)
    336 @end ifinfo
    337272@subsection Loosely-Coupled Systems
    338273
     
    351286capabilities which are expected by RTEMS.
    352287
    353 @ifinfo
    354 @node Systems with Mixed Coupling, Heterogeneous Systems, Loosely-Coupled Systems, Board Support Packages Multiprocessor Communications Interface (MPCI)
    355 @end ifinfo
    356288@subsection Systems with Mixed Coupling
    357289
     
    368300failure.
    369301
    370 @ifinfo
    371 @node Heterogeneous Systems, User Extensions Manager, Systems with Mixed Coupling, Board Support Packages Multiprocessor Communications Interface (MPCI)
    372 @end ifinfo
    373302@subsection Heterogeneous Systems
    374303
  • doc/user/clock.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Clock Manager, Clock Manager Introduction, INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress, Top
    11 @end ifinfo
    129@chapter Clock Manager
    13 @ifinfo
    14 @menu
    15 * Clock Manager Introduction::
    16 * Clock Manager Background::
    17 * Clock Manager Operations::
    18 * Clock Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Clock Manager Introduction, Clock Manager Background, Clock Manager, Clock Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3521@end itemize
    3622
    37 @ifinfo
    38 @node Clock Manager Background, Required Support, Clock Manager Introduction, Clock Manager
    39 @end ifinfo
    4023@section Background
    41 @ifinfo
    42 @menu
    43 * Required Support::
    44 * Time and Date Data Structures::
    45 * Clock Tick and Timeslicing::
    46 * Delays::
    47 * Timeouts::
    48 @end menu
    49 @end ifinfo
    50 
    51 @ifinfo
    52 @node Required Support, Time and Date Data Structures, Clock Manager Background, Clock Manager Background
    53 @end ifinfo
     24
    5425@subsection Required Support
    5526
     
    6435specified by the user in the Configuration Table.
    6536
    66 @ifinfo
    67 @node Time and Date Data Structures, Clock Tick and Timeslicing, Required Support, Clock Manager Background
    68 @end ifinfo
    6937@subsection Time and Date Data Structures
    7038
     
    137105seconds since the RTEMS epoch of January 1, 1988.
    138106
    139 @ifinfo
    140 @node Clock Tick and Timeslicing, Delays, Time and Date Data Structures, Clock Manager Background
    141 @end ifinfo
    142107@subsection Clock Tick and Timeslicing
    143108
     
    161126ready task of equal priority.
    162127
    163 @ifinfo
    164 @node Delays, Timeouts, Clock Tick and Timeslicing, Clock Manager Background
    165 @end ifinfo
    166128@subsection Delays
    167129
     
    175137sleep timer at a time.
    176138
    177 @ifinfo
    178 @node Timeouts, Clock Manager Operations, Delays, Clock Manager Background
    179 @end ifinfo
    180139@subsection Timeouts
    181140
     
    189148When a timeout expires, it unblocks the task with a timeout status code.
    190149
    191 @ifinfo
    192 @node Clock Manager Operations, Announcing a Tick, Timeouts, Clock Manager
    193 @end ifinfo
    194150@section Operations
    195 @ifinfo
    196 @menu
    197 * Announcing a Tick::
    198 * Setting the Time::
    199 * Obtaining the Time::
    200 @end menu
    201 @end ifinfo
    202 
    203 @ifinfo
    204 @node Announcing a Tick, Setting the Time, Clock Manager Operations, Clock Manager Operations
    205 @end ifinfo
     151
    206152@subsection Announcing a Tick
    207153
     
    224170calendar time and the dynamic set of timers.
    225171
    226 @ifinfo
    227 @node Setting the Time, Obtaining the Time, Announcing a Tick, Clock Manager Operations
    228 @end ifinfo
    229172@subsection Setting the Time
    230173
     
    235178the @code{@value{DIRPREFIX}clock_set} directive.
    236179
    237 @ifinfo
    238 @node Obtaining the Time, Clock Manager Directives, Setting the Time, Clock Manager Operations
    239 @end ifinfo
    240180@subsection Obtaining the Time
    241181
     
    272212invoked before the date and time have been set.
    273213
    274 @ifinfo
    275 @node Clock Manager Directives, CLOCK_SET - Set system date and time, Obtaining the Time, Clock Manager
    276 @end ifinfo
    277214@section Directives
    278 @ifinfo
    279 @menu
    280 * CLOCK_SET - Set system date and time::
    281 * CLOCK_GET - Get system date and time information::
    282 * CLOCK_TICK - Announce a clock tick::
    283 @end menu
    284 @end ifinfo
    285215
    286216This section details the clock manager's directives.
     
    290220
    291221@page
    292 @ifinfo
    293 @node CLOCK_SET - Set system date and time, CLOCK_GET - Get system date and time information, Clock Manager Directives, Clock Manager Directives
    294 @end ifinfo
    295222@subsection CLOCK_SET - Set system date and time
    296223
     
    343270
    344271@page
    345 @ifinfo
    346 @node CLOCK_GET - Get system date and time information, CLOCK_TICK - Announce a clock tick, CLOCK_SET - Set system date and time, Clock Manager Directives
    347 @end ifinfo
    348272@subsection CLOCK_GET - Get system date and time information
    349273
     
    436360
    437361@page
    438 @ifinfo
    439 @node CLOCK_TICK - Announce a clock tick, Timer Manager, CLOCK_GET - Get system date and time information, Clock Manager Directives
    440 @end ifinfo
    441362@subsection CLOCK_TICK - Announce a clock tick
    442363
  • doc/user/concepts.t

    r1f020c6 r20515fc  
    1111@c    Figure 2-1 Object ID Composition
    1212@c
    13 @ifinfo
    14 @node Key Concepts, Key Concepts Introduction, Overview Manual Organization, Top
    15 @end ifinfo
     13
    1614@chapter Key Concepts
    17 @ifinfo
    18 @menu
    19 * Key Concepts Introduction::
    20 * Key Concepts Objects::
    21 * Key Concepts Communication and Synchronization::
    22 * Key Concepts Time::
    23 * Key Concepts Memory Management::
    24 @end menu
    25 @end ifinfo
    26 
    27 @ifinfo
    28 @node Key Concepts Introduction, Key Concepts Objects, Key Concepts, Key Concepts
    29 @end ifinfo
     15
    3016@section Introduction
    3117
     
    3622one with these concepts.
    3723
    38 @ifinfo
    39 @node Key Concepts Objects, Key Concepts Communication and Synchronization, Key Concepts Introduction, Key Concepts
    40 @end ifinfo
    4124@section Objects
    4225
     
    195178user applications.
    196179
    197 @ifinfo
    198 @node Key Concepts Communication and Synchronization, Key Concepts Time, Key Concepts Objects, Key Concepts
    199 @end ifinfo
    200180@section Communication and Synchronization
    201181
     
    239219for exception handling.
    240220
    241 @ifinfo
    242 @node Key Concepts Time, Key Concepts Memory Management, Key Concepts Communication and Synchronization, Key Concepts
    243 @end ifinfo
    244221@section Time
    245222
     
    289266provided by a real time clock or counter/timer device.
    290267
    291 @ifinfo
    292 @node Key Concepts Memory Management, Initialization Manager, Key Concepts Time, Key Concepts
    293 @end ifinfo
    294268@section Memory Management
    295269
  • doc/user/conf.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Configuring a System, Configuring a System Configuration Table, EXTENSION_DELETE - Delete a extension set, Top
    11 @end ifinfo
    129@chapter Configuring a System
    13 @ifinfo
    14 @menu
    15 * Configuring a System Configuration Table::
    16 * Configuring a System RTEMS API Configuration Table::
    17 * Configuring a System POSIX API Configuration Table::
    18 * Configuring a System CPU Dependent Information Table::
    19 * Configuring a System Initialization Task Table::
    20 * Configuring a System Driver Address Table::
    21 * Configuring a System User Extensions Table::
    22 * Configuring a System Multiprocessor Configuration Table::
    23 * Configuring a System Multiprocessor Communications Interface Table::
    24 * Configuring a System Determining Memory Requirements::
    25 * Configuring a System Sizing the RTEMS RAM Workspace::
    26 @end menu
    27 @end ifinfo
    28 
    29 @ifinfo
    30 @node Configuring a System Configuration Table, Configuring a System RTEMS API Configuration Table, Configuring a System, Configuring a System
    31 @end ifinfo
     10
    3211@section Configuration Table
    3312
     
    146125@end table
    147126
    148 @ifinfo
    149 @node Configuring a System RTEMS API Configuration Table, Configuring a System POSIX API Configuration Table, Configuring a System Configuration Table, Configuring a System
    150 @end ifinfo
    151127@section RTEMS API Configuration Table
    152128
     
    239215@end table
    240216
    241 @ifinfo
    242 @node Configuring a System POSIX API Configuration Table, Configuring a System CPU Dependent Information Table, Configuring a System RTEMS API Configuration Table, Configuring a System
    243 @end ifinfo
    244217@section POSIX API Configuration Table
    245218
     
    341314@end table
    342315
    343 @ifinfo
    344 @node Configuring a System CPU Dependent Information Table, Configuring a System Initialization Task Table, Configuring a System POSIX API Configuration Table, Configuring a System
    345 @end ifinfo
    346316@section CPU Dependent Information Table
    347317
     
    354324target processor.
    355325
    356 @ifinfo
    357 @node Configuring a System Initialization Task Table, Configuring a System Driver Address Table, Configuring a System CPU Dependent Information Table, Configuring a System
    358 @end ifinfo
    359326@section Initialization Task Table
    360327
     
    478445@end ifset
    479446
    480 @ifinfo
    481 @node Configuring a System Driver Address Table, Configuring a System User Extensions Table, Configuring a System Initialization Task Table, Configuring a System
    482 @end ifinfo
    483447@section Driver Address Table
    484448
     
    575539chapter.
    576540
    577 @ifinfo
    578 @node Configuring a System User Extensions Table, Configuring a System Multiprocessor Configuration Table, Configuring a System Driver Address Table, Configuring a System
    579 @end ifinfo
    580541@section User Extensions Table
    581542
     
    744705provided in the User Extensions chapter.
    745706
    746 @ifinfo
    747 @node Configuring a System Multiprocessor Configuration Table, Configuring a System Multiprocessor Communications Interface Table, Configuring a System User Extensions Table, Configuring a System
    748 @end ifinfo
    749707@section Multiprocessor Configuration Table
    750708
     
    829787@end table
    830788
    831 @ifinfo
    832 @node Configuring a System Multiprocessor Communications Interface Table, Configuring a System Determining Memory Requirements, Configuring a System Multiprocessor Configuration Table, Configuring a System
    833 @end ifinfo
    834789@section Multiprocessor Communications Interface Table
    835790
     
    910865entry points is provided in the Multiprocessor chapter.
    911866
    912 @ifinfo
    913 @node Configuring a System Determining Memory Requirements, Configuring a System Sizing the RTEMS RAM Workspace, Configuring a System Multiprocessor Communications Interface Table, Configuring a System
    914 @end ifinfo
    915867@section Determining Memory Requirements
    916868
     
    960912should be treated as reserved words.
    961913
    962 @ifinfo
    963 @node Configuring a System Sizing the RTEMS RAM Workspace, Multiprocessing Manager, Configuring a System Determining Memory Requirements, Configuring a System
    964 @end ifinfo
    965914@section Sizing the RTEMS RAM Workspace
    966915
  • doc/user/dirstat.texi

    r1f020c6 r20515fc  
    88
    99@ifinfo
    10 @node Directive Status Codes, Example Application, MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet, Top
     10@node Directive Status Codes, Example Application, Multiprocessing Manager MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet, Top
    1111@end ifinfo
    1212@chapter Directive Status Codes
  • doc/user/dpmem.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Dual-Ported Memory Manager, Dual-Ported Memory Manager Introduction, REGION_GET_SEGMENT_SIZE - Obtain size of a segment, Top
    11 @end ifinfo
    129@chapter Dual-Ported Memory Manager
    13 @ifinfo
    14 @menu
    15 * Dual-Ported Memory Manager Introduction::
    16 * Dual-Ported Memory Manager Background::
    17 * Dual-Ported Memory Manager Operations::
    18 * Dual-Ported Memory Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Dual-Ported Memory Manager Introduction, Dual-Ported Memory Manager Background, Dual-Ported Memory Manager, Dual-Ported Memory Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3824@end itemize
    3925
    40 @ifinfo
    41 @node Dual-Ported Memory Manager Background, Dual-Ported Memory Manager Operations, Dual-Ported Memory Manager Introduction, Dual-Ported Memory Manager
    42 @end ifinfo
    4326@section Background
    4427
     
    5942transfers.
    6043
    61 @ifinfo
    62 @node Dual-Ported Memory Manager Operations, Creating a Port, Dual-Ported Memory Manager Background, Dual-Ported Memory Manager
    63 @end ifinfo
    6444@section Operations
    65 @ifinfo
    66 @menu
    67 * Creating a Port::
    68 * Obtaining Port IDs::
    69 * Converting an Address::
    70 * Deleting a DPMA Port::
    71 @end menu
    72 @end ifinfo
    73 
    74 @ifinfo
    75 @node Creating a Port, Obtaining Port IDs, Dual-Ported Memory Manager Operations, Dual-Ported Memory Manager Operations
    76 @end ifinfo
     45
    7746@subsection Creating a Port
    7847
     
    8756within it.
    8857
    89 @ifinfo
    90 @node Obtaining Port IDs, Converting an Address, Creating a Port, Dual-Ported Memory Manager Operations
    91 @end ifinfo
    9258@subsection Obtaining Port IDs
    9359
     
    10369access this port.
    10470
    105 @ifinfo
    106 @node Converting an Address, Deleting a DPMA Port, Obtaining Port IDs, Dual-Ported Memory Manager Operations
    107 @end ifinfo
    10871@subsection Converting an Address
    10972
     
    11780the address to be converted will be returned.
    11881
    119 @ifinfo
    120 @node Deleting a DPMA Port, Dual-Ported Memory Manager Directives, Converting an Address, Dual-Ported Memory Manager Operations
    121 @end ifinfo
    12282@subsection Deleting a DPMA Port
    12383
     
    12686its control block is returned to the DPCB free list.
    12787
    128 @ifinfo
    129 @node Dual-Ported Memory Manager Directives, PORT_CREATE - Create a port, Deleting a DPMA Port, Dual-Ported Memory Manager
    130 @end ifinfo
    13188@section Directives
    132 @ifinfo
    133 @menu
    134 * PORT_CREATE - Create a port::
    135 * PORT_IDENT - Get ID of a port::
    136 * PORT_DELETE - Delete a port::
    137 * PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address::
    138 * PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address::
    139 @end menu
    140 @end ifinfo
    14189
    14290This section details the dual-ported memory manager's
     
    14694
    14795@page
    148 @ifinfo
    149 @node PORT_CREATE - Create a port, PORT_IDENT - Get ID of a port, Dual-Ported Memory Manager Directives, Dual-Ported Memory Manager Directives
    150 @end ifinfo
    15196@subsection PORT_CREATE - Create a port
    15297
     
    206151
    207152@page
    208 @ifinfo
    209 @node PORT_IDENT - Get ID of a port, PORT_DELETE - Delete a port, PORT_CREATE - Create a port, Dual-Ported Memory Manager Directives
    210 @end ifinfo
    211153@subsection PORT_IDENT - Get ID of a port
    212154
     
    251193
    252194@page
    253 @ifinfo
    254 @node PORT_DELETE - Delete a port, PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address, PORT_IDENT - Get ID of a port, Dual-Ported Memory Manager Directives
    255 @end ifinfo
    256195@subsection PORT_DELETE - Delete a port
    257196
     
    295234
    296235@page
    297 @ifinfo
    298 @node PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address, PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address, PORT_DELETE - Delete a port, Dual-Ported Memory Manager Directives
    299 @end ifinfo
    300236@subsection PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address
    301237
     
    342278
    343279@page
    344 @ifinfo
    345 @node PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address, I/O Manager, PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address, Dual-Ported Memory Manager Directives
    346 @end ifinfo
    347280@subsection PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address
    348281
  • doc/user/event.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Event Manager, Event Manager Introduction, MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, Top
    11 @end ifinfo
    129@chapter Event Manager
    13 @ifinfo
    14 @menu
    15 * Event Manager Introduction::
    16 * Event Manager Background::
    17 * Event Manager Operations::
    18 * Event Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Event Manager Introduction, Event Manager Background, Event Manager, Event Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3420@end itemize
    3521
    36 @ifinfo
    37 @node Event Manager Background, Event Sets, Event Manager Introduction, Event Manager
    38 @end ifinfo
    3922@section Background
    40 @ifinfo
    41 @menu
    42 * Event Sets::
    43 * Building an Event Set or Condition::
    44 * Building an EVENT_RECEIVE Option Set::
    45 @end menu
    46 @end ifinfo
    47 
    48 @ifinfo
    49 @node Event Sets, Building an Event Set or Condition, Event Manager Background, Event Manager Background
    50 @end ifinfo
     23
    5124@subsection Event Sets
    5225
     
    8659condition is satisfied when every requested event is posted.
    8760
    88 @ifinfo
    89 @node Building an Event Set or Condition, Building an EVENT_RECEIVE Option Set, Event Sets, Event Manager Background
    90 @end ifinfo
    9161@subsection Building an Event Set or Condition
    9262
     
    10575@value{RPREFIX}EVENT_15 @value{OR} @value{RPREFIX}EVENT_31}.
    10676
    107 @ifinfo
    108 @node Building an EVENT_RECEIVE Option Set, Event Manager Operations, Building an Event Set or Condition, Event Manager Background
    109 @end ifinfo
    11077@subsection Building an EVENT_RECEIVE Option Set
    11178
     
    140107default condition for @code{@value{DIRPREFIX}event_receive}.
    141108
    142 @ifinfo
    143 @node Event Manager Operations, Sending an Event Set, Building an EVENT_RECEIVE Option Set, Event Manager
    144 @end ifinfo
    145109@section Operations
    146 @ifinfo
    147 @menu
    148 * Sending an Event Set::
    149 * Receiving an Event Set::
    150 * Determining the Pending Event Set::
    151 * Receiving all Pending Events::
    152 @end menu
    153 @end ifinfo
    154 
    155 @ifinfo
    156 @node Sending an Event Set, Receiving an Event Set, Event Manager Operations, Event Manager Operations
    157 @end ifinfo
     110
    158111@subsection Sending an Event Set
    159112
     
    184137@end itemize
    185138
    186 @ifinfo
    187 @node Receiving an Event Set, Determining the Pending Event Set, Sending an Event Set, Event Manager Operations
    188 @end ifinfo
    189139@subsection Receiving an Event Set
    190140
     
    209159@end itemize
    210160
    211 @ifinfo
    212 @node Determining the Pending Event Set, Receiving all Pending Events, Receiving an Event Set, Event Manager Operations
    213 @end ifinfo
    214161@subsection Determining the Pending Event Set
    215162
     
    220167set is left unaltered.
    221168
    222 @ifinfo
    223 @node Receiving all Pending Events, Event Manager Directives, Determining the Pending Event Set, Event Manager Operations
    224 @end ifinfo
    225169@subsection Receiving all Pending Events
    226170
     
    234178pending then the @code{@value{RPREFIX}UNSATISFIED} status code will be returned.
    235179
    236 @ifinfo
    237 @node Event Manager Directives, EVENT_SEND - Send event set to a task, Receiving all Pending Events, Event Manager
    238 @end ifinfo
    239180@section Directives
    240 @ifinfo
    241 @menu
    242 * EVENT_SEND - Send event set to a task::
    243 * EVENT_RECEIVE - Receive event condition::
    244 @end menu
    245 @end ifinfo
    246181
    247182This section details the event manager's directives.
     
    251186
    252187@page
    253 @ifinfo
    254 @node EVENT_SEND - Send event set to a task, EVENT_RECEIVE - Receive event condition, Event Manager Directives, Event Manager Directives
    255 @end ifinfo
    256188@subsection EVENT_SEND - Send event set to a task
    257189
     
    310242
    311243@page
    312 @ifinfo
    313 @node EVENT_RECEIVE - Receive event condition, Signal Manager, EVENT_SEND - Send event set to a task, Event Manager Directives
    314 @end ifinfo
    315244@subsection EVENT_RECEIVE - Receive event condition
    316245
  • doc/user/fatal.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Fatal Error Manager, Fatal Error Manager Introduction, IO_CONTROL - Special device services, Top
    11 @end ifinfo
    129@chapter Fatal Error Manager
    13 @ifinfo
    14 @menu
    15 * Fatal Error Manager Introduction::
    16 * Fatal Error Manager Background::
    17 * Fatal Error Manager Operations::
    18 * Fatal Error Manager Directives::
    19 @end menu
    20 @end ifinfo
    2110
    22 @ifinfo
    23 @node Fatal Error Manager Introduction, Fatal Error Manager Background, Fatal Error Manager, Fatal Error Manager
    24 @end ifinfo
    2511@section Introduction
    2612
     
    3319@end itemize
    3420
    35 @ifinfo
    36 @node Fatal Error Manager Background, Fatal Error Manager Operations, Fatal Error Manager Introduction, Fatal Error Manager
    37 @end ifinfo
    3821@section Background
    3922
     
    7457a specific target processor.
    7558
    76 @ifinfo
    77 @node Fatal Error Manager Operations, Announcing a Fatal Error, Fatal Error Manager Background, Fatal Error Manager
    78 @end ifinfo
    7959@section Operations
    80 @ifinfo
    81 @menu
    82 * Announcing a Fatal Error::
    83 @end menu
    84 @end ifinfo
    8560
    86 @ifinfo
    87 @node Announcing a Fatal Error, Fatal Error Manager Directives, Fatal Error Manager Operations, Fatal Error Manager Operations
    88 @end ifinfo
    8961@subsection Announcing a Fatal Error
    9062
     
    132104occurred.
    133105
    134 @ifinfo
    135 @node Fatal Error Manager Directives, FATAL_ERROR_OCCURRED - Invoke the fatal error handler, Announcing a Fatal Error, Fatal Error Manager
    136 @end ifinfo
    137106@section Directives
    138 @ifinfo
    139 @menu
    140 * FATAL_ERROR_OCCURRED - Invoke the fatal error handler::
    141 @end menu
    142 @end ifinfo
    143107
    144108This section details the fatal error manager's
     
    148112
    149113@page
    150 @ifinfo
    151 @node FATAL_ERROR_OCCURRED - Invoke the fatal error handler, Scheduling Concepts, Fatal Error Manager Directives, Fatal Error Manager Directives
    152 @end ifinfo
    153114@subsection FATAL_ERROR_OCCURRED - Invoke the fatal error handler
    154115
  • doc/user/init.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Initialization Manager, Initialization Manager Introduction, Key Concepts Memory Management, Top
    11 @end ifinfo
    129@chapter Initialization Manager
    13 @ifinfo
    14 @menu
    15 * Initialization Manager Introduction::
    16 * Initialization Manager Background::
    17 * Initialization Manager Operations::
    18 * Initialization Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Initialization Manager Introduction, Initialization Manager Background, Initialization Manager, Initialization Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    4026@end itemize
    4127
    42 @ifinfo
    43 @node Initialization Manager Background, Initialization Tasks, Initialization Manager Introduction, Initialization Manager
    44 @end ifinfo
    4528@section Background
    46 @ifinfo
    47 @menu
    48 * Initialization Tasks::
    49 * The System Initialization Task::
    50 * The Idle Task::
    51 * Initialization Manager Failure::
    52 @end menu
    53 @end ifinfo
    54 
    55 @ifinfo
    56 @node Initialization Tasks, The System Initialization Task, Initialization Manager Background, Initialization Manager Background
    57 @end ifinfo
     29
    5830@subsection Initialization Tasks
    5931
     
    8153initialization tasks.
    8254
    83 @ifinfo
    84 @node The System Initialization Task, The Idle Task, Initialization Tasks, Initialization Manager Background
    85 @end ifinfo
    8655@subsection The System Initialization Task
    8756
     
    10877consistency, and processes all requests from remote nodes.
    10978
    110 @ifinfo
    111 @node The Idle Task, Initialization Manager Failure, The System Initialization Task, Initialization Manager Background
    112 @end ifinfo
    11379@subsection The Idle Task
    11480
     
    11884other task is made ready to execute.
    11985
    120 @ifinfo
    121 @node Initialization Manager Failure, Initialization Manager Operations, The Idle Task, Initialization Manager Background
    122 @end ifinfo
    12386@subsection Initialization Manager Failure
    12487
     
    156119@end itemize
    157120
    158 @ifinfo
    159 @node Initialization Manager Operations, Initializing RTEMS, Initialization Manager Failure, Initialization Manager
    160 @end ifinfo
    161121@section Operations
    162 @ifinfo
    163 @menu
    164 * Initializing RTEMS::
    165 * Shutting Down RTEMS::
    166 @end menu
    167 @end ifinfo
    168 
    169 @ifinfo
    170 @node Initializing RTEMS, Shutting Down RTEMS, Initialization Manager Operations, Initialization Manager Operations
    171 @end ifinfo
     122
    172123@subsection Initializing RTEMS
    173124
     
    222173initialization sequences be used in an application.
    223174
    224 @ifinfo
    225 @node Shutting Down RTEMS, Initialization Manager Directives, Initializing RTEMS, Initialization Manager Operations
    226 @end ifinfo
    227175@subsection Shutting Down RTEMS
    228176
     
    233181@code{@value{DIRPREFIX}initialize_executive} directive.
    234182
    235 @ifinfo
    236 @node Initialization Manager Directives, INITIALIZE_EXECUTIVE - Initialize RTEMS, Shutting Down RTEMS, Initialization Manager
    237 @end ifinfo
    238183@section Directives
    239 @ifinfo
    240 @menu
    241 * INITIALIZE_EXECUTIVE - Initialize RTEMS::
    242 * INITIALIZE_EXECUTIVE_EARLY - Initialize RTEMS and do NOT Start Multitasking::
    243 * INITIALIZE_EXECUTIVE_LATE - Complete Initialization and Start Multitasking::
    244 * SHUTDOWN_EXECUTIVE - Shutdown RTEMS::
    245 @end menu
    246 @end ifinfo
    247184
    248185This section details the initialization manager's
     
    252189
    253190@page
    254 @ifinfo
    255 @node INITIALIZE_EXECUTIVE - Initialize RTEMS, INITIALIZE_EXECUTIVE_EARLY - Initialize RTEMS and do NOT Start Multitasking, Initialization Manager Directives, Initialization Manager Directives
    256 @end ifinfo
    257191@subsection INITIALIZE_EXECUTIVE - Initialize RTEMS
    258192
     
    318252
    319253@page
    320 @ifinfo
    321 @node INITIALIZE_EXECUTIVE_EARLY - Initialize RTEMS and do NOT Start Multitasking, INITIALIZE_EXECUTIVE_LATE - Complete Initialization and Start Multitasking, INITIALIZE_EXECUTIVE - Initialize RTEMS, Initialization Manager Directives
    322 @end ifinfo
    323254@subsection INITIALIZE_EXECUTIVE_EARLY - Initialize RTEMS and do NOT Start Multitasking
    324255
     
    373304
    374305@page
    375 @ifinfo
    376 @node INITIALIZE_EXECUTIVE_LATE - Complete Initialization and Start Multitasking, SHUTDOWN_EXECUTIVE - Shutdown RTEMS, INITIALIZE_EXECUTIVE_EARLY - Initialize RTEMS and do NOT Start Multitasking, Initialization Manager Directives
    377 @end ifinfo
    378306@subsection INITIALIZE_EXECUTIVE_LATE - Complete Initialization and Start Multitasking
    379307
     
    433361
    434362@page
    435 @ifinfo
    436 @node SHUTDOWN_EXECUTIVE - Shutdown RTEMS, Task Manager, INITIALIZE_EXECUTIVE_LATE - Complete Initialization and Start Multitasking, Initialization Manager Directives
    437 @end ifinfo
    438363@subsection SHUTDOWN_EXECUTIVE - Shutdown RTEMS
    439364
  • doc/user/intr.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Interrupt Manager, Interrupt Manager Introduction, TASK_WAKE_WHEN - Wake up when specified, Top
    11 @end ifinfo
    129@chapter Interrupt Manager
    13 @ifinfo
    14 @menu
    15 * Interrupt Manager Introduction::
    16 * Interrupt Manager Background::
    17 * Interrupt Manager Operations::
    18 * Interrupt Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Interrupt Manager Introduction, Interrupt Manager Background, Interrupt Manager, Interrupt Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    4228@end itemize
    4329
    44 @ifinfo
    45 @node Interrupt Manager Background, Processing an Interrupt, Interrupt Manager Introduction, Interrupt Manager
    46 @end ifinfo
    4730@section Background
    48 @ifinfo
    49 @menu
    50 * Processing an Interrupt::
    51 * RTEMS Interrupt Levels::
    52 * Disabling of Interrupts by RTEMS::
    53 @end menu
    54 @end ifinfo
    55 
    56 @ifinfo
    57 @node Processing an Interrupt, RTEMS Interrupt Levels, Interrupt Manager Background, Interrupt Manager Background
    58 @end ifinfo
     31
    5932@subsection Processing an Interrupt
    6033
     
    139112outermost ISR terminates will the postponed dispatching occur.
    140113
    141 @ifinfo
    142 @node RTEMS Interrupt Levels, Disabling of Interrupts by RTEMS, Processing an Interrupt, Interrupt Manager Background
    143 @end ifinfo
    144114@subsection RTEMS Interrupt Levels
    145115
     
    153123target processor.
    154124
    155 @ifinfo
    156 @node Disabling of Interrupts by RTEMS, Interrupt Manager Operations, RTEMS Interrupt Levels, Interrupt Manager Background
    157 @end ifinfo
    158125@subsection Disabling of Interrupts by RTEMS
    159126
     
    176143execute as non-maskable interrupts.
    177144
    178 @ifinfo
    179 @node Interrupt Manager Operations, Establishing an ISR, Disabling of Interrupts by RTEMS, Interrupt Manager
    180 @end ifinfo
    181145@section Operations
    182 @ifinfo
    183 @menu
    184 * Establishing an ISR::
    185 * Directives Allowed from an ISR::
    186 @end menu
    187 @end ifinfo
    188 
    189 @ifinfo
    190 @node Establishing an ISR, Directives Allowed from an ISR, Interrupt Manager Operations, Interrupt Manager Operations
    191 @end ifinfo
     146
    192147@subsection Establishing an ISR
    193148
     
    201156contents of the specified vector in the RTEMS' Vector Table.
    202157
    203 @ifinfo
    204 @node Directives Allowed from an ISR, Interrupt Manager Directives, Establishing an ISR, Interrupt Manager Operations
    205 @end ifinfo
    206158@subsection Directives Allowed from an ISR
    207159
     
    267219@end itemize
    268220
    269 @ifinfo
    270 @node Interrupt Manager Directives, INTERRUPT_CATCH - Establish an ISR, Directives Allowed from an ISR, Interrupt Manager
    271 @end ifinfo
    272221@section Directives
    273 @ifinfo
    274 @menu
    275 * INTERRUPT_CATCH - Establish an ISR::
    276 * INTERRUPT_DISABLE - Disable Interrupts::
    277 * INTERRUPT_ENABLE - Enable Interrupts::
    278 * INTERRUPT_FLASH - Flash Interrupts::
    279 * INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress::
    280 @end menu
    281 @end ifinfo
    282222
    283223This section details the interrupt manager's
     
    287227
    288228@page
    289 @ifinfo
    290 @node INTERRUPT_CATCH - Establish an ISR, INTERRUPT_DISABLE - Disable Interrupts, Interrupt Manager Directives, Interrupt Manager Directives
    291 @end ifinfo
    292229@subsection INTERRUPT_CATCH - Establish an ISR
    293230
     
    333270
    334271@page
    335 @ifinfo
    336 @node INTERRUPT_DISABLE - Disable Interrupts, INTERRUPT_ENABLE - Enable Interrupts, INTERRUPT_CATCH - Establish an ISR, Interrupt Manager Directives
    337 @end ifinfo
    338272@subsection INTERRUPT_DISABLE - Disable Interrupts
    339273
     
    376310
    377311@page
    378 @ifinfo
    379 @node INTERRUPT_ENABLE - Enable Interrupts, INTERRUPT_FLASH - Flash Interrupts, INTERRUPT_DISABLE - Disable Interrupts, Interrupt Manager Directives
    380 @end ifinfo
    381312@subsection INTERRUPT_ENABLE - Enable Interrupts
    382313
     
    418349
    419350@page
    420 @ifinfo
    421 @node INTERRUPT_FLASH - Flash Interrupts, INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress, INTERRUPT_ENABLE - Enable Interrupts, Interrupt Manager Directives
    422 @end ifinfo
    423351@subsection INTERRUPT_FLASH - Flash Interrupts
    424352
     
    459387
    460388@page
    461 @ifinfo
    462 @node INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress, Clock Manager, INTERRUPT_FLASH - Flash Interrupts, Interrupt Manager Directives
    463 @end ifinfo
    464389@subsection INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress
    465390
  • doc/user/io.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node I/O Manager, I/O Manager Introduction, PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address, Top
    11 @end ifinfo
    129@chapter I/O Manager
    13 @ifinfo
    14 @menu
    15 * I/O Manager Introduction::
    16 * I/O Manager Background::
    17 * I/O Manager Operations::
    18 * I/O Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node I/O Manager Introduction, I/O Manager Background, I/O Manager, I/O Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    4127@end itemize
    4228
    43 
    44 
    45 @ifinfo
    46 @node I/O Manager Background, Device Driver Table, I/O Manager Introduction, I/O Manager
    47 @end ifinfo
    4829@section Background
    49 @ifinfo
    50 @menu
    51 * Device Driver Table::
    52 * Major and Minor Device Numbers::
    53 * Device Names::
    54 * Device Driver Environment::
    55 * Device Driver Interface::
    56 * Device Driver Initialization::
    57 @end menu
    58 @end ifinfo
    59 
    60 @ifinfo
    61 @node Device Driver Table, Major and Minor Device Numbers, I/O Manager Background, I/O Manager Background
    62 @end ifinfo
     30
    6331@subsection Device Driver Table
    6432
     
    8553driver entry points.
    8654
    87 @ifinfo
    88 @node Major and Minor Device Numbers, Device Names, Device Driver Table, I/O Manager Background
    89 @end ifinfo
    9055@subsection Major and Minor Device Numbers
    9156
     
    9863controlled by the same driver.
    9964
    100 @ifinfo
    101 @node Device Names, Device Driver Environment, Major and Minor Device Numbers, I/O Manager Background
    102 @end ifinfo
    10365@subsection Device Names
    10466
     
    10870number pair associated with a device name.
    10971
    110 @ifinfo
    111 @node Device Driver Environment, Device Driver Interface, Device Names, I/O Manager Background
    112 @end ifinfo
    11372@subsection Device Driver Environment
    11473
     
    141100construction or operation of a device driver.
    142101
    143 @ifinfo
    144 @node Device Driver Interface, Device Driver Initialization, Device Driver Environment, I/O Manager Background
    145 @end ifinfo
    146102@subsection Device Driver Interface
    147103
     
    182138of the status indicate a driver specific code.
    183139
    184 @ifinfo
    185 @node Device Driver Initialization, I/O Manager Operations, Device Driver Interface, I/O Manager Background
    186 @end ifinfo
    187140@subsection Device Driver Initialization
    188141
     
    209162the fatal_error_occurred directive.
    210163
    211 @ifinfo
    212 @node I/O Manager Operations, Register and Lookup Name, Device Driver Initialization, I/O Manager
    213 @end ifinfo
    214164@section Operations
    215 @ifinfo
    216 @menu
    217 * Register and Lookup Name::
    218 * Accessing an Device Driver::
    219 @end menu
    220 @end ifinfo
    221 
    222 @ifinfo
    223 @node Register and Lookup Name, Accessing an Device Driver, I/O Manager Operations, I/O Manager Operations
    224 @end ifinfo
     165
    225166@subsection Register and Lookup Name
    226167
     
    236177conventions are dictated by RTEMS.
    237178
    238 @ifinfo
    239 @node Accessing an Device Driver, I/O Manager Directives, Register and Lookup Name, I/O Manager Operations
    240 @end ifinfo
    241179@subsection Accessing an Device Driver
    242180
     
    253191and the underlying device driver entry points.
    254192
    255 @ifinfo
    256 @node I/O Manager Directives, IO_INITIALIZE - Initialize a device driver, Accessing an Device Driver, I/O Manager
    257 @end ifinfo
    258193@section Directives
    259 @ifinfo
    260 @menu
    261 * IO_INITIALIZE - Initialize a device driver::
    262 * IO_REGISTER_NAME - Register a device::
    263 * IO_LOOKUP_NAME - Lookup a device::
    264 * IO_OPEN - Open a device::
    265 * IO_CLOSE - Close a device::
    266 * IO_READ - Read from a device::
    267 * IO_WRITE - Write to a device::
    268 * IO_CONTROL - Special device services::
    269 @end menu
    270 @end ifinfo
    271194
    272195This section details the I/O manager's directives.  A
     
    276199
    277200@page
    278 @ifinfo
    279 @node IO_INITIALIZE - Initialize a device driver, IO_REGISTER_NAME - Register a device, I/O Manager Directives, I/O Manager Directives
    280 @end ifinfo
    281201@subsection IO_INITIALIZE - Initialize a device driver
    282202
     
    329249
    330250@page
    331 @ifinfo
    332 @node IO_REGISTER_NAME - Register a device, IO_LOOKUP_NAME - Lookup a device, IO_INITIALIZE - Initialize a device driver, I/O Manager Directives
    333 @end ifinfo
    334251@subsection IO_REGISTER_NAME - Register a device
    335252
     
    372289
    373290@page
    374 @ifinfo
    375 @node IO_LOOKUP_NAME - Lookup a device, IO_OPEN - Open a device, IO_REGISTER_NAME - Register a device, I/O Manager Directives
    376 @end ifinfo
    377291@subsection IO_LOOKUP_NAME - Lookup a device
    378292
     
    413327
    414328@page
    415 @ifinfo
    416 @node IO_OPEN - Open a device, IO_CLOSE - Close a device, IO_LOOKUP_NAME - Lookup a device, I/O Manager Directives
    417 @end ifinfo
    418329@subsection IO_OPEN - Open a device
    419330
     
    460371
    461372@page
    462 @ifinfo
    463 @node IO_CLOSE - Close a device, IO_READ - Read from a device, IO_OPEN - Open a device, I/O Manager Directives
    464 @end ifinfo
    465373@subsection IO_CLOSE - Close a device
    466374
     
    507415
    508416@page
    509 @ifinfo
    510 @node IO_READ - Read from a device, IO_WRITE - Write to a device, IO_CLOSE - Close a device, I/O Manager Directives
    511 @end ifinfo
    512417@subsection IO_READ - Read from a device
    513418
     
    555460
    556461@page
    557 @ifinfo
    558 @node IO_WRITE - Write to a device, IO_CONTROL - Special device services, IO_READ - Read from a device, I/O Manager Directives
    559 @end ifinfo
    560462@subsection IO_WRITE - Write to a device
    561463
     
    603505
    604506@page
    605 @ifinfo
    606 @node IO_CONTROL - Special device services, Fatal Error Manager, IO_WRITE - Write to a device, I/O Manager Directives
    607 @end ifinfo
    608507@subsection IO_CONTROL - Special device services
    609508
  • doc/user/mp.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Multiprocessing Manager, Multiprocessing Manager Introduction, Configuring a System Sizing the RTEMS RAM Workspace, Top
    11 @end ifinfo
    129@chapter Multiprocessing Manager
    13 @ifinfo
    14 @menu
    15 * Multiprocessing Manager Introduction::
    16 * Multiprocessing Manager Background::
    17 * Multiprocessing Manager Multiprocessor Communications Interface Layer::
    18 * Multiprocessing Manager Operations::
    19 * Multiprocessing Manager Directives::
    20 @end menu
    21 @end ifinfo
    22 
    23 @ifinfo
    24 @node Multiprocessing Manager Introduction, Multiprocessing Manager Background, Multiprocessing Manager, Multiprocessing Manager
    25 @end ifinfo
     10
    2611@section Introduction
    2712
     
    5742software, to be viewed logically as a single system.
    5843
    59 @ifinfo
    60 @node Multiprocessing Manager Background, Nodes, Multiprocessing Manager Introduction, Multiprocessing Manager
    61 @end ifinfo
    6244@section Background
    63 @ifinfo
    64 @menu
    65 * Nodes::
    66 * Global Objects::
    67 * Global Object Table::
    68 * Remote Operations::
    69 * Proxies::
    70 * Multiprocessor Configuration Table::
    71 @end menu
    72 @end ifinfo
    7345
    7446RTEMS makes no assumptions regarding the connection
     
    9769heterogeneous processing required is isolated in the MPCI layer.
    9870
    99 @ifinfo
    100 @node Nodes, Global Objects, Multiprocessing Manager Background, Multiprocessing Manager Background
    101 @end ifinfo
    10271@subsection Nodes
    10372
     
    11786able to route messages based on the node number.
    11887
    119 @ifinfo
    120 @node Global Objects, Global Object Table, Nodes, Multiprocessing Manager Background
    121 @end ifinfo
    12288@subsection Global Objects
    12389
     
    134100relocation is not supported by RTEMS.
    135101
    136 @ifinfo
    137 @node Global Object Table, Remote Operations, Global Objects, Multiprocessing Manager Background
    138 @end ifinfo
    139102@subsection Global Object Table
    140103
     
    159122of a global object.
    160123
    161 @ifinfo
    162 @node Remote Operations, Proxies, Global Object Table, Multiprocessing Manager Background
    163 @end ifinfo
    164124@subsection Remote Operations
    165125
     
    230190the MPCI and makes no attempt to detect or correct errors.
    231191
    232 @ifinfo
    233 @node Proxies, Multiprocessor Configuration Table, Remote Operations, Multiprocessing Manager Background
    234 @end ifinfo
    235192@subsection Proxies
    236193
     
    253210tasks.
    254211
    255 @ifinfo
    256 @node Multiprocessor Configuration Table, Multiprocessing Manager Multiprocessor Communications Interface Layer, Proxies, Multiprocessing Manager Background
    257 @end ifinfo
    258212@subsection Multiprocessor Configuration Table
    259213
     
    264218chapter.
    265219
    266 @ifinfo
    267 @node Multiprocessing Manager Multiprocessor Communications Interface Layer, INITIALIZATION, Multiprocessor Configuration Table, Multiprocessing Manager
    268 @end ifinfo
    269220@section Multiprocessor Communications Interface Layer
    270 @ifinfo
    271 @menu
    272 * INITIALIZATION::
    273 * GET_PACKET::
    274 * RETURN_PACKET::
    275 * RECEIVE_PACKET::
    276 * SEND_PACKET::
    277 * Supporting Heterogeneous Environments::
    278 @end menu
    279 @end ifinfo
    280221
    281222The Multiprocessor Communications Interface Layer
     
    333274copy the message into the buffer obtained.
    334275
    335 @ifinfo
    336 @node INITIALIZATION, GET_PACKET, Multiprocessing Manager Multiprocessor Communications Interface Layer, Multiprocessing Manager Multiprocessor Communications Interface Layer
    337 @end ifinfo
    338276@subsection INITIALIZATION
    339277
     
    376314whenever needed.
    377315
    378 @ifinfo
    379 @node GET_PACKET, RETURN_PACKET, INITIALIZATION, Multiprocessing Manager Multiprocessor Communications Interface Layer
    380 @end ifinfo
    381316@subsection GET_PACKET
    382317
     
    416351arrived.
    417352
    418 @ifinfo
    419 @node RETURN_PACKET, RECEIVE_PACKET, GET_PACKET, Multiprocessing Manager Multiprocessor Communications Interface Layer
    420 @end ifinfo
    421353@subsection RETURN_PACKET
    422354
     
    448380should be invoked.
    449381
    450 @ifinfo
    451 @node RECEIVE_PACKET, SEND_PACKET, RETURN_PACKET, Multiprocessing Manager Multiprocessor Communications Interface Layer
    452 @end ifinfo
    453382@subsection RECEIVE_PACKET
    454383
     
    482411packet should contain NULL.
    483412
    484 @ifinfo
    485 @node SEND_PACKET, Supporting Heterogeneous Environments, RECEIVE_PACKET, Multiprocessing Manager Multiprocessor Communications Interface Layer
    486 @end ifinfo
    487413@subsection SEND_PACKET
    488414
     
    530456heterogeneous system.
    531457
    532 @ifinfo
    533 @node Supporting Heterogeneous Environments, Multiprocessing Manager Operations, SEND_PACKET, Multiprocessing Manager Multiprocessor Communications Interface Layer
    534 @end ifinfo
    535458@subsection Supporting Heterogeneous Environments
    536459
     
    615538@end itemize
    616539
    617 @ifinfo
    618 @node Multiprocessing Manager Operations, Announcing a Packet, Supporting Heterogeneous Environments, Multiprocessing Manager
    619 @end ifinfo
    620540@section Operations
    621 @ifinfo
    622 @menu
    623 * Announcing a Packet::
    624 @end menu
    625 @end ifinfo
    626 
    627 @ifinfo
    628 @node Announcing a Packet, Multiprocessing Manager Directives, Multiprocessing Manager Operations, Multiprocessing Manager Operations
    629 @end ifinfo
     541
    630542@subsection Announcing a Packet
    631543
     
    635547service routine or from within a polling routine.
    636548
    637 @ifinfo
    638 @node Multiprocessing Manager Directives, MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet, Announcing a Packet, Multiprocessing Manager
    639 @end ifinfo
    640549@section Directives
    641 @ifinfo
    642 @menu
    643 * MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet::
    644 @end menu
    645 @end ifinfo
    646550
    647551This section details the additional directives
     
    652556
    653557@page
    654 @ifinfo
    655 @node MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet, Directive Status Codes, Multiprocessing Manager Directives, Multiprocessing Manager Directives
    656 @end ifinfo
    657558@subsection MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
    658559
  • doc/user/msg.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Message Manager, Message Manager Introduction, SEMAPHORE_RELEASE - Release a semaphore, Top
    11 @end ifinfo
    129@chapter Message Manager
    13 @ifinfo
    14 @menu
    15 * Message Manager Introduction::
    16 * Message Manager Background::
    17 * Message Manager Operations::
    18 * Message Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Message Manager Introduction, Message Manager Background, Message Manager, Message Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    4127@end itemize
    4228
    43 @ifinfo
    44 @node Message Manager Background, Messages, Message Manager Introduction, Message Manager
    45 @end ifinfo
    4629@section Background
    47 @ifinfo
    48 @menu
    49 * Messages::
    50 * Message Queues::
    51 * Building a Message Queue's Attribute Set::
    52 * Building a MESSAGE_QUEUE_RECEIVE Option Set::
    53 @end menu
    54 @end ifinfo
    55 
    56 @ifinfo
    57 @node Messages, Message Queues, Message Manager Background, Message Manager Background
    58 @end ifinfo
     30
    5931@subsection Messages
    6032
     
    6436user-defined and can be actual data, pointer(s), or empty.
    6537
    66 @ifinfo
    67 @node Message Queues, Building a Message Queue's Attribute Set, Messages, Message Manager Background
    68 @end ifinfo
    6938@subsection Message Queues
    7039
     
    8453on a per message queue basis.
    8554
    86 @ifinfo
    87 @node Building a Message Queue's Attribute Set, Building a MESSAGE_QUEUE_RECEIVE Option Set, Message Queues, Message Manager Background
    88 @end ifinfo
    8955@subsection Building a Message Queue's Attribute Set
    9056
     
    11985@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}.
    12086
    121 @ifinfo
    122 @node Building a MESSAGE_QUEUE_RECEIVE Option Set, Message Manager Operations, Building a Message Queue's Attribute Set, Message Manager Background
    123 @end ifinfo
    12487@subsection Building a MESSAGE_QUEUE_RECEIVE Option Set
    12588
     
    145108be @code{@value{RPREFIX}NO_WAIT}.
    146109
    147 @ifinfo
    148 @node Message Manager Operations, Creating a Message Queue, Building a MESSAGE_QUEUE_RECEIVE Option Set, Message Manager
    149 @end ifinfo
    150110@section Operations
    151 @ifinfo
    152 @menu
    153 * Creating a Message Queue::
    154 * Obtaining Message Queue IDs::
    155 * Receiving a Message::
    156 * Sending a Message::
    157 * Broadcasting a Message::
    158 * Deleting a Message Queue::
    159 @end menu
    160 @end ifinfo
    161 
    162 @ifinfo
    163 @node Creating a Message Queue, Obtaining Message Queue IDs, Message Manager Operations, Message Manager Operations
    164 @end ifinfo
     111
    165112@subsection Creating a Message Queue
    166113
     
    180127capable of transmitting.
    181128
    182 @ifinfo
    183 @node Obtaining Message Queue IDs, Receiving a Message, Creating a Message Queue, Message Manager Operations
    184 @end ifinfo
    185129@subsection Obtaining Message Queue IDs
    186130
     
    194138directives to access this message queue.
    195139
    196 @ifinfo
    197 @node Receiving a Message, Sending a Message, Obtaining Message Queue IDs, Message Manager Operations
    198 @end ifinfo
    199140@subsection Receiving a Message
    200141
     
    223164returned an error code when the message queue is deleted.
    224165
    225 @ifinfo
    226 @node Sending a Message, Broadcasting a Message, Receiving a Message, Message Manager Operations
    227 @end ifinfo
    228166@subsection Sending a Message
    229167
     
    246184messages.
    247185
    248 @ifinfo
    249 @node Broadcasting a Message, Deleting a Message Queue, Sending a Message, Message Manager Operations
    250 @end ifinfo
    251186@subsection Broadcasting a Message
    252187
     
    257192tasks which were unblocked is returned to the caller.
    258193
    259 @ifinfo
    260 @node Deleting a Message Queue, Message Manager Directives, Broadcasting a Message, Message Manager Operations
    261 @end ifinfo
    262194@subsection Deleting a Message Queue
    263195
     
    273205at the message queue are also deleted and deallocated.
    274206
    275 @ifinfo
    276 @node Message Manager Directives, MESSAGE_QUEUE_CREATE - Create a queue, Deleting a Message Queue, Message Manager
    277 @end ifinfo
    278207@section Directives
    279 @ifinfo
    280 @menu
    281 * MESSAGE_QUEUE_CREATE - Create a queue::
    282 * MESSAGE_QUEUE_IDENT - Get ID of a queue::
    283 * MESSAGE_QUEUE_DELETE - Delete a queue::
    284 * MESSAGE_QUEUE_SEND - Put message at rear of a queue::
    285 * MESSAGE_QUEUE_URGENT - Put message at front of a queue::
    286 * MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue::
    287 * MESSAGE_QUEUE_RECEIVE - Receive message from a queue::
    288 * MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue::
    289 * MESSAGE_QUEUE_FLUSH - Flush all messages on a queue::
    290 @end menu
    291 @end ifinfo
    292208
    293209This section details the message manager's
     
    297213
    298214@page
    299 @ifinfo
    300 @node MESSAGE_QUEUE_CREATE - Create a queue, MESSAGE_QUEUE_IDENT - Get ID of a queue, Message Manager Directives, Message Manager Directives
    301 @end ifinfo
    302215@subsection MESSAGE_QUEUE_CREATE - Create a queue
    303216
     
    385298
    386299@page
    387 @ifinfo
    388 @node MESSAGE_QUEUE_IDENT - Get ID of a queue, MESSAGE_QUEUE_DELETE - Delete a queue, MESSAGE_QUEUE_CREATE - Create a queue, Message Manager Directives
    389 @end ifinfo
    390300@subsection MESSAGE_QUEUE_IDENT - Get ID of a queue
    391301
     
    445355
    446356@page
    447 @ifinfo
    448 @node MESSAGE_QUEUE_DELETE - Delete a queue, MESSAGE_QUEUE_SEND - Put message at rear of a queue, MESSAGE_QUEUE_IDENT - Get ID of a queue, Message Manager Directives
    449 @end ifinfo
    450357@subsection MESSAGE_QUEUE_DELETE - Delete a queue
    451358
     
    509416
    510417@page
    511 @ifinfo
    512 @node MESSAGE_QUEUE_SEND - Put message at rear of a queue, MESSAGE_QUEUE_URGENT - Put message at front of a queue, MESSAGE_QUEUE_DELETE - Delete a queue, Message Manager Directives
    513 @end ifinfo
    514418@subsection MESSAGE_QUEUE_SEND - Put message at rear of a queue
    515419
     
    570474
    571475@page
    572 @ifinfo
    573 @node MESSAGE_QUEUE_URGENT - Put message at front of a queue, MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue, MESSAGE_QUEUE_SEND - Put message at rear of a queue, Message Manager Directives
    574 @end ifinfo
    575476@subsection MESSAGE_QUEUE_URGENT - Put message at front of a queue
    576477
     
    632533
    633534@page
    634 @ifinfo
    635 @node MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue, MESSAGE_QUEUE_RECEIVE - Receive message from a queue, MESSAGE_QUEUE_URGENT - Put message at front of a queue, Message Manager Directives
    636 @end ifinfo
    637535@subsection MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue
    638536
     
    698596
    699597@page
    700 @ifinfo
    701 @node MESSAGE_QUEUE_RECEIVE - Receive message from a queue, MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue, MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue, Message Manager Directives
    702 @end ifinfo
    703598@subsection MESSAGE_QUEUE_RECEIVE - Receive message from a queue
    704599
     
    787682
    788683@page
    789 @ifinfo
    790 @node MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue, MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, MESSAGE_QUEUE_RECEIVE - Receive message from a queue, Message Manager Directives
    791 @end ifinfo
    792684@subsection MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
    793685
     
    832724
    833725@page
    834 @ifinfo
    835 @node MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, Event Manager, MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue, Message Manager Directives
    836 @end ifinfo
    837726@subsection MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
    838727
  • doc/user/overview.t

    r1f020c6 r20515fc  
    1414@c
    1515
    16 @ifinfo
    17 @node Overview, Overview Introduction, Preface, Top
    18 @end ifinfo
    1916@chapter Overview
    20 @ifinfo
    21 @menu
    22 * Overview Introduction::
    23 * Overview Real-time Application Systems::
    24 * Overview Real-time Executive::
    25 * Overview RTEMS Application Architecture::
    26 * Overview RTEMS Internal Architecture::
    27 * Overview User Customization and Extensibility::
    28 * Overview Portability::
    29 * Overview Memory Requirements::
    30 * Overview Audience::
    31 * Overview Conventions::
    32 * Overview Manual Organization::
    33 @end menu
    34 @end ifinfo
    35 
    36 @ifinfo
    37 @node Overview Introduction, Overview Real-time Application Systems, Overview, Overview
    38 @end ifinfo
     17
    3918@section Introduction
    4019
     
    6443supported.
    6544
    66 @ifinfo
    67 @node Overview Real-time Application Systems, Overview Real-time Executive, Overview Introduction, Overview
    68 @end ifinfo
    6945@section Real-time Application Systems
    7046
     
    10985characteristic of a real-time system.
    11086
    111 @ifinfo
    112 @node Overview Real-time Executive, Overview RTEMS Application Architecture, Overview Real-time Application Systems, Overview
    113 @end ifinfo
    11487@section Real-time Executive
    11588
     
    160133applications is significantly reduced.
    161134
    162 @ifinfo
    163 @node Overview RTEMS Application Architecture, Overview RTEMS Internal Architecture, Overview Real-time Executive, Overview
    164 @end ifinfo
    165135@section RTEMS Application Architecture
    166136
     
    253223@end ifset
    254224
    255 @ifinfo
    256 @node Overview RTEMS Internal Architecture, Overview User Customization and Extensibility, Overview RTEMS Application Architecture, Overview
    257 @end ifinfo
    258225@section RTEMS Internal Architecture
    259226
     
    328295@end itemize
    329296
    330 @ifinfo
    331 @node Overview User Customization and Extensibility, Overview Portability, Overview RTEMS Internal Architecture, Overview
    332 @end ifinfo
    333297@section User Customization and Extensibility
    334298
     
    351315as possible.
    352316
    353 @ifinfo
    354 @node Overview Portability, Overview Memory Requirements, Overview User Customization and Extensibility, Overview
    355 @end ifinfo
    356317@section Portability
    357318
     
    364325microprocessor architecture.
    365326
    366 @ifinfo
    367 @node Overview Memory Requirements, Overview Audience, Overview Portability, Overview
    368 @end ifinfo
    369327@section Memory Requirements
    370328
     
    402360located in either ROM or RAM.
    403361
    404 @ifinfo
    405 @node Overview Audience, Overview Conventions, Overview Memory Requirements, Overview
    406 @end ifinfo
    407362@section Audience
    408363
     
    426381document.
    427382
    428 @ifinfo
    429 @node Overview Conventions, Overview Manual Organization, Overview Audience, Overview
    430 @end ifinfo
    431383@section Conventions
    432384
     
    451403@end itemize
    452404
    453 @ifinfo
    454 @node Overview Manual Organization, Key Concepts, Overview Conventions, Overview
    455 @end ifinfo
    456405@section Manual Organization
    457406
  • doc/user/part.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Partition Manager, Partition Manager Introduction, SIGNAL_SEND - Send signal set to a task, Top
    11 @end ifinfo
    129@chapter Partition Manager
    13 @ifinfo
    14 @menu
    15 * Partition Manager Introduction::
    16 * Partition Manager Background::
    17 * Partition Manager Operations::
    18 * Partition Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Partition Manager Introduction, Partition Manager Background, Partition Manager, Partition Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3723@end itemize
    3824
    39 @ifinfo
    40 @node Partition Manager Background, Partition Manager Definitions, Partition Manager Introduction, Partition Manager
    41 @end ifinfo
    4225@section Background
    43 @ifinfo
    44 @menu
    45 * Partition Manager Definitions::
    46 * Building a Partition's Attribute Set::
    47 @end menu
    48 @end ifinfo
    49 
    50 @ifinfo
    51 @node Partition Manager Definitions, Building a Partition's Attribute Set, Partition Manager Background, Partition Manager Background
    52 @end ifinfo
     26
    5327@subsection Partition Manager Definitions
    5428
     
    6741adjacent allocated buffer.
    6842
    69 @ifinfo
    70 @node Building a Partition's Attribute Set, Partition Manager Operations, Partition Manager Definitions, Partition Manager Background
    71 @end ifinfo
    7243@subsection Building a Partition's Attribute Set
    7344
     
    9465is to be known globally.
    9566
    96 @ifinfo
    97 @node Partition Manager Operations, Creating a Partition, Building a Partition's Attribute Set, Partition Manager
    98 @end ifinfo
    9967@section Operations
    100 @ifinfo
    101 @menu
    102 * Creating a Partition::
    103 * Obtaining Partition IDs::
    104 * Acquiring a Buffer::
    105 * Releasing a Buffer::
    106 * Deleting a Partition::
    107 @end menu
    108 @end ifinfo
    109 
    110 @ifinfo
    111 @node Creating a Partition, Obtaining Partition IDs, Partition Manager Operations, Partition Manager Operations
    112 @end ifinfo
     68
    11369@subsection Creating a Partition
    11470
     
    12480calling task along with a unique partition ID.
    12581
    126 @ifinfo
    127 @node Obtaining Partition IDs, Acquiring a Buffer, Creating a Partition, Partition Manager Operations
    128 @end ifinfo
    12982@subsection Obtaining Partition IDs
    13083
     
    13992to access this partition.
    14093
    141 @ifinfo
    142 @node Acquiring a Buffer, Releasing a Buffer, Obtaining Partition IDs, Partition Manager Operations
    143 @end ifinfo
    14494@subsection Acquiring a Buffer
    14595
     
    152102become available.
    153103
    154 @ifinfo
    155 @node Releasing a Buffer, Deleting a Partition, Acquiring a Buffer, Partition Manager Operations
    156 @end ifinfo
    157104@subsection Releasing a Buffer
    158105
     
    162109was not previously allocated from this partition.
    163110
    164 @ifinfo
    165 @node Deleting a Partition, Partition Manager Directives, Releasing a Buffer, Partition Manager Operations
    166 @end ifinfo
    167111@subsection Deleting a Partition
    168112
     
    173117task attempting to do so will be returned an error status code.
    174118
    175 @ifinfo
    176 @node Partition Manager Directives, PARTITION_CREATE - Create a partition, Deleting a Partition, Partition Manager
    177 @end ifinfo
    178119@section Directives
    179 @ifinfo
    180 @menu
    181 * PARTITION_CREATE - Create a partition::
    182 * PARTITION_IDENT - Get ID of a partition::
    183 * PARTITION_DELETE - Delete a partition::
    184 * PARTITION_GET_BUFFER - Get buffer from a partition::
    185 * PARTITION_RETURN_BUFFER - Return buffer to a partition::
    186 @end menu
    187 @end ifinfo
    188120
    189121This section details the partition manager's
     
    193125
    194126@page
    195 @ifinfo
    196 @node PARTITION_CREATE - Create a partition, PARTITION_IDENT - Get ID of a partition, Partition Manager Directives, Partition Manager Directives
    197 @end ifinfo
    198127@subsection PARTITION_CREATE - Create a partition
    199128
     
    282211
    283212@page
    284 @ifinfo
    285 @node PARTITION_IDENT - Get ID of a partition, PARTITION_DELETE - Delete a partition, PARTITION_CREATE - Create a partition, Partition Manager Directives
    286 @end ifinfo
    287213@subsection PARTITION_IDENT - Get ID of a partition
    288214
     
    342268
    343269@page
    344 @ifinfo
    345 @node PARTITION_DELETE - Delete a partition, PARTITION_GET_BUFFER - Get buffer from a partition, PARTITION_IDENT - Get ID of a partition, Partition Manager Directives
    346 @end ifinfo
    347270@subsection PARTITION_DELETE - Delete a partition
    348271
     
    396319
    397320@page
    398 @ifinfo
    399 @node PARTITION_GET_BUFFER - Get buffer from a partition, PARTITION_RETURN_BUFFER - Return buffer to a partition, PARTITION_DELETE - Delete a partition, Partition Manager Directives
    400 @end ifinfo
    401321@subsection PARTITION_GET_BUFFER - Get buffer from a partition
    402322
     
    447367
    448368@page
    449 @ifinfo
    450 @node PARTITION_RETURN_BUFFER - Return buffer to a partition, Region Manager, PARTITION_GET_BUFFER - Get buffer from a partition, Partition Manager Directives
    451 @end ifinfo
    452369@subsection PARTITION_RETURN_BUFFER - Return buffer to a partition
    453370
  • doc/user/region.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Region Manager, Region Manager Introduction, PARTITION_RETURN_BUFFER - Return buffer to a partition, Top
    11 @end ifinfo
    129@chapter Region Manager
    13 @ifinfo
    14 @menu
    15 * Region Manager Introduction::
    16 * Region Manager Background::
    17 * Region Manager Operations::
    18 * Region Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Region Manager Introduction, Region Manager Background, Region Manager, Region Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3925@end itemize
    4026
    41 @ifinfo
    42 @node Region Manager Background, Region Manager Definitions, Region Manager Introduction, Region Manager
    43 @end ifinfo
    4427@section Background
    45 @ifinfo
    46 @menu
    47 * Region Manager Definitions::
    48 * Building an Attribute Set::
    49 * Building an Option Set::
    50 @end menu
    51 @end ifinfo
    52 
    53 @ifinfo
    54 @node Region Manager Definitions, Building an Attribute Set, Region Manager Background, Region Manager Background
    55 @end ifinfo
     28
    5629@subsection Region Manager Definitions
    5730
     
    8154the largest possible unused block.
    8255
    83 @ifinfo
    84 @node Building an Attribute Set, Building an Option Set, Region Manager Definitions, Region Manager Background
    85 @end ifinfo
    8656@subsection Building an Attribute Set
    8757
     
    11181directive should be @code{@value{RPREFIX}PRIORITY}.
    11282
    113 @ifinfo
    114 @node Building an Option Set, Region Manager Operations, Building an Attribute Set, Region Manager Background
    115 @end ifinfo
    11683@subsection Building an Option Set
    11784
     
    141108be @code{@value{RPREFIX}NO_WAIT}.
    142109
    143 @ifinfo
    144 @node Region Manager Operations, Creating a Region, Building an Option Set, Region Manager
    145 @end ifinfo
    146110@section Operations
    147 @ifinfo
    148 @menu
    149 * Creating a Region::
    150 * Obtaining Region IDs::
    151 * Adding Memory to a Region::
    152 * Acquiring a Segment::
    153 * Releasing a Segment::
    154 * Obtaining the Size of a Segment::
    155 * Deleting a Region::
    156 @end menu
    157 @end ifinfo
    158 
    159 @ifinfo
    160 @node Creating a Region, Obtaining Region IDs, Region Manager Operations, Region Manager Operations
    161 @end ifinfo
     111
    162112@subsection Creating a Region
    163113
     
    182132overhead required by RTEMS dynamically changes.
    183133
    184 @ifinfo
    185 @node Obtaining Region IDs, Adding Memory to a Region, Creating a Region, Region Manager Operations
    186 @end ifinfo
    187134@subsection Obtaining Region IDs
    188135
     
    198145access this region.
    199146
    200 @ifinfo
    201 @node Adding Memory to a Region, Acquiring a Segment, Obtaining Region IDs, Region Manager Operations
    202 @end ifinfo
    203147@subsection Adding Memory to a Region
    204148
     
    212156region.
    213157
    214 @ifinfo
    215 @node Acquiring a Segment, Releasing a Segment, Adding Memory to a Region, Region Manager Operations
    216 @end ifinfo
    217158@subsection Acquiring a Segment
    218159
     
    238179the message queue is deleted.
    239180
    240 @ifinfo
    241 @node Releasing a Segment, Obtaining the Size of a Segment, Acquiring a Segment, Region Manager Operations
    242 @end ifinfo
    243181@subsection Releasing a Segment
    244182
     
    251189task's segment request cannot be satisfied.
    252190
    253 @ifinfo
    254 @node Obtaining the Size of a Segment, Deleting a Region, Releasing a Segment, Region Manager Operations
    255 @end ifinfo
    256191@subsection Obtaining the Size of a Segment
    257192
     
    261196rounding up to a page size boundary.
    262197
    263 @ifinfo
    264 @node Deleting a Region, Region Manager Directives, Obtaining the Size of a Segment, Region Manager Operations
    265 @end ifinfo
    266198@subsection Deleting a Region
    267199
     
    276208a status code which indicates that the region was deleted.
    277209
    278 @ifinfo
    279 @node Region Manager Directives, REGION_CREATE - Create a region, Deleting a Region, Region Manager
    280 @end ifinfo
    281210@section Directives
    282 @ifinfo
    283 @menu
    284 * REGION_CREATE - Create a region::
    285 * REGION_IDENT - Get ID of a region::
    286 * REGION_DELETE - Delete a region::
    287 * REGION_EXTEND - Add memory to a region::
    288 * REGION_GET_SEGMENT - Get segment from a region::
    289 * REGION_RETURN_SEGMENT - Return segment to a region::
    290 * REGION_GET_SEGMENT_SIZE - Obtain size of a segment::
    291 @end menu
    292 @end ifinfo
    293211
    294212This section details the region manager's directives.
     
    298216
    299217@page
    300 @ifinfo
    301 @node REGION_CREATE - Create a region, REGION_IDENT - Get ID of a region, Region Manager Directives, Region Manager Directives
    302 @end ifinfo
    303218@subsection REGION_CREATE - Create a region
    304219
     
    379294
    380295@page
    381 @ifinfo
    382 @node REGION_IDENT - Get ID of a region, REGION_DELETE - Delete a region, REGION_CREATE - Create a region, Region Manager Directives
    383 @end ifinfo
    384296@subsection REGION_IDENT - Get ID of a region
    385297
     
    424336
    425337@page
    426 @ifinfo
    427 @node REGION_DELETE - Delete a region, REGION_EXTEND - Add memory to a region, REGION_IDENT - Get ID of a region, Region Manager Directives
    428 @end ifinfo
    429338@subsection REGION_DELETE - Delete a region
    430339
     
    470379
    471380@page
    472 @ifinfo
    473 @node REGION_EXTEND - Add memory to a region, REGION_GET_SEGMENT - Get segment from a region, REGION_DELETE - Delete a region, Region Manager Directives
    474 @end ifinfo
    475381@subsection REGION_EXTEND - Add memory to a region
    476382
     
    518424
    519425@page
    520 @ifinfo
    521 @node REGION_GET_SEGMENT - Get segment from a region, REGION_RETURN_SEGMENT - Return segment to a region, REGION_EXTEND - Add memory to a region, Region Manager Directives
    522 @end ifinfo
    523426@subsection REGION_GET_SEGMENT - Get segment from a region
    524427
     
    608511
    609512@page
    610 @ifinfo
    611 @node REGION_RETURN_SEGMENT - Return segment to a region, REGION_GET_SEGMENT_SIZE - Obtain size of a segment, REGION_GET_SEGMENT - Get segment from a region, Region Manager Directives
    612 @end ifinfo
    613513@subsection REGION_RETURN_SEGMENT - Return segment to a region
    614514
     
    664564
    665565@page
    666 @ifinfo
    667 @node REGION_GET_SEGMENT_SIZE - Obtain size of a segment, Dual-Ported Memory Manager, REGION_RETURN_SEGMENT - Return segment to a region, Region Manager Directives
    668 @end ifinfo
    669566@subsection REGION_GET_SEGMENT_SIZE - Obtain size of a segment
    670567
  • doc/user/rtmon.t

    r1f020c6 r20515fc  
    1313@c
    1414
    15 @ifinfo
    16 @node Rate Monotonic Manager, Rate Monotonic Manager Introduction, Scheduling Concepts Task State Transitions, Top
    17 @end ifinfo
    1815@chapter Rate Monotonic Manager
    19 @ifinfo
    20 @menu
    21 * Rate Monotonic Manager Introduction::
    22 * Rate Monotonic Manager Background::
    23 * Rate Monotonic Manager Operations::
    24 * Rate Monotonic Manager Directives::
    25 @end menu
    26 @end ifinfo
    27 
    28 @ifinfo
    29 @node Rate Monotonic Manager Introduction, Rate Monotonic Manager Background, Rate Monotonic Manager, Rate Monotonic Manager
    30 @end ifinfo
     16
    3117@section Introduction
    3218
     
    4430@end itemize
    4531
    46 @ifinfo
    47 @node Rate Monotonic Manager Background, Rate Monotonic Manager Required Support, Rate Monotonic Manager Introduction, Rate Monotonic Manager
    48 @end ifinfo
    4932@section Background
    50 @ifinfo
    51 @menu
    52 * Rate Monotonic Manager Required Support::
    53 * Rate Monotonic Manager Definitions::
    54 * Rate Monotonic Scheduling Algorithm::
    55 * Schedulability Analysis::
    56 * Assumptions::
    57 * Processor Utilization Rule::
    58 * Processor Utilization Rule Example::
    59 * First Deadline Rule::
    60 * First Deadline Rule Example::
    61 * Relaxation of Assumptions::
    62 * Further Reading::
    63 @end menu
    64 @end ifinfo
    6533
    6634The rate monotonic manager provides facilities to
     
    7341be used by any application which requires periodic tasks.
    7442
    75 @ifinfo
    76 @node Rate Monotonic Manager Required Support, Rate Monotonic Manager Definitions, Rate Monotonic Manager Background, Rate Monotonic Manager Background
    77 @end ifinfo
    7843@subsection Rate Monotonic Manager Required Support
    7944
    8045A clock tick is required to support the functionality provided by this manager.
    8146
    82 @ifinfo
    83 @node Rate Monotonic Manager Definitions, Rate Monotonic Scheduling Algorithm, Rate Monotonic Manager Required Support, Rate Monotonic Manager Background
    84 @end ifinfo
    8547@subsection Rate Monotonic Manager Definitions
    8648
     
    11577but the missile must be launched by a hard deadline.
    11678
    117 @ifinfo
    118 @node Rate Monotonic Scheduling Algorithm, Schedulability Analysis, Rate Monotonic Manager Definitions, Rate Monotonic Manager Background
    119 @end ifinfo
    12079@subsection Rate Monotonic Scheduling Algorithm
    12180
     
    236195schedulability is only guaranteed for the critical task set.
    237196
    238 @ifinfo
    239 @node Schedulability Analysis, Assumptions, Rate Monotonic Scheduling Algorithm, Rate Monotonic Manager Background
    240 @end ifinfo
    241197@subsection Schedulability Analysis
    242198
     
    248204@lowersections
    249205
    250 @ifinfo
    251 @node Assumptions, Processor Utilization Rule, Schedulability Analysis, Rate Monotonic Manager Background
    252 @end ifinfo
    253206@subsection Assumptions
    254207
     
    279232side-effects accounted for.
    280233
    281 @ifinfo
    282 @node Processor Utilization Rule, Processor Utilization Rule Example, Assumptions, Rate Monotonic Manager Background
    283 @end ifinfo
    284234@subsection Processor Utilization Rule
    285235
     
    314264approximately 0.88.
    315265
    316 @ifinfo
    317 @node Processor Utilization Rule Example, First Deadline Rule, Processor Utilization Rule, Rate Monotonic Manager Background
    318 @end ifinfo
    319266@subsection Processor Utilization Rule Example
    320267
     
    399346this task set is guaranteed to be schedulable using RMS.
    400347
    401 @ifinfo
    402 @node First Deadline Rule, First Deadline Rule Example, Processor Utilization Rule Example, Rate Monotonic Manager Background
    403 @end ifinfo
    404348@subsection First Deadline Rule
    405349
     
    425369initialization task deletes itself.
    426370
    427 @ifinfo
    428 @node First Deadline Rule Example, Relaxation of Assumptions, First Deadline Rule, Rate Monotonic Manager Background
    429 @end ifinfo
    430371@subsection First Deadline Rule Example
    431372
     
    607548Deadline Rule.
    608549
    609 @ifinfo
    610 @node Relaxation of Assumptions, Further Reading, First Deadline Rule Example, Rate Monotonic Manager Background
    611 @end ifinfo
    612550@subsection Relaxation of Assumptions
    613551
     
    648586analysis.
    649587
    650 @ifinfo
    651 @node Further Reading, Rate Monotonic Manager Operations, Relaxation of Assumptions, Rate Monotonic Manager Background
    652 @end ifinfo
    653588@subsection Further Reading
    654589
     
    675610@raisesections
    676611
    677 @ifinfo
    678 @node Rate Monotonic Manager Operations, Creating a Rate Monotonic Period, Further Reading, Rate Monotonic Manager
    679 @end ifinfo
    680612@section Operations
    681 @ifinfo
    682 @menu
    683 * Creating a Rate Monotonic Period::
    684 * Manipulating a Period::
    685 * Obtaining a Period's Status::
    686 * Canceling a Period::
    687 * Deleting a Rate Monotonic Period::
    688 * Examples::
    689 * Simple Periodic Task::
    690 * Task with Multiple Periods::
    691 @end menu
    692 @end ifinfo
    693 
    694 @ifinfo
    695 @node Creating a Rate Monotonic Period, Manipulating a Period, Rate Monotonic Manager Operations, Rate Monotonic Manager Operations
    696 @end ifinfo
     613
    697614@subsection Creating a Rate Monotonic Period
    698615
     
    706623monotonic period.
    707624
    708 @ifinfo
    709 @node Manipulating a Period, Obtaining a Period's Status, Creating a Rate Monotonic Period, Rate Monotonic Manager Operations
    710 @end ifinfo
    711625@subsection Manipulating a Period
    712626
     
    735649@end itemize
    736650
    737 @ifinfo
    738 @node Obtaining a Period's Status, Canceling a Period, Manipulating a Period, Rate Monotonic Manager Operations
    739 @end ifinfo
    740651@subsection Obtaining a Period's Status
    741652
     
    759670not alter the state or length of that period.
    760671
    761 @ifinfo
    762 @node Canceling a Period, Deleting a Rate Monotonic Period, Obtaining a Period's Status, Rate Monotonic Manager Operations
    763 @end ifinfo
    764672@subsection Canceling a Period
    765673
     
    769677reinitiated using the @code{@value{DIRPREFIX}rate_monotonic_period} directive.
    770678
    771 @ifinfo
    772 @node Deleting a Rate Monotonic Period, Examples, Canceling a Period, Rate Monotonic Manager Operations
    773 @end ifinfo
    774679@subsection Deleting a Rate Monotonic Period
    775680
     
    781686by a task other than the task which created the period.
    782687
    783 @ifinfo
    784 @node Examples, Simple Periodic Task, Deleting a Rate Monotonic Period, Rate Monotonic Manager Operations
    785 @end ifinfo
    786688@subsection Examples
    787689
     
    789691monotonic periods to construct periodic tasks.
    790692
    791 @ifinfo
    792 @node Simple Periodic Task, Task with Multiple Periods, Examples, Rate Monotonic Manager Operations
    793 @end ifinfo
    794693@subsection Simple Periodic Task
    795694
     
    837736monotonic period and itself.
    838737
    839 @ifinfo
    840 @node Task with Multiple Periods, Rate Monotonic Manager Directives, Simple Periodic Task, Rate Monotonic Manager Operations
    841 @end ifinfo
    842738@subsection Task with Multiple Periods
    843739
     
    926822will delete the rate monotonic periods and itself.
    927823
    928 @ifinfo
    929 @node Rate Monotonic Manager Directives, RATE_MONOTONIC_CREATE - Create a rate monotonic period, Task with Multiple Periods, Rate Monotonic Manager
    930 @end ifinfo
    931824@section Directives
    932 @ifinfo
    933 @menu
    934 * RATE_MONOTONIC_CREATE - Create a rate monotonic period::
    935 * RATE_MONOTONIC_IDENT - Get ID of a period::
    936 * RATE_MONOTONIC_CANCEL - Cancel a period::
    937 * RATE_MONOTONIC_DELETE - Delete a rate monotonic period::
    938 * RATE_MONOTONIC_PERIOD - Conclude current/Start next period::
    939 * RATE_MONOTONIC_GET_STATUS - Obtain status information on period::
    940 @end menu
    941 @end ifinfo
    942825
    943826This section details the rate monotonic manager's
     
    947830
    948831@page
    949 @ifinfo
    950 @node RATE_MONOTONIC_CREATE - Create a rate monotonic period, RATE_MONOTONIC_IDENT - Get ID of a period, Rate Monotonic Manager Directives, Rate Monotonic Manager Directives
    951 @end ifinfo
    952832@subsection RATE_MONOTONIC_CREATE - Create a rate monotonic period
    953833
     
    993873
    994874@page
    995 @ifinfo
    996 @node RATE_MONOTONIC_IDENT - Get ID of a period, RATE_MONOTONIC_CANCEL - Cancel a period, RATE_MONOTONIC_CREATE - Create a rate monotonic period, Rate Monotonic Manager Directives
    997 @end ifinfo
    998875@subsection RATE_MONOTONIC_IDENT - Get ID of a period
    999876
     
    1038915
    1039916@page
    1040 @ifinfo
    1041 @node RATE_MONOTONIC_CANCEL - Cancel a period, RATE_MONOTONIC_DELETE - Delete a rate monotonic period, RATE_MONOTONIC_IDENT - Get ID of a period, Rate Monotonic Manager Directives
    1042 @end ifinfo
    1043917@subsection RATE_MONOTONIC_CANCEL - Cancel a period
    1044918
     
    1082956
    1083957@page
    1084 @ifinfo
    1085 @node RATE_MONOTONIC_DELETE - Delete a rate monotonic period, RATE_MONOTONIC_PERIOD - Conclude current/Start next period, RATE_MONOTONIC_CANCEL - Cancel a period, Rate Monotonic Manager Directives
    1086 @end ifinfo
    1087958@subsection RATE_MONOTONIC_DELETE - Delete a rate monotonic period
    1088959
     
    1125996
    1126997@page
    1127 @ifinfo
    1128 @node RATE_MONOTONIC_PERIOD - Conclude current/Start next period, RATE_MONOTONIC_GET_STATUS - Obtain status information on period, RATE_MONOTONIC_DELETE - Delete a rate monotonic period, Rate Monotonic Manager Directives
    1129 @end ifinfo
    1130998@subsection RATE_MONOTONIC_PERIOD - Conclude current/Start next period
    1131999
     
    11791047---------------------
    11801048@page
    1181 @ifinfo
    1182 @node RATE_MONOTONIC_GET_STATUS - Obtain status information on period, Board Support Packages, RATE_MONOTONIC_PERIOD - Conclude current/Start next period, Rate Monotonic Manager Directives
    1183 @end ifinfo
    11841049@subsection RATE_MONOTONIC_GET_STATUS - Obtain status information on period
    11851050
  • doc/user/schedule.t

    r1f020c6 r20515fc  
    1212@c
    1313
    14 @ifinfo
    15 @node Scheduling Concepts, Scheduling Concepts Introduction, FATAL_ERROR_OCCURRED - Invoke the fatal error handler, Top
    16 @end ifinfo
    1714@chapter Scheduling Concepts
    18 @ifinfo
    19 @menu
    20 * Scheduling Concepts Introduction::
    21 * Scheduling Concepts Scheduling Mechanisms::
    22 * Scheduling Concepts Task State Transitions::
    23 @end menu
    24 @end ifinfo
    25 
    26 @ifinfo
    27 @node Scheduling Concepts Introduction, Scheduling Concepts Scheduling Mechanisms, Scheduling Concepts, Scheduling Concepts
    28 @end ifinfo
     15
    2916@section Introduction
    3017
     
    6148events.
    6249
    63 @ifinfo
    64 @node Scheduling Concepts Scheduling Mechanisms, Task Priority and Scheduling, Scheduling Concepts Introduction, Scheduling Concepts
    65 @end ifinfo
    6650@section Scheduling Mechanisms
    67 @ifinfo
    68 @menu
    69 * Task Priority and Scheduling::
    70 * Preemption::
    71 * Timeslicing::
    72 * Manual Round-Robin::
    73 * Dispatching Tasks::
    74 @end menu
    75 @end ifinfo
    7651
    7752RTEMS provides four mechanisms which allow the user
     
    9873description.
    9974
    100 @ifinfo
    101 @node Task Priority and Scheduling, Preemption, Scheduling Concepts Scheduling Mechanisms, Scheduling Concepts Scheduling Mechanisms
    102 @end ifinfo
    10375@subsection Task Priority and Scheduling
    10476
     
    12294@end itemize
    12395
    124 @ifinfo
    125 @node Preemption, Timeslicing, Task Priority and Scheduling, Scheduling Concepts Scheduling Mechanisms
    126 @end ifinfo
    12796@subsection Preemption
    12897
     
    138107control of the processor.
    139108
    140 @ifinfo
    141 @node Timeslicing, Manual Round-Robin, Preemption, Scheduling Concepts Scheduling Mechanisms
    142 @end ifinfo
    143109@subsection Timeslicing
    144110
     
    160126entire timeslice.
    161127
    162 @ifinfo
    163 @node Manual Round-Robin, Dispatching Tasks, Timeslicing, Scheduling Concepts Scheduling Mechanisms
    164 @end ifinfo
    165128@subsection Manual Round-Robin
    166129
     
    175138of the processor.
    176139
    177 @ifinfo
    178 @node Dispatching Tasks, Scheduling Concepts Task State Transitions, Manual Round-Robin, Scheduling Concepts Scheduling Mechanisms
    179 @end ifinfo
    180140@subsection Dispatching Tasks
    181141
     
    206166the last task to utilize the coprocessor.
    207167
    208 @ifinfo
    209 @node Scheduling Concepts Task State Transitions, Rate Monotonic Manager, Dispatching Tasks, Scheduling Concepts
    210 @end ifinfo
    211168@section Task State Transitions
    212169
  • doc/user/sem.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Semaphore Manager, Semaphore Manager Introduction, TIMER_RESET - Reset an interval timer, Top
    11 @end ifinfo
    129@chapter Semaphore Manager
    13 @ifinfo
    14 @menu
    15 * Semaphore Manager Introduction::
    16 * Semaphore Manager Background::
    17 * Semaphore Manager Operations::
    18 * Semaphore Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Semaphore Manager Introduction, Semaphore Manager Background, Semaphore Manager, Semaphore Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3824@end itemize
    3925
    40 @ifinfo
    41 @node Semaphore Manager Background, Nested Resource Access, Semaphore Manager Introduction, Semaphore Manager
    42 @end ifinfo
    4326@section Background
    44 @ifinfo
    45 @menu
    46 * Nested Resource Access::
    47 * Priority Inversion::
    48 * Priority Inheritance::
    49 * Priority Ceiling::
    50 * Building a Semaphore's Attribute Set::
    51 * Building a SEMAPHORE_OBTAIN Option Set::
    52 @end menu
    53 @end ifinfo
    5427
    5528A semaphore can be viewed as a protected variable
     
    9366the pending task.
    9467
    95 @ifinfo
    96 @node Nested Resource Access, Priority Inversion, Semaphore Manager Background, Semaphore Manager Background
    97 @end ifinfo
    9868@subsection Nested Resource Access
    9969
     
    11585
    11686
    117 @ifinfo
    118 @node Priority Inversion, Priority Inheritance, Nested Resource Access, Semaphore Manager Background
    119 @end ifinfo
    12087@subsection Priority Inversion
    12188
     
    133100from executing by lower priority tasks.
    134101
    135 @ifinfo
    136 @node Priority Inheritance, Priority Ceiling, Priority Inversion, Semaphore Manager Background
    137 @end ifinfo
    138102@subsection Priority Inheritance
    139103
     
    164128be restored to the normal value.
    165129
    166 @ifinfo
    167 @node Priority Ceiling, Building a Semaphore's Attribute Set, Priority Inheritance, Semaphore Manager Background
    168 @end ifinfo
    169130@subsection Priority Ceiling
    170131
     
    208169be restored to the normal value.
    209170
    210 @ifinfo
    211 @node Building a Semaphore's Attribute Set, Building a SEMAPHORE_OBTAIN Option Set, Priority Ceiling, Semaphore Manager Background
    212 @end ifinfo
    213171@subsection Building a Semaphore's Attribute Set
    214172
     
    264222@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}.
    265223
    266 @ifinfo
    267 @node Building a SEMAPHORE_OBTAIN Option Set, Semaphore Manager Operations, Building a Semaphore's Attribute Set, Semaphore Manager Background
    268 @end ifinfo
    269224@subsection Building a SEMAPHORE_OBTAIN Option Set
    270225
     
    293248directive should be @code{@value{RPREFIX}NO_WAIT}.
    294249
    295 @ifinfo
    296 @node Semaphore Manager Operations, Creating a Semaphore, Building a SEMAPHORE_OBTAIN Option Set, Semaphore Manager
    297 @end ifinfo
    298250@section Operations
    299 @ifinfo
    300 @menu
    301 * Creating a Semaphore::
    302 * Obtaining Semaphore IDs::
    303 * Acquiring a Semaphore::
    304 * Releasing a Semaphore::
    305 * Deleting a Semaphore::
    306 @end menu
    307 @end ifinfo
    308 
    309 @ifinfo
    310 @node Creating a Semaphore, Obtaining Semaphore IDs, Semaphore Manager Operations, Semaphore Manager Operations
    311 @end ifinfo
     251
    312252@subsection Creating a Semaphore
    313253
     
    329269semaphore ID is generated and returned to the calling task.
    330270
    331 @ifinfo
    332 @node Obtaining Semaphore IDs, Acquiring a Semaphore, Creating a Semaphore, Semaphore Manager Operations
    333 @end ifinfo
    334271@subsection Obtaining Semaphore IDs
    335272
     
    345282semaphore.
    346283
    347 @ifinfo
    348 @node Acquiring a Semaphore, Releasing a Semaphore, Obtaining Semaphore IDs, Semaphore Manager Operations
    349 @end ifinfo
    350284@subsection Acquiring a Semaphore
    351285
     
    390324be elevated.
    391325
    392 @ifinfo
    393 @node Releasing a Semaphore, Deleting a Semaphore, Acquiring a Semaphore, Semaphore Manager Operations
    394 @end ifinfo
    395326@subsection Releasing a Semaphore
    396327
     
    413344will have its priority restored to its normal value.
    414345
    415 @ifinfo
    416 @node Deleting a Semaphore, Semaphore Manager Directives, Releasing a Semaphore, Semaphore Manager Operations
    417 @end ifinfo
    418346@subsection Deleting a Semaphore
    419347
     
    426354references to the semaphore's name and ID are invalid.
    427355
    428 @ifinfo
    429 @node Semaphore Manager Directives, SEMAPHORE_CREATE - Create a semaphore, Deleting a Semaphore, Semaphore Manager
    430 @end ifinfo
    431356@section Directives
    432 @ifinfo
    433 @menu
    434 * SEMAPHORE_CREATE - Create a semaphore::
    435 * SEMAPHORE_IDENT - Get ID of a semaphore::
    436 * SEMAPHORE_DELETE - Delete a semaphore::
    437 * SEMAPHORE_OBTAIN - Acquire a semaphore::
    438 * SEMAPHORE_RELEASE - Release a semaphore::
    439 @end menu
    440 @end ifinfo
    441357
    442358This section details the semaphore manager's
     
    446362
    447363@page
    448 @ifinfo
    449 @node SEMAPHORE_CREATE - Create a semaphore, SEMAPHORE_IDENT - Get ID of a semaphore, Semaphore Manager Directives, Semaphore Manager Directives
    450 @end ifinfo
    451364@subsection SEMAPHORE_CREATE - Create a semaphore
    452365
     
    550463
    551464@page
    552 @ifinfo
    553 @node SEMAPHORE_IDENT - Get ID of a semaphore, SEMAPHORE_DELETE - Delete a semaphore, SEMAPHORE_CREATE - Create a semaphore, Semaphore Manager Directives
    554 @end ifinfo
    555465@subsection SEMAPHORE_IDENT - Get ID of a semaphore
    556466
     
    610520
    611521@page
    612 @ifinfo
    613 @node SEMAPHORE_DELETE - Delete a semaphore, SEMAPHORE_OBTAIN - Acquire a semaphore, SEMAPHORE_IDENT - Get ID of a semaphore, Semaphore Manager Directives
    614 @end ifinfo
    615522@subsection SEMAPHORE_DELETE - Delete a semaphore
    616523
     
    671578
    672579@page
    673 @ifinfo
    674 @node SEMAPHORE_OBTAIN - Acquire a semaphore, SEMAPHORE_RELEASE - Release a semaphore, SEMAPHORE_DELETE - Delete a semaphore, Semaphore Manager Directives
    675 @end ifinfo
    676580@subsection SEMAPHORE_OBTAIN - Acquire a semaphore
    677581
     
    763667
    764668@page
    765 @ifinfo
    766 @node SEMAPHORE_RELEASE - Release a semaphore, Message Manager, SEMAPHORE_OBTAIN - Acquire a semaphore, Semaphore Manager Directives
    767 @end ifinfo
    768669@subsection SEMAPHORE_RELEASE - Release a semaphore
    769670
  • doc/user/signal.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Signal Manager, Signal Manager Introduction, EVENT_RECEIVE - Receive event condition, Top
    11 @end ifinfo
    129@chapter Signal Manager
    13 @ifinfo
    14 @menu
    15 * Signal Manager Introduction::
    16 * Signal Manager Background::
    17 * Signal Manager Operations::
    18 * Signal Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Signal Manager Introduction, Signal Manager Background, Signal Manager, Signal Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3420@end itemize
    3521
    36 @ifinfo
    37 @node Signal Manager Background, Signal Manager Definitions, Signal Manager Introduction, Signal Manager
    38 @end ifinfo
    3922@section Background
    40 @ifinfo
    41 @menu
    42 * Signal Manager Definitions::
    43 * A Comparison of ASRs and ISRs::
    44 * Building a Signal Set::
    45 * Building an ASR's Mode::
    46 @end menu
    47 @end ifinfo
    48 
    49 @ifinfo
    50 @node Signal Manager Definitions, A Comparison of ASRs and ISRs, Signal Manager Background, Signal Manager Background
    51 @end ifinfo
     23
    5224@subsection Signal Manager Definitions
    5325
     
    7042
    7143
    72 @ifinfo
    73 @node A Comparison of ASRs and ISRs, Building a Signal Set, Signal Manager Definitions, Signal Manager Background
    74 @end ifinfo
    7544@subsection A Comparison of ASRs and ISRs
    7645
     
    9564@end itemize
    9665
    97 @ifinfo
    98 @node Building a Signal Set, Building an ASR's Mode, A Comparison of ASRs and ISRs, Signal Manager Background
    99 @end ifinfo
    10066@subsection Building a Signal Set
    10167
     
    11783@value{RPREFIX}SIGNAL_15 @value{OR} @value{RPREFIX}SIGNAL_31}.
    11884
    119 @ifinfo
    120 @node Building an ASR's Mode, Signal Manager Operations, Building a Signal Set, Signal Manager Background
    121 @end ifinfo
    12285@subsection Building an ASR's Mode
    12386
     
    172135desired processor mode and interrupt level.
    173136
    174 @ifinfo
    175 @node Signal Manager Operations, Establishing an ASR, Building an ASR's Mode, Signal Manager
    176 @end ifinfo
    177137@section Operations
    178 @ifinfo
    179 @menu
    180 * Establishing an ASR::
    181 * Sending a Signal Set::
    182 * Processing an ASR::
    183 @end menu
    184 @end ifinfo
    185 
    186 @ifinfo
    187 @node Establishing an ASR, Sending a Signal Set, Signal Manager Operations, Signal Manager Operations
    188 @end ifinfo
     138
    189139@subsection Establishing an ASR
    190140
     
    216166the ASR must be reentrant.
    217167
    218 @ifinfo
    219 @node Sending a Signal Set, Processing an ASR, Establishing an ASR, Signal Manager Operations
    220 @end ifinfo
    221168@subsection Sending a Signal Set
    222169
     
    247194that task once.
    248195
    249 @ifinfo
    250 @node Processing an ASR, Signal Manager Directives, Sending a Signal Set, Signal Manager Operations
    251 @end ifinfo
    252196@subsection Processing an ASR
    253197
     
    280224prior to entering the ASR.
    281225
    282 @ifinfo
    283 @node Signal Manager Directives, SIGNAL_CATCH - Establish an ASR, Processing an ASR, Signal Manager
    284 @end ifinfo
    285226@section Directives
    286 @ifinfo
    287 @menu
    288 * SIGNAL_CATCH - Establish an ASR::
    289 * SIGNAL_SEND - Send signal set to a task::
    290 @end menu
    291 @end ifinfo
    292227
    293228This section details the signal manager's directives.
     
    297232
    298233@page
    299 @ifinfo
    300 @node SIGNAL_CATCH - Establish an ASR, SIGNAL_SEND - Send signal set to a task, Signal Manager Directives, Signal Manager Directives
    301 @end ifinfo
    302234@subsection SIGNAL_CATCH - Establish an ASR
    303235
     
    371303
    372304@page
    373 @ifinfo
    374 @node SIGNAL_SEND - Send signal set to a task, Partition Manager, SIGNAL_CATCH - Establish an ASR, Signal Manager Directives
    375 @end ifinfo
    376305@subsection SIGNAL_SEND - Send signal set to a task
    377306
  • doc/user/task.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Task Manager, Task Manager Introduction, SHUTDOWN_EXECUTIVE - Shutdown RTEMS, Top
    11 @end ifinfo
    12 
    139@chapter Task Manager
    1410
    15 @ifinfo
    16 @menu
    17 * Task Manager Introduction::
    18 * Task Manager Background::
    19 * Task Manager Operations::
    20 * Task Manager Directives::
    21 @end menu
    22 @end ifinfo
    23 
    24 @ifinfo
    25 @node Task Manager Introduction, Task Manager Background, Task Manager, Task Manager
    26 @end ifinfo
    2711@section Introduction
    2812
     
    4731@end itemize
    4832
    49 @ifinfo
    50 @node Task Manager Background, Task Definition, Task Manager Introduction, Task Manager
    51 @end ifinfo
    52 
    5333@section Background
    54 
    55 @ifinfo
    56 @menu
    57 * Task Definition::
    58 * Task Control Block::
    59 * Task States::
    60 * Task Priority::
    61 * Task Mode::
    62 * Accessing Task Arguments::
    63 * Floating Point Considerations::
    64 * Building a Task's Attribute Set::
    65 * Building a Mode and Mask::
    66 @end menu
    67 
    68 @end ifinfo
    69 
    70 @ifinfo
    71 @node Task Definition, Task Control Block, Task Manager Background, Task Manager Background
    72 @end ifinfo
    7334
    7435@subsection Task Definition
     
    10061(TCB).
    10162
    102 @ifinfo
    103 @node Task Control Block, Task States, Task Definition, Task Manager Background
    104 @end ifinfo
    10563@subsection Task Control Block
    10664
     
    12785the task's TCB.
    12886
    129 @ifinfo
    130 @node Task States, Task Priority, Task Control Block, Task Manager Background
    131 @end ifinfo
    13287@subsection Task States
    13388
     
    152107current state and priority.
    153108
    154 @ifinfo
    155 @node Task Priority, Task Mode, Task States, Task Manager Background
    156 @end ifinfo
    157109@subsection Task Priority
    158110
     
    176128processor execution time.
    177129
    178 @ifinfo
    179 @node Task Mode, Accessing Task Arguments, Task Priority, Task Manager Background
    180 @end ifinfo
    181130@subsection Task Mode
    182131
     
    238187@end itemize
    239188
    240 @ifinfo
    241 @node Accessing Task Arguments, Floating Point Considerations, Task Mode, Task Manager Background
    242 @end ifinfo
    243189@subsection Accessing Task Arguments
    244190
     
    268214single argument as an index into an array of parameter blocks.
    269215
    270 @ifinfo
    271 @node Floating Point Considerations, Building a Task's Attribute Set, Accessing Task Arguments, Task Manager Background
    272 @end ifinfo
    273216@subsection Floating Point Considerations
    274217
     
    322265generally result in an exception condition.
    323266
    324 @ifinfo
    325 @node Building a Task's Attribute Set, Building a Mode and Mask, Floating Point Considerations, Task Manager Background
    326 @end ifinfo
    327267@subsection Building a Task's Attribute Set
    328268
     
    356296@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}FLOATING_POINT}.
    357297
    358 @ifinfo
    359 @node Building a Mode and Mask, Task Manager Operations, Building a Task's Attribute Set, Task Manager Background
    360 @end ifinfo
    361298@subsection Building a Mode and Mask
    362299
     
    483420interrupt level and preemption mode are being altered.
    484421
    485 @ifinfo
    486 @node Task Manager Operations, Creating Tasks, Building a Mode and Mask, Task Manager
    487 @end ifinfo
    488 
    489422@section Operations
    490423
    491 @ifinfo
    492 @menu
    493 * Creating Tasks::
    494 * Obtaining Task IDs::
    495 * Starting and Restarting Tasks::
    496 * Suspending and Resuming Tasks::
    497 * Delaying the Currently Executing Task::
    498 * Changing Task Priority::
    499 * Changing Task Mode::
    500 * Notepad Locations::
    501 * Task Deletion::
    502 @end menu
    503 @end ifinfo
    504 
    505 @ifinfo
    506 @node Creating Tasks, Obtaining Task IDs, Task Manager Operations, Task Manager Operations
    507 @end ifinfo
    508424@subsection Creating Tasks
    509425
     
    517433execute in the most privileged mode of the processor.
    518434
    519 @ifinfo
    520 @node Obtaining Task IDs, Starting and Restarting Tasks, Creating Tasks, Task Manager Operations
    521 @end ifinfo
    522435@subsection Obtaining Task IDs
    523436
     
    532445used by other directives to manipulate this task.
    533446
    534 @ifinfo
    535 @node Starting and Restarting Tasks, Suspending and Resuming Tasks, Obtaining Task IDs, Task Manager Operations
    536 @end ifinfo
    537447@subsection Starting and Restarting Tasks
    538448
     
    567477restarted).  All restarted tasks are placed in the ready state.
    568478
    569 @ifinfo
    570 @node Suspending and Resuming Tasks, Delaying the Currently Executing Task, Starting and Restarting Tasks, Task Manager Operations
    571 @end ifinfo
    572479@subsection Suspending and Resuming Tasks
    573480
     
    591498task which is not suspended is considered an error.
    592499
    593 @ifinfo
    594 @node Delaying the Currently Executing Task, Changing Task Priority, Suspending and Resuming Tasks, Task Manager Operations
    595 @end ifinfo
    596500@subsection Delaying the Currently Executing Task
    597501
     
    611515occurred, at which time the task is unblocked.
    612516
    613 @ifinfo
    614 @node Changing Task Priority, Changing Task Mode, Delaying the Currently Executing Task, Task Manager Operations
    615 @end ifinfo
    616517@subsection Changing Task Priority
    617518
     
    630531original value.
    631532
    632 @ifinfo
    633 @node Changing Task Mode, Notepad Locations, Changing Task Priority, Task Manager Operations
    634 @end ifinfo
    635533@subsection Changing Task Mode
    636534
     
    645543original value.
    646544
    647 @ifinfo
    648 @node Notepad Locations, Task Deletion, Changing Task Mode, Task Manager Operations
    649 @end ifinfo
    650545@subsection Notepad Locations
    651546
     
    663558contained in any one of the sixteen notepads of a specified task.
    664559
    665 @ifinfo
    666 @node Task Deletion, Task Manager Directives, Notepad Locations, Task Manager Operations
    667 @end ifinfo
    668560@subsection Task Deletion
    669561
     
    693585which instruct the task to delete itself.
    694586
    695 @ifinfo
    696 @node Task Manager Directives, TASK_CREATE - Create a task, Task Deletion, Task Manager
    697 @end ifinfo
    698 
    699587@section Directives
    700 
    701 @ifinfo
    702 @menu
    703 * TASK_CREATE - Create a task::
    704 * TASK_IDENT - Get ID of a task::
    705 * TASK_START - Start a task::
    706 * TASK_RESTART - Restart a task::
    707 * TASK_DELETE - Delete a task::
    708 * TASK_SUSPEND - Suspend a task::
    709 * TASK_RESUME - Resume a task::
    710 * TASK_SET_PRIORITY - Set task priority::
    711 * TASK_MODE - Change current task's mode::
    712 * TASK_GET_NOTE - Get task notepad entry::
    713 * TASK_SET_NOTE - Set task notepad entry::
    714 * TASK_WAKE_AFTER - Wake up after interval::
    715 * TASK_WAKE_WHEN - Wake up when specified::
    716 @end menu
    717 @end ifinfo
    718588
    719589This section details the task manager's directives.  A
     
    724594@page
    725595
    726 @ifinfo
    727 @node TASK_CREATE - Create a task, TASK_IDENT - Get ID of a task, Task Manager Directives, Task Manager Directives
    728 @end ifinfo
    729596@subsection TASK_CREATE - Create a task
    730597
     
    836703@page
    837704
    838 @ifinfo
    839 @node TASK_IDENT - Get ID of a task, TASK_START - Start a task, TASK_CREATE - Create a task, Task Manager Directives
    840 @end ifinfo
    841705@subsection TASK_IDENT - Get ID of a task
    842706
     
    894758@page
    895759
    896 @ifinfo
    897 @node TASK_START - Start a task, TASK_RESTART - Restart a task, TASK_IDENT - Get ID of a task, Task Manager Directives
    898 @end ifinfo
    899760@subsection TASK_START - Start a task
    900761
     
    946807@page
    947808
    948 @ifinfo
    949 @node TASK_RESTART - Restart a task, TASK_DELETE - Delete a task, TASK_START - Start a task, Task Manager Directives
    950 @end ifinfo
    951809@subsection TASK_RESTART - Restart a task
    952810
     
    1010868@page
    1011869
    1012 @ifinfo
    1013 @node TASK_DELETE - Delete a task, TASK_SUSPEND - Suspend a task, TASK_RESTART - Restart a task, Task Manager Directives
    1014 @end ifinfo
    1015870@subsection TASK_DELETE - Delete a task
    1016871
     
    1069924@page
    1070925
    1071 @ifinfo
    1072 @node TASK_SUSPEND - Suspend a task, TASK_RESUME - Resume a task, TASK_DELETE - Delete a task, Task Manager Directives
    1073 @end ifinfo
    1074926@subsection TASK_SUSPEND - Suspend a task
    1075927
     
    1120972@page
    1121973
    1122 @ifinfo
    1123 @node TASK_RESUME - Resume a task, TASK_SET_PRIORITY - Set task priority, TASK_SUSPEND - Suspend a task, Task Manager Directives
    1124 @end ifinfo
    1125974@subsection TASK_RESUME - Resume a task
    1126975
     
    11681017@page
    11691018
    1170 @ifinfo
    1171 @node TASK_SET_PRIORITY - Set task priority, TASK_MODE - Change current task's mode, TASK_RESUME - Resume a task, Task Manager Directives
    1172 @end ifinfo
    11731019@subsection TASK_SET_PRIORITY - Set task priority
    11741020
     
    12321078@page
    12331079
    1234 @ifinfo
    1235 @node TASK_MODE - Change current task's mode, TASK_GET_NOTE - Get task notepad entry, TASK_SET_PRIORITY - Set task priority, Task Manager Directives
    1236 @end ifinfo
    12371080@subsection TASK_MODE - Change current task's mode
    12381081
     
    13891232@page
    13901233
    1391 @ifinfo
    1392 @node TASK_GET_NOTE - Get task notepad entry, TASK_SET_NOTE - Set task notepad entry, TASK_MODE - Change current task's mode, Task Manager Directives
    1393 @end ifinfo
    13941234@subsection TASK_GET_NOTE - Get task notepad entry
    13951235
     
    14441284@page
    14451285
    1446 @ifinfo
    1447 @node TASK_SET_NOTE - Set task notepad entry, TASK_WAKE_AFTER - Wake up after interval, TASK_GET_NOTE - Get task notepad entry, Task Manager Directives
    1448 @end ifinfo
    14491286@subsection TASK_SET_NOTE - Set task notepad entry
    14501287
     
    14991336@page
    15001337
    1501 @ifinfo
    1502 @node TASK_WAKE_AFTER - Wake up after interval, TASK_WAKE_WHEN - Wake up when specified, TASK_SET_NOTE - Set task notepad entry, Task Manager Directives
    1503 @end ifinfo
    15041338@subsection TASK_WAKE_AFTER - Wake up after interval
    15051339
     
    15461380@page
    15471381
    1548 @ifinfo
    1549 @node TASK_WAKE_WHEN - Wake up when specified, Interrupt Manager, TASK_WAKE_AFTER - Wake up after interval, Task Manager Directives
    1550 @end ifinfo
    15511382@subsection TASK_WAKE_WHEN - Wake up when specified
    15521383
  • doc/user/timer.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node Timer Manager, Timer Manager Introduction, CLOCK_TICK - Announce a clock tick, Top
    11 @end ifinfo
    129@chapter Timer Manager
    13 @ifinfo
    14 @menu
    15 * Timer Manager Introduction::
    16 * Timer Manager Background::
    17 * Timer Manager Operations::
    18 * Timer Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node Timer Manager Introduction, Timer Manager Background, Timer Manager, Timer Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3925
    4026
    41 @ifinfo
    42 @node Timer Manager Background, Timer Manager Required Support, Timer Manager Introduction, Timer Manager
    43 @end ifinfo
    4427@section Background
    45 @ifinfo
    46 @menu
    47 * Timer Manager Required Support::
    48 * Timers::
    49 * Timer Service Routines::
    50 @end menu
    51 @end ifinfo
    52 
    53 @ifinfo
    54 @node Timer Manager Required Support, Timers, Timer Manager Background, Timer Manager Background
    55 @end ifinfo
     28
    5629@subsection Required Support
    5730
    5831A clock tick is required to support the functionality provided by this manager.
    5932
    60 @ifinfo
    61 @node Timers, Timer Service Routines, Timer Manager Required Support, Timer Manager Background
    62 @end ifinfo
    6333@subsection Timers
    6434
     
    8151sometimes referred to as a "keep alive" or a "deadman" timer.
    8252
    83 @ifinfo
    84 @node Timer Service Routines, Timer Manager Operations, Timers, Timer Manager Background
    85 @end ifinfo
    8653@subsection Timer Service Routines
    8754
     
    11279service routine.  The argument user_data may be NULL.
    11380
    114 @ifinfo
    115 @node Timer Manager Operations, Creating a Timer, Timer Service Routines, Timer Manager
    116 @end ifinfo
    11781@section Operations
    118 @ifinfo
    119 @menu
    120 * Creating a Timer::
    121 * Obtaining Timer IDs::
    122 * Initiating an Interval Timer::
    123 * Initiating a Time of Day Timer::
    124 * Canceling a Timer::
    125 * Resetting a Timer::
    126 * Deleting a Timer::
    127 @end menu
    128 @end ifinfo
    129 
    130 @ifinfo
    131 @node Creating a Timer, Obtaining Timer IDs, Timer Manager Operations, Timer Manager Operations
    132 @end ifinfo
     82
    13383@subsection Creating a Timer
    13484
     
    13989and are not active.
    14090
    141 @ifinfo
    142 @node Obtaining Timer IDs, Initiating an Interval Timer, Creating a Timer, Timer Manager Operations
    143 @end ifinfo
    14491@subsection Obtaining Timer IDs
    14592
     
    154101is used by other directives to manipulate this timer.
    155102
    156 @ifinfo
    157 @node Initiating an Interval Timer, Initiating a Time of Day Timer, Obtaining Timer IDs, Timer Manager Operations
    158 @end ifinfo
    159103@subsection Initiating an Interval Timer
    160104
     
    165109@code{@value{DIRPREFIX}clock_tick} directive.
    166110
    167 @ifinfo
    168 @node Initiating a Time of Day Timer, Canceling a Timer, Initiating an Interval Timer, Timer Manager Operations
    169 @end ifinfo
    170111@subsection Initiating a Time of Day Timer
    171112
     
    176117@code{@value{DIRPREFIX}clock_tick} directive.
    177118
    178 @ifinfo
    179 @node Canceling a Timer, Resetting a Timer, Initiating a Time of Day Timer, Timer Manager Operations
    180 @end ifinfo
    181119@subsection Canceling a Timer
    182120
     
    188126@code{@value{DIRPREFIX}timer_fire_when} directives.
    189127
    190 @ifinfo
    191 @node Resetting a Timer, Deleting a Timer, Canceling a Timer, Timer Manager Operations
    192 @end ifinfo
    193128@subsection Resetting a Timer
    194129
     
    202137fired by this directive.
    203138
    204 @ifinfo
    205 @node Deleting a Timer, Timer Manager Directives, Resetting a Timer, Timer Manager Operations
    206 @end ifinfo
    207139@subsection Deleting a Timer
    208140
     
    214146Any subsequent references to the timer's name and ID are invalid.
    215147
    216 @ifinfo
    217 @node Timer Manager Directives, TIMER_CREATE - Create a timer, Deleting a Timer, Timer Manager
    218 @end ifinfo
    219148@section Directives
    220 @ifinfo
    221 @menu
    222 * TIMER_CREATE - Create a timer::
    223 * TIMER_IDENT - Get ID of a timer::
    224 * TIMER_CANCEL - Cancel a timer::
    225 * TIMER_DELETE - Delete a timer::
    226 * TIMER_FIRE_AFTER - Fire timer after interval::
    227 * TIMER_FIRE_WHEN - Fire timer when specified::
    228 * TIMER_RESET - Reset an interval timer::
    229 @end menu
    230 @end ifinfo
    231149
    232150This section details the timer manager's directives.
     
    236154
    237155@page
    238 @ifinfo
    239 @node TIMER_CREATE - Create a timer, TIMER_IDENT - Get ID of a timer, Timer Manager Directives, Timer Manager Directives
    240 @end ifinfo
    241156@subsection TIMER_CREATE - Create a timer
    242157
     
    281196
    282197@page
    283 @ifinfo
    284 @node TIMER_IDENT - Get ID of a timer, TIMER_CANCEL - Cancel a timer, TIMER_CREATE - Create a timer, Timer Manager Directives
    285 @end ifinfo
    286198@subsection TIMER_IDENT - Get ID of a timer
    287199
     
    326238
    327239@page
    328 @ifinfo
    329 @node TIMER_CANCEL - Cancel a timer, TIMER_DELETE - Delete a timer, TIMER_IDENT - Get ID of a timer, Timer Manager Directives
    330 @end ifinfo
    331240@subsection TIMER_CANCEL - Cancel a timer
    332241
     
    366275
    367276@page
    368 @ifinfo
    369 @node TIMER_DELETE - Delete a timer, TIMER_FIRE_AFTER - Fire timer after interval, TIMER_CANCEL - Cancel a timer, Timer Manager Directives
    370 @end ifinfo
    371277@subsection TIMER_DELETE - Delete a timer
    372278
     
    409315
    410316@page
    411 @ifinfo
    412 @node TIMER_FIRE_AFTER - Fire timer after interval, TIMER_FIRE_WHEN - Fire timer when specified, TIMER_DELETE - Delete a timer, Timer Manager Directives
    413 @end ifinfo
    414317@subsection TIMER_FIRE_AFTER - Fire timer after interval
    415318
     
    459362
    460363@page
    461 @ifinfo
    462 @node TIMER_FIRE_WHEN - Fire timer when specified, TIMER_RESET - Reset an interval timer, TIMER_FIRE_AFTER - Fire timer after interval, Timer Manager Directives
    463 @end ifinfo
    464364@subsection TIMER_FIRE_WHEN - Fire timer when specified
    465365
     
    510410
    511411@page
    512 @ifinfo
    513 @node TIMER_RESET - Reset an interval timer, Semaphore Manager, TIMER_FIRE_WHEN - Fire timer when specified, Timer Manager Directives
    514 @end ifinfo
    515412@subsection TIMER_RESET - Reset an interval timer
    516413
  • doc/user/userext.t

    r1f020c6 r20515fc  
    77@c
    88
    9 @ifinfo
    10 @node User Extensions Manager, User Extensions Manager Introduction, Heterogeneous Systems, Top
    11 @end ifinfo
    129@chapter User Extensions Manager
    13 @ifinfo
    14 @menu
    15 * User Extensions Manager Introduction::
    16 * User Extensions Manager Background::
    17 * User Extensions Manager Operations::
    18 * User Extensions Manager Directives::
    19 @end menu
    20 @end ifinfo
    21 
    22 @ifinfo
    23 @node User Extensions Manager Introduction, User Extensions Manager Background, User Extensions Manager, User Extensions Manager
    24 @end ifinfo
     10
    2511@section Introduction
    2612
     
    3723@end itemize
    3824
    39 @ifinfo
    40 @node User Extensions Manager Background, Extension Sets, User Extensions Manager Introduction, User Extensions Manager
    41 @end ifinfo
    4225@section Background
    43 @ifinfo
    44 @menu
    45 * Extension Sets::
    46 * TCB Extension Area::
    47 * Extensions::
    48 * TASK_CREATE Extension::
    49 * TASK_START Extension::
    50 * TASK_RESTART Extension::
    51 * TASK_DELETE Extension::
    52 * TASK_SWITCH Extension::
    53 * TASK_POST_SWITCH Extension::
    54 * TASK_BEGIN Extension::
    55 * TASK_EXITTED Extension::
    56 * FATAL Error Extension::
    57 * Order of Invocation::
    58 @end menu
    59 @end ifinfo
    6026
    6127User extension routines are invoked when the
     
    7743arguments that are appropriate to the system event.
    7844
    79 @ifinfo
    80 @node Extension Sets, TCB Extension Area, User Extensions Manager Background, User Extensions Manager Background
    81 @end ifinfo
    8245@subsection Extension Sets
    8346
     
    155118naming  restrictions on the user.
    156119
    157 @ifinfo
    158 @node TCB Extension Area, Extensions, Extension Sets, User Extensions Manager Background
    159 @end ifinfo
    160120@subsection TCB Extension Area
    161121
     
    194154directives to obtain and release the extension buffers.
    195155
    196 @ifinfo
    197 @node Extensions, TASK_CREATE Extension, TCB Extension Area, User Extensions Manager Background
    198 @end ifinfo
    199156@subsection Extensions
    200157
     
    208165conventions on the user.
    209166
    210 @ifinfo
    211 @node TASK_CREATE Extension, TASK_START Extension, Extensions, User Extensions Manager Background
    212 @end ifinfo
    213167@subsection TASK_CREATE Extension
    214168
     
    245199chain.
    246200
    247 @ifinfo
    248 @node TASK_START Extension, TASK_RESTART Extension, TASK_CREATE Extension, User Extensions Manager Background
    249 @end ifinfo
    250201@subsection TASK_START Extension
    251202
     
    282233it is placed on a ready TCB chain.
    283234
    284 @ifinfo
    285 @node TASK_RESTART Extension, TASK_DELETE Extension, TASK_START Extension, User Extensions Manager Background
    286 @end ifinfo
    287235@subsection TASK_RESTART Extension
    288236
     
    318266ready TCB chain.
    319267
    320 @ifinfo
    321 @node TASK_DELETE Extension, TASK_SWITCH Extension, TASK_RESTART Extension, User Extensions Manager Background
    322 @end ifinfo
    323268@subsection TASK_DELETE Extension
    324269
     
    357302task is deleting itself (current_task is equal to deleted_task).
    358303
    359 @ifinfo
    360 @node TASK_SWITCH Extension, TASK_POST_SWITCH Extension, TASK_DELETE Extension, User Extensions Manager Background
    361 @end ifinfo
    362304@subsection TASK_SWITCH Extension
    363305
     
    395337directives.
    396338
    397 @ifinfo
    398 @node TASK_POST_SWITCH Extension, TASK_BEGIN Extension, TASK_SWITCH Extension, User Extensions Manager Background
    399 @end ifinfo
    400339@subsection TASK_POST_SWITCH Extension
    401340
     
    430369of the current_task.
    431370
    432 @ifinfo
    433 @node TASK_BEGIN Extension, TASK_EXITTED Extension, TASK_POST_SWITCH Extension, User Extensions Manager Background
    434 @end ifinfo
    435371@subsection TASK_BEGIN Extension
    436372
     
    464400extensions, this is not a critical distinction.
    465401
    466 @ifinfo
    467 @node TASK_EXITTED Extension, FATAL Error Extension, TASK_BEGIN Extension, User Extensions Manager Background
    468 @end ifinfo
    469402@subsection TASK_EXITTED Extension
    470403
     
    504437@lowersections
    505438
    506 @ifinfo
    507 @node FATAL Error Extension, Order of Invocation, TASK_EXITTED Extension, User Extensions Manager Background
    508 @end ifinfo
    509439@subsection FATAL Error Extension
    510440
     
    545475@raisesections
    546476
    547 @ifinfo
    548 @node Order of Invocation, User Extensions Manager Operations, FATAL Error Extension, User Extensions Manager Background
    549 @end ifinfo
    550477@subsection Order of Invocation
    551478
     
    592519extension is invoked after that of the other extensions.
    593520
    594 @ifinfo
    595 @node User Extensions Manager Operations, Creating an Extension Set, Order of Invocation, User Extensions Manager
    596 @end ifinfo
    597521@section Operations
    598 @ifinfo
    599 @menu
    600 * Creating an Extension Set::
    601 * Obtaining Extension Set IDs::
    602 * Deleting an Extension Set::
    603 @end menu
    604 @end ifinfo
    605 
    606 @ifinfo
    607 @node Creating an Extension Set, Obtaining Extension Set IDs, User Extensions Manager Operations, User Extensions Manager Operations
    608 @end ifinfo
     522
    609523@subsection Creating an Extension Set
    610524
     
    616530even supporting an extension.
    617531
    618 @ifinfo
    619 @node Obtaining Extension Set IDs, Deleting an Extension Set, Creating an Extension Set, User Extensions Manager Operations
    620 @end ifinfo
    621532@subsection Obtaining Extension Set IDs
    622533
     
    632543to manipulate this extension set.
    633544
    634 @ifinfo
    635 @node Deleting an Extension Set, User Extensions Manager Directives, Obtaining Extension Set IDs, User Extensions Manager Operations
    636 @end ifinfo
    637545@subsection Deleting an Extension Set
    638546
     
    644552name and ID are invalid.
    645553
    646 @ifinfo
    647 @node User Extensions Manager Directives, EXTENSION_CREATE - Create a extension set, Deleting an Extension Set, User Extensions Manager
    648 @end ifinfo
    649554@section Directives
    650 @ifinfo
    651 @menu
    652 * EXTENSION_CREATE - Create a extension set::
    653 * EXTENSION_IDENT - Get ID of a extension set::
    654 * EXTENSION_DELETE - Delete a extension set::
    655 @end menu
    656 @end ifinfo
    657555
    658556This section details the user extension manager's
     
    662560
    663561@page
    664 @ifinfo
    665 @node EXTENSION_CREATE - Create a extension set, EXTENSION_IDENT - Get ID of a extension set, User Extensions Manager Directives, User Extensions Manager Directives
    666 @end ifinfo
    667562@subsection EXTENSION_CREATE - Create a extension set
    668563
     
    710605
    711606@page
    712 @ifinfo
    713 @node EXTENSION_IDENT - Get ID of a extension set, EXTENSION_DELETE - Delete a extension set, EXTENSION_CREATE - Create a extension set, User Extensions Manager Directives
    714 @end ifinfo
    715607@subsection EXTENSION_IDENT - Get ID of a extension set
    716608
     
    756648
    757649@page
    758 @ifinfo
    759 @node EXTENSION_DELETE - Delete a extension set, Configuring a System, EXTENSION_IDENT - Get ID of a extension set, User Extensions Manager Directives
    760 @end ifinfo
    761650@subsection EXTENSION_DELETE - Delete a extension set
    762651
Note: See TracChangeset for help on using the changeset viewer.