include/adainclude/rtems-clock.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
0042 package RTEMS.Clock is
0043
0044    --
0045    --  Clock Types
0046    --
0047
0048    type Time_Value is
0049       record
0050          Seconds      : RTEMS.Unsigned32;
0051          Microseconds : RTEMS.Unsigned32;
0052       end record;
0053
0054    --
0055    --  Clock Manager
0056    --
0057
0058    procedure Set (
0059       Time_Buffer : in     RTEMS.Time_Of_Day;
0060       Result      :    out RTEMS.Status_Codes
0061    );
0062
0063    procedure Get_TOD (
0064       Time   :    out RTEMS.Time_Of_Day;
0065       Result :    out RTEMS.Status_Codes
0066    );
0067
0068    procedure Get_TOD_Time_Value (
0069       Time   :    out RTEMS.Time_Value;
0070       Result :    out RTEMS.Status_Codes
0071    );
0072
0073    procedure Get_Seconds_Since_Epoch(
0074       The_Interval :    out RTEMS.Interval;
0075       Result       :    out RTEMS.Status_Codes
0076    );
0077
0078    function Get_Ticks_Per_Second
0079    return RTEMS.Interval;
0080    pragma Import (
0081       C,
0082       Get_Ticks_Per_Second,
0083       "rtems_clock_get_ticks_per_second"
0084    );
0085
0086    function Get_Ticks_Since_Boot
0087    return RTEMS.Interval;
0088
0089    procedure Get_Uptime (
0090       Uptime :    out RTEMS.Timespec;
0091       Result :    out RTEMS.Status_Codes
0092    );
0093
0094    procedure Tick (
0095       Result :    out RTEMS.Status_Codes
0096    );
0097
0098 end RTEMS.Clock;
0099