Changeset 8ad2468c in rtems


Ignore:
Timestamp:
Aug 8, 2008, 1:49:19 PM (11 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, master
Children:
3b14b7ad
Parents:
35454e27
Message:

2008-08-08 Sebastian Huber <sebastian.huber@…>

  • user/msg.t, user/sem.t, user/task.t: Update to new parameter types. Emphasize that you can use a pointer for task arguments.
Location:
doc
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r35454e27 r8ad2468c  
     12008-08-08     Sebastian Huber <sebastian.huber@embedded-brains.de>
     2
     3        * user/msg.t, user/sem.t, user/task.t: Update to new parameter types.
     4        Emphasize that you can use a pointer for task arguments.
     5
    162008-08-07      Joel Sherrill <joel.sherrill@OARcorp.com>
    27
  • doc/user/msg.t

    r35454e27 r8ad2468c  
    233233  rtems_name        name,
    234234  uint32_t          count,
    235   uint32_t          max_message_size,
     235  size_t            max_message_size,
    236236  rtems_attribute   attribute_set,
    237237  rtems_id         *id
     
    455455@example
    456456rtems_status_code rtems_message_queue_send(
    457   rtems_id  id,
    458   void    *buffer,
    459   size_t    size
     457  rtems_id   id,
     458  cons void *buffer,
     459  size_t     size
    460460);
    461461@end example
     
    520520@example
    521521rtems_status_code rtems_message_queue_urgent(
    522   rtems_id  id,
    523   void    *buffer,
    524   size_t    size
     522  rtems_id    id,
     523  const void *buffer,
     524  size_t      size
    525525);
    526526@end example
     
    586586@example
    587587rtems_status_code rtems_message_queue_broadcast(
    588   rtems_id  id,
    589   void    *buffer,
    590   size_t    size,
    591   uint32_t *count
     588  rtems_id    id,
     589  const void *buffer,
     590  size_t      size,
     591  uint32_t   *count
    592592);
    593593@end example
     
    660660  void           *buffer,
    661661  size_t         *size,
    662   uint32_t        option_set,
     662  rtems_option    option_set,
    663663  rtems_interval  timeout
    664664);
     
    697697queue, then it is copied to buffer, size is set to return the
    698698length of the message in bytes, and this directive returns
    699 immediately with a successful return code.
     699immediately with a successful return code.  The buffer has to be big enough to
     700receive a message of the maximum length with respect to this message queue.
    700701
    701702If the calling task chooses to return immediately and
  • doc/user/sem.t

    r35454e27 r8ad2468c  
    629629rtems_status_code rtems_semaphore_obtain(
    630630  rtems_id        id,
    631   uint32_t        option_set,
     631  rtems_option    option_set,
    632632  rtems_interval  timeout
    633633);
     
    813813after this directive is executed.  Tasks which are unblocked as the
    814814result of this directive will return from the
    815 @code{@value{DIRPREFIX}semaphore_release} directive with a
     815@code{@value{DIRPREFIX}semaphore_obtain} directive with a
    816816status code of @code{@value{RPREFIX}UNSATISFIED} to indicate
    817817that the semaphore was not obtained.
  • doc/user/task.t

    r35454e27 r8ad2468c  
    949949was created.  The starting address of the task is given in
    950950entry_point.  The task's starting argument is contained in
    951 argument.  This argument can be a single value or used as an
    952 index into an array of parameter blocks.
     951argument.  This argument can be a single value or used as an index into an
     952array of parameter blocks.  The type of this numeric argument is an unsigned
     953integer type with the property that any valid pointer to void can be converted
     954to this type and then converted back to a pointer to void.  The result will
     955compare equal to the original pointer.
    953956
    954957@subheading NOTES:
     
    10021005dormant state.
    10031006
    1004 The task's starting argument is contained in argument.  This
    1005 argument can be a single value or an index into an array of
    1006 parameter blocks.  This new argument may be used to distinguish
     1007The task's starting argument is contained in argument.  This argument can be a
     1008single value or an index into an array of parameter blocks.  The type of this
     1009numeric argument is an unsigned integer type with the property that any valid
     1010pointer to void can be converted to this type and then converted back to a
     1011pointer to void.  The result will compare equal to the original pointer.  This
     1012new argument may be used to distinguish
    10071013between the initial @code{@value{DIRPREFIX}task_start}
    10081014of the task and any ensuing calls
Note: See TracChangeset for help on using the changeset viewer.