Changeset a94c5a5d in rtems


Ignore:
Timestamp:
05/31/97 15:55:10 (27 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
6d4e604b
Parents:
1499931d
Message:

Changed bitwise OR's used to build up option and attribute sets
to be correct in either C or Ada.

Added the interrupt disable, enable, flash, and is in progress directives.

changed "97" to "1997"

Location:
doc
Files:
30 edited

Legend:

Unmodified
Added
Removed

  • doc/new_chapters/posix_test_plan.texi

    r1499931d ra94c5a5d  
    4848
    4949@set edition 4.1.0a
    50 @set update-date 1 June 97
    51 @set update-month June 97
     50@set update-date 1 June 1997
     51@set update-month June 1997
    5252
    5353@c

  • doc/posix_users/posix_test_plan.texi

    r1499931d ra94c5a5d  
    4848
    4949@set edition 4.1.0a
    50 @set update-date 1 June 97
    51 @set update-month June 97
     50@set update-date 1 June 1997
     51@set update-month June 1997
    5252
    5353@c

  • doc/relnotes/relnotes.texi

    r1499931d ra94c5a5d  
    4848
    4949@set edition 4.1.0a
    50 @set update-date 1 June 97
    51 @set update-month June 97
     50@set update-date 1 June 1997
     51@set update-month June 1997
    5252
    5353@c

  • doc/supplements/hppa1_1/hppa1_1.texi

    r1499931d ra94c5a5d  
    3535
    3636@set edition 4.1.0a
    37 @set update-date 1 June 97
    38 @set update-month June 97
     37@set update-date 1 June 1997
     38@set update-month June 1997
    3939
    4040@c

  • doc/supplements/i386/i386.texi

    r1499931d ra94c5a5d  
    4141
    4242@set edition 4.1.0a
    43 @set update-date 1 June 97
    44 @set update-month June 97
     43@set update-date 1 June 1997
     44@set update-month June 1997
    4545
    4646@c

  • doc/supplements/i960/i960.texi

    r1499931d ra94c5a5d  
    3535
    3636@set edition 4.1.0a
    37 @set update-date 1 June 97
    38 @set update-month June 97
     37@set update-date 1 June 1997
     38@set update-month June 1997
    3939
    4040@c

  • doc/supplements/m68k/m68k.texi

    r1499931d ra94c5a5d  
    3535
    3636@set edition 4.1.0a
    37 @set update-date 1 June 97
    38 @set update-month June 97
     37@set update-date 1 June 1997
     38@set update-month June 1997
    3939
    4040@c

  • doc/supplements/sparc/sparc.texi

    r1499931d ra94c5a5d  
    3535
    3636@set edition 4.1.0a
    37 @set update-date 1 June 97
    38 @set update-month June 97
     37@set update-date 1 June 1997
     38@set update-month June 1997
    3939
    4040@c

  • doc/user/bsp.t

    r1499931d ra94c5a5d  
    9595state.
    9696
    97 @item Must allocate a stack of at least MINIMUM_STACK_SIZE
     97@item Must allocate a stack of at least @code{MINIMUM_STACK_SIZE}
    9898bytes and initialize the stack pointer for the
    9999initialize_executive directive.
    … …  
    140140
    141141The size of the interrupt stack must be greater than
    142 or equal to the constant MINIMUM_STACK_SIZE.
     142or equal to the constant @code{MINIMUM_STACK_SIZE}.
    143143
    144144@ifinfo

  • doc/user/c_user.texi

    r1499931d ra94c5a5d  
    4040@set is-C
    4141@clear is-Ada
    42 @set RTEMS-LANGUAGE C
    43 @set RTEMS-STRUCTURE structure
    44 @set RTEMS-ROUTINE function
    45 @c the language is @value{RTEMS-LANGUAGE}
     42@set LANGUAGE C
     43@set STRUCTURE structure
     44@set ROUTINE function
     45@set OR |
     46@c the language is @value{LANGUAGE}
    4647@c NOTE:  don't use underscore in the name
    4748@c
    … …  
    5253
    5354@set edition 4.1.0a
    54 @set update-date 1 June 97
    55 @set update-month June 97
     55@set update-date 1 June 1997
     56@set update-month June 1997
    5657
    5758@c
    … …  
    6566@finalout
    6667
    67 @title RTEMS Applications C User's Guide
     68@title RTEMS C User's Guide
    6869@subtitle Edition @value{edition}, for RTEMS 4.1.0
    6970@sp 1

  • doc/user/clock.t

    r1499931d ra94c5a5d  
    66
    77@ifinfo
    8 @node Clock Manager, Clock Manager Introduction, INTERRUPT_CATCH - Establish an ISR, Top
     8@node Clock Manager, Clock Manager Introduction, INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress, Top
    99@end ifinfo
    1010@chapter Clock Manager
    … …  
    240240
    241241@itemize @bullet
    242 @item CLOCK_GET_TOD - obtain native style date and time
    243 @item CLOCK_GET_TIME_VALUE - obtain UNIX-style date and time
    244 @item CLOCK_GET_TICKS_SINCE_BOOT - obtain number of ticks since RTEMS was initialized
    245 @item CLOCK_GET_SECONDS_SINCE_EPOCH - obtain number of seconds since RTEMS epoch
    246 @item CLOCK_GET_TICKS_PER_SECOND - obtain number of clock ticks per second
     242@item @code{CLOCK_GET_TOD} - obtain native style date and time
     243
     244@item @code{CLOCK_GET_TIME_VALUE} - obtain UNIX-style date and time
     245
     246@item @code{CLOCK_GET_TICKS_SINCE_BOOT} - obtain number of ticks
     247since RTEMS was initialized
     248
     249@item @code{CLOCK_GET_SECONDS_SINCE_EPOCH} - obtain number of seconds
     250since RTEMS epoch
     251
     252@item @code{CLOCK_GET_TICKS_PER_SECOND} - obtain number of clock ticks
     253per second
     254
    247255@end itemize
    248256
    … …  
    355363This directive obtains the system date and time.  If
    356364the caller is attempting to obtain the date and time (i.e.
    357 option is set to either CLOCK_GET_SECONDS_SINCE_EPOCH,
    358 CLOCK_GET_TOD, or CLOCK_GET_TIME_VALUE) and the date and time
     365option is set to either @code{CLOCK_GET_SECONDS_SINCE_EPOCH},
     366@code{CLOCK_GET_TOD}, or @code{CLOCK_GET_TIME_VALUE}) and the date and time
    359367has not been set with a previous call to clock_set, then the
    360 NOT_DEFINED status code is returned.  The caller can always
     368@code{NOT_DEFINED} status code is returned.  The caller can always
    361369obtain the number of ticks per second (option is
    362 CLOCK_GET_TICKS_PER_SECOND) and the number of ticks since the
    363 executive was initialized option is CLOCK_GET_TICKS_SINCE_BOOT).
     370@code{CLOCK_GET_TICKS_PER_SECOND}) and the number of ticks since the
     371executive was initialized option is @code{CLOCK_GET_TICKS_SINCE_BOOT}).
    364372
    365373@subheading NOTES:

  • doc/user/conf.t

    r1499931d ra94c5a5d  
    3636argument to the initialize_executive directive, which MUST be
    3737the first RTEMS directive called.  The RTEMS Configuration Table
    38 is defined in the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
     38is defined in the following @value{LANGUAGE} @value{STRUCTURE}:
    3939
    4040@ifset is-C
    … …  
    152152For example, the user can configure the maximum number of tasks for
    153153this application. The RTEMS API Configuration Table is defined in
    154 the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
     154the following @value{LANGUAGE} @value{STRUCTURE}:
    155155
    156156@ifset is-C
    … …  
    245245For example, the user can configure the maximum number of threads for
    246246this application. The POSIX API Configuration Table is defined in
    247 the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
     247the following @value{LANGUAGE} @value{STRUCTURE}:
    248248 
    249249@ifset is-C
    … …  
    487487Configuration Table.  The format of each entry in the Device
    488488Driver Table is defined in
    489 the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
     489the following @value{LANGUAGE} @value{STRUCTURE}:
    490490
    491491@ifset is-C
    … …  
    544544
    545545Driver entry points configured as NULL will always
    546 return a status code of SUCCESSFUL.  No user code will be
     546return a status code of @code{SUCCESSFUL}.  No user code will be
    547547executed in this situation.
    548548
    … …  
    755755Multiprocessing chapter.  The format of the Multiprocessor
    756756Configuration Table is defined in
    757 the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
     757the following @value{LANGUAGE} @value{STRUCTURE}:
    758758
    759759@ifset is-C
    … …  
    830830
    831831The format of this table is defined in
    832 the following @value{RTEMS-LANGUAGE} @value{RTEMS-STRUCTURE}:
     832the following @value{LANGUAGE} @value{STRUCTURE}:
    833833
    834834@ifset is-C
    … …  
    971971be aligned on a four-byte boundary.  Failure to properly align
    972972the workspace area will result in the fatal_error_occurred
    973 directive being invoked with the INVALID_ADDRESS error code.
     973directive being invoked with the @code{INVALID_ADDRESS} error code.
    974974
    975975A worksheet is provided in the Memory Requirements

  • doc/user/dirstat.texi

    r1499931d ra94c5a5d  
    1010@chapter Directive Status Codes
    1111@table @b
    12 @item @b{SUCCESSFUL} - successful completion
    13 @item @b{TASK_EXITTED} - returned from a task
    14 @item @b{MP_NOT_CONFIGURED} - multiprocessing not configured
    15 @item @b{INVALID_NAME} - invalid object name
    16 @item @b{INVALID_ID} - invalid object id
    17 @item @b{TOO_MANY} - too many
    18 @item @b{TIMEOUT} - timed out waiting
    19 @item @b{OBJECT_WAS_DELETED} - object was deleted while waiting
    20 @item @b{INVALID_SIZE} - invalid specified size
    21 @item @b{INVALID_ADDRESS} - invalid address specified
    22 @item @b{INVALID_NUMBER} - number was invalid
    23 @item @b{NOT_DEFINED} - item not initialized
    24 @item @b{RESOURCE_IN_USE} - resources outstanding
    25 @item @b{UNSATISFIED} - request not satisfied
    26 @item @b{INCORRECT_STATE} - task is in wrong state
    27 @item @b{ALREADY_SUSPENDED} - task already in state
    28 @item @b{ILLEGAL_ON_SELF} - illegal for calling task
    29 @item @b{ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object
    30 @item @b{CALLED_FROM_ISR} - invalid environment
    31 @item @b{INVALID_PRIORITY} - invalid task priority
    32 @item @b{INVALID_CLOCK} - invalid time buffer
    33 @item @b{INVALID_NODE} - invalid node id
    34 @item @b{NOT_CONFIGURED} - directive not configured
    35 @item @b{NOT_OWNER_OF_RESOURCE} - not owner of resource
    36 @item @b{NOT_IMPLEMENTED} - directive not implemented
    37 @item @b{INTERNAL_ERROR} - RTEMS inconsistency detected
    38 @item @b{NO_MEMORY} - could not get enough memory
     12@item @code{SUCCESSFUL} - successful completion
     13@item @code{TASK_EXITTED} - returned from a task
     14@item @code{MP_NOT_CONFIGURED} - multiprocessing not configured
     15@item @code{INVALID_NAME} - invalid object name
     16@item @code{INVALID_ID} - invalid object id
     17@item @code{TOO_MANY} - too many
     18@item @code{TIMEOUT} - timed out waiting
     19@item @code{OBJECT_WAS_DELETED} - object was deleted while waiting
     20@item @code{INVALID_SIZE} - invalid specified size
     21@item @code{INVALID_ADDRESS} - invalid address specified
     22@item @code{INVALID_NUMBER} - number was invalid
     23@item @code{NOT_DEFINED} - item not initialized
     24@item @code{RESOURCE_IN_USE} - resources outstanding
     25@item @code{UNSATISFIED} - request not satisfied
     26@item @code{INCORRECT_STATE} - task is in wrong state
     27@item @code{ALREADY_SUSPENDED} - task already in state
     28@item @code{ILLEGAL_ON_SELF} - illegal for calling task
     29@item @code{ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object
     30@item @code{CALLED_FROM_ISR} - invalid environment
     31@item @code{INVALID_PRIORITY} - invalid task priority
     32@item @code{INVALID_CLOCK} - invalid time buffer
     33@item @code{INVALID_NODE} - invalid node id
     34@item @code{NOT_CONFIGURED} - directive not configured
     35@item @code{NOT_OWNER_OF_RESOURCE} - not owner of resource
     36@item @code{NOT_IMPLEMENTED} - directive not implemented
     37@item @code{INTERNAL_ERROR} - RTEMS inconsistency detected
     38@item @code{NO_MEMORY} - could not get enough memory
    3939@end table
    4040

  • doc/user/event.t

    r1499931d ra94c5a5d  
    7979be used to determine when the request is satisfied. An event
    8080condition is satisfied based upon one of two algorithms which
    81 are selected by the user.  The EVENT_ANY algorithm states that
     81are selected by the user.  The @code{EVENT_ANY} algorithm states that
    8282an event condition is satisfied when at least a single requested
    83 event is posted.  The EVENT_ALL algorithm states that an event
     83event is posted.  The @code{EVENT_ALL} algorithm states that an event
    8484condition is satisfied when every requested event is posted.
    8585
    … …  
    9090
    9191An event set or condition is built by a bitwise OR of
    92 the desired events.  The set of valid events is EVENT_0 through
    93 EVENT_31.  If an event is not explicitly specified in the set or
     92the desired events.  The set of valid events is @code{EVENT_0} through
     93@code{EVENT_31}.  If an event is not explicitly specified in the set or
    9494condition, then it is not present.  Events are specifically
    9595designed to be mutually exclusive, therefore bitwise OR and
    … …  
    9898
    9999For example, when sending the event set consisting of
    100 EVENT_6, EVENT_15, and EVENT_31, the event parameter to the
    101 event_send directive should be EVENT_6 | EVENT_15 | EVENT_31.
     100@code{EVENT_6}, @code{EVENT_15}, and @code{EVENT_31},
     101the event parameter to the event_send directive should be
     102@code{EVENT_6 @value{OR} EVENT_15 @value{OR} EVENT_31}.
    102103
    103104@ifinfo
    … …  
    111112
    112113@itemize @bullet
    113 @item WAIT - task will wait for event (default)
    114 @item NO_WAIT - task should not wait
    115 @item EVENT_ALL - return after all events (default)
    116 @item EVENT_ANY - return after any events
     114@item @code{WAIT} - task will wait for event (default)
     115@item @code{NO_WAIT} - task should not wait
     116@item @code{EVENT_ALL} - return after all events (default)
     117@item @code{EVENT_ANY} - return after any events
    117118@end itemize
    118119
    … …  
    123124required to appear in the option list, although it is a good
    124125programming practice to specify default options.  If all
    125 defaults are desired, the option DEFAULT_OPTIONS should be
     126defaults are desired, the option @code{DEFAULT_OPTIONS} should be
    126127specified on this call.
    127128
    … …  
    129130to poll for all events in a particular event condition to
    130131arrive.  The option parameter passed to the event_receive
    131 directive should be either EVENT_ALL | NO_WAIT or NO_WAIT.  The
    132 option parameter can be set to NO_WAIT because EVENT_ALL is the
     132directive should be either @code{EVENT_ALL @value{OR} NO_WAIT}
     133or @code{NO_WAIT}.  The option parameter can be set to
     134@code{NO_WAIT} because @code{EVENT_ALL} is the
    133135default condition for event_receive.
    134136
    … …  
    195197event condition to be satisfied.
    196198
    197 @item Specifying the NO_WAIT option forces an immediate return
     199@item Specifying the @code{NO_WAIT} option forces an immediate return
    198200with an error status code.
    199201
    … …  
    219221A task can receive all of the currently pending
    220222events by calling the event_receive directive with a value of
    221 ALL_EVENTS for the input event condition and NO_WAIT | EVENT_ANY
     223@code{ALL_EVENTS} for the input event condition and
     224@code{NO_WAIT @value{OR} EVENT_ANY}
    222225for the option set.  The pending events are returned to the
    223226calling task and the event set is cleared.  If no events are
    224 pending then the UNSATISFIED status code will be returned.
     227pending then the @code{UNSATISFIED} status code will be returned.
    225228
    226229@ifinfo
    … …  
    283286@subheading NOTES:
    284287
    285 Specifying SELF for id results in the event set being
     288Specifying @code{SELF} for id results in the event set being
    286289sent to the calling task.
    287290
    … …  
    331334@subheading DIRECTIVE STATUS CODES:
    332335@code{SUCCESSFUL} - event received successfully@*
    333 @code{UNSATISFIED} - input event not satisfied (NO_WAIT)@*
     336@code{UNSATISFIED} - input event not satisfied (@code{NO_WAIT})@*
    334337@code{TIMEOUT} - timed out waiting for event
    335338
    … …  
    338341This directive attempts to receive the event
    339342condition specified in event_in.  If event_in is set to
    340 PENDING_EVENTS, then the current pending events are returned in
    341 event_out and left pending.  The WAIT and NO_WAIT options in the
     343@code{PENDING_EVENTS}, then the current pending events are returned in
     344event_out and left pending.  The @code{WAIT} and @code{NO_WAIT} options in the
    342345option_set parameter are used to specify whether or not the task
    343346is willing to wait for the event condition to be satisfied.
    344 EVENT_ANY and EVENT_ALL are used in the option_set parameter are
     347@code{EVENT_ANY} and @code{EVENT_ALL} are used in the option_set parameter are
    345348used to specify whether a single event or the complete event set
    346349is necessary to satisfy the event condition.  The event_out
    … …  
    351354event_out is set to the satisfied events and the pending events
    352355in the event condition are cleared.  If the event condition is
    353 not satisfied and NO_WAIT is specified, then event_out is set to
     356not satisfied and @code{NO_WAIT} is specified, then event_out is set to
    354357the currently satisfied events.  If the calling task chooses to
    355358wait, then it will block waiting for the event condition.
    … …  
    357360If the calling task must wait for the event condition
    358361to be satisfied, then the timeout parameter is used to specify
    359 the maximum interval to wait.  If it is set to NO_TIMEOUT, then
     362the maximum interval to wait.  If it is set to @code{NO_TIMEOUT}, then
    360363the calling task will wait forever.
    361364
    … …  
    370373
    371374@itemize @bullet
    372 @item WAIT      task will wait for event (default)
    373 @item NO_WAIT   task should not wait
    374 @item EVENT_ALL         return after all events (default)
    375 @item EVENT_ANY         return after any events
    376 @end itemize
    377 
     375@item @code{WAIT}       task will wait for event (default)
     376@item @code{NO_WAIT}    task should not wait
     377@item @code{EVENT_ALL}  return after all events (default)
     378@item @code{EVENT_ANY}  return after any events
     379@end itemize
     380

  • doc/user/fatal.t

    r1499931d ra94c5a5d  
    9191fatal error handlers or the RTEMS fatal error handler, the
    9292fatal_error_occurred directive stores useful information in the
    93 variable _Internal_errors_What_happened.  This structure
     93variable @code{_Internal_errors_What_happened}.  This structure
    9494contains three pieces of information:
    9595

  • doc/user/intr.t

    r1499931d ra94c5a5d  
    5757interrupt occurs, the processor will automatically vector to
    5858RTEMS.  RTEMS saves and restores all registers which are not
    59 preserved by the normal @value{RTEMS-LANGUAGE} calling convention
     59preserved by the normal @value{LANGUAGE} calling convention
    6060for the target
    6161processor and invokes the user's ISR.  The user's ISR is
    … …  
    266266@menu
    267267* INTERRUPT_CATCH - Establish an ISR::
     268* INTERRUPT_DISABLE - Disable Interrupts::
     269* INTERRUPT_ENABLE - Enable Interrupts::
     270* INTERRUPT_FLASH - Flash Interrupts::
     271* INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress::
    268272@end menu
    269273@end ifinfo
    … …  
    276280@page
    277281@ifinfo
    278 @node INTERRUPT_CATCH - Establish an ISR, Clock Manager, Interrupt Manager Directives, Interrupt Manager Directives
     282@node INTERRUPT_CATCH - Establish an ISR, INTERRUPT_DISABLE - Disable Interrupts, Interrupt Manager Directives, Interrupt Manager Directives
    279283@end ifinfo
    280284@subsection INTERRUPT_CATCH - Establish an ISR
    … …  
    318322@subheading NOTES:
    319323
    320 This directive will not cause the calling task to be
    321 preempted.
    322 
     324This directive will not cause the calling task to be preempted.
     325
     326@page
     327@ifinfo
     328@node INTERRUPT_DISABLE - Disable Interrupts, INTERRUPT_ENABLE - Enable Interrupts, INTERRUPT_CATCH - Establish an ISR, Interrupt Manager Directives
     329@end ifinfo
     330@subsection INTERRUPT_DISABLE - Disable Interrupts
     331
     332@subheading CALLING SEQUENCE:
     333
     334@ifset is-C
     335@example
     336void rtems_interrupt_disable(
     337  rtems_isr_level  level
     338);
     339@end example
     340@end ifset
     341
     342@ifset is-Ada
     343@example
     344function Interrupt_Disable
     345return RTEMS.ISR_Level;
     346@end example
     347@end ifset
     348
     349@subheading DIRECTIVE STATUS CODES:
     350
     351NONE
     352
     353@subheading DESCRIPTION:
     354
     355This directive disables all maskable interrupts and returns
     356the previous @code{level}.  A later invocation of the
     357@code{rtems_interrupt_enable} directive should be used to
     358restore the interrupt level.
     359
     360@subheading NOTES:
     361
     362This directive will not cause the calling task to be preempted.
     363
     364@ifset is-C
     365@b{This directive is implemented as a macro which modifies the @code{level}
     366parameter.}
     367@end ifset
     368
     369@page
     370@ifinfo
     371@node INTERRUPT_ENABLE - Enable Interrupts, INTERRUPT_FLASH - Flash Interrupts, INTERRUPT_DISABLE - Disable Interrupts, Interrupt Manager Directives
     372@end ifinfo
     373@subsection INTERRUPT_ENABLE - Enable Interrupts
     374
     375@subheading CALLING SEQUENCE:
     376
     377@ifset is-C
     378@example
     379void rtems_interrupt_enable(
     380  rtems_isr_level  level
     381);
     382@end example
     383@end ifset
     384
     385@ifset is-Ada
     386@example
     387procedure Interrupt_Enable (
     388   Level : in     RTEMS.ISR_Level
     389);
     390@end example
     391@end ifset
     392
     393@subheading DIRECTIVE STATUS CODES:
     394
     395NONE
     396
     397@subheading DESCRIPTION:
     398
     399This directive enables maskable interrupts to the @code{level}
     400which was returned by a previous call to @code{rtems_interrupt_disable}.
     401Immediately prior to invoking this directive, maskable interrupts should
     402be disabled by a call to @code{rtems_interrupt_disable} and will be enabled
     403when this directive returns to the caller.
     404
     405@subheading NOTES:
     406
     407This directive will not cause the calling task to be preempted.
     408
     409
     410@page
     411@ifinfo
     412@node INTERRUPT_FLASH - Flash Interrupts, INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress, INTERRUPT_ENABLE - Enable Interrupts, Interrupt Manager Directives
     413@end ifinfo
     414@subsection INTERRUPT_FLASH - Flash Interrupts
     415
     416@subheading CALLING SEQUENCE:
     417
     418@ifset is-C
     419@example
     420void rtems_interrupt_flash(
     421  rtems_isr_level level
     422);
     423@end example
     424@end ifset
     425
     426@ifset is-Ada
     427@example
     428procedure Interrupt_Flash (
     429   Level : in     RTEMS.ISR_Level
     430);
     431@end example
     432@end ifset
     433
     434@subheading DIRECTIVE STATUS CODES:
     435
     436NONE
     437
     438@subheading DESCRIPTION:
     439
     440This directive temporarily enables maskable interrupts to the @code{level}
     441which was returned by a previous call to @code{rtems_interrupt_disable}. 
     442Immediately prior to invoking this directive, maskable interrupts should
     443be disabled by a call to @code{rtems_interrupt_disable} and will be redisabled
     444when this directive returns to the caller.
     445
     446@subheading NOTES:
     447
     448This directive will not cause the calling task to be preempted.
     449
     450@page
     451@ifinfo
     452@node INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress, Clock Manager, INTERRUPT_FLASH - Flash Interrupts, Interrupt Manager Directives
     453@end ifinfo
     454@subsection INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress
     455
     456@subheading CALLING SEQUENCE:
     457
     458@ifset is-C
     459@example
     460rtems_boolean rtems_interrupt_is_in_progress( void );
     461@end example
     462@end ifset
     463
     464@ifset is-Ada
     465@example
     466function Interrupt_Is_In_Progress
     467return RTEMS.Boolean;
     468@end example
     469@end ifset
     470
     471@subheading DIRECTIVE STATUS CODES:
     472
     473NONE
     474
     475@subheading DESCRIPTION:
     476
     477This directive returns @code{TRUE} if the processor is currently
     478servicing an interrupt and @code{FALSE} otherwise.  A return value
     479of @code{TRUE} indicates that the caller is an interrupt service
     480routine, @b{NOT} a task.  The directives available to an interrupt
     481service routine are restricted.
     482
     483@subheading NOTES:
     484
     485This directive will not cause the calling task to be preempted.
     486

  • doc/user/io.t

    r1499931d ra94c5a5d  
    7878If the device driver does not support a particular
    7979entry point, then that entry in the Configuration Table should
    80 be NULL.  RTEMS will return SUCCESSFUL as the executive's and
     80be NULL.  RTEMS will return @code{SUCCESSFUL} as the executive's and
    8181zero (0) as the device driver's return code for these device
    8282driver entry points.
    … …  
    384384   Name         : in     String;
    385385   Device_Info  :    out RTEMS.Driver_Name_t;
     386   Result       :    out RTEMS.Status_Codes
    386387);
    387388@end example

  • doc/user/mp.t

    r1499931d ra94c5a5d  
    600600@item Packets are composed of both RTEMS and application data.
    601601All RTEMS data is treated as thirty-two (32) bit unsigned
    602 quantities and is in the first MINIMUM_UNSIGNED32S_TO_CONVERT
     602quantities and is in the first @code{MINIMUM_UNSIGNED32S_TO_CONVERT}
    603603thirty-two (32) quantities of the packet.
    604604

  • doc/user/msg.t

    r1499931d ra94c5a5d  
    101101appear in the attribute list, although it is a good programming
    102102practice to specify default attributes.  If all defaults are
    103 desired, the attribute DEFAULT_ATTRIBUTES should be specified on
     103desired, the attribute @code{DEFAULT_ATTRIBUTES} should be specified on
    104104this call.
    105105
    … …  
    107107needed to create a local message queue with the task priority
    108108waiting queue discipline.  The attribute_set parameter to the
    109 message_queue_create directive could be either PRIORITY or LOCAL
    110 | PRIORITY.  The attribute_set parameter can be set to PRIORITY
    111 because LOCAL is the default for all created message queues.  If
     109message_queue_create directive could be either
     110@code{PRIORITY} or @code{LOCAL @value{OR} PRIORITY}. 
     111The attribute_set parameter can be set to @code{PRIORITY}
     112because @code{LOCAL} is the default for all created message queues.  If
    112113a similar message queue were to be known globally, then the
    113 attribute_set parameter would be GLOBAL | PRIORITY.
     114attribute_set parameter would be @code{GLOBAL @value{OR} PRIORITY}.
    114115
    115116@ifinfo
    … …  
    124125
    125126@itemize @bullet
    126 @item WAIT - task will wait for a message (default)
    127 @item NO_WAIT - task should not wait
     127@item @code{WAIT} - task will wait for a message (default)
     128@item @code{NO_WAIT} - task should not wait
    128129@end itemize
    129130
    … …  
    131132appear in the option OR list, although it is a good programming
    132133practice to specify default options.  If all defaults are
    133 desired, the option DEFAULT_OPTIONS should be specified on this
     134desired, the option @code{DEFAULT_OPTIONS} should be specified on this
    134135call.
    135136
    136137This example demonstrates the option parameter needed
    137138to poll for a message to arrive.  The option parameter passed to
    138 the message_queue_receive directive should be NO_WAIT.
     139the message_queue_receive directive should be @code{NO_WAIT}.
    139140
    140141@ifinfo
    … …  
    204205message to arrive.
    205206
    206 @item Specifying the NO_WAIT option forces an immediate return
     207@item Specifying the @code{NO_WAIT} option forces an immediate return
    207208with an error status code.
    208209
    … …  
    422423preempted.
    423424
    424 If node is SEARCH_ALL_NODES, all nodes are searched
     425If node is @code{SEARCH_ALL_NODES}, all nodes are searched
    425426with the local node being searched first.  All other nodes are
    426427searched with the lowest numbered node searched first.
    … …  
    730731
    731732This directive receives a message from the message
    732 queue specified in id.  The WAIT and NO_WAIT options of the
     733queue specified in id.  The @code{WAIT} and @code{NO_WAIT} options of the
    733734options parameter allow the calling task to specify whether to
    734735wait for a message to become available or return immediately.
    … …  
    752753parameter specifies the maximum interval to wait before the
    753754calling task desires to be unblocked.  If it is set to
    754 NO_TIMEOUT, then the calling task will wait forever.
     755@code{NO_TIMEOUT}, then the calling task will wait forever.
    755756
    756757@subheading NOTES:
    … …  
    760761
    761762@itemize @bullet
    762 @item WAIT - task will wait for a message (default)
    763 @item NO_WAIT - task should not wait
     763@item @code{WAIT} - task will wait for a message (default)
     764@item @code{NO_WAIT} - task should not wait
    764765@end itemize
    765766
    … …  
    768769does not reside on the local node will generate a request to the
    769770remote node to obtain a message from the specified message
    770 queue.  If no message is available and WAIT was specified, then
     771queue.  If no message is available and @code{WAIT} was specified, then
    771772the task must be blocked until a message is posted.  A proxy is
    772773allocated on the remote node to represent the task until the

  • doc/user/overview.t

    r1499931d ra94c5a5d  
    5555
    5656This manual describes the usage of RTEMS for
    57 applications written in the @value{RTEMS-LANGUAGE} programming language.  Those
     57applications written in the @value{LANGUAGE} programming language.  Those
    5858implementation details that are processor dependent are provided
    5959in the Applications Supplement documents.  A supplement
    … …  
    410410management as well as intertask communication and
    411411synchronization.  Since directives, user related data
    412 structures, and examples are presented in @value{RTEMS-LANGUAGE}, a basic
    413 understanding of the @value{RTEMS-LANGUAGE} programming language
     412structures, and examples are presented in @value{LANGUAGE}, a basic
     413understanding of the @value{LANGUAGE} programming language
    414414is required to fully
    415415understand the material presented.  However, because of the

  • doc/user/part.t

    r1499931d ra94c5a5d  
    8787required to appear in the attribute list, although it is a good
    8888programming practice to specify default attributes.  If all
    89 defaults are desired, the attribute DEFAULT_ATTRIBUTES should be
     89defaults are desired, the attribute @code{DEFAULT_ATTRIBUTES} should be
    9090specified on this call.  The attribute_set parameter should be
    9191GLOBAL to indicate that the partition is to be known globally.
    … …  
    324324preempted.
    325325
    326 If node is SEARCH_ALL_NODES, all nodes are searched
     326If node is @code{SEARCH_ALL_NODES}, all nodes are searched
    327327with the local node being searched first.  All other nodes are
    328328searched with the lowest numbered node searched first.

  • doc/user/preface.texi

    r1499931d ra94c5a5d  
    182182functionally compliant real-time multiprocessor executive.  It
    183183describes the user interface and run-time behavior of Release
    184 @value{RTEMS-RELEASE} of the @value{RTEMS-LANGUAGE} interface
     184@value{RELEASE} of the @value{LANGUAGE} interface
    185185to RTEMS.
    186186

  • doc/user/region.t

    r1499931d ra94c5a5d  
    9999required to appear in the attribute list, although it is a good
    100100programming practice to specify default attributes.  If all
    101 defaults are desired, the attribute DEFAULT_ATTRIBUTES should be
     101defaults are desired, the attribute @code{DEFAULT_ATTRIBUTES} should be
    102102specified on this call.
    103103
    … …  
    117117
    118118@itemize @bullet
    119 @item WAIT - task will wait for semaphore (default)
    120 @item NO_WAIT - task should not wait
     119@item @code{WAIT} - task will wait for semaphore (default)
     120@item @code{NO_WAIT} - task should not wait
    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 DEFAULT_OPTIONS should be
     129defaults are desired, the option @code{DEFAULT_OPTIONS} should be
    130130specified on this call.
    131131
    132132This example demonstrates the option parameter needed
    133133to poll for a segment.  The option parameter passed to the
    134 region_get_segment directive should be NO_WAIT.
     134region_get_segment directive should be @code{NO_WAIT}.
    135135
    136136@ifinfo
    … …  
    217217@item By default, the calling task will wait forever to acquire the segment.
    218218
    219 @item Specifying the NO_WAIT option forces an immediate return
     219@item Specifying the @code{NO_WAIT} option forces an immediate return
    220220with an error status code.
    221221
    … …  
    348348waiting for a segment to be serviced according to task priority.
    349349Specifying FIFO in attribute_set or selecting
    350 DEFAULT_ATTRIBUTES will cause waiting tasks to be serviced in
     350@code{DEFAULT_ATTRIBUTES} will cause waiting tasks to be serviced in
    351351First In-First Out order.
    352352
    … …  
    554554This directive obtains a variable size segment from
    555555the region specified by id.  The address of the allocated
    556 segment is returned in segment.  The WAIT and NO_WAIT components
     556segment is returned in segment.  The @code{WAIT} and @code{NO_WAIT} components
    557557of the options parameter are used to specify whether the calling
    558558tasks wish to wait for a segment to become available or return
    … …  
    560560sufficiently sized segment is available, then the segment is
    561561successfully acquired by returning immediately with  the
    562 SUCCESSFUL status code.
     562@code{SUCCESSFUL} status code.
    563563
    564564If the calling task chooses to return immediately and
    … …  
    575575The timeout parameter specifies the maximum interval
    576576that a task is willing to wait to obtain a segment.  If timeout
    577 is set to NO_TIMEOUT, then the calling task will wait forever.
     577is set to @code{NO_TIMEOUT}, then the calling task will wait forever.
    578578
    579579@subheading NOTES:
    … …  
    587587
    588588@itemize @bullet
    589 @item WAIT - task will wait for semaphore (default)
    590 @item NO_WAIT - task should not wait
     589@item @code{WAIT} - task will wait for semaphore (default)
     590@item @code{NO_WAIT} - task should not wait
    591591@end itemize
    592592

  • doc/user/rtmon.t

    r1499931d ra94c5a5d  
    730730
    731731If the rate_monotonic_period directive is invoked
    732 with a period of PERIOD_STATUS ticks, the current state of the
     732with a period of @code{PERIOD_STATUS} ticks, the current state of the
    733733specified rate monotonic period will be returned.  The following
    734734table details the relationship between the period's status and
    … …  
    737737
    738738@itemize @bullet
    739 @item SUCCESSFUL - period is running
    740 
    741 @item TIMEOUT - period has expired
    742 
    743 @item NOT_DEFINED - period has never been initiated
     739@item @code{SUCCESSFUL} - period is running
     740
     741@item @code{TIMEOUT} - period has expired
     742
     743@item @code{NOT_DEFINED} - period has never been initiated
    744744@end itemize
    745745
    … …  
    11501150immediately initiated and the directive returns immediately.
    11511151
    1152 If invoked with a period of PERIOD_STATUS ticks, the
     1152If invoked with a period of @code{PERIOD_STATUS} ticks, the
    11531153current state of id will be returned.  The directive status
    11541154indicates the current state of the period.  This does not alter
    … …  
    12181218@end ifset
    12191219
    1220 If the period's state is RATE_MONOTONIC_INACTIVE, both
     1220If the period's state is @code{RATE_MONOTONIC_INACTIVE}, both
    12211221ticks_since_last_period and ticks_executed_since_last_period
    12221222will be set to 0.  Otherwise, ticks_since_last_period will

  • doc/user/schedule.t

    r1499931d ra94c5a5d  
    166166algorithm is called manual round-robin.  Manual round-robin is
    167167invoked by using the task_wake_after directive with a time
    168 interval of YIELD_PROCESSOR.  This allows a task to give up the
     168interval of @code{YIELD_PROCESSOR}.  This allows a task to give up the
    169169processor and be immediately returned to the ready chain at the
    170170end of its priority group.  If no other tasks of the same
    … …  
    194194
    195195Tasks that utilize a numeric coprocessor and are
    196 created with the FLOATING_POINT attribute require additional
     196created with the @code{FLOATING_POINT} attribute require additional
    197197operations during a context switch.  These additional operations
    198198are necessary to save and restore the floating point context of
    199 FLOATING_POINT tasks.  To avoid unnecessary save and restore
     199@code{FLOATING_POINT} tasks.  To avoid unnecessary save and restore
    200200operations, the state of the numeric coprocessor is only saved
    201 when a FLOATING_POINT task is dispatched and that task was not
     201when a @code{FLOATING_POINT} task is dispatched and that task was not
    202202the last task to utilize the coprocessor.
    203203

  • doc/user/sem.t

    r1499931d ra94c5a5d  
    229229required to appear in the attribute list, although it is a good
    230230programming practice to specify default attributes.  If all
    231 defaults are desired, the attribute DEFAULT_ATTRIBUTES should be
     231defaults are desired, the attribute @code{DEFAULT_ATTRIBUTES} should be
    232232specified on this call.
    233233
    … …  
    235235needed to create a local semaphore with the task priority
    236236waiting queue discipline.  The attribute_set parameter passed to
    237 the semaphore_create directive could be either PRIORITY or LOCAL
    238 | PRIORITY.  The attribute_set parameter can be set to PRIORITY
    239 because LOCAL is the default for all created tasks.  If a
     237the semaphore_create directive could be either
     238@code{PRIORITY} or @code{LOCAL @value{OR} PRIORITY}. 
     239The attribute_set parameter can be set to @code{PRIORITY}
     240because @code{LOCAL} is the default for all created tasks.  If a
    240241similar semaphore were to be known globally, then the
    241 attribute_set parameter would be GLOBAL | PRIORITY.
     242attribute_set parameter would be @code{GLOBAL @value{OR} PRIORITY}.
    242243
    243244@ifinfo
    … …  
    251252
    252253@itemize @bullet
    253 @item WAIT - task will wait for semaphore (default)
    254 @item NO_WAIT - task should not wait
     254@item @code{WAIT} - task will wait for semaphore (default)
     255@item @code{NO_WAIT} - task should not wait
    255256@end itemize
    256257
    … …  
    261262required to appear in the list, although it is a good
    262263programming practice to specify default options.  If all
    263 defaults are desired, the option DEFAULT_OPTIONS should be
     264defaults are desired, the option @code{DEFAULT_OPTIONS} should be
    264265specified on this call.
    265266
    266267This example demonstrates the option parameter needed
    267268to poll for a semaphore.  The option parameter passed to the
    268 semaphore_obtain directive should be NO_WAIT.
     269semaphore_obtain directive should be @code{NO_WAIT}.
    269270
    270271@ifinfo
    … …  
    343344acquire the semaphore.
    344345
    345 @item Specifying NO_WAIT forces an immediate return with an
     346@item Specifying @code{NO_WAIT} forces an immediate return with an
    346347error status code.
    347348
    … …  
    561562preempted.
    562563
    563 If node is SEARCH_ALL_NODES, all nodes are searched
     564If node is @code{SEARCH_ALL_NODES}, all nodes are searched
    564565with the local node being searched first.  All other nodes are
    565566searched with the lowest numbered node searched first.
    … …  
    673674
    674675This directive acquires the semaphore specified by
    675 id.  The WAIT and NO_WAIT components of the options parameter
     676id.  The @code{WAIT} and @code{NO_WAIT} components of the options parameter
    676677indicate whether the calling task wants to wait for the
    677678semaphore to become available or return immediately if the
    678 semaphore is not currently available.  With either WAIT or
    679 NO_WAIT, if the current semaphore count is positive, then it is
     679semaphore is not currently available.  With either @code{WAIT} or
     680@code{NO_WAIT}, if the current semaphore count is positive, then it is
    680681decremented by one and the semaphore is successfully acquired by
    681682returning immediately with a successful return code.
    … …  
    703704The timeout parameter specifies the maximum interval
    704705the calling task is willing to be blocked waiting for the
    705 semaphore.  If it is set to NO_TIMEOUT, then the calling task
    706 will wait forever.  If the semaphore is available or the NO_WAIT
     706semaphore.  If it is set to @code{NO_TIMEOUT}, then the calling task
     707will wait forever.  If the semaphore is available or the @code{NO_WAIT}
    707708option component is set, then timeout is ignored.
    708709
    … …  
    712713
    713714@itemize @bullet
    714 @item WAIT - task will wait for semaphore (default)
    715 @item NO_WAIT - task should not wait
     715@item @code{WAIT} - task will wait for semaphore (default)
     716@item @code{NO_WAIT} - task should not wait
    716717@end itemize
    717718
    … …  
    719720the local node will generate a request to the remote node to
    720721access the semaphore.  If the semaphore is not available and
    721 NO_WAIT was not specified, then the task must be blocked until
     722@code{NO_WAIT} was not specified, then the task must be blocked until
    722723the semaphore is released.  A proxy is allocated on the remote
    723724node to represent the task until the semaphore is released.

  • doc/user/signal.t

    r1499931d ra94c5a5d  
    9999
    100100A signal set is built by a bitwise OR of the desired
    101 signals.  The set of valid signals is SIGNAL_0 through
    102 SIGNAL_31.  If a signal is not explicitly specified in the
     101signals.  The set of valid signals is @code{SIGNAL_0} through
     102@code{SIGNAL_31}.  If a signal is not explicitly specified in the
    103103signal set, then it is not present.  Signal values are
    104104specifically designed to be mutually exclusive, therefore
    … …  
    107107
    108108This example demonstrates the signal parameter used
    109 when sending the signal set consisting of SIGNAL_6, SIGNAL_15,
    110 and SIGNAL_31.  The signal parameter provided to the signal_send
    111 directive should be SIGNAL_6 | SIGNAL_15 | SIGNAL_31.
     109when sending the signal set consisting of
     110@code{SIGNAL_6}, @code{SIGNAL_15}, and @code{SIGNAL_31}. 
     111The signal parameter provided to the signal_send directive should be
     112@code{SIGNAL_6 @value{OR} SIGNAL_15 @value{OR} SIGNAL_31}.
    112113
    113114@ifinfo
    … …  
    145146with the signal_catch to establish an ASR which executes at
    146147interrupt level three and is non-preemptible.  The mode should
    147 be set to INTERRUPT_LEVEL(3) | NO_PREEMPT to indicate the
     148be set to
     149@code{INTERRUPT_LEVEL(3) @value{OR} NO_PREEMPT} to indicate the
    148150desired processor mode and interrupt level.
    149151
    … …  
    232234limited to the meaning of the single argument passed to an ASR.
    233235The ASR should have the following calling sequence and adhere to
    234 @value{RTEMS-LANGUAGE} calling conventions:
     236@value{LANGUAGE} calling conventions:
    235237
    236238@ifset is-C

  • doc/user/task.t

    r1499931d ra94c5a5d  
    279279@subsection Floating Point Considerations
    280280
    281 Creating a task with the FLOATING_POINT flag results in
     281Creating a task with the @code{FLOATING_POINT} flag results in
    282282additional memory being allocated for the TCB to store the state
    283283of the numeric coprocessor during task switches.  This
    284 additional memory is NOT allocated for NO_FLOATING_POINT tasks.
    285 Saving and restoring the context of a FLOATING_POINT task takes
    286 longer than that of a NO_FLOATING_POINT task because of the
     284additional memory is @b{NOT} allocated for @code{NO_FLOATING_POINT} tasks.
     285Saving and restoring the context of a @code{FLOATING_POINT} task takes
     286longer than that of a @code{NO_FLOATING_POINT} task because of the
    287287relatively large amount of time required for the numeric
    288288coprocessor to save or restore its computational state.
    … …  
    292292is optimized to avoid unnecessarily saving and restoring the
    293293state of the numeric coprocessor.  The state of the numeric
    294 coprocessor is only saved when a FLOATING_POINT task is
     294coprocessor is only saved when a @code{FLOATING_POINT} task is
    295295dispatched and that task was not the last task to utilize the
    296 coprocessor.  In a system with only one FLOATING_POINT task, the
     296coprocessor.  In a system with only one @code{FLOATING_POINT} task, the
    297297state of the numeric coprocessor will never be saved or
    298298restored. 
    299299
    300 Although the overhead imposed by FLOATING_POINT tasks is
     300Although the overhead imposed by @code{FLOATING_POINT} tasks is
    301301minimal, some applications may wish to completely avoid the
    302 overhead associated with FLOATING_POINT tasks and still utilize
     302overhead associated with @code{FLOATING_POINT} tasks and still utilize
    303303a numeric coprocessor.  By preventing a task from being
    304304preempted while performing a sequence of floating point
    305 operations, a NO_FLOATING_POINT task can utilize the numeric
    306 coprocessor without incurring the overhead of a FLOATING_POINT
     305operations, a @code{NO_FLOATING_POINT} task can utilize the numeric
     306coprocessor without incurring the overhead of a @code{FLOATING_POINT}
    307307context switch.  This approach also avoids the allocation of a
    308308floating point context area.  However, if this approach is taken
    309309by the application designer, NO tasks should be created as
    310 FLOATING_POINT tasks.  Otherwise, the floating point context
     310@code{FLOATING_POINT} tasks.  Otherwise, the floating point context
    311311will not be correctly maintained because RTEMS assumes that the
    312312state of the numeric coprocessor will not be altered by
    313 NO_FLOATING_POINT tasks.
     313@code{NO_FLOATING_POINT} tasks.
    314314
    315315If the supported processor type does not have hardware floating
    … …  
    317317provide built-in support for hardware floating point on that
    318318processor.  In this case, all tasks are considered
    319 NO_FLOATING_POINT whether created as FLOATING_POINT or
    320 NO_FLOATING_POINT tasks.  A floating point emulation software
     319@code{NO_FLOATING_POINT} whether created as @code{FLOATING_POINT} or
     320@code{NO_FLOATING_POINT} tasks.  A floating point emulation software
    321321library must be utilized for floating point operations.
    322322
    … …  
    325325processor, then RTEMS will utilize this capability to enable the
    326326floating point unit only for tasks which are created with the
    327 FLOATING_POINT attribute.  The consequence of a
    328 NO_FLOATING_POINT task attempting to access the floating point
     327@code{FLOATING_POINT} attribute.  The consequence of a
     328@code{NO_FLOATING_POINT} task attempting to access the floating point
    329329unit is CPU dependent but will i general result in an exception
    330330condition.
    … …  
    352352to appear in the component list, although it is a good
    353353programming practice to specify default components.  If all
    354 defaults are desired, then DEFAULT_ATTRIBUTES should be used.
     354defaults are desired, then @code{DEFAULT_ATTRIBUTES} should be used.
    355355
    356356This example demonstrates the attribute_set parameter needed to
    357357create a local task which utilizes the numeric coprocessor.  The
    358 attribute_set parameter could be FLOATING_POINT or LOCAL |
    359 FLOATING_POINT.  The attribute_set parameter can be set to
    360 FLOATING_POINT because LOCAL is the default for all created
     358attribute_set parameter could be @code{FLOATING_POINT} or
     359@code{LOCAL @value{OR} FLOATING_POINT}. 
     360The attribute_set parameter can be set to
     361@code{FLOATING_POINT} because @code{LOCAL} is the default for all created
    361362tasks.  If the task were global and used the numeric
    362 coprocessor, then the attribute_set parameter would be GLOBAL |
    363 FLOATING_POINT.
     363coprocessor, then the attribute_set parameter would be
     364@code{GLOBAL @value{OR} FLOATING_POINT}.
    364365
    365366@ifinfo
    … …  
    450451the mode component list, although it is a good programming
    451452practice to specify default components.  If all defaults are
    452 desired, the mode DEFAULT_MODES and the mask ALL_MODE_MASKS
     453desired, the mode @code{DEFAULT_MODES} and the mask @code{ALL_MODE_MASKS}
    453454should be used.
    454455
    … …  
    456457used with the task_mode directive to place a task at interrupt
    457458level 3 and make it non-preemptible.  The mode should be set to
    458 INTERRUPT_LEVEL(3) | NO_PREEMPT to indicate the desired
     459@code{INTERRUPT_LEVEL(3) @value{RTEMSOR} NO_PREEMPT} to indicate the desired
    459460preemption mode and interrupt level, while the mask parameter
    460 should be set to INTERRUPT_MASK | NO_PREEMPT_MASK to indicate
    461 that the calling task's interrupt level and preemption mode are
     461should be set to @code{INTERRUPT_MASK @value{RTEMSOR} NO_PREEMPT_MASK}
     462to indicate that the calling task's interrupt level and preemption mode are
    462463being altered.
    463464
    … …  
    567568blocked until the delay interval has elapsed, at which time the
    568569task is unblocked.  A task calling the task_wake_after directive
    569 with a delay interval of YIELD_PROCESSOR ticks will yield the
     570with a delay interval of @code{YIELD_PROCESSOR} ticks will yield the
    570571processor to any other ready task of equal or greater priority
    571572and remain ready to execute.
    … …  
    726727floating point context area.  The mode parameter contains values
    727728which sets the task's initial execution mode.  The
    728 FLOATING_POINT attribute should be specified if the created task
     729@code{FLOATING_POINT} attribute should be specified if the created task
    729730is to use a numeric coprocessor.  For performance reasons, it is
    730731recommended that tasks not using the numeric coprocessor should
    731 specify the NO_FLOATING_POINT attribute.  If the GLOBAL
     732specify the @code{NO_FLOATING_POINT} attribute.  If the GLOBAL
    732733attribute is specified, the task can be accessed from remote
    733734nodes.  The task id, returned in id, is used in other task
    … …  
    745746target processor.
    746747
    747 The requested stack size should be at least MINIMUM_STACK_SIZE
    748 bytes.  The value of MINIMUM_STACK_SIZE is processor dependent.
     748The requested stack size should be at least @code{MINIMUM_STACK_SIZE}
     749bytes.  The value of @code{MINIMUM_STACK_SIZE} is processor dependent.
    749750Application developers should consider the stack usage of the
    750751device drivers when calculating the stack size required for
    … …  
    821822This directive obtains the task id associated with the task name
    822823specified in name.  A task may obtain its own id by specifying
    823 SELF or its own task name in name.  If the task name is not
     824@code{SELF} or its own task name in name.  If the task name is not
    824825unique, then the task id returned will match one of the tasks
    825826with that name.  However, this task id is not guaranteed to
    … …  
    830831This directive will not cause the running task to be preempted.
    831832
    832 If node is SEARCH_ALL_NODES, all nodes are searched with the
     833If node is @code{SEARCH_ALL_NODES}, all nodes are searched with the
    833834local node being searched first.  All other nodes are searched
    834835with the lowest numbered node searched first.
    … …  
    945946
    946947@subheading NOTES:
    947 If id is SELF, the calling task will be restarted and will not
     948If id is @code{SELF}, the calling task will be restarted and will not
    948949return from this directive.
    949950
    … …  
    988989another task, as specified by id.  RTEMS stops the execution of
    989990the task and reclaims the stack memory, any allocated delay or
    990 timeout timers, the TCB, and, if the task is FLOATING_POINT, its
     991timeout timers, the TCB, and, if the task is @code{FLOATING_POINT}, its
    991992floating point context area.  RTEMS does not reclaim the
    992993following resources: region segments, partition buffers,
    … …  
    10031004argument or by sending it a message, an event, or a signal.
    10041005
    1005 Deletion of the current task (SELF) will force RTEMS to select
     1006Deletion of the current task (@code{SELF}) will force RTEMS to select
    10061007another task to execute.
    10071008
    … …  
    10521053
    10531054@subheading NOTES:
    1054 The requesting task can suspend itself by specifying SELF as id.
     1055The requesting task can suspend itself by specifying @code{SELF} as id.
    10551056In this case, the task will be suspended and a successful
    10561057return code will be returned when the task is resumed.
    … …  
    11411142@subheading DESCRIPTION:
    11421143This directive manipulates the priority of the task specified by
    1143 id.  An id of SELF is used to indicate the calling task.  When
     1144id.  An id of @code{SELF} is used to indicate the calling task.  When
    11441145new_priority is not equal to CURRENT_PRIORITY, the specified
    11451146task's previous priority is returned in old_priority.  When
    … …  
    13341335This directive will not cause the running task to be preempted.
    13351336
    1336 If id is set to SELF, the calling task accesses its own notepad.
     1337If id is set to @code{SELF}, the calling task accesses its own notepad.
    13371338
    13381339@c This version of the paragraph avoids the overfull hbox error.
    … …  
    13411342
    13421343The sixteen notepad locations can be accessed using the constants
    1343 NOTEPAD_0 through NOTEPAD_15.
     1344@code{NOTEPAD_0} through @code{NOTEPAD_15}.
    13441345
    13451346Getting a note of a global task which does not reside on the
    … …  
    13861387
    13871388@subheading NOTES:
    1388 If id is set to SELF, the calling task accesses its own notepad
     1389If id is set to @code{SELF}, the calling task accesses its own notepad
    13891390locations.
    13901391
    … …  
    13961397
    13971398The sixteen notepad locations can be accessed using the constants
    1398 NOTEPAD_0 through NOTEPAD_15.
     1399@code{NOTEPAD_0} through @code{NOTEPAD_15}.
    13991400
    14001401Setting a notepad location of a global task which does not
    … …  
    14411442
    14421443A task may give up the processor and remain in the ready state
    1443 by specifying a value of YIELD_PROCESSOR in ticks.
     1444by specifying a value of @code{YIELD_PROCESSOR} in ticks.
    14441445
    14451446The maximum timer interval that can be specified is the maximum

  • doc/user/timer.t

    r1499931d ra94c5a5d  
    7575@subsection Timer Service Routines
    7676
    77 The timer service routine should adhere to @value{RTEMS-LANGUAGE} calling
     77The timer service routine should adhere to @value{LANGUAGE} calling
    7878conventions and have a prototype similar to the following::
    7979

  • doc/user/userext.t

    r1499931d ra94c5a5d  
    199199of each extension.  Each section will contain a prototype of a
    200200function with the appropriate calling sequence for the
    201 corresponding extension.  The names given for the @value{RTEMS-LANGUAGE}
    202 @value{RTEMS-ROUTINE} and
     201corresponding extension.  The names given for the @value{LANGUAGE}
     202@value{ROUTINE} and
    203203its arguments are all defined by the user.  The names used in
    204204the examples were arbitrarily chosen and impose no naming
    … …  
    497497returns control to RTEMS, then the RTEMS default handler will be
    498498used.  This default handler invokes the directive
    499 fatal_error_occurred with the TASK_EXITTED directive status.
     499fatal_error_occurred with the @code{TASK_EXITTED} directive status.
    500500
    501501@lowersections
Note: See TracChangeset for help on using the changeset viewer.