include/adainclude/rtems-object.ads

0001 -- SPDX-License-Identifier: BSD-2-Clause
0002
0003 --
0004 --  RTEMS / Specification
0005 --
0006 --  DESCRIPTION:
0007 --
0008 --  This package provides the interface to the RTEMS API.
0009 --
0010 --  DEPENDENCIES:
0011 --
0012 --  NOTES:
0013 --    RTEMS initialization and configuration are called from
0014 --    the BSP side, therefore should never be called from ADA.
0015 --
0016 --  COPYRIGHT (c) 1997-2011.
0017 --  On-Line Applications Research Corporation (OAR).
0018 --
0019 --  Redistribution and use in source and binary forms, with or without
0020 --  modification, are permitted provided that the following conditions
0021 --  are met:
0022 --  1. Redistributions of source code must retain the above copyright
0023 --     notice, this list of conditions and the following disclaimer.
0024 --  2. Redistributions in binary form must reproduce the above copyright
0025 --     notice, this list of conditions and the following disclaimer in the
0026 --     documentation and/or other materials provided with the distribution.
0027 --
0028 --  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0029 --  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0030 --  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0031 --  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0032 --  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0033 --  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0034 --  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0035 --  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0036 --  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0037 --  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0038 --  POSSIBILITY OF SUCH DAMAGE.
0039 --
0040
0041 package RTEMS.Object is
0042
0043    --
0044    --  Object Services
0045    --
0046
0047    function Build_Name (
0048       C1 : in     Character;
0049       C2 : in     Character;
0050       C3 : in     Character;
0051       C4 : in     Character
0052    ) return RTEMS.Name;
0053
0054    procedure Get_Classic_Name(
0055       ID     : in     RTEMS.ID;
0056       Name   :    out RTEMS.Name;
0057       Result :    out RTEMS.Status_Codes
0058    );
0059
0060    procedure Get_Name(
0061       ID     : in     RTEMS.ID;
0062       Name   :    out String;
0063       Result :    out RTEMS.Address
0064    );
0065
0066    procedure Set_Name(
0067       ID     : in     RTEMS.ID;
0068       Name   : in     String;
0069       Result :    out RTEMS.Status_Codes
0070    );
0071
0072    procedure Id_Get_API(
0073       ID  : in     RTEMS.ID;
0074       API :    out RTEMS.Unsigned32
0075    );
0076
0077    procedure Id_Get_Class(
0078       ID        : in     RTEMS.ID;
0079       The_Class :    out RTEMS.Unsigned32
0080    );
0081
0082    procedure Id_Get_Node(
0083       ID   : in     RTEMS.ID;
0084       Node :    out RTEMS.Unsigned32
0085    );
0086
0087    procedure Id_Get_Index(
0088       ID    : in     RTEMS.ID;
0089       Index :    out RTEMS.Unsigned32
0090    );
0091
0092    function Build_Id(
0093       The_API   : in     RTEMS.Unsigned32;
0094       The_Class : in     RTEMS.Unsigned32;
0095       The_Node  : in     RTEMS.Unsigned32;
0096       The_Index : in     RTEMS.Unsigned32
0097    ) return RTEMS.Id;
0098
0099    function Id_API_Minimum return RTEMS.Unsigned32;
0100
0101    function Id_API_Maximum return RTEMS.Unsigned32;
0102
0103    procedure API_Minimum_Class(
0104       API     : in     RTEMS.Unsigned32;
0105       Minimum :    out RTEMS.Unsigned32
0106    );
0107
0108    procedure API_Maximum_Class(
0109       API     : in     RTEMS.Unsigned32;
0110       Maximum :    out RTEMS.Unsigned32
0111    );
0112
0113    procedure Get_API_Name(
0114       API  : in     RTEMS.Unsigned32;
0115       Name :    out String
0116    );
0117
0118    procedure Get_API_Class_Name(
0119       The_API   : in     RTEMS.Unsigned32;
0120       The_Class : in     RTEMS.Unsigned32;
0121       Name      :    out String
0122    );
0123
0124    type API_Class_Information is
0125      record
0126         Minimum_Id    : RTEMS.Id;
0127         Maximum_Id    : RTEMS.Id;
0128         Maximum       : RTEMS.Unsigned32;
0129         AutoExtend    : RTEMS.Boolean;
0130         Unallocated   : RTEMS.Unsigned32;
0131      end record;
0132
0133    procedure Get_Class_Information(
0134       The_API   : in     RTEMS.Unsigned32;
0135       The_Class : in     RTEMS.Unsigned32;
0136       Info      :    out API_Class_Information;
0137       Result    :    out RTEMS.Status_Codes
0138    );
0139
0140 end RTEMS.Object;