Changeset ca6c741 in rtems


Ignore:
Timestamp:
05/06/04 19:22:02 (19 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Children:
e2f50f9d
Parents:
df54012
Message:

2004-05-06 Joel Sherrill <joel@…>

PR 618/rtems

  • clock.t, dpmem.t, event.t, msg.t, part.t, region.t, sem.t, task.t, timer.t: Add NULL checks.
Location:
doc/user
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • doc/user/ChangeLog

    rdf54012 rca6c741  
     12004-05-06      Joel Sherrill <joel@OARcorp.com>
     2
     3        PR 618/rtems
     4        * clock.t, dpmem.t, event.t, msg.t, part.t, region.t, sem.t, task.t,
     5        timer.t: Add NULL checks.
     6
    172003-11-25      Joel Sherrill <joel@OARcorp.com>
    28

  • doc/user/clock.t

    rdf54012 rca6c741  
    263263@subheading DIRECTIVE STATUS CODES:
    264264@code{@value{RPREFIX}SUCCESSFUL} - date and time set successfully@*
     265@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL@*
    265266@code{@value{RPREFIX}INVALID_TIME_OF_DAY} - invalid time of day
    266267
    … …  
    321322@subheading DIRECTIVE STATUS CODES:
    322323@code{@value{RPREFIX}SUCCESSFUL} - current time obtained successfully@*
    323 @code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set
     324@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set@*
     325@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL
    324326
    325327@subheading DESCRIPTION:
    … …  
    415417
    416418@subheading DIRECTIVE STATUS CODES:
    417 @code{@value{RPREFIX}SUCCESSFUL} - current time obtained successfully
     419@code{@value{RPREFIX}SUCCESSFUL} - clock tick processed successfully
    418420
    419421@subheading DESCRIPTION:

  • doc/user/dpmem.t

    rdf54012 rca6c741  
    140140@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
    141141@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
     142@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    142143@code{@value{RPREFIX}TOO_MANY} - too many DP memory areas created
    143144
    … …  
    196197@subheading DIRECTIVE STATUS CODES:
    197198@code{@value{RPREFIX}SUCCESSFUL} - port identified successfully@*
     199@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    198200@code{@value{RPREFIX}INVALID_NAME} - port name not found
    199201
    … …  
    292294
    293295@subheading DIRECTIVE STATUS CODES:
    294 @code{@value{RPREFIX}SUCCESSFUL} -  always successful
     296@code{@value{RPREFIX}INVALID_ADDRESS} - @code{internal} is NULL@*
     297@code{@value{RPREFIX}SUCCESSFUL} - successful conversion
    295298
    296299@subheading DESCRIPTION:
    … …  
    342345
    343346@subheading DIRECTIVE STATUS CODES:
    344 @code{@value{RPREFIX}SUCCESSFUL} -  always successful
     347@code{@value{RPREFIX}INVALID_ADDRESS} - @code{external} is NULL@*
     348@code{@value{RPREFIX}SUCCESSFUL} - successful conversion
    345349
    346350@subheading DESCRIPTION:

  • doc/user/event.t

    rdf54012 rca6c741  
    296296@code{@value{RPREFIX}SUCCESSFUL} - event received successfully@*
    297297@code{@value{RPREFIX}UNSATISFIED} - input event not satisfied (@code{@value{RPREFIX}NO_WAIT})@*
     298@code{@value{RPREFIX}INVALID_ADDRESS} - @code{event_out} is NULL@*
    298299@code{@value{RPREFIX}TIMEOUT} - timed out waiting for event
    299300

  • doc/user/msg.t

    rdf54012 rca6c741  
    256256@code{@value{RPREFIX}SUCCESSFUL} - queue created successfully@*
    257257@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     258@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    258259@code{@value{RPREFIX}INVALID_NUMBER} - invalid message count@*
    259260@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*
    … …  
    342343@subheading DIRECTIVE STATUS CODES:
    343344@code{@value{RPREFIX}SUCCESSFUL} - queue identified successfully@*
     345@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    344346@code{@value{RPREFIX}INVALID_NAME} - queue name not found@*
    345347@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    … …  
    474476@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
    475477@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*
     478@code{@value{RPREFIX}INVALID_ADDRESS} - @code{buffer} is NULL@*
    476479@code{@value{RPREFIX}UNSATISFIED} - out of message buffers@*
    477480@code{@value{RPREFIX}TOO_MANY} - queue's limit has been reached
    … …  
    538541@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
    539542@code{@value{RPREFIX}INVALID_SIZE} - invalid message size@*
     543@code{@value{RPREFIX}INVALID_ADDRESS} - @code{buffer} is NULL@*
    540544@code{@value{RPREFIX}UNSATISFIED} - out of message buffers@*
    541545@code{@value{RPREFIX}TOO_MANY} - queue's limit has been reached
    … …  
    604608@code{@value{RPREFIX}SUCCESSFUL} - message broadcasted successfully@*
    605609@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     610@code{@value{RPREFIX}INVALID_ADDRESS} - @code{buffer} is NULL@*
     611@code{@value{RPREFIX}INVALID_ADDRESS} - @code{count} is NULL@*
    606612@code{@value{RPREFIX}INVALID_SIZE} - invalid message size
    607613
    … …  
    675681@code{@value{RPREFIX}SUCCESSFUL} - message received successfully@*
    676682@code{@value{RPREFIX}INVALID_ID} - invalid queue id@*
     683@code{@value{RPREFIX}INVALID_ADDRESS} - @code{buffer} is NULL@*
     684@code{@value{RPREFIX}INVALID_ADDRESS} - @code{count} is NULL@*
    677685@code{@value{RPREFIX}UNSATISFIED} - queue is empty@*
    678686@code{@value{RPREFIX}TIMEOUT} - timed out waiting for message@*
    … …  
    760768@subheading DIRECTIVE STATUS CODES:
    761769@code{@value{RPREFIX}SUCCESSFUL} - number of messages pending returned successfully@*
     770@code{@value{RPREFIX}INVALID_ADDRESS} - @code{count} is NULL@*
    762771@code{@value{RPREFIX}INVALID_ID} - invalid queue id
    763772
    … …  
    808817@subheading DIRECTIVE STATUS CODES:
    809818@code{@value{RPREFIX}SUCCESSFUL} - message queue flushed successfully@*
     819@code{@value{RPREFIX}INVALID_ADDRESS} - @code{count} is NULL@*
    810820@code{@value{RPREFIX}INVALID_ID} - invalid queue id
    811821

  • doc/user/part.t

    rdf54012 rca6c741  
    174174@code{@value{RPREFIX}TOO_MANY} - too many partitions created@*
    175175@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
     176@code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@*
     177@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    176178@code{@value{RPREFIX}INVALID_SIZE} - length or buffer size is 0@*
    177179@code{@value{RPREFIX}INVALID_SIZE} - length is less than the buffer size@*
    … …  
    258260@subheading DIRECTIVE STATUS CODES:
    259261@code{@value{RPREFIX}SUCCESSFUL} - partition identified successfully@*
     262@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    260263@code{@value{RPREFIX}INVALID_NAME} - partition name not found@*
    261264@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    … …  
    377380@subheading DIRECTIVE STATUS CODES:
    378381@code{@value{RPREFIX}SUCCESSFUL} - buffer obtained successfully@*
     382@code{@value{RPREFIX}INVALID_ADDRESS} - @code{buffer} is NULL@*
    379383@code{@value{RPREFIX}INVALID_ID} - invalid partition id@*
    380384@code{@value{RPREFIX}UNSATISFIED} - all buffers are allocated
    … …  
    431435@subheading DIRECTIVE STATUS CODES:
    432436@code{@value{RPREFIX}SUCCESSFUL} - buffer returned successfully@*
     437@code{@value{RPREFIX}INVALID_ADDRESS} - @code{buffer} is NULL@*
    433438@code{@value{RPREFIX}INVALID_ID} - invalid partition id@*
    434439@code{@value{RPREFIX}INVALID_ADDRESS} - buffer address not in partition

  • doc/user/region.t

    rdf54012 rca6c741  
    264264@code{@value{RPREFIX}SUCCESSFUL} - region created successfully@*
    265265@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     266@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
     267@code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@*
    266268@code{@value{RPREFIX}INVALID_ADDRESS} - address not on four byte boundary@*
    267269@code{@value{RPREFIX}TOO_MANY} - too many regions created@*
    … …  
    340342
    341343@code{@value{RPREFIX}SUCCESSFUL} - region identified successfully@*
     344@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    342345@code{@value{RPREFIX}INVALID_NAME} - region name not found
    343346
    … …  
    440443
    441444@code{@value{RPREFIX}SUCCESSFUL} - region extended successfully@*
     445@code{@value{RPREFIX}INVALID_ADDRESS} - @code{starting_address} is NULL@*
    442446@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
    443447@code{@value{RPREFIX}INVALID_ADDRESS} - invalid address of area to add
    … …  
    495499
    496500@code{@value{RPREFIX}SUCCESSFUL} - segment obtained successfully@*
     501@code{@value{RPREFIX}INVALID_ADDRESS} - @code{segment} is NULL@*
    497502@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
    498503@code{@value{RPREFIX}INVALID_SIZE} - request is for zero bytes or exceeds
    … …  
    582587
    583588@code{@value{RPREFIX}SUCCESSFUL} - segment returned successfully@*
     589@code{@value{RPREFIX}INVALID_ADDRESS} - @code{segment} is NULL@*
    584590@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
    585591@code{@value{RPREFIX}INVALID_ADDRESS} - segment address not in region
    … …  
    643649
    644650@code{@value{RPREFIX}SUCCESSFUL} - segment obtained successfully@*
     651@code{@value{RPREFIX}INVALID_ADDRESS} - @code{segment} is NULL@*
     652@code{@value{RPREFIX}INVALID_ADDRESS} - @code{size} is NULL@*
    645653@code{@value{RPREFIX}INVALID_ID} - invalid region id@*
    646654@code{@value{RPREFIX}INVALID_ADDRESS} - segment address not in region

  • doc/user/sem.t

    rdf54012 rca6c741  
    410410@code{@value{RPREFIX}SUCCESSFUL} - semaphore created successfully@*
    411411@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
     412@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    412413@code{@value{RPREFIX}TOO_MANY} - too many semaphores created@*
    413414@code{@value{RPREFIX}NOT_DEFINED} - invalid attribute set@*

  • doc/user/task.t

    rdf54012 rca6c741  
    713713@subheading DIRECTIVE STATUS CODES:
    714714@code{@value{RPREFIX}SUCCESSFUL} - task created successfully@*
     715@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    715716@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
    716717@code{@value{RPREFIX}INVALID_SIZE} - stack too small@*
    … …  
    820821@subheading DIRECTIVE STATUS CODES:
    821822@code{@value{RPREFIX}SUCCESSFUL} - task identified successfully@*
     823@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    822824@code{@value{RPREFIX}INVALID_NAME} - invalid task name@*
    823825@code{@value{RPREFIX}INVALID_NODE} - invalid node id
    … …  
    12611263@ifset is-Ada
    12621264@example
    1263 procedure Task_Delete (
     1265procedure Task_Mode (
    12641266   Mode_Set          : in     RTEMS.Mode;
    12651267   Mask              : in     RTEMS.Mode;
    … …  
    12711273
    12721274@subheading DIRECTIVE STATUS CODES:
    1273 @code{@value{RPREFIX}SUCCESSFUL} - task mode set successfully
     1275@code{@value{RPREFIX}SUCCESSFUL} - task mode set successfully@*
     1276@code{@value{RPREFIX}INVALID_ADDRESS} - @code{previous_mode_set} is NULL
    12741277
    12751278@subheading DESCRIPTION:
    … …  
    14321435@subheading DIRECTIVE STATUS CODES:
    14331436@code{@value{RPREFIX}SUCCESSFUL} - note obtained successfully@*
     1437@code{@value{RPREFIX}INVALID_ADDRESS} - @code{note} is NULL@*
    14341438@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
    14351439@code{@value{RPREFIX}INVALID_NUMBER} - invalid notepad location
    … …  
    15901594@subheading DIRECTIVE STATUS CODES:
    15911595@code{@value{RPREFIX}SUCCESSFUL} - awakened at date/time successfully@*
     1596@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL@*
    15921597@code{@value{RPREFIX}INVALID_TIME_OF_DAY} - invalid time buffer@*
    15931598@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set
    … …  
    16191624rtems_status_code rtems_task_variable_add(
    16201625  rtems_id  tid,
    1621   void    **ptr,
     1626  void    **task_variable,
    16221627  void    (*dtor)(void *)
    16231628);
    … …  
    16421647@subheading DIRECTIVE STATUS CODES:
    16431648@code{@value{RPREFIX}SUCCESSFUL} - per task variable added successfully@*
     1649@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is NULL@*
    16441650@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
    16451651@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
    … …  
    16811687rtems_status_code rtems_task_variable_get(
    16821688  rtems_id  tid,
    1683   void    **ptr,
    1684   void    **result
     1689  void    **task_variable,
     1690  void    **task_variable_value
    16851691);
    16861692@end example
    … …  
    17001706@subheading DIRECTIVE STATUS CODES:
    17011707@code{@value{RPREFIX}SUCCESSFUL} - per task variable added successfully@*
    1702 @code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     1708@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is NULL@*
     1709@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable_value} is NULL@*
     1710@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is not found@*
    17031711@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
    17041712@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks@*
    … …  
    17121720@subheading NOTES:
    17131721
    1714 If you change memory which @code{result} points to, remember to declare that
    1715 memory as volatile, so that the compiler will optimize it correctly.  In this
    1716 case both the pointer @code{result} and data referenced by @code{result}
     1722If you change memory which @code{task_variable_value} points to,
     1723remember to declare that memory as volatile, so that the compiler
     1724will optimize it correctly.  In this case both the pointer
     1725@code{task_variable_value} and data referenced by @code{task_variable_value}
    17171726should be considered volatile.
    17181727
    … …  
    17321741rtems_status_code rtems_task_variable_delete(
    17331742  rtems_id  tid,
    1734   void    **ptr
     1743  void    **task_variable
    17351744);
    17361745@end example
    … …  
    17511760@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
    17521761@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
     1762@code{@value{RPREFIX}INVALID_ADDRESS} - @code{task_variable} is NULL@*
    17531763@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks@*
    17541764

  • doc/user/timer.t

    rdf54012 rca6c741  
    234234@subheading DIRECTIVE STATUS CODES:
    235235@code{@value{RPREFIX}SUCCESSFUL} - timer created successfully@*
     236@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    236237@code{@value{RPREFIX}INVALID_NAME} - invalid timer name@*
    237238@code{@value{RPREFIX}TOO_MANY} - too many timers created
    … …  
    282283@subheading DIRECTIVE STATUS CODES:
    283284@code{@value{RPREFIX}SUCCESSFUL} - timer identified successfully@*
     285@code{@value{RPREFIX}INVALID_ADDRESS} - @code{id} is NULL@*
    284286@code{@value{RPREFIX}INVALID_NAME} - timer name not found
    285287
    … …  
    423425@subheading DIRECTIVE STATUS CODES:
    424426@code{@value{RPREFIX}SUCCESSFUL} - timer initiated successfully@*
     427@code{@value{RPREFIX}INVALID_ADDRESS} - @code{routine} is NULL@*
    425428@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
    426429@code{@value{RPREFIX}INVALID_NUMBER} - invalid interval
    … …  
    476479@subheading DIRECTIVE STATUS CODES:
    477480@code{@value{RPREFIX}SUCCESSFUL} - timer initiated successfully@*
     481@code{@value{RPREFIX}INVALID_ADDRESS} - @code{routine} is NULL@*
     482@code{@value{RPREFIX}INVALID_ADDRESS} - @code{wall_time} is NULL@*
    478483@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
    479484@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set@*
    … …  
    584589@subheading DIRECTIVE STATUS CODES:
    585590@code{@value{RPREFIX}SUCCESSFUL} - timer initiated successfully@*
     591@code{@value{RPREFIX}INVALID_ADDRESS} - @code{routine} is NULL@*
    586592@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
    587593@code{@value{RPREFIX}INVALID_NUMBER} - invalid interval@*
    … …  
    640646@subheading DIRECTIVE STATUS CODES:
    641647@code{@value{RPREFIX}SUCCESSFUL} - timer initiated successfully@*
     648@code{@value{RPREFIX}INVALID_ADDRESS} - @code{routine} is NULL@*
     649@code{@value{RPREFIX}INVALID_ADDRESS} - @code{wall_time} is NULL@*
    642650@code{@value{RPREFIX}INVALID_ID} - invalid timer id@*
    643651@code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set@*
Note: See TracChangeset for help on using the changeset viewer.