![[RTEMS Logo]](/images/logo.png){kind=logo}
Changeset a3a7527 in rtems
- Timestamp:
- Mar 27, 1998, 1:04:02 PM (24 years ago)
- Branches:
- 4.10, 4.11, 4.8, 4.9, 5, master
- Children:
- 4fa4ea65
- Parents:
- 0ef0ff2
- Location:
- doc/user
- Files:
-
- 9 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user/c_user.texi
r0ef0ff2 ra3a7527 46 46 @set ROUTINE function 47 47 @set OR | 48 @set RPREFIX RTEMS_ 48 49 @c the language is @value{LANGUAGE} 49 50 @c NOTE: don't use underscore in the name -
doc/user/event.t
r0ef0ff2 ra3a7527 102 102 @code{EVENT_6}, @code{EVENT_15}, and @code{EVENT_31}, 103 103 the 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}. 105 106 106 107 @ifinfo … … 132 133 to poll for all events in a particular event condition to 133 134 arrive. The option parameter passed to the event_receive 134 directive should be either @code{EVENT_ALL @value{OR} NO_WAIT} 135 directive should be either 136 @code{@value{RPREFIX}EVENT_ALL @value{OR} @value{RPREFIX}NO_WAIT} 135 137 or @code{NO_WAIT}. The option parameter can be set to 136 138 @code{NO_WAIT} because @code{EVENT_ALL} is the … … 224 226 events by calling the event_receive directive with a value of 225 227 @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} 227 229 for the option set. The pending events are returned to the 228 230 calling task and the event set is cleared. If no events are -
doc/user/intr.t
r0ef0ff2 ra3a7527 361 361 This directive disables all maskable interrupts and returns 362 362 the previous @code{level}. A later invocation of the 363 @code{ rtems_interrupt_enable} directive should be used to363 @code{interrupt_enable} directive should be used to 364 364 restore the interrupt level. 365 365 … … 404 404 405 405 This directive enables maskable interrupts to the @code{level} 406 which was returned by a previous call to @code{ rtems_interrupt_disable}.406 which was returned by a previous call to @code{interrupt_disable}. 407 407 Immediately prior to invoking this directive, maskable interrupts should 408 be disabled by a call to @code{ rtems_interrupt_disable} and will be enabled408 be disabled by a call to @code{interrupt_disable} and will be enabled 409 409 when this directive returns to the caller. 410 410 … … 445 445 446 446 This directive temporarily enables maskable interrupts to the @code{level} 447 which was returned by a previous call to @code{ rtems_interrupt_disable}.447 which was returned by a previous call to @code{interrupt_disable}. 448 448 Immediately prior to invoking this directive, maskable interrupts should 449 be disabled by a call to @code{ rtems_interrupt_disable} and will be redisabled449 be disabled by a call to @code{interrupt_disable} and will be redisabled 450 450 when this directive returns to the caller. 451 451 -
doc/user/msg.t
r0ef0ff2 ra3a7527 37 37 @item @code{message_queue_broadcast} - Broadcast N messages to a queue 38 38 @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 queue39 @item @code{message_queue_get_number_pending} - Get number of messages pending on a queue 40 40 @item @code{message_queue_flush} - Flush all messages on a queue 41 41 @end itemize … … 93 93 94 94 @itemize @bullet 95 @item FIFO- tasks wait by FIFO (default)96 @item PRIORITY- tasks wait by priority97 @item LOCAL- local message queue (default)98 @item GLOBAL- global message queue95 @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 99 99 @end itemize 100 100 … … 111 111 waiting queue discipline. The attribute_set parameter to the 112 112 message_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}. 114 115 The attribute_set parameter can be set to @code{PRIORITY} 115 116 because @code{LOCAL} is the default for all created message queues. If 116 117 a similar message queue were to be known globally, then the 117 attribute_set parameter would be @code{GLOBAL @value{OR} PRIORITY}. 118 attribute_set parameter would be 119 @code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}. 118 120 119 121 @ifinfo … … 343 345 is used to access the message queue. 344 346 345 Specifying PRIORITYin attribute_set causes tasks347 Specifying @code{PRIORITY} in attribute_set causes tasks 346 348 waiting for a message to be serviced according to task priority. 347 When FIFOis specified, waiting tasks are serviced in First349 When @code{FIFO} is specified, waiting tasks are serviced in First 348 350 In-First Out order. 349 351 … … 357 359 358 360 @itemize @bullet 359 @item FIFO- tasks wait by FIFO (default)360 @item PRIORITY- tasks wait by priority361 @item LOCAL- local message queue (default)362 @item GLOBAL- global message queue361 @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 363 365 @end itemize 364 366 … … 748 750 queue and the queue is empty, then the calling task is placed on 749 751 the message wait queue and blocked. If the queue was created 750 with the PRIORITYoption specified, then the calling task is752 with the @code{PRIORITY} option specified, then the calling task is 751 753 inserted into the wait queue according to its priority. But, if 752 the queue was created with the FIFOoption specified, then the754 the queue was created with the @code{FIFO} option specified, then the 753 755 calling task is placed at the rear of the wait queue. 754 756 -
doc/user/region.t
r0ef0ff2 ra3a7527 91 91 92 92 @itemize @bullet 93 @item FIFO- tasks wait by FIFO (default)94 @item PRIORITY- tasks wait by priority93 @item @code{FIFO} - tasks wait by FIFO (default) 94 @item @code{PRIORITY} - tasks wait by priority 95 95 @end itemize 96 96 … … 107 107 needed to create a region with the task priority waiting queue 108 108 discipline. The attribute_set parameter to the region_create 109 directive should be PRIORITY.109 directive should be @code{PRIORITY}. 110 110 111 111 @ifinfo … … 347 347 segment is constructed in the region. 348 348 349 Specifying PRIORITYin attribute_set causes tasks349 Specifying @code{PRIORITY} in attribute_set causes tasks 350 350 waiting for a segment to be serviced according to task priority. 351 Specifying FIFOin attribute_set or selecting351 Specifying @code{FIFO} in attribute_set or selecting 352 352 @code{DEFAULT_ATTRIBUTES} will cause waiting tasks to be serviced in 353 353 First In-First Out order. … … 570 570 available, then the calling task is placed on the region's 571 571 segment wait queue and blocked. If the region was created with 572 the PRIORITYoption, then the calling task is inserted into the572 the @priority{PRIORITY} option, then the calling task is inserted into the 573 573 wait queue according to its priority. However, if the region 574 was created with the FIFOoption, then the calling task is574 was created with the @priority{FIFO} option, then the calling task is 575 575 placed at the rear of the wait queue. 576 576 -
doc/user/schedule.t
r0ef0ff2 ra3a7527 129 129 Another way the user can alter the basic scheduling 130 130 algorithm is by manipulating the preemption mode flag 131 ( PREEMPT_MASK) of individual tasks. If preemption is disabled132 for a task ( NO_PREEMPT), then the task will not relinquish131 (@code{PREEMPT_MASK}) of individual tasks. If preemption is disabled 132 for a task (@code{NO_PREEMPT}), then the task will not relinquish 133 133 control of the processor until it terminates, blocks, or 134 134 re-enables preemption. Even tasks which become ready to run and … … 147 147 scheduling algorithm. Like preemption, timeslicing is specified 148 148 on a task by task basis using the timeslicing mode flag 149 ( TIMESLICE_MASK). If timeslicing is enabled for a task150 ( TIMESLICE), then RTEMS will limit the amount of time the task149 (@code{TIMESLICE_MASK}). If timeslicing is enabled for a task 150 (@code{TIMESLICE}), then RTEMS will limit the amount of time the task 151 151 can execute before the processor is allocated to another task. 152 152 Each tick of the real-time clock reduces the currently running -
doc/user/sem.t
r0ef0ff2 ra3a7527 238 238 waiting queue discipline. The attribute_set parameter passed to 239 239 the 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}. 241 242 The attribute_set parameter can be set to @code{PRIORITY} 242 243 because @code{LOCAL} is the default for all created tasks. If a 243 244 similar semaphore were to be known globally, then the 244 attribute_set parameter would be @code{GLOBAL @value{OR} PRIORITY}. 245 attribute_set parameter would be 246 @code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}. 245 247 246 248 @ifinfo … … 689 691 decremented by one and the calling task is placed on the 690 692 semaphore's wait queue and blocked. If the semaphore was 691 created with the PRIORITYattribute, then the calling task is693 created with the @code{PRIORITY} attribute, then the calling task is 692 694 inserted into the queue according to its priority. However, if 693 the semaphore was created with the FIFOattribute, then the695 the semaphore was created with the @code{FIFO} attribute, then the 694 696 calling task is placed at the rear of the wait queue. If the 695 binary semaphore was created with the INHERIT_PRIORITY697 binary semaphore was created with the @code{INHERIT_PRIORITY} 696 698 attribute, then the priority of the task currently holding the 697 699 binary semaphore is guaranteed to be greater than or equal to 698 700 that of the blocking task. If the binary semaphore was created 699 with the PRIORITY_CEILINGattribute, a task successfully obtains701 with the @code{PRIORITY_CEILING} attribute, a task successfully obtains 700 702 the semaphore, and the priority of that task is greater than the 701 703 ceiling priority for this semaphore, then the priority of the -
doc/user/signal.t
r0ef0ff2 ra3a7527 112 112 @code{SIGNAL_6}, @code{SIGNAL_15}, and @code{SIGNAL_31}. 113 113 The 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}. 115 116 116 117 @ifinfo … … 126 127 127 128 @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 136 152 @end itemize 137 153 … … 149 165 interrupt level three and is non-preemptible. The mode should 150 166 be 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} 168 to indicate the 152 169 desired processor mode and interrupt level. 153 170 … … 323 340 324 341 @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 333 365 @end itemize 334 366 -
doc/user/task.t
r0ef0ff2 ra3a7527 136 136 137 137 @itemize @bullet 138 @item @ code{executing} - Currently scheduled to the CPU139 @item @ code{ready} - May be scheduled to the CPU140 @item @ code{blocked} - Unable to be scheduled to the CPU141 @item @ code{dormant} - Created task that is not started142 @item @ code{non-existent} - Uncreated or deleted task138 @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 143 143 @end itemize 144 144 … … 236 236 @item @code{ASR} - enable ASR processing (default) 237 237 @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 n238 @item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} - enable all interrupts (default) 239 @item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} - execute at interrupt level n 240 240 @end itemize 241 241 … … 353 353 create a local task which utilizes the numeric coprocessor. The 354 354 attribute_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}. 356 356 The attribute_set parameter can be set to 357 357 @code{FLOATING_POINT} because @code{LOCAL} is the default for all created 358 358 tasks. If the task were global and used the numeric 359 359 coprocessor, 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}. 361 361 362 362 @ifinfo … … 372 372 @ifset use-ascii 373 373 @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 382 397 @end itemize 383 398 @end ifset … … 387 402 @c this is temporary 388 403 @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 397 427 398 428 @end itemize … … 453 483 used with the task_mode directive to place a task at interrupt 454 484 level 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 456 487 preemption mode and interrupt level, while the mask parameter 457 should be set to @code{INTERRUPT_MASK @value{RTEMSOR} NO_PREEMPT_MASK} 488 should be set to 489 @code{@value{RPREFIX}INTERRUPT_MASK @value{OR} @value{RPREFIX}NO_PREEMPT_MASK} 458 490 to indicate that the calling task's interrupt level and preemption mode are 459 491 being altered. … … 712 744 713 745 @subheading DIRECTIVE STATUS CODES: 714 @code{ SUCCESSFUL} - task created successfully@*746 @code{@value{RPREFIX}SUCCESSFUL} - task created successfully@* 715 747 @code{INVALID_NAME} - invalid task name@* 716 748 @code{INVALID_SIZE} - stack too small@* … … 769 801 @item @code{ASR} - enable ASR processing (default) 770 802 @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 n803 @item @code{@value{RPREFIX}INTERRUPT_LEVEL(0)} - enable all interrupts (default) 804 @item @code{@value{RPREFIX}INTERRUPT_LEVEL(n)} - execute at interrupt level n 773 805 @end itemize 774 806 … … 1221 1253 1222 1254 A task can obtain its current execution mode, without modifying 1223 it, by calling this directive with a mask value of CURRENT_MODE.1255 it, by calling this directive with a mask value of @code{CURRENT_MODE}. 1224 1256 1225 1257 To temporarily disable the processing of a valid ASR, a task
Note: See TracChangeset
for help on using the changeset viewer.
