Changeset 0bc8e5c in rtems


Ignore:
Timestamp:
Feb 1, 2008, 9:24:04 PM (12 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, master
Children:
8407b5e
Parents:
d5a36d3
Message:

2008-02-01 Joel Sherrill <joel.sherrill@…>

  • user/object.t: Add Ada binding for Object Services.
Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    rd5a36d3 r0bc8e5c  
     12008-02-01      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * user/object.t: Add Ada binding for Object Services.
     4
    152008-01-29      Joel Sherrill <joel.sherrill@oarcorp.com>
    26
  • doc/user/object.t

    rd5a36d3 r0bc8e5c  
    117117@ifset is-Ada
    118118@example
    119 TBD
     119procedure Build_Name(
     120   c1   : in     RTEMS.Unsigned8;
     121   c2   : in     RTEMS.Unsigned8;
     122   c3   : in     RTEMS.Unsigned8;
     123   c4   : in     RTEMS.Unsigned8;
     124   Name :    out RTEMS.Name
     125);
    120126@end example
    121127@end ifset
     
    159165@ifset is-Ada
    160166@example
    161 TBD
     167procedure Object_Get_Classic_Name(
     168   ID     : in     RTEMS.ID;
     169   Name   :    out RTEMS.Name;
     170   Result :    out RTEMS.Status_Codes
     171);
    162172@end example
    163173@end ifset
     
    190200
    191201@ifset is-C
    192 @findex rtems_build_name
     202@findex rtems_object_get_name
    193203@example
    194204char *rtems_object_get_name(
     
    202212@ifset is-Ada
    203213@example
    204 TBD
     214procedure Object_Get_Name(
     215   ID     : in     RTEMS.ID;
     216   Name   :    out RTEMS.Name;
     217   Result :    out RTEMS.Status_Codes
     218);
    205219@end example
    206220@end ifset
     
    226240@c
    227241@page
    228 @subsection SET_OBJECT_NAME - Set object name
     242@subsection OBJECT_SET_NAME - Set object name
    229243
    230244@cindex set object name
     
    233247
    234248@ifset is-C
    235 @findex rtems_build_name
     249@findex rtems_object_set_name
    236250@example
    237251rtems_status_code rtems_object_set_name(
     
    244258@ifset is-Ada
    245259@example
    246 TBD
     260procedure Object_Set_Name(
     261   ID     : in     RTEMS.ID;
     262   Name   : in     String;
     263   Result :    out RTEMS.Status_Codes
     264);
    247265@end example
    248266@end ifset
     
    298316@ifset is-Ada
    299317@example
    300 TBD
     318procedure Object_Id_Get_API(
     319   ID  : in     RTEMS.ID;
     320   API :    out RTEMS.Unsigned32
     321);
    301322@end example
    302323@end ifset
     
    337358@ifset is-Ada
    338359@example
    339 TBD
     360procedure Object_Id_Get_Class(
     361   ID        : in     RTEMS.ID;
     362   The_Class :    out RTEMS.Unsigned32
     363);
    340364@end example
    341365@end ifset
     
    376400@ifset is-Ada
    377401@example
    378 TBD
     402procedure Object_Id_Get_Node(
     403   ID   : in     RTEMS.ID;
     404   Node :    out RTEMS.Unsigned32
     405);
    379406@end example
    380407@end ifset
     
    415442@ifset is-Ada
    416443@example
    417 TBD
     444procedure Object_Id_Get_Index(
     445   ID    : in     RTEMS.ID;
     446   Index :    out RTEMS.Unsigned32
     447);
    418448@end example
    419449@end ifset
     
    447477@example
    448478rtems_id rtems_build_id(
    449   uint32_t api,
    450   uint32_t class,
    451   uint32_t node,
    452   uint32_t index
    453 );
    454 @end example
    455 @end ifset
    456 
    457 @ifset is-Ada
    458 @example
    459 TBD
     479  uint32_t the_api,
     480  uint32_t the_class,
     481  uint32_t the_node,
     482  uint32_t the_index
     483);
     484@end example
     485@end ifset
     486
     487@ifset is-Ada
     488@example
     489function Build_Id(
     490   the_api   : in     RTEMS.Unsigned32;
     491   the_class : in     RTEMS.Unsigned32;
     492   the_node  : in     RTEMS.Unsigned32;
     493   the_index : in     RTEMS.Unsigned32
     494) return RTEMS.Id;
    460495@end example
    461496@end ifset
     
    468503
    469504This service constructs an object Id from the provided
    470 @code{api}, @code{class}, @code{node}, and @code{index}.
     505@code{the_api}, @code{the_class}, @code{the_node}, and @code{the_index}.
    471506
    472507
     
    497532@ifset is-Ada
    498533@example
    499 TBD
     534function Object_Id_API_Minimum return RTEMS.Unsigned32;
    500535@end example
    501536@end ifset
     
    533568@ifset is-Ada
    534569@example
    535 TBD
     570function Object_Id_API_Maximum return RTEMS.Unsigned32;
    536571@end example
    537572@end ifset
     
    571606@ifset is-Ada
    572607@example
    573 TBD
     608procedure Object_API_Minimum_Class(
     609   API     : in     RTEMS.Unsigned32;
     610   Minimum :    out RTEMS.Unsigned32
     611);
    574612@end example
    575613@end ifset
     
    612650@ifset is-Ada
    613651@example
    614 TBD
     652procedure Object_API_Maximum_Class(
     653   API     : in     RTEMS.Unsigned32;
     654   Maximum :    out RTEMS.Unsigned32
     655);
    615656@end example
    616657@end ifset
     
    654695@ifset is-Ada
    655696@example
    656 TBD
     697procedure Object_Get_API_Name(
     698   API  : in     RTEMS.Unsigned32;
     699   Name :    out String
     700);
    657701@end example
    658702@end ifset
     
    661705
    662706If @code{api} is not valid, the string @code{"BAD API"} is returned.
    663 
    664 If @code{class} is not valid, the string @code{"BAD CLASS"} is returned.
    665707
    666708If successful, this service returns a pointer to a string
     
    692734@example
    693735const char *rtems_object_get_api_class_name(
    694   uint32_t class,
    695   uint32_t api
    696 );
    697 @end example
    698 @end ifset
    699 
    700 @ifset is-Ada
    701 @example
    702 TBD
    703 @end example
    704 @end ifset
    705 
    706 @subheading DIRECTIVE STATUS CODES
    707 
    708 If @code{api} is not valid, the string @code{"BAD API"} is returned.
    709 
    710 If @code{class} is not valid, the string @code{"BAD CLASS"} is returned.
     736  uint32_t the_class,
     737  uint32_t the_api
     738);
     739@end example
     740@end ifset
     741
     742@ifset is-Ada
     743@example
     744procedure Object_Get_API_Class_Name(
     745   The_API   : in     RTEMS.Unsigned32;
     746   The_Class : in     RTEMS.Unsigned32;
     747   Name      :    out String
     748);
     749@end example
     750@end ifset
     751
     752@subheading DIRECTIVE STATUS CODES
     753
     754If @code{the_api} is not valid, the string @code{"BAD API"} is returned.
     755
     756If @code{the_class} is not valid, the string @code{"BAD CLASS"} is returned.
    711757
    712758If successful, this service returns a pointer to a string
    713 containing the name of the specified @code{api}/@code{class} pair.
     759containing the name of the specified @code{the_api}/@code{the_class} pair.
    714760
    715761@subheading DESCRIPTION:
    716762
    717763This service returns the name of the object class indicated by the
    718 specified @code{api} and @code{class}.
     764specified @code{the_api} and @code{the_class}.
    719765
    720766@subheading NOTES:
     
    739785@example
    740786rtems_status_code rtems_object_get_class_information(
    741   uint32_t                             api,
    742   uint32_t                             class,
     787  uint32_t                            the_api,
     788  uint32_t                            the_class,
    743789  rtems_object_api_class_information *info
    744790);
     
    748794@ifset is-Ada
    749795@example
    750 TBD
     796procedure Object_Get_Class_Information(
     797   The_API   : in     RTEMS.Unsigned32;
     798   The_Class : in     RTEMS.Unsigned32;
     799   Info      :    out RTEMS.Object_API_Class_Information;
     800   Result    :    out RTEMS.Status_Codes
     801);
    751802@end example
    752803@end ifset
     
    755806@code{@value{RPREFIX}SUCCESSFUL} - information obtained successfully@*
    756807@code{@value{RPREFIX}INVALID_ADDRESS} - @code{info} is NULL@*
    757 @code{@value{RPREFIX}INVALID_NUMBER} - invalid @code{api} or @code{class}
     808@code{@value{RPREFIX}INVALID_NUMBER} - invalid @code{api} or @code{the_class}
    758809
    759810If successful, the structure located at @code{info} will be filled
    760 in with information about the specified @code{api}/@code{class} pairing.
     811in with information about the specified @code{api}/@code{the_class} pairing.
    761812
    762813@subheading DESCRIPTION:
    763814
    764815This service returns information about the object class indicated by the
    765 specified @code{api} and @code{class}. This structure is defined as
     816specified @code{api} and @code{the_class}. This structure is defined as
    766817follows:
    767818
     819@ifset is-C
    768820@example
    769821typedef struct @{
     
    775827@} rtems_object_api_class_information;
    776828@end example
    777 
    778 @subheading NOTES:
    779 
    780 This directive is strictly local and does not impact task scheduling.
    781 
     829@end ifset
     830
     831@ifset is-Ada
     832@example
     833
     834@end example
     835@end ifset
     836
     837
     838@subheading NOTES:
     839
     840This directive is strictly local and does not impact task scheduling.
     841
Note: See TracChangeset for help on using the changeset viewer.