Changeset a5f5acad in rtems


Ignore:
Timestamp:
Nov 10, 1999, 1:38:34 PM (20 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
dcc1f6b6
Parents:
aff08f5
Message:

Updated to include more documentation from CS595.

Location:
doc/itron3.0
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • doc/itron3.0/eventflags.t

    raff08f5 ra5f5acad  
    2121@item @code{clr_flg} - Clear Eventflag
    2222@item @code{wai_flg} - Wait on Eventflag
    23 @item @code{pol_flg} - Wait for Eventflag(Polling)
     23@item @code{pol_flg} - Wait for Eventflag (Polling)
    2424@item @code{twai_flg} - Wait on Eventflag with Timeout
    2525@item @code{ref_flg} - Reference Eventflag Status
     
    3131
    3232An eventflag is used by a task (or ISR) to inform another task of the
    33 occurrence of a significant situation. Thirty-two eventflags are
    34 associated with each task. A collection of one or more eventflags is
    35 referred to as an event set. The application developer should remember the
     33occurrence of a significant situation. One word bit-field is associated with each eventflags. The application developer should remember the
    3634following key characteristics of event operations when utilizing the event
    3735manager:
     
    4644@end itemize
    4745
    48 A pending event is an event that has been posted but not received. An
     46A pending event is an event that has been set. An
    4947event condition is used to specify the events which the task desires to
    5048receive and the algorithm which will be used to determine when the request
     
    5553event condition is satisfied when every requested event is posted.
    5654
    57 An event set or condition is built by a bitwise OR of the desired events.
     55An eventflags or condition is built by a bitwise OR of the desired events.
    5856If an event is not explicitly specified in the set or condition, then it
    5957is not present. Events are specifically designed to be mutually exclusive,
     
    107105may be used freely by the user for including extended information about
    108106the eventflag to be created. Information set here may be accessed by
    109 ref_flg. If a larger region is desired for including user information, or
     107@code{ref_flg}. If a larger region is desired for including user information, or
    110108if the user wishes to change the contents of this information, the usr
    111109should allocate memory area and set the address of this memory packet to
    112 exinf.  The OS does not take care of the contents of exinf. This
     110@code{exinf}.  The OS does not take care of the contents of @code{exinf}. This
    113111implementation does not use this field.
    114112
     
    135133/* Reference Eventflags (ref_flg) Structure */
    136134typedef struct t_rflg @{
    137  VP       exinf; /* extended information */
    138  BOOL_ID  wtsk; /* indicates whether there is a waiting task */
     135 VP       exinf;  /* extended information */
     136 BOOL_ID  wtsk;   /* indicates whether or not there is a waiting task */
    139137 UINT     flgptn; /* eventflag bit pattern */
    140138 /* additional implementation dependent information may be included */
     
    151149
    152150indicates whether or not there is a task waiting for the eventflag in
    153 question.  If there is no waiting task, wtsk is returned as FALSE = 0. 
    154 If there is a waiting task, wtsk is returned as a value other than 0.
     151question.  If there is no waiting task, @code{wtsk} is returned as FALSE = 0. 
     152If there is a waiting task, @code{wtsk} is returned as a value other than 0.
    155153
    156154@item flgptn
     
    359357The @code{set_flg} system call sets the bits specified by @code{setptn} of the
    360358one word eventflag specified by @code{flgid}.  In other words, a logical
    361 sum is taken for the values of the eventflag specified by flgid with the
     359sum is taken for the values of the eventflag specified by @code{flgid} with the
    362360value of @code{setptn}.
    363361
     
    517515The @code{wai_flg} system call waits for the eventflag specified by
    518516@code{flgid} to be set to satisfy the wait release condition specified by
    519 @code{wfmode}.
     517@code{wfmode}. The Eventflags bit-pattern will be returned with a pointer @code{p_flgptn}.
    520518
    521519If the eventflag specified by @code{flgid} already satisfies the wait
     
    703701  UINT waiptn,
    704702  UINT wfmode,
     703  TMO tmout
    705704);
    706705@end example
     
    856855@code{wtsk} and @code{flgptn} (such as eventflag attributes,
    857856@code{flgatr}) may also be referred.
    858 
  • doc/itron3.0/fixedblock.t

    raff08f5 ra5f5acad  
    175175@subheading NOTES:
    176176
     177NONE
     178
    177179
    178180@c
     
    236238@subheading NOTES:
    237239
     240NONE
     241
    238242
    239243@c
     
    289293@subheading NOTES:
    290294
     295NONE
     296
    291297@c
    292298@c  rel_blf
  • doc/itron3.0/mailbox.t

    raff08f5 ra5f5acad  
    1 @c@*
     1@c
    22@c  This is the chapter from the RTEMS ITRON User's Guide that
    33@c  documents the services provided by the mailbox
  • doc/itron3.0/memorypool.t

    raff08f5 ra5f5acad  
    251251@subheading NOTES:
    252252
     253NONE
     254
    253255@c
    254256@c  tget_blk
     
    306308@subheading NOTES:
    307309
     310NONE
     311
    308312@c
    309313@c  rel_blk
  • doc/itron3.0/status.t

    raff08f5 ra5f5acad  
    178178@item Functional tests for complete routines.
    179179@item Yellow line testing needs to be verified.
     180@item No Timing Tests
    180181@end itemize
    181182
     
    230231@itemize @bullet
    231232@item Yellow Lined BUT Timeout Cases Not Actually Executed
     233@item No Timing Tests
    232234@end itemize
    233235
     
    293295@itemize @bullet
    294296@item No Tests Written
    295 @end itemize
    296 
    297 @item Documentation
    298 @itemize @bullet
    299 @item Shell, Needs to be Fleshed Out
     297@item No Timing Tests
     298@end itemize
     299
     300@item Documentation
     301@itemize @bullet
     302@item Good First Draft.
     303@item No Information in Operations.
     304@item Should not use "standard-like" language.
    300305@end itemize
    301306
     
    358363@itemize @bullet
    359364@item No Tests Written
    360 @end itemize
    361 
    362 @item Documentation
    363 @itemize @bullet
    364 @item Shell, Needs to be Fleshed Out
     365@item No Timing Tests
     366@end itemize
     367
     368@item Documentation
     369@itemize @bullet
     370@item Needs More Text
     371@item No Information in Background or Operations.
     372@item Service Descriptions are Weak.
    365373@end itemize
    366374
     
    425433@itemize @bullet
    426434@item No Tests Written
    427 @end itemize
    428 
    429 @item Documentation
    430 @itemize @bullet
    431 @item Shell, Needs to be Fleshed Out
     435@item No Timing Tests
     436@end itemize
     437
     438@item Documentation
     439@itemize @bullet
     440@item Good First Draft.
     441@item No Information in Operations
    432442@end itemize
    433443
     
    489499@itemize @bullet
    490500@item No Tests Written
     501@item No Timing Tests
    491502@end itemize
    492503
     
    579590@itemize @bullet
    580591@item No Tests Written
     592@item No Timing Tests
    581593@end itemize
    582594
     
    643655@itemize @bullet
    644656@item No Tests Written
    645 @end itemize
    646 
    647 @item Documentation
    648 @itemize @bullet
    649 @item Shell, Needs to be Fleshed Out
     657@item No Timing Tests
     658@end itemize
     659
     660@item Documentation
     661@itemize @bullet
     662@item Good First Draft.
     663@item No Information in Operations
     664@item Should not use "standard-like" language.
    650665@end itemize
    651666
     
    707722@itemize @bullet
    708723@item No Tests Written
    709 @end itemize
    710 
    711 @item Documentation
    712 @itemize @bullet
    713 @item Shell, Needs to be Fleshed Out
     724@item No Timing Tests
     725@end itemize
     726
     727@item Documentation
     728@itemize @bullet
     729@item Good First Draft.
     730@item No Information in Background or Operations
     731@item Should not use "standard-like" language.
    714732@end itemize
    715733
     
    774792@itemize @bullet
    775793@item No Tests Written
    776 @end itemize
    777 
    778 @item Documentation
    779 @itemize @bullet
    780 @item Shell, Needs to be Fleshed Out
     794@item No Timing Tests
     795@end itemize
     796
     797@item Documentation
     798@itemize @bullet
     799@item Have Version in Word
    781800@end itemize
    782801
     
    834853@itemize @bullet
    835854@item No Tests Written
     855@item No Timing Tests
    836856@end itemize
    837857
     
    892912@itemize @bullet
    893913@item No Tests Written
     914@item No Timing Tests
    894915@end itemize
    895916
Note: See TracChangeset for help on using the changeset viewer.