Changeset a3a7527 in rtems


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

Attempting to add variable so that in C all constants start with RTEMS_
and all directives start with rtems_.

Location:
doc/user
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • doc/user/c_user.texi

    r0ef0ff2 ra3a7527  
    4646@set ROUTINE function
    4747@set OR |
     48@set RPREFIX RTEMS_
    4849@c the language is @value{LANGUAGE}
    4950@c NOTE:  don't use underscore in the name
  • doc/user/event.t

    r0ef0ff2 ra3a7527  
    102102@code{EVENT_6}, @code{EVENT_15}, and @code{EVENT_31},
    103103the event parameter to the event_send directive should be
    104 @code{EVENT_6 @value{OR} EVENT_15 @value{OR} EVENT_31}.
     104@code{@value{RPREFIX}EVENT_6 @value{OR}
     105@value{RPREFIX}EVENT_15 @value{OR} @value{RPREFIX}EVENT_31}.
    105106
    106107@ifinfo
     
    132133to poll for all events in a particular event condition to
    133134arrive.  The option parameter passed to the event_receive
    134 directive should be either @code{EVENT_ALL @value{OR} NO_WAIT}
     135directive should be either
     136@code{@value{RPREFIX}EVENT_ALL @value{OR} @value{RPREFIX}NO_WAIT}
    135137or @code{NO_WAIT}.  The option parameter can be set to
    136138@code{NO_WAIT} because @code{EVENT_ALL} is the
     
    224226events by calling the event_receive directive with a value of
    225227@code{ALL_EVENTS} for the input event condition and
    226 @code{NO_WAIT @value{OR} EVENT_ANY}
     228@code{@value{RPREFIX}NO_WAIT @value{OR} @value{RPREFIX}EVENT_ANY}
    227229for the option set.  The pending events are returned to the
    228230calling task and the event set is cleared.  If no events are
  • doc/user/intr.t

    r0ef0ff2 ra3a7527  
    361361This directive disables all maskable interrupts and returns
    362362the previous @code{level}.  A later invocation of the
    363 @code{rtems_interrupt_enable} directive should be used to
     363@code{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{rtems_interrupt_disable}.
     406which was returned by a previous call to @code{interrupt_disable}.
    407407Immediately prior to invoking this directive, maskable interrupts should
    408 be disabled by a call to @code{rtems_interrupt_disable} and will be enabled
     408be disabled by a call to @code{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{rtems_interrupt_disable}. 
     447which was returned by a previous call to @code{interrupt_disable}. 
    448448Immediately prior to invoking this directive, maskable interrupts should
    449 be disabled by a call to @code{rtems_interrupt_disable} and will be redisabled
     449be disabled by a call to @code{interrupt_disable} and will be redisabled
    450450when this directive returns to the caller.
    451451
  • doc/user/msg.t

    r0ef0ff2 ra3a7527  
    3737@item @code{message_queue_broadcast} - Broadcast N messages to a queue
    3838@item @code{message_queue_receive} - Receive message from a queue
    39 @item @code{rtems_message_queue_get_number_pending} - Get number of messages pending on a queue
     39@item @code{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 FIFO - tasks wait by FIFO (default)
    96 @item PRIORITY - tasks wait by priority
    97 @item LOCAL - local message queue (default)
    98 @item GLOBAL - global message queue
     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
    9999@end itemize
    100100
     
    111111waiting queue discipline.  The attribute_set parameter to the
    112112message_queue_create directive could be either
    113 @code{PRIORITY} or @code{LOCAL @value{OR} PRIORITY}. 
     113@code{PRIORITY} or
     114@code{@value{RPREFIX}LOCAL @value{OR} @value{RPREFIX}PRIORITY}. 
    114115The attribute_set parameter can be set to @code{PRIORITY}
    115116because @code{LOCAL} is the default for all created message queues.  If
    116117a similar message queue were to be known globally, then the
    117 attribute_set parameter would be @code{GLOBAL @value{OR} PRIORITY}.
     118attribute_set parameter would be
     119@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}.
    118120
    119121@ifinfo
     
    343345is used to access the message queue.
    344346
    345 Specifying PRIORITY in attribute_set causes tasks
     347Specifying @code{PRIORITY} in attribute_set causes tasks
    346348waiting for a message to be serviced according to task priority.
    347 When FIFO is specified, waiting tasks are serviced in First
     349When @code{FIFO} is specified, waiting tasks are serviced in First
    348350In-First Out order.
    349351
     
    357359
    358360@itemize @bullet
    359 @item FIFO - tasks wait by FIFO (default)
    360 @item PRIORITY - tasks wait by priority
    361 @item LOCAL - local message queue (default)
    362 @item GLOBAL - global message queue
     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
    363365@end itemize
    364366
     
    748750queue and the queue is empty, then the calling task is placed on
    749751the message wait queue and blocked.  If the queue was created
    750 with the PRIORITY option specified, then the calling task is
     752with the @code{PRIORITY} option specified, then the calling task is
    751753inserted into the wait queue according to its priority.  But, if
    752 the queue was created with the FIFO option specified, then the
     754the queue was created with the @code{FIFO} option specified, then the
    753755calling task is placed at the rear of the wait queue.
    754756
  • doc/user/region.t

    r0ef0ff2 ra3a7527  
    9191
    9292@itemize @bullet
    93 @item FIFO - tasks wait by FIFO (default)
    94 @item PRIORITY - tasks wait by priority
     93@item @code{FIFO} - tasks wait by FIFO (default)
     94@item @code{PRIORITY} - tasks wait by priority
    9595@end itemize
    9696
     
    107107needed to create a region with the task priority waiting queue
    108108discipline.  The attribute_set parameter to the region_create
    109 directive should be PRIORITY.
     109directive should be @code{PRIORITY}.
    110110
    111111@ifinfo
     
    347347segment is constructed in the region.
    348348
    349 Specifying PRIORITY in attribute_set causes tasks
     349Specifying @code{PRIORITY} in attribute_set causes tasks
    350350waiting for a segment to be serviced according to task priority.
    351 Specifying FIFO in attribute_set or selecting
     351Specifying @code{FIFO} in attribute_set or selecting
    352352@code{DEFAULT_ATTRIBUTES} will cause waiting tasks to be serviced in
    353353First In-First Out order.
     
    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 option, then the calling task is inserted into the
     572the @priority{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 FIFO option, then the calling task is
     574was created with the @priority{FIFO} option, then the calling task is
    575575placed at the rear of the wait queue.
    576576
  • doc/user/schedule.t

    r0ef0ff2 ra3a7527  
    129129Another way the user can alter the basic scheduling
    130130algorithm is by manipulating the preemption mode flag
    131 (PREEMPT_MASK) of individual tasks.  If preemption is disabled
    132 for a task (NO_PREEMPT), then the task will not relinquish
     131(@code{PREEMPT_MASK}) of individual tasks.  If preemption is disabled
     132for a task (@code{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 (TIMESLICE_MASK).  If timeslicing is enabled for a task
    150 (TIMESLICE), then RTEMS will limit the amount of time the task
     149(@code{TIMESLICE_MASK}).  If timeslicing is enabled for a task
     150(@code{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
  • doc/user/sem.t

    r0ef0ff2 ra3a7527  
    238238waiting queue discipline.  The attribute_set parameter passed to
    239239the semaphore_create directive could be either
    240 @code{PRIORITY} or @code{LOCAL @value{OR} PRIORITY}. 
     240@code{PRIORITY} or
     241@code{@value{RPREFIX}LOCAL @value{OR} @value{RPREFIX}PRIORITY}. 
    241242The attribute_set parameter can be set to @code{PRIORITY}
    242243because @code{LOCAL} is the default for all created tasks.  If a
    243244similar semaphore were to be known globally, then the
    244 attribute_set parameter would be @code{GLOBAL @value{OR} PRIORITY}.
     245attribute_set parameter would be
     246@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}.
    245247
    246248@ifinfo
     
    689691decremented by one and the calling task is placed on the
    690692semaphore's wait queue and blocked.  If the semaphore was
    691 created with the PRIORITY attribute, then the calling task is
     693created with the @code{PRIORITY} attribute, then the calling task is
    692694inserted into the queue according to its priority.  However, if
    693 the semaphore was created with the FIFO attribute, then the
     695the semaphore was created with the @code{FIFO} attribute, then the
    694696calling task is placed at the rear of the wait queue.  If the
    695 binary semaphore was created with the INHERIT_PRIORITY
     697binary semaphore was created with the @code{INHERIT_PRIORITY}
    696698attribute, then the priority of the task currently holding the
    697699binary semaphore is guaranteed to be greater than or equal to
    698700that of the blocking task.  If the binary semaphore was created
    699 with the PRIORITY_CEILING attribute, a task successfully obtains
     701with the @code{PRIORITY_CEILING} attribute, a task successfully obtains
    700702the semaphore, and the priority of that task is greater than the
    701703ceiling priority for this semaphore, then the priority of the
  • doc/user/signal.t

    r0ef0ff2 ra3a7527  
    112112@code{SIGNAL_6}, @code{SIGNAL_15}, and @code{SIGNAL_31}. 
    113113The signal parameter provided to the signal_send directive should be
    114 @code{SIGNAL_6 @value{OR} SIGNAL_15 @value{OR} SIGNAL_31}.
     114@code{@value{RPREFIX}SIGNAL_6 @value{OR}
     115@value{RPREFIX}SIGNAL_15 @value{OR} @value{RPREFIX}SIGNAL_31}.
    115116
    116117@ifinfo
     
    126127
    127128@itemize @bullet
    128 @item PREEMPT is masked by PREEMPT_MASK and enables preemption
    129 @item NO_PREEMPT is masked by PREEMPT_MASK and disables preemption
    130 @item NO_TIMESLICE is masked by TIMESLICE_MASK and disables timeslicing
    131 @item TIMESLICE is masked by TIMESLICE_MASK and enables timeslicing
    132 @item ASR is masked by ASR_MASK and enables ASR processing
    133 @item NO_ASR is masked by ASR_MASK and disables ASR processing
    134 @item INTERRUPT_LEVEL(0) is masked by INTERRUPT_MASK and enables all interrupts
    135 @item INTERRUPT_LEVEL(n) is masked by INTERRUPT_MASK and sets interrupts level n
     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
     146
     147@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
    136152@end itemize
    137153
     
    149165interrupt level three and is non-preemptible.  The mode should
    150166be set to
    151 @code{INTERRUPT_LEVEL(3) @value{OR} NO_PREEMPT} to indicate the
     167@code{@value{RPREFIX}INTERRUPT_LEVEL(3) @value{OR} @value{RPREFIX}NO_PREEMPT}
     168to indicate the
    152169desired processor mode and interrupt level.
    153170
     
    323340
    324341@itemize @bullet
    325 @item PREEMPT is masked by PREEMPT_MASK and enables preemption
    326 @item NO_PREEMPT is masked by PREEMPT_MASK and disables preemption
    327 @item NO_TIMESLICE is masked by TIMESLICE_MASK and disables timeslicing
    328 @item TIMESLICE is masked by TIMESLICE_MASK and enables timeslicing
    329 @item ASR is masked by ASR_MASK and enables ASR processing
    330 @item NO_ASR is masked by ASR_MASK and disables ASR processing
    331 @item INTERRUPT_LEVEL(0) is masked by INTERRUPT_MASK and enables all interrupts
    332 @item INTERRUPT_LEVEL(n) is masked by INTERRUPT_MASK and sets interrupts level n
     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
     359
     360@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
    333365@end itemize
    334366
  • doc/user/task.t

    r0ef0ff2 ra3a7527  
    136136
    137137@itemize @bullet
    138 @item @code{executing} - Currently scheduled to the CPU
    139 @item @code{ready} - May be scheduled to the CPU
    140 @item @code{blocked} - Unable to be scheduled to the CPU
    141 @item @code{dormant} - Created task that is not started
    142 @item @code{non-existent} - Uncreated or deleted task
     138@item @b{executing} - Currently scheduled to the CPU
     139@item @b{ready} - May be scheduled to the CPU
     140@item @b{blocked} - Unable to be scheduled to the CPU
     141@item @b{dormant} - Created task that is not started
     142@item @b{non-existent} - Uncreated or deleted task
    143143@end itemize
    144144
     
    236236@item @code{ASR} - enable ASR processing (default)
    237237@item @code{NO_ASR} - disable ASR processing
    238 @item @code{INTERRUPT_LEVEL(0)} - enable all interrupts (default)
    239 @item @code{INTERRUPT_LEVEL(n)} - execute at interrupt level n
     238@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} - enable all interrupts (default)
     239@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} - execute at interrupt level n
    240240@end itemize
    241241
     
    353353create a local task which utilizes the numeric coprocessor.  The
    354354attribute_set parameter could be @code{FLOATING_POINT} or
    355 @code{LOCAL @value{OR} FLOATING_POINT}. 
     355@code{@value{RPREFIX}LOCAL @value{OR} @value{RPREFIX}FLOATING_POINT}. 
    356356The attribute_set parameter can be set to
    357357@code{FLOATING_POINT} because @code{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
    360 @code{GLOBAL @value{OR} FLOATING_POINT}.
     360@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}FLOATING_POINT}.
    361361
    362362@ifinfo
     
    372372@ifset use-ascii
    373373@itemize @bullet
    374 @item PREEMPT is masked by PREEMPT_MASK and enables preemption
    375 @item NO_PREEMPT is masked by PREEMPT_MASK and disables preemption
    376 @item NO_TIMESLICE is masked by TIMESLICE_MASK and disables timeslicing
    377 @item TIMESLICE is masked by TIMESLICE_MASK and enables timeslicing
    378 @item ASR is masked by ASR_MASK and enables ASR processing
    379 @item NO_ASR is masked by ASR_MASK and disables ASR processing
    380 @item INTERRUPT_LEVEL(0) is masked by INTERRUPT_MASK and enables all interrupts
    381 @item INTERRUPT_LEVEL(n) is masked by INTERRUPT_MASK and sets interrupts level n
     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
     391
     392@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
    382397@end itemize
    383398@end ifset
     
    387402@c this is temporary
    388403@itemize @bullet
    389 @item PREEMPT is masked by PREEMPT_MASK and enables preemption
    390 @item NO_PREEMPT is masked by PREEMPT_MASK and disables preemption
    391 @item NO_TIMESLICE is masked by TIMESLICE_MASK and disables timeslicing
    392 @item TIMESLICE is masked by TIMESLICE_MASK and enables timeslicing
    393 @item ASR is masked by ASR_MASK and enables ASR processing
    394 @item NO_ASR is masked by ASR_MASK and disables ASR processing
    395 @item INTERRUPT_LEVEL(0) is masked by INTERRUPT_MASK and enables all interrupts
    396 @item INTERRUPT_LEVEL(n) is masked by INTERRUPT_MASK and sets interrupts level n
     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
     421
     422@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
    397427 
    398428@end itemize
     
    453483used with the task_mode directive to place a task at interrupt
    454484level 3 and make it non-preemptible.  The mode should be set to
    455 @code{INTERRUPT_LEVEL(3) @value{RTEMSOR} NO_PREEMPT} to indicate the desired
     485@code{@value{RPREFIX}INTERRUPT_LEVEL(3)
     486@value{OR} @value{RPREFIX}NO_PREEMPT} to indicate the desired
    456487preemption mode and interrupt level, while the mask parameter
    457 should be set to @code{INTERRUPT_MASK @value{RTEMSOR} NO_PREEMPT_MASK}
     488should be set to
     489@code{@value{RPREFIX}INTERRUPT_MASK @value{OR} @value{RPREFIX}NO_PREEMPT_MASK}
    458490to indicate that the calling task's interrupt level and preemption mode are
    459491being altered.
     
    712744
    713745@subheading DIRECTIVE STATUS CODES:
    714 @code{SUCCESSFUL} - task created successfully@*
     746@code{@value{RPREFIX}SUCCESSFUL} - task created successfully@*
    715747@code{INVALID_NAME} - invalid task name@*
    716748@code{INVALID_SIZE} - stack too small@*
     
    769801@item @code{ASR} - enable ASR processing (default)
    770802@item @code{NO_ASR} - disable ASR processing
    771 @item @code{INTERRUPT_LEVEL(0)} - enable all interrupts (default)
    772 @item @code{INTERRUPT_LEVEL(n)} - execute at interrupt level n
     803@item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} - enable all interrupts (default)
     804@item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} - execute at interrupt level n
    773805@end itemize
    774806
     
    12211253
    12221254A task can obtain its current execution mode, without modifying
    1223 it, by calling this directive with a mask value of CURRENT_MODE.
     1255it, by calling this directive with a mask value of @code{CURRENT_MODE}.
    12241256
    12251257To temporarily disable the processing of a valid ASR, a task
Note: See TracChangeset for help on using the changeset viewer.