Changeset 71689d4 in rtems


Ignore:
Timestamp:
Nov 16, 1999, 6:40:25 PM (20 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
8f9efcb9
Parents:
dc2b337
Message:

Added reference to rtems_get_class, rtems_get_node, and rtems_get_index
so users know they are part of the public API.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/concepts.t

    rdc2b337 r71689d4  
    6161
    6262@cindex object ID
     63@cindex object ID composition
    6364
    6465@need 3000
     
    6667An object ID is a unique unsigned thirty-two bit
    6768entity composed of three parts: object class, node, and index.
    68 The most significant six bits are the object class.  The next
    69 ten bits are the number of the node on which this object was
    70 created.  The node number is always one (1) in a single
    71 processor system.  The least significant sixteen bits form an
    72 identifier within a particular object type.  This identifier,
    73 called the object index, ranges in value from 1 to the maximum
    74 number of objects configured for this object type.
    7569
    7670@ifset use-ascii
     
    152146@end ifset
    153147
     148The most significant six bits are the object class.  The next
     149ten bits are the number of the node on which this object was
     150created.  The node number is always one (1) in a single
     151processor system.  The least significant sixteen bits form an
     152identifier within a particular object type.  This identifier,
     153called the object index, ranges in value from 1 to the maximum
     154number of objects configured for this object type.
     155
    154156
    155157The three components of an object ID make it possible
     
    171173directives are not necessary in a properly designed single
    172174processor application.
     175
     176In addition, services are provided to portably examine the
     177three subcomponents of an RTEMS ID.  These services are
     178prototyped as follows:
     179
     180@cindex obtaining class from object ID
     181@cindex obtaining node from object ID
     182@cindex obtaining index from object ID
     183@cindex get class from object ID
     184@cindex get node from object ID
     185@cindex get index from object ID
     186@findex rtems_get_class
     187@findex rtems_get_node
     188@findex rtems_get_index
     189
     190@example
     191rtems_unsigned32 rtems_get_class( rtems_id );
     192rtems_unsigned32 rtems_get_node( rtems_id );
     193rtems_unsigned32 rtems_get_index( rtems_id );
     194@end example
    173195
    174196An object control block is a data structure defined
Note: See TracChangeset for help on using the changeset viewer.