ada/support/timer_driver.ads

0001 -- SPDX-License-Identifier: BSD-2-Clause
0002
0003 --
0004 --  Timer_Driver / Specification
0005 --
0006 --  Description:
0007 --
0008 --  This package is the specification for the Timer Driver.
0009 --
0010 --  Dependencies:
0011 --
0012 --
0013 --
0014 --  COPYRIGHT (c) 1989-1997.
0015 --  On-Line Applications Research Corporation (OAR).
0016 --
0017 --  Redistribution and use in source and binary forms, with or without
0018 --  modification, are permitted provided that the following conditions
0019 --  are met:
0020 --  1. Redistributions of source code must retain the above copyright
0021 --     notice, this list of conditions and the following disclaimer.
0022 --  2. Redistributions in binary form must reproduce the above copyright
0023 --     notice, this list of conditions and the following disclaimer in the
0024 --     documentation and/or other materials provided with the distribution.
0025 --
0026 --  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0027 --  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0028 --  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0029 --  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0030 --  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0031 --  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0032 --  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0033 --  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0034 --  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0035 --  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0036 --  POSSIBILITY OF SUCH DAMAGE.
0037 --
0038
0039 with RTEMS;
0040
0041 package Timer_Driver is
0042
0043 --
0044 --  Initialize
0045 --
0046 --  Description:
0047 --
0048 --  This subprogram initializes the hardware timer to start it.
0049 --
0050
0051    procedure Initialize;
0052    pragma Import (C, Initialize, "benchmark_timer_initialize");
0053
0054 --
0055 --  Read_Timer
0056 --
0057 --  Description:
0058 --
0059 --  This subprogram stops the timer, calculates the length of time
0060 --  in microseconds since the timer was started, and returns that
0061 --  value.
0062 --
0063
0064    function Read_Timer
0065    return RTEMS.Unsigned32;
0066    pragma Import (C, Read_Timer, "benchmark_timer_read");
0067
0068 --
0069 --  Empty_Function
0070 --
0071 --  Description:
0072 --
0073 --  This subprogram is an empty subprogram.  It is used to
0074 --  insure that a loop will be included in the final executable
0075 --  so that loop overhead can be subtracted from the directive
0076 --  times reported.
0077 --
0078
0079    procedure Empty_Function;
0080
0081 --
0082 --  Set_Find_Average_Overhead
0083 --
0084 --  Description:
0085 --
0086 --  This subprogram sets the Find_Average_Overhead flag to the
0087 --  the value passed.
0088 --
0089
0090    procedure Set_Find_Average_Overhead (
0091       Find_Flag : in     Standard.Boolean
0092    );
0093
0094 private
0095
0096 end Timer_Driver;