Changeset f331481c in rtems


Ignore:
Timestamp:
Mar 27, 1998, 1:24:52 PM (23 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
3973e40
Parents:
4fa4ea65
Message:

Conditionally adding RTEMS_ and rtems_ prefixes.

Location:
doc/user
Files:
17 edited

Legend:

Unmodified
Added
Removed
  • doc/user/dpmem.t

    r4fa4ea65 rf331481c  
    3131
    3232@itemize @bullet
    33 @item @code{port_create} - Create a port
    34 @item @code{port_ident} - Get ID of a port
    35 @item @code{port_delete} - Delete a port
    36 @item @code{port_external_to_internal} - Convert external to internal address
    37 @item @code{port_internal_to_external} - Convert internal to external address
     33@item @code{@value{DIRPREFIX}port_create} - Create a port
     34@item @code{@value{DIRPREFIX}port_ident} - Get ID of a port
     35@item @code{@value{DIRPREFIX}port_delete} - Delete a port
     36@item @code{@value{DIRPREFIX}port_external_to_internal} - Convert external to internal address
     37@item @code{@value{DIRPREFIX}port_internal_to_external} - Convert internal to external address
    3838@end itemize
    3939
     
    176176
    177177@subheading DIRECTIVE STATUS CODES:
    178 @code{SUCCESSFUL} - port created successfully@*
    179 @code{INVALID_NAME} - invalid task name@*
    180 @code{INVALID_ADDRESS} - address not on four byte boundary@*
    181 @code{TOO_MANY} - too many DP memory areas created
     178@code{@value{RPREFIX}SUCCESSFUL} - port created successfully@*
     179@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     180@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
     181@code{@value{RPREFIX}TOO_MANY} - too many DP memory areas created
    182182
    183183@subheading DESCRIPTION:
     
    230230
    231231@subheading DIRECTIVE STATUS CODES:
    232 @code{SUCCESSFUL} - port identified successfully@*
    233 @code{INVALID_NAME} - port name not found
     232@code{@value{RPREFIX}SUCCESSFUL} - port identified successfully@*
     233@code{@value{RPREFIX}INVALID_NAME} - port name not found
    234234
    235235@subheading DESCRIPTION:
     
    273273
    274274@subheading DIRECTIVE STATUS CODES:
    275 @code{SUCCESSFUL} - port deleted successfully@*
    276 @code{INVALID_ID} - invalid port id
     275@code{@value{RPREFIX}SUCCESSFUL} - port deleted successfully@*
     276@code{@value{RPREFIX}INVALID_ID} - invalid port id
    277277
    278278@subheading DESCRIPTION:
     
    321321
    322322@subheading DIRECTIVE STATUS CODES:
    323 @code{SUCCESSFUL} -  always successful
     323@code{@value{RPREFIX}SUCCESSFUL} -  always successful
    324324
    325325@subheading DESCRIPTION:
     
    368368
    369369@subheading DIRECTIVE STATUS CODES:
    370 @code{SUCCESSFUL} -  always successful
     370@code{@value{RPREFIX}SUCCESSFUL} -  always successful
    371371
    372372@subheading DESCRIPTION:
  • doc/user/event.t

    r4fa4ea65 rf331481c  
    3030
    3131@itemize @bullet
    32 @item @code{event_send} - Send event set to a task
    33 @item @code{event_receive} - Receive event condition
     32@item @code{@value{DIRPREFIX}event_send} - Send event set to a task
     33@item @code{@value{DIRPREFIX}event_receive} - Receive event condition
    3434@end itemize
    3535
     
    8181be used to determine when the request is satisfied. An event
    8282condition is satisfied based upon one of two algorithms which
    83 are selected by the user.  The @code{EVENT_ANY} algorithm states that
     83are selected by the user.  The @code{@value{RPREFIX}EVENT_ANY} algorithm states that
    8484an event condition is satisfied when at least a single requested
    85 event is posted.  The @code{EVENT_ALL} algorithm states that an event
     85event is posted.  The @code{@value{RPREFIX}EVENT_ALL} algorithm states that an event
    8686condition is satisfied when every requested event is posted.
    8787
     
    9292
    9393An event set or condition is built by a bitwise OR of
    94 the desired events.  The set of valid events is @code{EVENT_0} through
    95 @code{EVENT_31}.  If an event is not explicitly specified in the set or
     94the desired events.  The set of valid events is @code{@value{RPREFIX}EVENT_0} through
     95@code{@value{RPREFIX}EVENT_31}.  If an event is not explicitly specified in the set or
    9696condition, then it is not present.  Events are specifically
    9797designed to be mutually exclusive, therefore bitwise OR and
     
    100100
    101101For example, when sending the event set consisting of
    102 @code{EVENT_6}, @code{EVENT_15}, and @code{EVENT_31},
     102@code{@value{RPREFIX}EVENT_6}, @code{@value{RPREFIX}EVENT_15}, and @code{@value{RPREFIX}EVENT_31},
    103103the event parameter to the event_send directive should be
    104104@code{@value{RPREFIX}EVENT_6 @value{OR}
     
    115115
    116116@itemize @bullet
    117 @item @code{WAIT} - task will wait for event (default)
    118 @item @code{NO_WAIT} - task should not wait
    119 @item @code{EVENT_ALL} - return after all events (default)
    120 @item @code{EVENT_ANY} - return after any events
     117@item @code{@value{RPREFIX}WAIT} - task will wait for event (default)
     118@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
     119@item @code{@value{RPREFIX}EVENT_ALL} - return after all events (default)
     120@item @code{@value{RPREFIX}EVENT_ANY} - return after any events
    121121@end itemize
    122122
     
    127127required to appear in the option list, although it is a good
    128128programming practice to specify default options.  If all
    129 defaults are desired, the option @code{DEFAULT_OPTIONS} should be
     129defaults are desired, the option @code{@value{RPREFIX}DEFAULT_OPTIONS} should be
    130130specified on this call.
    131131
     
    135135directive should be either
    136136@code{@value{RPREFIX}EVENT_ALL @value{OR} @value{RPREFIX}NO_WAIT}
    137 or @code{NO_WAIT}.  The option parameter can be set to
    138 @code{NO_WAIT} because @code{EVENT_ALL} is the
     137or @code{@value{RPREFIX}NO_WAIT}.  The option parameter can be set to
     138@code{@value{RPREFIX}NO_WAIT} because @code{@value{RPREFIX}EVENT_ALL} is the
    139139default condition for event_receive.
    140140
     
    201201event condition to be satisfied.
    202202
    203 @item Specifying the @code{NO_WAIT} option forces an immediate return
     203@item Specifying the @code{@value{RPREFIX}NO_WAIT} option forces an immediate return
    204204with an error status code.
    205205
     
    225225A task can receive all of the currently pending
    226226events by calling the event_receive directive with a value of
    227 @code{ALL_EVENTS} for the input event condition and
     227@code{@value{RPREFIX}ALL_EVENTS} for the input event condition and
    228228@code{@value{RPREFIX}NO_WAIT @value{OR} @value{RPREFIX}EVENT_ANY}
    229229for the option set.  The pending events are returned to the
    230230calling task and the event set is cleared.  If no events are
    231 pending then the @code{UNSATISFIED} status code will be returned.
     231pending then the @code{@value{RPREFIX}UNSATISFIED} status code will be returned.
    232232
    233233@ifinfo
     
    275275
    276276@subheading DIRECTIVE STATUS CODES:
    277 @code{SUCCESSFUL} - event set sent successfully@*
    278 @code{INVALID_ID} - invalid task id
     277@code{@value{RPREFIX}SUCCESSFUL} - event set sent successfully@*
     278@code{@value{RPREFIX}INVALID_ID} - invalid task id
    279279
    280280@subheading DESCRIPTION:
     
    290290@subheading NOTES:
    291291
    292 Specifying @code{SELF} for id results in the event set being
     292Specifying @code{@value{RPREFIX}SELF} for id results in the event set being
    293293sent to the calling task.
    294294
     
    337337
    338338@subheading DIRECTIVE STATUS CODES:
    339 @code{SUCCESSFUL} - event received successfully@*
    340 @code{UNSATISFIED} - input event not satisfied (@code{NO_WAIT})@*
    341 @code{TIMEOUT} - timed out waiting for event
     339@code{@value{RPREFIX}SUCCESSFUL} - event received successfully@*
     340@code{@value{RPREFIX}UNSATISFIED} - input event not satisfied (@code{@value{RPREFIX}NO_WAIT})@*
     341@code{@value{RPREFIX}TIMEOUT} - timed out waiting for event
    342342
    343343@subheading DESCRIPTION:
     
    345345This directive attempts to receive the event
    346346condition specified in event_in.  If event_in is set to
    347 @code{PENDING_EVENTS}, then the current pending events are returned in
    348 event_out and left pending.  The @code{WAIT} and @code{NO_WAIT} options in the
     347@code{@value{RPREFIX}PENDING_EVENTS}, then the current pending events are returned in
     348event_out and left pending.  The @code{@value{RPREFIX}WAIT} and @code{@value{RPREFIX}NO_WAIT} options in the
    349349option_set parameter are used to specify whether or not the task
    350350is willing to wait for the event condition to be satisfied.
    351 @code{EVENT_ANY} and @code{EVENT_ALL} are used in the option_set parameter are
     351@code{@value{RPREFIX}EVENT_ANY} and @code{@value{RPREFIX}EVENT_ALL} are used in the option_set parameter are
    352352used to specify whether a single event or the complete event set
    353353is necessary to satisfy the event condition.  The event_out
     
    358358event_out is set to the satisfied events and the pending events
    359359in the event condition are cleared.  If the event condition is
    360 not satisfied and @code{NO_WAIT} is specified, then event_out is set to
     360not satisfied and @code{@value{RPREFIX}NO_WAIT} is specified, then event_out is set to
    361361the currently satisfied events.  If the calling task chooses to
    362362wait, then it will block waiting for the event condition.
     
    364364If the calling task must wait for the event condition
    365365to be satisfied, then the timeout parameter is used to specify
    366 the maximum interval to wait.  If it is set to @code{NO_TIMEOUT}, then
     366the maximum interval to wait.  If it is set to @code{@value{RPREFIX}NO_TIMEOUT}, then
    367367the calling task will wait forever.
    368368
     
    377377
    378378@itemize @bullet
    379 @item @code{WAIT}       task will wait for event (default)
    380 @item @code{NO_WAIT}    task should not wait
    381 @item @code{EVENT_ALL}  return after all events (default)
    382 @item @code{EVENT_ANY}  return after any events
     379@item @code{@value{RPREFIX}WAIT}        task will wait for event (default)
     380@item @code{@value{RPREFIX}NO_WAIT}     task should not wait
     381@item @code{@value{RPREFIX}EVENT_ALL}   return after all events (default)
     382@item @code{@value{RPREFIX}EVENT_ANY}   return after any events
    383383@end itemize
    384384
  • doc/user/fatal.t

    r4fa4ea65 rf331481c  
    3030
    3131@itemize @bullet
    32 @item @code{fatal_error_occurred} - Invoke the fatal error handler
     32@item @code{@value{DIRPREFIX}fatal_error_occurred} - Invoke the fatal error handler
    3333@end itemize
    3434
  • doc/user/init.t

    r4fa4ea65 rf331481c  
    3434
    3535@itemize @bullet
    36 @item @code{initialize_executive} - Initialize RTEMS
    37 @item @code{initialize_executive_early} - Initialize RTEMS and do NOT Start Multitasking
    38 @item @code{initialize_executive_late} - Complete Initialization and Start Multitasking
    39 @item @code{shutdown_executive} - Shutdown RTEMS
     36@item @code{@value{DIRPREFIX}initialize_executive} - Initialize RTEMS
     37@item @code{@value{DIRPREFIX}initialize_executive_early} - Initialize RTEMS and do NOT Start Multitasking
     38@item @code{@value{DIRPREFIX}initialize_executive_late} - Complete Initialization and Start Multitasking
     39@item @code{@value{DIRPREFIX}shutdown_executive} - Shutdown RTEMS
    4040@end itemize
    4141
  • doc/user/intr.t

    r4fa4ea65 rf331481c  
    3535
    3636@itemize @bullet
    37 @item @code{interrupt_catch} - Establish an ISR
    38 @item @code{interrupt_disable} - Disable Interrupts
    39 @item @code{interrupt_enable} - Enable Interrupts
    40 @item @code{interrupt_flash} - Flash Interrupt
    41 @item @code{interrupt_is_in_progress} - Is an ISR in Progress
     37@item @code{@value{DIRPREFIX}interrupt_catch} - Establish an ISR
     38@item @code{@value{DIRPREFIX}interrupt_disable} - Disable Interrupts
     39@item @code{@value{DIRPREFIX}interrupt_enable} - Enable Interrupts
     40@item @code{@value{DIRPREFIX}interrupt_flash} - Flash Interrupt
     41@item @code{@value{DIRPREFIX}interrupt_is_in_progress} - Is an ISR in Progress
    4242@end itemize
    4343
     
    314314
    315315@subheading DIRECTIVE STATUS CODES:
    316 @code{SUCCESSFUL} - ISR established successfully@*
    317 @code{INVALID_NUMBER} - illegal vector number@*
    318 @code{INVALID_ADDRESS} - illegal ISR entry point or invalid old_isr_handler
     316@code{@value{RPREFIX}SUCCESSFUL} - ISR established successfully@*
     317@code{@value{RPREFIX}INVALID_NUMBER} - illegal vector number@*
     318@code{@value{RPREFIX}INVALID_ADDRESS} - illegal ISR entry point or invalid old_isr_handler
    319319
    320320@subheading DESCRIPTION:
     
    361361This directive disables all maskable interrupts and returns
    362362the previous @code{level}.  A later invocation of the
    363 @code{interrupt_enable} directive should be used to
     363@code{@value{DIRPREFIX}interrupt_enable} directive should be used to
    364364restore the interrupt level.
    365365
     
    404404
    405405This directive enables maskable interrupts to the @code{level}
    406 which was returned by a previous call to @code{interrupt_disable}.
     406which was returned by a previous call to @code{@value{DIRPREFIX}interrupt_disable}.
    407407Immediately prior to invoking this directive, maskable interrupts should
    408 be disabled by a call to @code{interrupt_disable} and will be enabled
     408be disabled by a call to @code{@value{DIRPREFIX}interrupt_disable} and will be enabled
    409409when this directive returns to the caller.
    410410
     
    445445
    446446This directive temporarily enables maskable interrupts to the @code{level}
    447 which was returned by a previous call to @code{interrupt_disable}. 
     447which was returned by a previous call to @code{@value{DIRPREFIX}interrupt_disable}. 
    448448Immediately prior to invoking this directive, maskable interrupts should
    449 be disabled by a call to @code{interrupt_disable} and will be redisabled
     449be disabled by a call to @code{@value{DIRPREFIX}interrupt_disable} and will be redisabled
    450450when this directive returns to the caller.
    451451
  • doc/user/io.t

    r4fa4ea65 rf331481c  
    3131
    3232@itemize @bullet
    33 @item @code{io_initialize} - Initialize a device driver
    34 @item @code{io_register_name} - Register a device name
    35 @item @code{io_lookup_name} - Look up a device name
    36 @item @code{io_open} - Open a device
    37 @item @code{io_close} - Close a device
    38 @item @code{io_read} - Read from a device
    39 @item @code{io_write} - Write to a device
    40 @item @code{io_control} - Special device services
     33@item @code{@value{DIRPREFIX}io_initialize} - Initialize a device driver
     34@item @code{@value{DIRPREFIX}io_register_name} - Register a device name
     35@item @code{@value{DIRPREFIX}io_lookup_name} - Look up a device name
     36@item @code{@value{DIRPREFIX}io_open} - Open a device
     37@item @code{@value{DIRPREFIX}io_close} - Close a device
     38@item @code{@value{DIRPREFIX}io_read} - Read from a device
     39@item @code{@value{DIRPREFIX}io_write} - Write to a device
     40@item @code{@value{DIRPREFIX}io_control} - Special device services
    4141@end itemize
    4242
     
    8080If the device driver does not support a particular
    8181entry point, then that entry in the Configuration Table should
    82 be NULL.  RTEMS will return @code{SUCCESSFUL} as the executive's and
     82be NULL.  RTEMS will return @code{@value{RPREFIX}SUCCESSFUL} as the executive's and
    8383zero (0) as the device driver's return code for these device
    8484driver entry points.
     
    299299
    300300@subheading DIRECTIVE STATUS CODES:
    301 @code{SUCCESSFUL} - successfully initialized@*
    302 @code{INVALID_NUMBER} - invalid major device number
     301@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     302@code{@value{RPREFIX}INVALID_NUMBER} - invalid major device number
    303303
    304304@subheading DESCRIPTION:
     
    351351
    352352@subheading DIRECTIVE STATUS CODES:
    353 @code{SUCCESSFUL} - successfully initialized@*
    354 @code{TOO_MANY} - too many devices registered
     353@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     354@code{@value{RPREFIX}TOO_MANY} - too many devices registered
    355355
    356356@subheading DESCRIPTION:
     
    392392
    393393@subheading DIRECTIVE STATUS CODES:
    394 @code{SUCCESSFUL} - successfully initialized@*
    395 @code{UNSATISFIED} - name not registered
     394@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     395@code{@value{RPREFIX}UNSATISFIED} - name not registered
    396396
    397397@subheading DESCRIPTION:
     
    436436
    437437@subheading DIRECTIVE STATUS CODES:
    438 @code{SUCCESSFUL} - successfully initialized@*
    439 @code{INVALID_NUMBER} - invalid major device number
     438@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     439@code{@value{RPREFIX}INVALID_NUMBER} - invalid major device number
    440440
    441441@subheading DESCRIPTION:
     
    483483
    484484@subheading DIRECTIVE STATUS CODES:
    485 @code{SUCCESSFUL} - successfully initialized@*
    486 @code{INVALID_NUMBER} - invalid major device number
     485@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     486@code{@value{RPREFIX}INVALID_NUMBER} - invalid major device number
    487487
    488488@subheading DESCRIPTION:
     
    530530
    531531@subheading DIRECTIVE STATUS CODES:
    532 @code{SUCCESSFUL} - successfully initialized@*
    533 @code{INVALID_NUMBER} - invalid major device number
     532@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     533@code{@value{RPREFIX}INVALID_NUMBER} - invalid major device number
    534534
    535535@subheading DESCRIPTION:
     
    578578
    579579@subheading DIRECTIVE STATUS CODES:
    580 @code{SUCCESSFUL} - successfully initialized@*
    581 @code{INVALID_NUMBER} - invalid major device number
     580@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     581@code{@value{RPREFIX}INVALID_NUMBER} - invalid major device number
    582582
    583583@subheading DESCRIPTION:
     
    626626
    627627@subheading DIRECTIVE STATUS CODES:
    628 @code{SUCCESSFUL} - successfully initialized@*
    629 @code{INVALID_NUMBER} - invalid major device number
     628@code{@value{RPREFIX}SUCCESSFUL} - successfully initialized@*
     629@code{@value{RPREFIX}INVALID_NUMBER} - invalid major device number
    630630
    631631@subheading DESCRIPTION:
  • doc/user/mp.t

    r4fa4ea65 rf331481c  
    602602@item Packets are composed of both RTEMS and application data.
    603603All RTEMS data is treated as thirty-two (32) bit unsigned
    604 quantities and is in the first @code{MINIMUM_UNSIGNED32S_TO_CONVERT}
     604quantities and is in the first @code{@value{RPREFIX}MINIMUM_UNSIGNED32S_TO_CONVERT}
    605605thirty-two (32) quantities of the packet.
    606606
  • doc/user/msg.t

    r4fa4ea65 rf331481c  
    3030
    3131@itemize @bullet
    32 @item @code{message_queue_create} - Create a queue
    33 @item @code{message_queue_ident} - Get ID of a queue
    34 @item @code{message_queue_delete} - Delete a queue
    35 @item @code{message_queue_send} - Put message at rear of a queue
    36 @item @code{message_queue_urgent} - Put message at front of a queue
    37 @item @code{message_queue_broadcast} - Broadcast N messages to a queue
    38 @item @code{message_queue_receive} - Receive message from a queue
    39 @item @code{message_queue_get_number_pending} - Get number of messages pending on a queue
     32@item @code{@value{DIRPREFIX}message_queue_create} - Create a queue
     33@item @code{@value{DIRPREFIX}message_queue_ident} - Get ID of a queue
     34@item @code{@value{DIRPREFIX}message_queue_delete} - Delete a queue
     35@item @code{@value{DIRPREFIX}message_queue_send} - Put message at rear of a queue
     36@item @code{@value{DIRPREFIX}message_queue_urgent} - Put message at front of a queue
     37@item @code{@value{DIRPREFIX}message_queue_broadcast} - Broadcast N messages to a queue
     38@item @code{@value{DIRPREFIX}message_queue_receive} - Receive message from a queue
     39@item @code{@value{DIRPREFIX}message_queue_get_number_pending} - Get number of messages pending on a queue
    4040@item @code{message_queue_flush} - Flush all messages on a queue
    4141@end itemize
     
    9393
    9494@itemize @bullet
    95 @item @code{FIFO} - tasks wait by FIFO (default)
    96 @item @code{PRIORITY} - tasks wait by priority
    97 @item @code{LOCAL} - local message queue (default)
    98 @item @code{GLOBAL} - global message queue
     95@item @code{@value{RPREFIX}FIFO} - tasks wait by FIFO (default)
     96@item @code{@value{RPREFIX}PRIORITY} - tasks wait by priority
     97@item @code{@value{RPREFIX}LOCAL} - local message queue (default)
     98@item @code{@value{RPREFIX}GLOBAL} - global message queue
    9999@end itemize
    100100
     
    104104appear in the attribute list, although it is a good programming
    105105practice to specify default attributes.  If all defaults are
    106 desired, the attribute @code{DEFAULT_ATTRIBUTES} should be specified on
     106desired, the attribute @code{@value{RPREFIX}DEFAULT_ATTRIBUTES} should be specified on
    107107this call.
    108108
     
    111111waiting queue discipline.  The attribute_set parameter to the
    112112message_queue_create directive could be either
    113 @code{PRIORITY} or
     113@code{@value{RPREFIX}PRIORITY} or
    114114@code{@value{RPREFIX}LOCAL @value{OR} @value{RPREFIX}PRIORITY}. 
    115 The attribute_set parameter can be set to @code{PRIORITY}
    116 because @code{LOCAL} is the default for all created message queues.  If
     115The attribute_set parameter can be set to @code{@value{RPREFIX}PRIORITY}
     116because @code{@value{RPREFIX}LOCAL} is the default for all created message queues.  If
    117117a similar message queue were to be known globally, then the
    118118attribute_set parameter would be
     
    130130
    131131@itemize @bullet
    132 @item @code{WAIT} - task will wait for a message (default)
    133 @item @code{NO_WAIT} - task should not wait
     132@item @code{@value{RPREFIX}WAIT} - task will wait for a message (default)
     133@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    134134@end itemize
    135135
     
    137137appear in the option OR list, although it is a good programming
    138138practice to specify default options.  If all defaults are
    139 desired, the option @code{DEFAULT_OPTIONS} should be specified on this
     139desired, the option @code{@value{RPREFIX}DEFAULT_OPTIONS} should be specified on this
    140140call.
    141141
    142142This example demonstrates the option parameter needed
    143143to poll for a message to arrive.  The option parameter passed to
    144 the message_queue_receive directive should be @code{NO_WAIT}.
     144the message_queue_receive directive should be @code{@value{RPREFIX}NO_WAIT}.
    145145
    146146@ifinfo
     
    210210message to arrive.
    211211
    212 @item Specifying the @code{NO_WAIT} option forces an immediate return
     212@item Specifying the @code{@value{RPREFIX}NO_WAIT} option forces an immediate return
    213213with an error status code.
    214214
     
    327327
    328328@subheading DIRECTIVE STATUS CODES:
    329 @code{SUCCESSFUL} - queue created successfully@*
    330 @code{INVALID_NAME} - invalid task name@*
    331 @code{INVALID_NUMBER} - invalid message count@*
    332 @code{INVALID_SIZE} - invalid message size@*
    333 @code{TOO_MANY} - too many queues created@*
    334 @code{MP_NOT_CONFIGURED} - multiprocessing not configured@*
    335 @code{TOO_MANY} - too many global objects
     329@code{@value{RPREFIX}SUCCESSFUL} - queue created successfully@*
     330@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     331@code{@value{RPREFIX}INVALID_NUMBER} - invalid message count@*
     332@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*
     333@code{@value{RPREFIX}TOO_MANY} - too many queues created@*
     334@code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured@*
     335@code{@value{RPREFIX}TOO_MANY} - too many global objects
    336336
    337337@subheading DESCRIPTION:
     
    345345is used to access the message queue.
    346346
    347 Specifying @code{PRIORITY} in attribute_set causes tasks
     347Specifying @code{@value{RPREFIX}PRIORITY} in attribute_set causes tasks
    348348waiting for a message to be serviced according to task priority.
    349 When @code{FIFO} is specified, waiting tasks are serviced in First
     349When @code{@value{RPREFIX}FIFO} is specified, waiting tasks are serviced in First
    350350In-First Out order.
    351351
     
    359359
    360360@itemize @bullet
    361 @item @code{FIFO} - tasks wait by FIFO (default)
    362 @item @code{PRIORITY} - tasks wait by priority
    363 @item @code{LOCAL} - local message queue (default)
    364 @item @code{GLOBAL} - global message queue
     361@item @code{@value{RPREFIX}FIFO} - tasks wait by FIFO (default)
     362@item @code{@value{RPREFIX}PRIORITY} - tasks wait by priority
     363@item @code{@value{RPREFIX}LOCAL} - local message queue (default)
     364@item @code{@value{RPREFIX}GLOBAL} - global message queue
    365365@end itemize
    366366
     
    411411
    412412@subheading DIRECTIVE STATUS CODES:
    413 @code{SUCCESSFUL} - queue identified successfully@*
    414 @code{INVALID_NAME} - queue name not found@*
    415 @code{INVALID_NODE} - invalid node id
     413@code{@value{RPREFIX}SUCCESSFUL} - queue identified successfully@*
     414@code{@value{RPREFIX}INVALID_NAME} - queue name not found@*
     415@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    416416
    417417@subheading DESCRIPTION:
     
    429429preempted.
    430430
    431 If node is @code{SEARCH_ALL_NODES}, all nodes are searched
     431If node is @code{@value{RPREFIX}SEARCH_ALL_NODES}, all nodes are searched
    432432with the local node being searched first.  All other nodes are
    433433searched with the lowest numbered node searched first.
     
    467467
    468468@subheading DIRECTIVE STATUS CODES:
    469 @code{SUCCESSFUL} - queue deleted successfully@*
    470 @code{INVALID_ID} - invalid queue id@*
    471 @code{ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote queue
     469@code{@value{RPREFIX}SUCCESSFUL} - queue deleted successfully@*
     470@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     471@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote queue
    472472
    473473@subheading DESCRIPTION:
     
    535535
    536536@subheading DIRECTIVE STATUS CODES:
    537 @code{SUCCESSFUL} - message sent successfully@*
    538 @code{INVALID_ID} - invalid queue id@*
    539 @code{INVALID_SIZE} - invalid message size@*
    540 @code{UNSATISFIED} - out of message buffers@*
    541 @code{TOO_MANY} - queue's limit has been reached
     537@code{@value{RPREFIX}SUCCESSFUL} - message sent successfully@*
     538@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     539@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*
     540@code{@value{RPREFIX}UNSATISFIED} - out of message buffers@*
     541@code{@value{RPREFIX}TOO_MANY} - queue's limit has been reached
    542542
    543543@subheading DESCRIPTION:
     
    596596
    597597@subheading DIRECTIVE STATUS CODES:
    598 @code{SUCCESSFUL} - message sent successfully@*
    599 @code{INVALID_ID} - invalid queue id@*
    600 @code{INVALID_SIZE} - invalid message size@*
    601 @code{UNSATISFIED} - out of message buffers@*
    602 @code{TOO_MANY} - queue's limit has been reached
     598@code{@value{RPREFIX}SUCCESSFUL} - message sent successfully@*
     599@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     600@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*
     601@code{@value{RPREFIX}UNSATISFIED} - out of message buffers@*
     602@code{@value{RPREFIX}TOO_MANY} - queue's limit has been reached
    603603
    604604@subheading DESCRIPTION:
     
    660660
    661661@subheading DIRECTIVE STATUS CODES:
    662 @code{SUCCESSFUL} - message broadcasted successfully@*
    663 @code{INVALID_ID} - invalid queue id@*
    664 @code{INVALID_SIZE} - invalid message size
     662@code{@value{RPREFIX}SUCCESSFUL} - message broadcasted successfully@*
     663@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     664@code{@value{RPREFIX}INVALID_SIZE} - invalid message size
    665665
    666666@subheading DESCRIPTION:
     
    728728
    729729@subheading DIRECTIVE STATUS CODES:
    730 @code{SUCCESSFUL} - message received successfully@*
    731 @code{INVALID_ID} - invalid queue id@*
    732 @code{UNSATISFIED} - queue is empty@*
    733 @code{TIMEOUT} - timed out waiting for message@*
    734 @code{OBJECT_WAS_DELETED} - queue deleted while waiting
     730@code{@value{RPREFIX}SUCCESSFUL} - message received successfully@*
     731@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     732@code{@value{RPREFIX}UNSATISFIED} - queue is empty@*
     733@code{@value{RPREFIX}TIMEOUT} - timed out waiting for message@*
     734@code{@value{RPREFIX}OBJECT_WAS_DELETED} - queue deleted while waiting
    735735
    736736@subheading DESCRIPTION:
    737737
    738738This directive receives a message from the message
    739 queue specified in id.  The @code{WAIT} and @code{NO_WAIT} options of the
     739queue specified in id.  The @code{@value{RPREFIX}WAIT} and @code{@value{RPREFIX}NO_WAIT} options of the
    740740options parameter allow the calling task to specify whether to
    741741wait for a message to become available or return immediately.
     
    750750queue and the queue is empty, then the calling task is placed on
    751751the message wait queue and blocked.  If the queue was created
    752 with the @code{PRIORITY} option specified, then the calling task is
     752with the @code{@value{RPREFIX}PRIORITY} option specified, then the calling task is
    753753inserted into the wait queue according to its priority.  But, if
    754 the queue was created with the @code{FIFO} option specified, then the
     754the queue was created with the @code{@value{RPREFIX}FIFO} option specified, then the
    755755calling task is placed at the rear of the wait queue.
    756756
     
    759759parameter specifies the maximum interval to wait before the
    760760calling task desires to be unblocked.  If it is set to
    761 @code{NO_TIMEOUT}, then the calling task will wait forever.
     761@code{@value{RPREFIX}NO_TIMEOUT}, then the calling task will wait forever.
    762762
    763763@subheading NOTES:
     
    767767
    768768@itemize @bullet
    769 @item @code{WAIT} - task will wait for a message (default)
    770 @item @code{NO_WAIT} - task should not wait
     769@item @code{@value{RPREFIX}WAIT} - task will wait for a message (default)
     770@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    771771@end itemize
    772772
     
    774774does not reside on the local node will generate a request to the
    775775remote node to obtain a message from the specified message
    776 queue.  If no message is available and @code{WAIT} was specified, then
     776queue.  If no message is available and @code{@value{RPREFIX}WAIT} was specified, then
    777777the task must be blocked until a message is posted.  A proxy is
    778778allocated on the remote node to represent the task until the
     
    810810
    811811@subheading DIRECTIVE STATUS CODES:
    812 @code{SUCCESSFUL} - number of messages pending returned successfully@*
    813 @code{INVALID_ID} - invalid queue id
     812@code{@value{RPREFIX}SUCCESSFUL} - number of messages pending returned successfully@*
     813@code{@value{RPREFIX}INVALID_ID} - invalid queue id
    814814
    815815@subheading DESCRIPTION:
     
    855855
    856856@subheading DIRECTIVE STATUS CODES:
    857 @code{SUCCESSFUL} - message queue flushed successfully@*
    858 @code{INVALID_ID} - invalid queue id
     857@code{@value{RPREFIX}SUCCESSFUL} - message queue flushed successfully@*
     858@code{@value{RPREFIX}INVALID_ID} - invalid queue id
    859859
    860860@subheading DESCRIPTION:
  • doc/user/part.t

    r4fa4ea65 rf331481c  
    3030
    3131@itemize @bullet
    32 @item @code{partition_create} - Create a partition
    33 @item @code{partition_ident} - Get ID of a partition
    34 @item @code{partition_delete} - Delete a partition
    35 @item @code{partition_get_buffer} - Get buffer from a partition
    36 @item @code{partition_return_buffer} - Return buffer to a partition
     32@item @code{@value{DIRPREFIX}partition_create} - Create a partition
     33@item @code{@value{DIRPREFIX}partition_ident} - Get ID of a partition
     34@item @code{@value{DIRPREFIX}partition_delete} - Delete a partition
     35@item @code{@value{DIRPREFIX}partition_get_buffer} - Get buffer from a partition
     36@item @code{@value{DIRPREFIX}partition_return_buffer} - Return buffer to a partition
    3737@end itemize
    3838
     
    8989required to appear in the attribute list, although it is a good
    9090programming practice to specify default attributes.  If all
    91 defaults are desired, the attribute @code{DEFAULT_ATTRIBUTES} should be
     91defaults are desired, the attribute @code{@value{RPREFIX}DEFAULT_ATTRIBUTES} should be
    9292specified on this call.  The attribute_set parameter should be
    9393GLOBAL to indicate that the partition is to be known globally.
     
    225225
    226226@subheading DIRECTIVE STATUS CODES:
    227 @code{SUCCESSFUL} - partition created successfully@*
    228 @code{INVALID_NAME} - invalid task name@*
    229 @code{TOO_MANY} - too many partitions created@*
    230 @code{INVALID_ADDRESS} - address not on four byte boundary@*
    231 @code{INVALID_SIZE} - length or buffer size is 0@*
    232 @code{INVALID_SIZE} - length is less than the buffer size@*
    233 @code{INVALID_SIZE} - buffer size not a multiple of 4@*
    234 @code{MP_NOT_CONFIGURED} - multiprocessing not configured@*
    235 @code{TOO_MANY} - too many global objects
     227@code{@value{RPREFIX}SUCCESSFUL} - partition created successfully@*
     228@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     229@code{@value{RPREFIX}TOO_MANY} - too many partitions created@*
     230@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
     231@code{@value{RPREFIX}INVALID_SIZE} - length or buffer size is 0@*
     232@code{@value{RPREFIX}INVALID_SIZE} - length is less than the buffer size@*
     233@code{@value{RPREFIX}INVALID_SIZE} - buffer size not a multiple of 4@*
     234@code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured@*
     235@code{@value{RPREFIX}TOO_MANY} - too many global objects
    236236
    237237@subheading DESCRIPTION:
     
    308308
    309309@subheading DIRECTIVE STATUS CODES:
    310 @code{SUCCESSFUL} - partition identified successfully@*
    311 @code{INVALID_NAME} - partition name not found@*
    312 @code{INVALID_NODE} - invalid node id
     310@code{@value{RPREFIX}SUCCESSFUL} - partition identified successfully@*
     311@code{@value{RPREFIX}INVALID_NAME} - partition name not found@*
     312@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    313313
    314314@subheading DESCRIPTION:
     
    326326preempted.
    327327
    328 If node is @code{SEARCH_ALL_NODES}, all nodes are searched
     328If node is @code{@value{RPREFIX}SEARCH_ALL_NODES}, all nodes are searched
    329329with the local node being searched first.  All other nodes are
    330330searched with the lowest numbered node searched first.
     
    364364
    365365@subheading DIRECTIVE STATUS CODES:
    366 @code{SUCCESSFUL} - partition deleted successfully@*
    367 @code{INVALID_ID} - invalid partition id@*
    368 @code{RESOURCE_IN_USE} - buffers still in use@*
    369 @code{ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote partition
     366@code{@value{RPREFIX}SUCCESSFUL} - partition deleted successfully@*
     367@code{@value{RPREFIX}INVALID_ID} - invalid partition id@*
     368@code{@value{RPREFIX}RESOURCE_IN_USE} - buffers still in use@*
     369@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote partition
    370370
    371371@subheading DESCRIPTION:
     
    420420
    421421@subheading DIRECTIVE STATUS CODES:
    422 @code{SUCCESSFUL} - buffer obtained successfully@*
    423 @code{INVALID_ID} - invalid partition id@*
    424 @code{UNSATISFIED} - all buffers are allocated
     422@code{@value{RPREFIX}SUCCESSFUL} - buffer obtained successfully@*
     423@code{@value{RPREFIX}INVALID_ID} - invalid partition id@*
     424@code{@value{RPREFIX}UNSATISFIED} - all buffers are allocated
    425425
    426426@subheading DESCRIPTION:
     
    471471
    472472@subheading DIRECTIVE STATUS CODES:
    473 @code{SUCCESSFUL} - buffer returned successfully@*
    474 @code{INVALID_ID} - invalid partition id@*
    475 @code{INVALID_ADDRESS} - buffer address not in partition
     473@code{@value{RPREFIX}SUCCESSFUL} - buffer returned successfully@*
     474@code{@value{RPREFIX}INVALID_ID} - invalid partition id@*
     475@code{@value{RPREFIX}INVALID_ADDRESS} - buffer address not in partition
    476476
    477477@subheading DESCRIPTION:
  • doc/user/region.t

    r4fa4ea65 rf331481c  
    3030
    3131@itemize @bullet
    32 @item @code{region_create} - Create a region
    33 @item @code{region_ident} - Get ID of a region
    34 @item @code{region_delete} - Delete a region
    35 @item @code{region_extend} - Add memory to a region
    36 @item @code{region_get_segment} - Get segment from a region
    37 @item @code{region_return_segment} - Return segment to a region
    38 @item @code{region_get_segment_size} - Obtain size of a segment
     32@item @code{@value{DIRPREFIX}region_create} - Create a region
     33@item @code{@value{DIRPREFIX}region_ident} - Get ID of a region
     34@item @code{@value{DIRPREFIX}region_delete} - Delete a region
     35@item @code{@value{DIRPREFIX}region_extend} - Add memory to a region
     36@item @code{@value{DIRPREFIX}region_get_segment} - Get segment from a region
     37@item @code{@value{DIRPREFIX}region_return_segment} - Return segment to a region
     38@item @code{@value{DIRPREFIX}region_get_segment_size} - Obtain size of a segment
    3939@end itemize
    4040
     
    9191
    9292@itemize @bullet
    93 @item @code{FIFO} - tasks wait by FIFO (default)
    94 @item @code{PRIORITY} - tasks wait by priority
     93@item @code{@value{RPREFIX}FIFO} - tasks wait by FIFO (default)
     94@item @code{@value{RPREFIX}PRIORITY} - tasks wait by priority
    9595@end itemize
    9696
     
    101101required to appear in the attribute list, although it is a good
    102102programming practice to specify default attributes.  If all
    103 defaults are desired, the attribute @code{DEFAULT_ATTRIBUTES} should be
     103defaults are desired, the attribute @code{@value{RPREFIX}DEFAULT_ATTRIBUTES} should be
    104104specified on this call.
    105105
     
    107107needed to create a region with the task priority waiting queue
    108108discipline.  The attribute_set parameter to the region_create
    109 directive should be @code{PRIORITY}.
     109directive should be @code{@value{RPREFIX}PRIORITY}.
    110110
    111111@ifinfo
     
    119119
    120120@itemize @bullet
    121 @item @code{WAIT} - task will wait for semaphore (default)
    122 @item @code{NO_WAIT} - task should not wait
     121@item @code{@value{RPREFIX}WAIT} - task will wait for semaphore (default)
     122@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    123123@end itemize
    124124
     
    129129required to appear in the option list, although it is a good
    130130programming practice to specify default options.  If all
    131 defaults are desired, the option @code{DEFAULT_OPTIONS} should be
     131defaults are desired, the option @code{@value{RPREFIX}DEFAULT_OPTIONS} should be
    132132specified on this call.
    133133
    134134This example demonstrates the option parameter needed
    135135to poll for a segment.  The option parameter passed to the
    136 region_get_segment directive should be @code{NO_WAIT}.
     136region_get_segment directive should be @code{@value{RPREFIX}NO_WAIT}.
    137137
    138138@ifinfo
     
    219219@item By default, the calling task will wait forever to acquire the segment.
    220220
    221 @item Specifying the @code{NO_WAIT} option forces an immediate return
     221@item Specifying the @code{@value{RPREFIX}NO_WAIT} option forces an immediate return
    222222with an error status code.
    223223
     
    326326@subheading DIRECTIVE STATUS CODES:
    327327
    328 @code{SUCCESSFUL} - region created successfully@*
    329 @code{INVALID_NAME} - invalid task name@*
    330 @code{INVALID_ADDRESS} - address not on four byte boundary@*
    331 @code{TOO_MANY} - too many regions created@*
    332 @code{INVALID_SIZE} - invalid page size
     328@code{@value{RPREFIX}SUCCESSFUL} - region created successfully@*
     329@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     330@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
     331@code{@value{RPREFIX}TOO_MANY} - too many regions created@*
     332@code{@value{RPREFIX}INVALID_SIZE} - invalid page size
    333333
    334334@subheading DESCRIPTION:
     
    347347segment is constructed in the region.
    348348
    349 Specifying @code{PRIORITY} in attribute_set causes tasks
     349Specifying @code{@value{RPREFIX}PRIORITY} in attribute_set causes tasks
    350350waiting for a segment to be serviced according to task priority.
    351 Specifying @code{FIFO} in attribute_set or selecting
    352 @code{DEFAULT_ATTRIBUTES} will cause waiting tasks to be serviced in
     351Specifying @code{@value{RPREFIX}FIFO} in attribute_set or selecting
     352@code{@value{RPREFIX}DEFAULT_ATTRIBUTES} will cause waiting tasks to be serviced in
    353353First In-First Out order.
    354354
     
    399399@subheading DIRECTIVE STATUS CODES:
    400400
    401 @code{SUCCESSFUL} - region identified successfully@*
    402 @code{INVALID_NAME} - region name not found
     401@code{@value{RPREFIX}SUCCESSFUL} - region identified successfully@*
     402@code{@value{RPREFIX}INVALID_NAME} - region name not found
    403403
    404404@subheading DESCRIPTION:
     
    442442@subheading DIRECTIVE STATUS CODES:
    443443
    444 @code{SUCCESSFUL} - region deleted successfully@*
    445 @code{INVALID_ID} - invalid region id@*
    446 @code{RESOURCE_IN_USE} - segments still in use
     444@code{@value{RPREFIX}SUCCESSFUL} - region deleted successfully@*
     445@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
     446@code{@value{RPREFIX}RESOURCE_IN_USE} - segments still in use
    447447
    448448@subheading DESCRIPTION:
     
    492492@subheading DIRECTIVE STATUS CODES:
    493493
    494 @code{SUCCESSFUL} - region extended successfully@*
    495 @code{INVALID_ID} - invalid region id@*
    496 @code{INVALID_ADDRESS} - invalid address of area to add
     494@code{@value{RPREFIX}SUCCESSFUL} - region extended successfully@*
     495@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
     496@code{@value{RPREFIX}INVALID_ADDRESS} - invalid address of area to add
    497497
    498498@subheading DESCRIPTION:
     
    544544@subheading DIRECTIVE STATUS CODES:
    545545
    546 @code{SUCCESSFUL} - segment obtained successfully@*
    547 @code{INVALID_ID} - invalid region id@*
    548 @code{INVALID_SIZE} - request is for zero bytes or exceeds
     546@code{@value{RPREFIX}SUCCESSFUL} - segment obtained successfully@*
     547@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
     548@code{@value{RPREFIX}INVALID_SIZE} - request is for zero bytes or exceeds
    549549the size of maximum segment which is possible for this region@*
    550 @code{UNSATISFIED} - segment of requested size not available@*
    551 @code{TIMEOUT} - timed out waiting for segment@*
    552 @code{OBJECT_WAS_DELETED} - semaphore deleted while waiting
     550@code{@value{RPREFIX}UNSATISFIED} - segment of requested size not available@*
     551@code{@value{RPREFIX}TIMEOUT} - timed out waiting for segment@*
     552@code{@value{RPREFIX}OBJECT_WAS_DELETED} - semaphore deleted while waiting
    553553
    554554@subheading DESCRIPTION:
     
    556556This directive obtains a variable size segment from
    557557the region specified by id.  The address of the allocated
    558 segment is returned in segment.  The @code{WAIT} and @code{NO_WAIT} components
     558segment is returned in segment.  The @code{@value{RPREFIX}WAIT} and @code{@value{RPREFIX}NO_WAIT} components
    559559of the options parameter are used to specify whether the calling
    560560tasks wish to wait for a segment to become available or return
     
    562562sufficiently sized segment is available, then the segment is
    563563successfully acquired by returning immediately with  the
    564 @code{SUCCESSFUL} status code.
     564@code{@value{RPREFIX}SUCCESSFUL} status code.
    565565
    566566If the calling task chooses to return immediately and
     
    570570available, then the calling task is placed on the region's
    571571segment wait queue and blocked.  If the region was created with
    572 the @priority{PRIORITY} option, then the calling task is inserted into the
     572the @code{@value{RPREFIX}PRIORITY} option, then the calling task is inserted into the
    573573wait queue according to its priority.  However, if the region
    574 was created with the @priority{FIFO} option, then the calling task is
     574was created with the @code{@value{RPREFIX}FIFO} option, then the calling task is
    575575placed at the rear of the wait queue.
    576576
    577577The timeout parameter specifies the maximum interval
    578578that a task is willing to wait to obtain a segment.  If timeout
    579 is set to @code{NO_TIMEOUT}, then the calling task will wait forever.
     579is set to @code{@value{RPREFIX}NO_TIMEOUT}, then the calling task will wait forever.
    580580
    581581@subheading NOTES:
     
    589589
    590590@itemize @bullet
    591 @item @code{WAIT} - task will wait for semaphore (default)
    592 @item @code{NO_WAIT} - task should not wait
     591@item @code{@value{RPREFIX}WAIT} - task will wait for semaphore (default)
     592@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    593593@end itemize
    594594
     
    625625@subheading DIRECTIVE STATUS CODES:
    626626
    627 @code{SUCCESSFUL} - segment returned successfully@*
    628 @code{INVALID_ID} - invalid region id@*
    629 @code{INVALID_ADDRESS} - segment address not in region
     627@code{@value{RPREFIX}SUCCESSFUL} - segment returned successfully@*
     628@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
     629@code{@value{RPREFIX}INVALID_ADDRESS} - segment address not in region
    630630
    631631@subheading DESCRIPTION:
     
    683683@subheading DIRECTIVE STATUS CODES:
    684684
    685 @code{SUCCESSFUL} - segment obtained successfully@*
    686 @code{INVALID_ID} - invalid region id@*
    687 @code{INVALID_ADDRESS} - segment address not in region
     685@code{@value{RPREFIX}SUCCESSFUL} - segment obtained successfully@*
     686@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
     687@code{@value{RPREFIX}INVALID_ADDRESS} - segment address not in region
    688688
    689689@subheading DESCRIPTION:
  • doc/user/rtmon.t

    r4fa4ea65 rf331481c  
    3636
    3737@itemize @bullet
    38 @item @code{rate_monotonic_create} - Create a rate monotonic period
    39 @item @code{rate_monotonic_ident} - Get ID of a period
    40 @item @code{rate_monotonic_cancel} - Cancel a period
    41 @item @code{rate_monotonic_delete} - Delete a rate monotonic period
    42 @item @code{rate_monotonic_period} - Conclude current/Start next period
    43 @item @code{rate_monotonic_get_status} - Obtain status information on period
     38@item @code{@value{DIRPREFIX}rate_monotonic_create} - Create a rate monotonic period
     39@item @code{@value{DIRPREFIX}rate_monotonic_ident} - Get ID of a period
     40@item @code{@value{DIRPREFIX}rate_monotonic_cancel} - Cancel a period
     41@item @code{@value{DIRPREFIX}rate_monotonic_delete} - Delete a rate monotonic period
     42@item @code{@value{DIRPREFIX}rate_monotonic_period} - Conclude current/Start next period
     43@item @code{@value{DIRPREFIX}rate_monotonic_get_status} - Obtain status information on period
    4444@end itemize
    4545
     
    740740
    741741If the rate_monotonic_period directive is invoked
    742 with a period of @code{PERIOD_STATUS} ticks, the current state of the
     742with a period of @code{@value{RPREFIX}PERIOD_STATUS} ticks, the current state of the
    743743specified rate monotonic period will be returned.  The following
    744744table details the relationship between the period's status and
     
    747747
    748748@itemize @bullet
    749 @item @code{SUCCESSFUL} - period is running
    750 
    751 @item @code{TIMEOUT} - period has expired
    752 
    753 @item @code{NOT_DEFINED} - period has never been initiated
     749@item @code{@value{RPREFIX}SUCCESSFUL} - period is running
     750
     751@item @code{@value{RPREFIX}TIMEOUT} - period has expired
     752
     753@item @code{@value{RPREFIX}NOT_DEFINED} - period has never been initiated
    754754@end itemize
    755755
     
    967967
    968968@subheading DIRECTIVE STATUS CODES:
    969 @code{SUCCESSFUL} - rate monotonic period created successfully@*
    970 @code{INVALID_NAME} - invalid task name@*
    971 @code{TOO_MANY} - too many periods created
     969@code{@value{RPREFIX}SUCCESSFUL} - rate monotonic period created successfully@*
     970@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     971@code{@value{RPREFIX}TOO_MANY} - too many periods created
    972972
    973973@subheading DESCRIPTION:
     
    10131013
    10141014@subheading DIRECTIVE STATUS CODES:
    1015 @code{SUCCESSFUL} - period identified successfully@*
    1016 @code{INVALID_NAME} - period name not found
     1015@code{@value{RPREFIX}SUCCESSFUL} - period identified successfully@*
     1016@code{@value{RPREFIX}INVALID_NAME} - period name not found
    10171017
    10181018@subheading DESCRIPTION:
     
    10561056
    10571057@subheading DIRECTIVE STATUS CODES:
    1058 @code{SUCCESSFUL} - period canceled successfully@*
    1059 @code{INVALID_ID} - invalid rate monotonic period id@*
    1060 @code{NOT_OWNER_OF_RESOURCE} - rate monotonic period not created by calling task
     1058@code{@value{RPREFIX}SUCCESSFUL} - period canceled successfully@*
     1059@code{@value{RPREFIX}INVALID_ID} - invalid rate monotonic period id@*
     1060@code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - rate monotonic period not created by calling task
    10611061
    10621062@subheading DESCRIPTION:
     
    11001100
    11011101@subheading DIRECTIVE STATUS CODES:
    1102 @code{SUCCESSFUL} - period deleted successfully@*
    1103 @code{INVALID_ID} - invalid rate monotonic period id
     1102@code{@value{RPREFIX}SUCCESSFUL} - period deleted successfully@*
     1103@code{@value{RPREFIX}INVALID_ID} - invalid rate monotonic period id
    11041104
    11051105@subheading DESCRIPTION:
     
    11451145
    11461146@subheading DIRECTIVE STATUS CODES:
    1147 @code{SUCCESSFUL} - period initiated successfully@*
    1148 @code{INVALID_ID} - invalid rate monotonic period id@*
    1149 @code{NOT_OWNER_OF_RESOURCE} - period not created by calling task@*
    1150 @code{NOT_DEFINED} - period has never been initiated (only
     1147@code{@value{RPREFIX}SUCCESSFUL} - period initiated successfully@*
     1148@code{@value{RPREFIX}INVALID_ID} - invalid rate monotonic period id@*
     1149@code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - period not created by calling task@*
     1150@code{@value{RPREFIX}NOT_DEFINED} - period has never been initiated (only
    11511151possible when period is set to PERIOD_STATUS)@*
    1152 @code{TIMEOUT} - period has expired
     1152@code{@value{RPREFIX}TIMEOUT} - period has expired
    11531153
    11541154@subheading DESCRIPTION:
     
    11611161immediately initiated and the directive returns immediately.
    11621162
    1163 If invoked with a period of @code{PERIOD_STATUS} ticks, the
     1163If invoked with a period of @code{@value{RPREFIX}PERIOD_STATUS} ticks, the
    11641164current state of id will be returned.  The directive status
    11651165indicates the current state of the period.  This does not alter
     
    11991199
    12001200@subheading DIRECTIVE STATUS CODES:
    1201 @code{SUCCESSFUL} - period initiated successfully@*
    1202 @code{INVALID_ID} - invalid rate monotonic period id@*
    1203 @code{INVALID_ADDRESS} - invalid address of status@*
     1201@code{@value{RPREFIX}SUCCESSFUL} - period initiated successfully@*
     1202@code{@value{RPREFIX}INVALID_ID} - invalid rate monotonic period id@*
     1203@code{@value{RPREFIX}INVALID_ADDRESS} - invalid address of status@*
    12041204
    12051205@subheading DESCRIPTION:
  • doc/user/schedule.t

    r4fa4ea65 rf331481c  
    129129Another way the user can alter the basic scheduling
    130130algorithm is by manipulating the preemption mode flag
    131 (@code{PREEMPT_MASK}) of individual tasks.  If preemption is disabled
    132 for a task (@code{NO_PREEMPT}), then the task will not relinquish
     131(@code{@value{RPREFIX}PREEMPT_MASK}) of individual tasks.  If preemption is disabled
     132for a task (@code{@value{RPREFIX}NO_PREEMPT}), then the task will not relinquish
    133133control of the processor until it terminates, blocks, or
    134134re-enables preemption.  Even tasks which become ready to run and
     
    147147scheduling algorithm.  Like preemption, timeslicing is specified
    148148on a task by task basis using the timeslicing mode flag
    149 (@code{TIMESLICE_MASK}).  If timeslicing is enabled for a task
    150 (@code{TIMESLICE}), then RTEMS will limit the amount of time the task
     149(@code{@value{RPREFIX}TIMESLICE_MASK}).  If timeslicing is enabled for a task
     150(@code{@value{RPREFIX}TIMESLICE}), then RTEMS will limit the amount of time the task
    151151can execute before the processor is allocated to another task.
    152152Each tick of the real-time clock reduces the currently running
     
    168168algorithm is called manual round-robin.  Manual round-robin is
    169169invoked by using the task_wake_after directive with a time
    170 interval of @code{YIELD_PROCESSOR}.  This allows a task to give up the
     170interval of @code{@value{RPREFIX}YIELD_PROCESSOR}.  This allows a task to give up the
    171171processor and be immediately returned to the ready chain at the
    172172end of its priority group.  If no other tasks of the same
     
    196196
    197197Tasks that utilize a numeric coprocessor and are
    198 created with the @code{FLOATING_POINT} attribute require additional
     198created with the @code{@value{RPREFIX}FLOATING_POINT} attribute require additional
    199199operations during a context switch.  These additional operations
    200200are necessary to save and restore the floating point context of
    201 @code{FLOATING_POINT} tasks.  To avoid unnecessary save and restore
     201@code{@value{RPREFIX}FLOATING_POINT} tasks.  To avoid unnecessary save and restore
    202202operations, the state of the numeric coprocessor is only saved
    203 when a @code{FLOATING_POINT} task is dispatched and that task was not
     203when a @code{@value{RPREFIX}FLOATING_POINT} task is dispatched and that task was not
    204204the last task to utilize the coprocessor.
    205205
  • doc/user/sem.t

    r4fa4ea65 rf331481c  
    3131
    3232@itemize @bullet
    33 @item @code{semaphore_create} -  Create a semaphore
    34 @item @code{semaphore_ident} - Get ID of a semaphore
    35 @item @code{semaphore_delete} - Delete a semaphore
    36 @item @code{semaphore_obtain} - Acquire a semaphore
    37 @item @code{semaphore_release} - Release a semaphore
     33@item @code{@value{DIRPREFIX}semaphore_create} -  Create a semaphore
     34@item @code{@value{DIRPREFIX}semaphore_ident} - Get ID of a semaphore
     35@item @code{@value{DIRPREFIX}semaphore_delete} - Delete a semaphore
     36@item @code{@value{DIRPREFIX}semaphore_obtain} - Acquire a semaphore
     37@item @code{@value{DIRPREFIX}semaphore_release} - Release a semaphore
    3838@end itemize
    3939
     
    231231required to appear in the attribute list, although it is a good
    232232programming practice to specify default attributes.  If all
    233 defaults are desired, the attribute @code{DEFAULT_ATTRIBUTES} should be
     233defaults are desired, the attribute @code{@value{RPREFIX}DEFAULT_ATTRIBUTES} should be
    234234specified on this call.
    235235
     
    238238waiting queue discipline.  The attribute_set parameter passed to
    239239the semaphore_create directive could be either
    240 @code{PRIORITY} or
     240@code{@value{RPREFIX}PRIORITY} or
    241241@code{@value{RPREFIX}LOCAL @value{OR} @value{RPREFIX}PRIORITY}. 
    242 The attribute_set parameter can be set to @code{PRIORITY}
    243 because @code{LOCAL} is the default for all created tasks.  If a
     242The attribute_set parameter can be set to @code{@value{RPREFIX}PRIORITY}
     243because @code{@value{RPREFIX}LOCAL} is the default for all created tasks.  If a
    244244similar semaphore were to be known globally, then the
    245245attribute_set parameter would be
     
    256256
    257257@itemize @bullet
    258 @item @code{WAIT} - task will wait for semaphore (default)
    259 @item @code{NO_WAIT} - task should not wait
     258@item @code{@value{RPREFIX}WAIT} - task will wait for semaphore (default)
     259@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    260260@end itemize
    261261
     
    266266required to appear in the list, although it is a good
    267267programming practice to specify default options.  If all
    268 defaults are desired, the option @code{DEFAULT_OPTIONS} should be
     268defaults are desired, the option @code{@value{RPREFIX}DEFAULT_OPTIONS} should be
    269269specified on this call.
    270270
    271271This example demonstrates the option parameter needed
    272272to poll for a semaphore.  The option parameter passed to the
    273 semaphore_obtain directive should be @code{NO_WAIT}.
     273semaphore_obtain directive should be @code{@value{RPREFIX}NO_WAIT}.
    274274
    275275@ifinfo
     
    348348acquire the semaphore.
    349349
    350 @item Specifying @code{NO_WAIT} forces an immediate return with an
     350@item Specifying @code{@value{RPREFIX}NO_WAIT} forces an immediate return with an
    351351error status code.
    352352
     
    457457
    458458@subheading DIRECTIVE STATUS CODES:
    459 @code{SUCCESSFUL} - semaphore created successfully@*
    460 @code{INVALID_NAME} - invalid task name@*
    461 @code{TOO_MANY} - too many semaphores created@*
    462 @code{NOT_DEFINED} - invalid attribute set@*
    463 @code{INVALID_NUMBER} - invalid starting count for binary semaphore@*
    464 @code{MP_NOT_CONFIGURED} - multiprocessing not configured@*
    465 @code{TOO_MANY} - too many global objects
     459@code{@value{RPREFIX}SUCCESSFUL} - semaphore created successfully@*
     460@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     461@code{@value{RPREFIX}TOO_MANY} - too many semaphores created@*
     462@code{@value{RPREFIX}NOT_DEFINED} - invalid attribute set@*
     463@code{@value{RPREFIX}INVALID_NUMBER} - invalid starting count for binary semaphore@*
     464@code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured@*
     465@code{@value{RPREFIX}TOO_MANY} - too many global objects
    466466
    467467@subheading DESCRIPTION:
     
    546546
    547547@subheading DIRECTIVE STATUS CODES:
    548 @code{SUCCESSFUL} - semaphore identified successfully@*
    549 @code{INVALID_NAME} - semaphore name not found@*
    550 @code{INVALID_NODE} - invalid node id
     548@code{@value{RPREFIX}SUCCESSFUL} - semaphore identified successfully@*
     549@code{@value{RPREFIX}INVALID_NAME} - semaphore name not found@*
     550@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    551551
    552552@subheading DESCRIPTION:
     
    564564preempted.
    565565
    566 If node is @code{SEARCH_ALL_NODES}, all nodes are searched
     566If node is @code{@value{RPREFIX}SEARCH_ALL_NODES}, all nodes are searched
    567567with the local node being searched first.  All other nodes are
    568568searched with the lowest numbered node searched first.
     
    602602
    603603@subheading DIRECTIVE STATUS CODES:
    604 @code{SUCCESSFUL} -  semaphore deleted successfully@*
    605 @code{INVALID_ID} - invalid semaphore id@*
    606 @code{ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote semaphore@*
    607 @code{RESOURCE_IN_USE} - binary semaphore is in use
     604@code{@value{RPREFIX}SUCCESSFUL} -  semaphore deleted successfully@*
     605@code{@value{RPREFIX}INVALID_ID} - invalid semaphore id@*
     606@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot delete remote semaphore@*
     607@code{@value{RPREFIX}RESOURCE_IN_USE} - binary semaphore is in use
    608608
    609609@subheading DESCRIPTION:
     
    667667
    668668@subheading DIRECTIVE STATUS CODES:
    669 @code{SUCCESSFUL} - semaphore obtained successfully@*
    670 @code{UNSATISFIED} - semaphore not available@*
    671 @code{TIMEOUT} - timed out waiting for semaphore@*
    672 @code{OBJECT_WAS_DELETED} - semaphore deleted while waiting@*
    673 @code{INVALID_ID} - invalid semaphore id
     669@code{@value{RPREFIX}SUCCESSFUL} - semaphore obtained successfully@*
     670@code{@value{RPREFIX}UNSATISFIED} - semaphore not available@*
     671@code{@value{RPREFIX}TIMEOUT} - timed out waiting for semaphore@*
     672@code{@value{RPREFIX}OBJECT_WAS_DELETED} - semaphore deleted while waiting@*
     673@code{@value{RPREFIX}INVALID_ID} - invalid semaphore id
    674674
    675675@subheading DESCRIPTION:
    676676
    677677This directive acquires the semaphore specified by
    678 id.  The @code{WAIT} and @code{NO_WAIT} components of the options parameter
     678id.  The @code{@value{RPREFIX}WAIT} and @code{@value{RPREFIX}NO_WAIT} components of the options parameter
    679679indicate whether the calling task wants to wait for the
    680680semaphore to become available or return immediately if the
    681 semaphore is not currently available.  With either @code{WAIT} or
    682 @code{NO_WAIT}, if the current semaphore count is positive, then it is
     681semaphore is not currently available.  With either @code{@value{RPREFIX}WAIT} or
     682@code{@value{RPREFIX}NO_WAIT}, if the current semaphore count is positive, then it is
    683683decremented by one and the semaphore is successfully acquired by
    684684returning immediately with a successful return code.
     
    691691decremented by one and the calling task is placed on the
    692692semaphore's wait queue and blocked.  If the semaphore was
    693 created with the @code{PRIORITY} attribute, then the calling task is
     693created with the @code{@value{RPREFIX}PRIORITY} attribute, then the calling task is
    694694inserted into the queue according to its priority.  However, if
    695 the semaphore was created with the @code{FIFO} attribute, then the
     695the semaphore was created with the @code{@value{RPREFIX}FIFO} attribute, then the
    696696calling task is placed at the rear of the wait queue.  If the
    697 binary semaphore was created with the @code{INHERIT_PRIORITY}
     697binary semaphore was created with the @code{@value{RPREFIX}INHERIT_PRIORITY}
    698698attribute, then the priority of the task currently holding the
    699699binary semaphore is guaranteed to be greater than or equal to
    700700that of the blocking task.  If the binary semaphore was created
    701 with the @code{PRIORITY_CEILING} attribute, a task successfully obtains
     701with the @code{@value{RPREFIX}PRIORITY_CEILING} attribute, a task successfully obtains
    702702the semaphore, and the priority of that task is greater than the
    703703ceiling priority for this semaphore, then the priority of the
     
    706706The timeout parameter specifies the maximum interval
    707707the calling task is willing to be blocked waiting for the
    708 semaphore.  If it is set to @code{NO_TIMEOUT}, then the calling task
    709 will wait forever.  If the semaphore is available or the @code{NO_WAIT}
     708semaphore.  If it is set to @code{@value{RPREFIX}NO_TIMEOUT}, then the calling task
     709will wait forever.  If the semaphore is available or the @code{@value{RPREFIX}NO_WAIT}
    710710option component is set, then timeout is ignored.
    711711
     
    715715
    716716@itemize @bullet
    717 @item @code{WAIT} - task will wait for semaphore (default)
    718 @item @code{NO_WAIT} - task should not wait
     717@item @code{@value{RPREFIX}WAIT} - task will wait for semaphore (default)
     718@item @code{@value{RPREFIX}NO_WAIT} - task should not wait
    719719@end itemize
    720720
     
    722722the local node will generate a request to the remote node to
    723723access the semaphore.  If the semaphore is not available and
    724 @code{NO_WAIT} was not specified, then the task must be blocked until
     724@code{@value{RPREFIX}NO_WAIT} was not specified, then the task must be blocked until
    725725the semaphore is released.  A proxy is allocated on the remote
    726726node to represent the task until the semaphore is released.
     
    755755
    756756@subheading DIRECTIVE STATUS CODES:
    757 @code{SUCCESSFUL} - semaphore released successfully@*
    758 @code{INVALID_ID} - invalid semaphore id@*
    759 @code{NOT_OWNER_OF_RESOURCE} - calling task does not own semaphore
     757@code{@value{RPREFIX}SUCCESSFUL} - semaphore released successfully@*
     758@code{@value{RPREFIX}INVALID_ID} - invalid semaphore id@*
     759@code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - calling task does not own semaphore
    760760
    761761@subheading DESCRIPTION:
  • doc/user/signal.t

    r4fa4ea65 rf331481c  
    3030
    3131@itemize @bullet
    32 @item @code{signal_catch} - Establish an ASR
    33 @item @code{signal_send} - Send signal set to a task
     32@item @code{@value{DIRPREFIX}signal_catch} - Establish an ASR
     33@item @code{@value{DIRPREFIX}signal_send} - Send signal set to a task
    3434@end itemize
    3535
     
    101101
    102102A signal set is built by a bitwise OR of the desired
    103 signals.  The set of valid signals is @code{SIGNAL_0} through
    104 @code{SIGNAL_31}.  If a signal is not explicitly specified in the
     103signals.  The set of valid signals is @code{@value{RPREFIX}SIGNAL_0} through
     104@code{@value{RPREFIX}SIGNAL_31}.  If a signal is not explicitly specified in the
    105105signal set, then it is not present.  Signal values are
    106106specifically designed to be mutually exclusive, therefore
     
    110110This example demonstrates the signal parameter used
    111111when sending the signal set consisting of
    112 @code{SIGNAL_6}, @code{SIGNAL_15}, and @code{SIGNAL_31}. 
     112@code{@value{RPREFIX}SIGNAL_6}, @code{@value{RPREFIX}SIGNAL_15}, and @code{@value{RPREFIX}SIGNAL_31}. 
    113113The signal parameter provided to the signal_send directive should be
    114114@code{@value{RPREFIX}SIGNAL_6 @value{OR}
     
    127127
    128128@itemize @bullet
    129 @item @code{PREEMPT} is masked by
    130 @code{PREEMPT_MASK} and enables preemption
    131 
    132 @item @code{NO_PREEMPT} is masked by
    133 @code{PREEMPT_MASK} and disables preemption
    134 
    135 @item @code{NO_TIMESLICE} is masked by
    136 @code{TIMESLICE_MASK} and disables timeslicing
    137 
    138 @item @code{TIMESLICE} is masked by
    139 @code{TIMESLICE_MASK} and enables timeslicing
    140 
    141 @item @code{ASR} is masked by
    142 @code{ASR_MASK} and enables ASR processing
    143 
    144 @item @code{NO_ASR} is masked by
    145 @code{ASR_MASK} and disables ASR processing
     129@item @code{@value{RPREFIX}PREEMPT} is masked by
     130@code{@value{RPREFIX}PREEMPT_MASK} and enables preemption
     131
     132@item @code{@value{RPREFIX}NO_PREEMPT} is masked by
     133@code{@value{RPREFIX}PREEMPT_MASK} and disables preemption
     134
     135@item @code{@value{RPREFIX}NO_TIMESLICE} is masked by
     136@code{@value{RPREFIX}TIMESLICE_MASK} and disables timeslicing
     137
     138@item @code{@value{RPREFIX}TIMESLICE} is masked by
     139@code{@value{RPREFIX}TIMESLICE_MASK} and enables timeslicing
     140
     141@item @code{@value{RPREFIX}ASR} is masked by
     142@code{@value{RPREFIX}ASR_MASK} and enables ASR processing
     143
     144@item @code{@value{RPREFIX}NO_ASR} is masked by
     145@code{@value{RPREFIX}ASR_MASK} and disables ASR processing
    146146
    147147@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} is masked by
    148 @code{INTERRUPT_MASK} and enables all interrupts
    149 
    150 @item @code{@value{RPREFIX}INTERRUPT_LEVEL}(n)} is masked by
    151 @code{INTERRUPT_MASK} and sets interrupts level n
     148@code{@value{RPREFIX}INTERRUPT_MASK} and enables all interrupts
     149
     150@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} is masked by
     151@code{@value{RPREFIX}INTERRUPT_MASK} and sets interrupts level n
    152152@end itemize
    153153
     
    319319
    320320@subheading DIRECTIVE STATUS CODES:
    321 @code{SUCCESSFUL} - always successful
     321@code{@value{RPREFIX}SUCCESSFUL} - always successful
    322322
    323323@subheading DESCRIPTION:
     
    340340
    341341@itemize @bullet
    342 @item @code{PREEMPT} is masked by
    343 @code{PREEMPT_MASK} and enables preemption
    344 
    345 @item @code{NO_PREEMPT} is masked by
    346 @code{PREEMPT_MASK} and disables preemption
    347 
    348 @item @code{NO_TIMESLICE} is masked by
    349 @code{TIMESLICE_MASK} and disables timeslicing
    350 
    351 @item @code{TIMESLICE} is masked by
    352 @code{TIMESLICE_MASK} and enables timeslicing
    353 
    354 @item @code{ASR} is masked by
    355 @code{ASR_MASK} and enables ASR processing
    356 
    357 @item @code{NO_ASR} is masked by
    358 @code{ASR_MASK} and disables ASR processing
     342@item @code{@value{RPREFIX}PREEMPT} is masked by
     343@code{@value{RPREFIX}PREEMPT_MASK} and enables preemption
     344
     345@item @code{@value{RPREFIX}NO_PREEMPT} is masked by
     346@code{@value{RPREFIX}PREEMPT_MASK} and disables preemption
     347
     348@item @code{@value{RPREFIX}NO_TIMESLICE} is masked by
     349@code{@value{RPREFIX}TIMESLICE_MASK} and disables timeslicing
     350
     351@item @code{@value{RPREFIX}TIMESLICE} is masked by
     352@code{@value{RPREFIX}TIMESLICE_MASK} and enables timeslicing
     353
     354@item @code{@value{RPREFIX}ASR} is masked by
     355@code{@value{RPREFIX}ASR_MASK} and enables ASR processing
     356
     357@item @code{@value{RPREFIX}NO_ASR} is masked by
     358@code{@value{RPREFIX}ASR_MASK} and disables ASR processing
    359359
    360360@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} is masked by
    361 @code{INTERRUPT_MASK} and enables all interrupts
    362 
    363 @item @code{@value{RPREFIX}INTERRUPT_LEVEL}(n)} is masked by
    364 @code{INTERRUPT_MASK} and sets interrupts level n
     361@code{@value{RPREFIX}INTERRUPT_MASK} and enables all interrupts
     362
     363@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} is masked by
     364@code{@value{RPREFIX}INTERRUPT_MASK} and sets interrupts level n
    365365@end itemize
    366366
     
    393393
    394394@subheading DIRECTIVE STATUS CODES:
    395 @code{SUCCESSFUL} - signal sent successfully@*
    396 @code{INVALID_ID} - task id invalid@*
    397 @code{NOT_DEFINED} - ASR invalid
     395@code{@value{RPREFIX}SUCCESSFUL} - signal sent successfully@*
     396@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
     397@code{@value{RPREFIX}NOT_DEFINED} - ASR invalid
    398398
    399399@subheading DESCRIPTION:
  • doc/user/task.t

    r4fa4ea65 rf331481c  
    3232
    3333@itemize @bullet
    34 @item @code{task_create} - Create a task
    35 @item @code{task_ident} - Get ID of a task
    36 @item @code{task_start} - Start a task
    37 @item @code{task_restart} - Restart a task
    38 @item @code{task_delete} - Delete a task
    39 @item @code{task_suspend} - Suspend a task
    40 @item @code{task_resume} - Resume a task
    41 @item @code{task_set_priority} - Set task priority
    42 @item @code{task_mode} - Change current task's mode
    43 @item @code{task_get_note} - Get task notepad entry
    44 @item @code{task_set_note} - Set task notepad entry
    45 @item @code{task_wake_after} - Wake up after interval
    46 @item @code{task_wake_when} - Wake up when specified 
     34@item @code{@value{DIRPREFIX}task_create} - Create a task
     35@item @code{@value{DIRPREFIX}task_ident} - Get ID of a task
     36@item @code{@value{DIRPREFIX}task_start} - Start a task
     37@item @code{@value{DIRPREFIX}task_restart} - Restart a task
     38@item @code{@value{DIRPREFIX}task_delete} - Delete a task
     39@item @code{@value{DIRPREFIX}task_suspend} - Suspend a task
     40@item @code{@value{DIRPREFIX}task_resume} - Resume a task
     41@item @code{@value{DIRPREFIX}task_set_priority} - Set task priority
     42@item @code{@value{DIRPREFIX}task_mode} - Change current task's mode
     43@item @code{@value{DIRPREFIX}task_get_note} - Get task notepad entry
     44@item @code{@value{DIRPREFIX}task_set_note} - Set task notepad entry
     45@item @code{@value{DIRPREFIX}task_wake_after} - Wake up after interval
     46@item @code{@value{DIRPREFIX}task_wake_when} - Wake up when specified 
    4747@end itemize
    4848
     
    196196The preemption component allows a task to determine when control
    197197of the processor is relinquished.  If preemption is disabled
    198 (NO_PREEMPT), the task will retain control of the processor as
     198(@code{@value{RPREFIX}NO_PREEMPT}), the task will retain control of the processor as
    199199long as it is in the executing state -- even if a higher
    200 priority task is made ready.  If preemption is enabled (PREEMPT)
     200priority task is made ready.  If preemption is enabled (@code{@value{RPREFIX}PREEMPT})
    201201and a higher priority task is made ready, then the processor
    202202will be taken away from the current task immediately and given
     
    205205The timeslicing component is used by the RTEMS scheduler to
    206206determine how the processor is allocated to tasks of equal
    207 priority.  If timeslicing is enabled (TIMESLICE), then RTEMS
     207priority.  If timeslicing is enabled (@code{@value{RPREFIX}TIMESLICE}), then RTEMS
    208208will limit the amount of time the task can execute before the
    209209processor is allocated to another ready task of equal priority.
    210210The length of the timeslice is application dependent and
    211211specified in the Configuration Table.  If timeslicing is
    212 disabled (NO_TIMESLICE), then the task will be allowed to
     212disabled (@code{@value{RPREFIX}NO_TIMESLICE}), then the task will be allowed to
    213213execute until a task of higher priority is made ready.  If
    214 NO_PREEMPT is selected, then the timeslicing component is
     214@code{@value{RPREFIX}NO_PREEMPT} is selected, then the timeslicing component is
    215215ignored by the scheduler.
    216216
    217217The asynchronous signal processing component is used to
    218218determine when received signals are to be processed by the task.
    219  If signal processing is enabled (ASR), then signals sent to the
     219 If signal processing is enabled (@code{@value{RPREFIX}ASR}), then signals sent to the
    220220task will be processed the next time the task executes.  If
    221 signal processing is disabled (NO_ASR), then all signals
     221signal processing is disabled (@code{@value{RPREFIX}NO_ASR}), then all signals
    222222received by the task will remain posted until signal processing
    223223is enabled.  This component affects only tasks which have
     
    226226The interrupt level component is used to determine which
    227227interrupts will be enabled when the task is executing.
    228 INTERRUPT_LEVEL(n) specifies that the task will execute at
    229 interrupt level n.
     228@code{@value{RPREFIX}INTERRUPT_LEVEL(n)}
     229specifies that the task will execute at interrupt level n.
    230230
    231231@itemize  @bullet
    232 @item @code{PREEMPT} - enable preemption (default)
    233 @item @code{NO_PREEMPT} - disable preemption
    234 @item @code{NO_TIMESLICE} - disable timeslicing (default)
    235 @item @code{TIMESLICE} - enable timeslicing
    236 @item @code{ASR} - enable ASR processing (default)
    237 @item @code{NO_ASR} - disable ASR processing
     232@item @code{@value{RPREFIX}PREEMPT} - enable preemption (default)
     233@item @code{@value{RPREFIX}NO_PREEMPT} - disable preemption
     234@item @code{@value{RPREFIX}NO_TIMESLICE} - disable timeslicing (default)
     235@item @code{@value{RPREFIX}TIMESLICE} - enable timeslicing
     236@item @code{@value{RPREFIX}ASR} - enable ASR processing (default)
     237@item @code{@value{RPREFIX}NO_ASR} - disable ASR processing
    238238@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} - enable all interrupts (default)
    239239@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} - execute at interrupt level n
     
    275275@subsection Floating Point Considerations
    276276
    277 Creating a task with the @code{FLOATING_POINT} flag results in
     277Creating a task with the @code{@value{RPREFIX}FLOATING_POINT} flag results in
    278278additional memory being allocated for the TCB to store the state
    279279of the numeric coprocessor during task switches.  This
    280 additional memory is @b{NOT} allocated for @code{NO_FLOATING_POINT} tasks.
    281 Saving and restoring the context of a @code{FLOATING_POINT} task takes
    282 longer than that of a @code{NO_FLOATING_POINT} task because of the
     280additional memory is @b{NOT} allocated for @code{@value{RPREFIX}NO_FLOATING_POINT} tasks.
     281Saving and restoring the context of a @code{@value{RPREFIX}FLOATING_POINT} task takes
     282longer than that of a @code{@value{RPREFIX}NO_FLOATING_POINT} task because of the
    283283relatively large amount of time required for the numeric
    284284coprocessor to save or restore its computational state.
     
    288288is optimized to avoid unnecessarily saving and restoring the
    289289state of the numeric coprocessor.  The state of the numeric
    290 coprocessor is only saved when a @code{FLOATING_POINT} task is
     290coprocessor is only saved when a @code{@value{RPREFIX}FLOATING_POINT} task is
    291291dispatched and that task was not the last task to utilize the
    292 coprocessor.  In a system with only one @code{FLOATING_POINT} task, the
     292coprocessor.  In a system with only one @code{@value{RPREFIX}FLOATING_POINT} task, the
    293293state of the numeric coprocessor will never be saved or
    294294restored. 
    295295
    296 Although the overhead imposed by @code{FLOATING_POINT} tasks is
     296Although the overhead imposed by @code{@value{RPREFIX}FLOATING_POINT} tasks is
    297297minimal, some applications may wish to completely avoid the
    298 overhead associated with @code{FLOATING_POINT} tasks and still utilize
     298overhead associated with @code{@value{RPREFIX}FLOATING_POINT} tasks and still utilize
    299299a numeric coprocessor.  By preventing a task from being
    300300preempted while performing a sequence of floating point
    301 operations, a @code{NO_FLOATING_POINT} task can utilize the numeric
    302 coprocessor without incurring the overhead of a @code{FLOATING_POINT}
     301operations, a @code{@value{RPREFIX}NO_FLOATING_POINT} task can utilize the numeric
     302coprocessor without incurring the overhead of a @code{@value{RPREFIX}FLOATING_POINT}
    303303context switch.  This approach also avoids the allocation of a
    304304floating point context area.  However, if this approach is taken
    305305by the application designer, NO tasks should be created as
    306 @code{FLOATING_POINT} tasks.  Otherwise, the floating point context
     306@code{@value{RPREFIX}FLOATING_POINT} tasks.  Otherwise, the floating point context
    307307will not be correctly maintained because RTEMS assumes that the
    308308state of the numeric coprocessor will not be altered by
    309 @code{NO_FLOATING_POINT} tasks.
     309@code{@value{RPREFIX}NO_FLOATING_POINT} tasks.
    310310
    311311If the supported processor type does not have hardware floating
     
    313313provide built-in support for hardware floating point on that
    314314processor.  In this case, all tasks are considered
    315 @code{NO_FLOATING_POINT} whether created as @code{FLOATING_POINT} or
    316 @code{NO_FLOATING_POINT} tasks.  A floating point emulation software
     315@code{@value{RPREFIX}NO_FLOATING_POINT} whether created as @code{@value{RPREFIX}FLOATING_POINT} or
     316@code{@value{RPREFIX}NO_FLOATING_POINT} tasks.  A floating point emulation software
    317317library must be utilized for floating point operations.
    318318
     
    321321processor, then RTEMS will utilize this capability to enable the
    322322floating point unit only for tasks which are created with the
    323 @code{FLOATING_POINT} attribute.  The consequence of a
    324 @code{NO_FLOATING_POINT} task attempting to access the floating point
     323@code{@value{RPREFIX}FLOATING_POINT} attribute.  The consequence of a
     324@code{@value{RPREFIX}NO_FLOATING_POINT} task attempting to access the floating point
    325325unit is CPU dependent but will i general result in an exception
    326326condition.
     
    336336
    337337@itemize @bullet
    338 @item @code{NO_FLOATING_POINT} - does not use coprocessor (default)
    339 @item @code{FLOATING_POINT} - uses numeric coprocessor
    340 @item @code{LOCAL} - local task (default)
    341 @item @code{GLOBAL} - global task
     338@item @code{@value{RPREFIX}NO_FLOATING_POINT} - does not use coprocessor (default)
     339@item @code{@value{RPREFIX}FLOATING_POINT} - uses numeric coprocessor
     340@item @code{@value{RPREFIX}LOCAL} - local task (default)
     341@item @code{@value{RPREFIX}GLOBAL} - global task
    342342@end itemize
    343343
     
    348348to appear in the component list, although it is a good
    349349programming practice to specify default components.  If all
    350 defaults are desired, then @code{DEFAULT_ATTRIBUTES} should be used.
     350defaults are desired, then @code{@value{RPREFIX}DEFAULT_ATTRIBUTES} should be used.
    351351
    352352This example demonstrates the attribute_set parameter needed to
    353353create a local task which utilizes the numeric coprocessor.  The
    354 attribute_set parameter could be @code{FLOATING_POINT} or
     354attribute_set parameter could be @code{@value{RPREFIX}FLOATING_POINT} or
    355355@code{@value{RPREFIX}LOCAL @value{OR} @value{RPREFIX}FLOATING_POINT}. 
    356356The attribute_set parameter can be set to
    357 @code{FLOATING_POINT} because @code{LOCAL} is the default for all created
     357@code{@value{RPREFIX}FLOATING_POINT} because @code{@value{RPREFIX}LOCAL} is the default for all created
    358358tasks.  If the task were global and used the numeric
    359359coprocessor, then the attribute_set parameter would be
     
    372372@ifset use-ascii
    373373@itemize @bullet
    374 @item @code{PREEMPT} is masked by
    375 @code{PREEMPT_MASK} and enables preemption
    376 
    377 @item @code{NO_PREEMPT} is masked by
    378 @code{PREEMPT_MASK} and disables preemption
    379 
    380 @item @code{NO_TIMESLICE} is masked by
    381 @code{TIMESLICE_MASK} and disables timeslicing
    382 
    383 @item @code{TIMESLICE} is masked by
    384 @code{TIMESLICE_MASK} and enables timeslicing
    385 
    386 @item @code{ASR} is masked by
    387 @code{ASR_MASK} and enables ASR processing
    388 
    389 @item @code{NO_ASR} is masked by
    390 @code{ASR_MASK} and disables ASR processing
     374@item @code{@value{RPREFIX}PREEMPT} is masked by
     375@code{@value{RPREFIX}PREEMPT_MASK} and enables preemption
     376
     377@item @code{@value{RPREFIX}NO_PREEMPT} is masked by
     378@code{@value{RPREFIX}PREEMPT_MASK} and disables preemption
     379
     380@item @code{@value{RPREFIX}NO_TIMESLICE} is masked by
     381@code{@value{RPREFIX}TIMESLICE_MASK} and disables timeslicing
     382
     383@item @code{@value{RPREFIX}TIMESLICE} is masked by
     384@code{@value{RPREFIX}TIMESLICE_MASK} and enables timeslicing
     385
     386@item @code{@value{RPREFIX}ASR} is masked by
     387@code{@value{RPREFIX}ASR_MASK} and enables ASR processing
     388
     389@item @code{@value{RPREFIX}NO_ASR} is masked by
     390@code{@value{RPREFIX}ASR_MASK} and disables ASR processing
    391391
    392392@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} is masked by
    393 @code{INTERRUPT_MASK} and enables all interrupts
    394 
    395 @item @code{@value{RPREFIX}INTERRUPT_LEVEL}(n)} is masked by
    396 @code{INTERRUPT_MASK} and sets interrupts level n
     393@code{@value{RPREFIX}INTERRUPT_MASK} and enables all interrupts
     394
     395@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} is masked by
     396@code{@value{RPREFIX}INTERRUPT_MASK} and sets interrupts level n
    397397@end itemize
    398398@end ifset
     
    402402@c this is temporary
    403403@itemize @bullet
    404 @item @code{PREEMPT} is masked by
    405 @code{PREEMPT_MASK} and enables preemption
    406 
    407 @item @code{NO_PREEMPT} is masked by
    408 @code{PREEMPT_MASK} and disables preemption
    409 
    410 @item @code{NO_TIMESLICE} is masked by
    411 @code{TIMESLICE_MASK} and disables timeslicing
    412 
    413 @item @code{TIMESLICE} is masked by
    414 @code{TIMESLICE_MASK} and enables timeslicing
    415 
    416 @item @code{ASR} is masked by
    417 @code{ASR_MASK} and enables ASR processing
    418 
    419 @item @code{NO_ASR} is masked by
    420 @code{ASR_MASK} and disables ASR processing
     404@item @code{@value{RPREFIX}PREEMPT} is masked by
     405@code{@value{RPREFIX}PREEMPT_MASK} and enables preemption
     406
     407@item @code{@value{RPREFIX}NO_PREEMPT} is masked by
     408@code{@value{RPREFIX}PREEMPT_MASK} and disables preemption
     409
     410@item @code{@value{RPREFIX}NO_TIMESLICE} is masked by
     411@code{@value{RPREFIX}TIMESLICE_MASK} and disables timeslicing
     412
     413@item @code{@value{RPREFIX}TIMESLICE} is masked by
     414@code{@value{RPREFIX}TIMESLICE_MASK} and enables timeslicing
     415
     416@item @code{@value{RPREFIX}ASR} is masked by
     417@code{@value{RPREFIX}ASR_MASK} and enables ASR processing
     418
     419@item @code{@value{RPREFIX}NO_ASR} is masked by
     420@code{@value{RPREFIX}ASR_MASK} and disables ASR processing
    421421
    422422@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} is masked by
    423 @code{INTERRUPT_MASK} and enables all interrupts
    424 
    425 @item @code{@value{RPREFIX}INTERRUPT_LEVEL}(n)} is masked by
    426 @code{INTERRUPT_MASK} and sets interrupts level n
     423@code{@value{RPREFIX}INTERRUPT_MASK} and enables all interrupts
     424
     425@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} is masked by
     426@code{@value{RPREFIX}INTERRUPT_MASK} and sets interrupts level n
    427427 
    428428@end itemize
     
    477477the mode component list, although it is a good programming
    478478practice to specify default components.  If all defaults are
    479 desired, the mode @code{DEFAULT_MODES} and the mask @code{ALL_MODE_MASKS}
     479desired, the mode @code{@value{RPREFIX}DEFAULT_MODES} and the mask @code{@value{RPREFIX}ALL_MODE_MASKS}
    480480should be used.
    481481
     
    599599blocked until the delay interval has elapsed, at which time the
    600600task is unblocked.  A task calling the task_wake_after directive
    601 with a delay interval of @code{YIELD_PROCESSOR} ticks will yield the
     601with a delay interval of @code{@value{RPREFIX}YIELD_PROCESSOR} ticks will yield the
    602602processor to any other ready task of equal or greater priority
    603603and remain ready to execute.
     
    745745@subheading DIRECTIVE STATUS CODES:
    746746@code{@value{RPREFIX}SUCCESSFUL} - task created successfully@*
    747 @code{INVALID_NAME} - invalid task name@*
    748 @code{INVALID_SIZE} - stack too small@*
    749 @code{INVALID_PRIORITY} - invalid task priority@*
    750 @code{MP_NOT_CONFIGURED} - multiprocessing not configured@*
    751 @code{TOO_MANY} - too many tasks created@*
    752 @code{UNSATISFIED} - not enough memory for stack/FP context@*
    753 @code{TOO_MANY} - too many global objects
     747@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     748@code{@value{RPREFIX}INVALID_SIZE} - stack too small@*
     749@code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority@*
     750@code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured@*
     751@code{@value{RPREFIX}TOO_MANY} - too many tasks created@*
     752@code{@value{RPREFIX}UNSATISFIED} - not enough memory for stack/FP context@*
     753@code{@value{RPREFIX}TOO_MANY} - too many global objects
    754754
    755755@subheading DESCRIPTION:
     
    758758floating point context area.  The mode parameter contains values
    759759which sets the task's initial execution mode.  The
    760 @code{FLOATING_POINT} attribute should be specified if the created task
     760@code{@value{RPREFIX}FLOATING_POINT} attribute should be specified if the created task
    761761is to use a numeric coprocessor.  For performance reasons, it is
    762762recommended that tasks not using the numeric coprocessor should
    763 specify the @code{NO_FLOATING_POINT} attribute.  If the GLOBAL
     763specify the @code{@value{RPREFIX}NO_FLOATING_POINT} attribute.  If the GLOBAL
    764764attribute is specified, the task can be accessed from remote
    765765nodes.  The task id, returned in id, is used in other task
     
    777777target processor.
    778778
    779 The requested stack size should be at least @code{MINIMUM_STACK_SIZE}
    780 bytes.  The value of @code{MINIMUM_STACK_SIZE} is processor dependent.
     779The requested stack size should be at least @code{@value{RPREFIX}MINIMUM_STACK_SIZE}
     780bytes.  The value of @code{@value{RPREFIX}MINIMUM_STACK_SIZE} is processor dependent.
    781781Application developers should consider the stack usage of the
    782782device drivers when calculating the stack size required for
     
    786786
    787787@itemize @bullet
    788 @item @code{NO_FLOATING_POINT} - does not use coprocessor (default)
    789 @item @code{FLOATING_POINT} - uses numeric coprocessor
    790 @item @code{LOCAL} - local task (default)
    791 @item @code{GLOBAL} - global task
     788@item @code{@value{RPREFIX}NO_FLOATING_POINT} - does not use coprocessor (default)
     789@item @code{@value{RPREFIX}FLOATING_POINT} - uses numeric coprocessor
     790@item @code{@value{RPREFIX}LOCAL} - local task (default)
     791@item @code{@value{RPREFIX}GLOBAL} - global task
    792792@end itemize
    793793
     
    795795
    796796@itemize  @bullet
    797 @item @code{PREEMPT} - enable preemption (default)
    798 @item @code{NO_PREEMPT} - disable preemption
    799 @item @code{NO_TIMESLICE} - disable timeslicing (default)
    800 @item @code{TIMESLICE} - enable timeslicing
    801 @item @code{ASR} - enable ASR processing (default)
    802 @item @code{NO_ASR} - disable ASR processing
     797@item @code{@value{RPREFIX}PREEMPT} - enable preemption (default)
     798@item @code{@value{RPREFIX}NO_PREEMPT} - disable preemption
     799@item @code{@value{RPREFIX}NO_TIMESLICE} - disable timeslicing (default)
     800@item @code{@value{RPREFIX}TIMESLICE} - enable timeslicing
     801@item @code{@value{RPREFIX}ASR} - enable ASR processing (default)
     802@item @code{@value{RPREFIX}NO_ASR} - disable ASR processing
    803803@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} - enable all interrupts (default)
    804804@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} - execute at interrupt level n
     
    846846
    847847@subheading DIRECTIVE STATUS CODES:
    848 @code{SUCCESSFUL} - task identified successfully@*
    849 @code{INVALID_NAME} - invalid task name@*
    850 @code{INVALID_NODE} - invalid node id
     848@code{@value{RPREFIX}SUCCESSFUL} - task identified successfully@*
     849@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     850@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    851851
    852852@subheading DESCRIPTION:
    853853This directive obtains the task id associated with the task name
    854854specified in name.  A task may obtain its own id by specifying
    855 @code{SELF} or its own task name in name.  If the task name is not
     855@code{@value{RPREFIX}SELF} or its own task name in name.  If the task name is not
    856856unique, then the task id returned will match one of the tasks
    857857with that name.  However, this task id is not guaranteed to
     
    862862This directive will not cause the running task to be preempted.
    863863
    864 If node is @code{SEARCH_ALL_NODES}, all nodes are searched with the
     864If node is @code{@value{RPREFIX}SEARCH_ALL_NODES}, all nodes are searched with the
    865865local node being searched first.  All other nodes are searched
    866866with the lowest numbered node searched first.
     
    903903
    904904@subheading DIRECTIVE STATUS CODES:
    905 @code{SUCCESSFUL} - ask started successfully@*
    906 @code{INVALID_ADDRESS} - invalid task entry point@*
    907 @code{INVALID_ID} - invalid task id@*
    908 @code{INCORRECT_STATE} - task not in the dormant state@*
    909 @code{ILLEGAL_ON_REMOTE_OBJECT} - cannot start remote task
     905@code{@value{RPREFIX}SUCCESSFUL} - ask started successfully@*
     906@code{@value{RPREFIX}INVALID_ADDRESS} - invalid task entry point@*
     907@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     908@code{@value{RPREFIX}INCORRECT_STATE} - task not in the dormant state@*
     909@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot start remote task
    910910
    911911@subheading DESCRIPTION:
     
    953953
    954954@subheading DIRECTIVE STATUS CODES:
    955 @code{SUCCESSFUL} - task restarted successfully@*
    956 @code{INVALID_ID} - task id invalid@*
    957 @code{INCORRECT_STATE} - task never started@*
    958 @code{ILLEGAL_ON_REMOTE_OBJECT} - cannot restart remote task
     955@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
     956@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
     957@code{@value{RPREFIX}INCORRECT_STATE} - task never started@*
     958@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot restart remote task
    959959
    960960@subheading DESCRIPTION:
     
    977977
    978978@subheading NOTES:
    979 If id is @code{SELF}, the calling task will be restarted and will not
     979If id is @code{@value{RPREFIX}SELF}, the calling task will be restarted and will not
    980980return from this directive.
    981981
     
    10121012
    10131013@subheading DIRECTIVE STATUS CODES:
    1014 @code{SUCCESSFUL} - task restarted successfully@*
    1015 @code{INVALID_ID} - task id invalid@*
    1016 @code{ILLEGAL_ON_REMOTE_OBJECT} - cannot restart remote task
     1014@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
     1015@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
     1016@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - cannot restart remote task
    10171017
    10181018@subheading DESCRIPTION:
     
    10201020another task, as specified by id.  RTEMS stops the execution of
    10211021the task and reclaims the stack memory, any allocated delay or
    1022 timeout timers, the TCB, and, if the task is @code{FLOATING_POINT}, its
     1022timeout timers, the TCB, and, if the task is @code{@value{RPREFIX}FLOATING_POINT}, its
    10231023floating point context area.  RTEMS does not reclaim the
    10241024following resources: region segments, partition buffers,
     
    10351035argument or by sending it a message, an event, or a signal.
    10361036
    1037 Deletion of the current task (@code{SELF}) will force RTEMS to select
     1037Deletion of the current task (@code{@value{RPREFIX}SELF}) will force RTEMS to select
    10381038another task to execute.
    10391039
     
    10711071
    10721072@subheading DIRECTIVE STATUS CODES:
    1073 @code{SUCCESSFUL} - task restarted successfully@*
    1074 @code{INVALID_ID} - task id invalid@*
    1075 @code{ALREADY_SUSPENDED} - task already suspended
     1073@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
     1074@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
     1075@code{@value{RPREFIX}ALREADY_SUSPENDED} - task already suspended
    10761076
    10771077@subheading DESCRIPTION:
     
    10841084
    10851085@subheading NOTES:
    1086 The requesting task can suspend itself by specifying @code{SELF} as id.
     1086The requesting task can suspend itself by specifying @code{@value{RPREFIX}SELF} as id.
    10871087In this case, the task will be suspended and a successful
    10881088return code will be returned when the task is resumed.
     
    11211121
    11221122@subheading DIRECTIVE STATUS CODES:
    1123 @code{SUCCESSFUL} - task restarted successfully@*
    1124 @code{INVALID_ID} - task id invalid@*
    1125 @code{INCORRECT_STATE} - task not suspended
     1123@code{@value{RPREFIX}SUCCESSFUL} - task restarted successfully@*
     1124@code{@value{RPREFIX}INVALID_ID} - task id invalid@*
     1125@code{@value{RPREFIX}INCORRECT_STATE} - task not suspended
    11261126
    11271127@subheading DESCRIPTION:
     
    11731173
    11741174@subheading DIRECTIVE STATUS CODES:
    1175 @code{SUCCESSFUL} - task priority set successfully@*
    1176 @code{INVALID_ID} - invalid task id@*
    1177 @code{INVALID_PRIORITY} - invalid task priority
     1175@code{@value{RPREFIX}SUCCESSFUL} - task priority set successfully@*
     1176@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     1177@code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority
    11781178
    11791179@subheading DESCRIPTION:
    11801180This directive manipulates the priority of the task specified by
    1181 id.  An id of @code{SELF} is used to indicate the calling task.  When
     1181id.  An id of @code{@value{RPREFIX}SELF} is used to indicate the calling task.  When
    11821182new_priority is not equal to CURRENT_PRIORITY, the specified
    11831183task's previous priority is returned in old_priority.  When
     
    12351235
    12361236@subheading DIRECTIVE STATUS CODES:
    1237 @code{SUCCESSFUL} - task mode set successfully
     1237@code{@value{RPREFIX}SUCCESSFUL} - task mode set successfully
    12381238
    12391239@subheading DESCRIPTION:
     
    12531253
    12541254A task can obtain its current execution mode, without modifying
    1255 it, by calling this directive with a mask value of @code{CURRENT_MODE}.
     1255it, by calling this directive with a mask value of @code{@value{RPREFIX}CURRENT_MODE}.
    12561256
    12571257To temporarily disable the processing of a valid ASR, a task
     
    13611361
    13621362@subheading DIRECTIVE STATUS CODES:
    1363 @code{SUCCESSFUL} - note obtained successfully@*
    1364 @code{INVALID_ID} - invalid task id@*
    1365 @code{INVALID_NUMBER} - invalid notepad location
     1363@code{@value{RPREFIX}SUCCESSFUL} - note obtained successfully@*
     1364@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     1365@code{@value{RPREFIX}INVALID_NUMBER} - invalid notepad location
    13661366
    13671367@subheading DESCRIPTION:
     
    13721372This directive will not cause the running task to be preempted.
    13731373
    1374 If id is set to @code{SELF}, the calling task accesses its own notepad.
     1374If id is set to @code{@value{RPREFIX}SELF}, the calling task accesses its own notepad.
    13751375
    13761376@c This version of the paragraph avoids the overfull hbox error.
     
    13791379
    13801380The sixteen notepad locations can be accessed using the constants
    1381 @code{NOTEPAD_0} through @code{NOTEPAD_15}.
     1381@code{@value{RPREFIX}NOTEPAD_0} through @code{@value{RPREFIX}NOTEPAD_15}.
    13821382
    13831383Getting a note of a global task which does not reside on the
     
    14151415
    14161416@subheading DIRECTIVE STATUS CODES:
    1417 @code{SUCCESSFUL} - task's note set successfully@*
    1418 @code{INVALID_ID} - invalid task id@*
    1419 @code{INVALID_NUMBER} - invalid notepad location
     1417@code{@value{RPREFIX}SUCCESSFUL} - task's note set successfully@*
     1418@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     1419@code{@value{RPREFIX}INVALID_NUMBER} - invalid notepad location
    14201420
    14211421@subheading DESCRIPTION:
     
    14241424
    14251425@subheading NOTES:
    1426 If id is set to @code{SELF}, the calling task accesses its own notepad
     1426If id is set to @code{@value{RPREFIX}SELF}, the calling task accesses its own notepad
    14271427locations.
    14281428
     
    14341434
    14351435The sixteen notepad locations can be accessed using the constants
    1436 @code{NOTEPAD_0} through @code{NOTEPAD_15}.
     1436@code{@value{RPREFIX}NOTEPAD_0} through @code{@value{RPREFIX}NOTEPAD_15}.
    14371437
    14381438Setting a notepad location of a global task which does not
     
    14661466
    14671467@subheading DIRECTIVE STATUS CODES:
    1468 @code{SUCCESSFUL} - always successful
     1468@code{@value{RPREFIX}SUCCESSFUL} - always successful
    14691469
    14701470@subheading DESCRIPTION:
     
    14791479
    14801480A task may give up the processor and remain in the ready state
    1481 by specifying a value of @code{YIELD_PROCESSOR} in ticks.
     1481by specifying a value of @code{@value{RPREFIX}YIELD_PROCESSOR} in ticks.
    14821482
    14831483The maximum timer interval that can be specified is the maximum
     
    15131513
    15141514@subheading DIRECTIVE STATUS CODES:
    1515 @code{SUCCESSFUL} - awakened at date/time successfully@*
     1515@code{@value{RPREFIX}SUCCESSFUL} - awakened at date/time successfully@*
    15161516@code{INVALID_TIME_OF_DAY} - invalid time buffer@*
    1517 @code{NOT_DEFINED} - system date and time is not set
     1517@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set
    15181518
    15191519@subheading DESCRIPTION:
  • doc/user/timer.t

    r4fa4ea65 rf331481c  
    2929
    3030@itemize @bullet
    31 @item @code{timer_create} - Create a timer
    32 @item @code{timer_ident} - Get ID of a timer
    33 @item @code{timer_cancel} - Cancel a timer
    34 @item @code{timer_delete} - Delete a timer
    35 @item @code{timer_fire_after} - Fire timer after interval
    36 @item @code{timer_fire_when} - Fire timer when specified
    37 @item @code{timer_reset} - Reset an interval timer
     31@item @code{@value{DIRPREFIX}timer_create} - Create a timer
     32@item @code{@value{DIRPREFIX}timer_ident} - Get ID of a timer
     33@item @code{@value{DIRPREFIX}timer_cancel} - Cancel a timer
     34@item @code{@value{DIRPREFIX}timer_delete} - Delete a timer
     35@item @code{@value{DIRPREFIX}timer_fire_after} - Fire timer after interval
     36@item @code{@value{DIRPREFIX}timer_fire_when} - Fire timer when specified
     37@item @code{@value{DIRPREFIX}timer_reset} - Reset an interval timer
    3838@end itemize
    3939
     
    259259
    260260@subheading DIRECTIVE STATUS CODES:
    261 @code{SUCCESSFUL} - timer created successfully@*
    262 @code{INVALID_NAME} - invalid timer name@*
    263 @code{TOO_MANY} - too many timers created
     261@code{@value{RPREFIX}SUCCESSFUL} - timer created successfully@*
     262@code{@value{RPREFIX}INVALID_NAME} - invalid timer name@*
     263@code{@value{RPREFIX}TOO_MANY} - too many timers created
    264264
    265265@subheading DESCRIPTION:
     
    304304
    305305@subheading DIRECTIVE STATUS CODES:
    306 @code{SUCCESSFUL} - timer identified successfully@*
    307 @code{INVALID_NAME} - timer name not found
     306@code{@value{RPREFIX}SUCCESSFUL} - timer identified successfully@*
     307@code{@value{RPREFIX}INVALID_NAME} - timer name not found
    308308
    309309@subheading DESCRIPTION:
     
    347347
    348348@subheading DIRECTIVE STATUS CODES:
    349 @code{SUCCESSFUL} - timer canceled successfully@*
    350 @code{INVALID_ID} - invalid timer id
     349@code{@value{RPREFIX}SUCCESSFUL} - timer canceled successfully@*
     350@code{@value{RPREFIX}INVALID_ID} - invalid timer id
    351351
    352352@subheading DESCRIPTION:
     
    386386
    387387@subheading DIRECTIVE STATUS CODES:
    388 @code{SUCCESSFUL} - timer deleted successfully@*
    389 @code{INVALID_ID} - invalid timer id
     388@code{@value{RPREFIX}SUCCESSFUL} - timer deleted successfully@*
     389@code{@value{RPREFIX}INVALID_ID} - invalid timer id
    390390
    391391@subheading DESCRIPTION:
     
    435435
    436436@subheading DIRECTIVE STATUS CODES:
    437 @code{SUCCESSFUL} - timer initiated successfully@*
    438 @code{INVALID_ID} - invalid timer id@*
    439 @code{INVALID_NUMBER} - invalid interval
     437@code{@value{RPREFIX}SUCCESSFUL} - timer initiated successfully@*
     438@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
     439@code{@value{RPREFIX}INVALID_NUMBER} - invalid interval
    440440
    441441@subheading DESCRIPTION:
     
    485485
    486486@subheading DIRECTIVE STATUS CODES:
    487 @code{SUCCESSFUL} - timer initiated successfully@*
    488 @code{INVALID_ID} - invalid timer id@*
    489 @code{NOT_DEFINED} - system date and time is not set@*
    490 @code{INVALID_CLOCK} - invalid time of day
     487@code{@value{RPREFIX}SUCCESSFUL} - timer initiated successfully@*
     488@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
     489@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set@*
     490@code{@value{RPREFIX}INVALID_CLOCK} - invalid time of day
    491491
    492492@subheading DESCRIPTION:
     
    530530
    531531@subheading DIRECTIVE STATUS CODES:
    532 @code{SUCCESSFUL} - timer reset successfully@*
    533 @code{INVALID_ID} - invalid timer id@*
    534 @code{NOT_DEFINED} - attempted to reset a when or newly created timer
     532@code{@value{RPREFIX}SUCCESSFUL} - timer reset successfully@*
     533@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
     534@code{@value{RPREFIX}NOT_DEFINED} - attempted to reset a when or newly created timer
    535535
    536536@subheading DESCRIPTION:
  • doc/user/userext.t

    r4fa4ea65 rf331481c  
    3232
    3333@itemize @bullet
    34 @item @code{extension_create} - Create an extension set
    35 @item @code{extension_ident} - Get ID of an extension set
    36 @item @code{extension_delete} - Delete an extension set
     34@item @code{@value{DIRPREFIX}extension_create} - Create an extension set
     35@item @code{@value{DIRPREFIX}extension_ident} - Get ID of an extension set
     36@item @code{@value{DIRPREFIX}extension_delete} - Delete an extension set
    3737@end itemize
    3838
     
    499499returns control to RTEMS, then the RTEMS default handler will be
    500500used.  This default handler invokes the directive
    501 fatal_error_occurred with the @code{TASK_EXITTED} directive status.
     501fatal_error_occurred with the @code{@value{RPREFIX}TASK_EXITTED} directive status.
    502502
    503503@lowersections
     
    689689
    690690@subheading DIRECTIVE STATUS CODES:
    691 @code{SUCCESSFUL} -  extension set created successfully@*
    692 @code{INVALID_NAME} - invalid extension set name@*
    693 @code{TOO_MANY} - too many extension sets created
     691@code{@value{RPREFIX}SUCCESSFUL} -  extension set created successfully@*
     692@code{@value{RPREFIX}INVALID_NAME} - invalid extension set name@*
     693@code{@value{RPREFIX}TOO_MANY} - too many extension sets created
    694694
    695695@subheading DESCRIPTION:
     
    735735
    736736@subheading DIRECTIVE STATUS CODES:
    737 @code{SUCCESSFUL} -  extension set identified successfully@*
    738 @code{INVALID_NAME} - extension set name not found
     737@code{@value{RPREFIX}SUCCESSFUL} -  extension set identified successfully@*
     738@code{@value{RPREFIX}INVALID_NAME} - extension set name not found
    739739
    740740@subheading DESCRIPTION:
     
    779779
    780780@subheading DIRECTIVE STATUS CODES:
    781 @code{SUCCESSFUL} -  extension set deleted successfully@*
    782 @code{INVALID_ID} - invalid extension set id
     781@code{@value{RPREFIX}SUCCESSFUL} -  extension set deleted successfully@*
     782@code{@value{RPREFIX}INVALID_ID} - invalid extension set id
    783783
    784784@subheading DESCRIPTION:
Note: See TracChangeset for help on using the changeset viewer.