blob: 320a57ac23fbb702627a63ab5d4682559d18acca [file] [log] [blame]
alexander3c798932021-03-26 21:42:19 +00001/*
2 * Copyright (c) 2021 Arm Limited. All rights reserved.
3 * SPDX-License-Identifier: Apache-2.0
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010017#ifndef TIMER_SIMPLE_PLATFORM_H
18#define TIMER_SIMPLE_PLATFORM_H
alexander3c798932021-03-26 21:42:19 +000019
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010020#include "stubs_simple_platform.h"
alexander3c798932021-03-26 21:42:19 +000021
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010022/* Container for timestamp for simple platform. */
23typedef struct _generic_time_counter {
alexander3c798932021-03-26 21:42:19 +000024 uint64_t counter_systick;
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010025} generic_time_counter;
alexander3c798932021-03-26 21:42:19 +000026
27/**
28 * @brief Resets the counters.
29 */
30void timer_reset(void);
31
32/**
33 * @brief Gets the current counter values.
34 * @returns counter struct.
35 **/
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010036generic_time_counter get_time_counter(void);
alexander3c798932021-03-26 21:42:19 +000037
38/**
39 * @brief Gets the cycle counts elapsed between start and end.
40 * @return difference in counter values as 32 bit unsigned integer.
41 */
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010042uint64_t get_cycle_count_diff(generic_time_counter *start, generic_time_counter *end);
alexander3c798932021-03-26 21:42:19 +000043
44/**
45 * @brief Enables or triggers cycle counting mechanism, if required
46 * by the platform.
47 */
48void start_cycle_counter(void);
49
50/**
51 * @brief Stops cycle counting mechanism, if required by the platform.
52 */
53void stop_cycle_counter(void);
54
Kshitij Sisodia659fcd92021-05-19 10:30:06 +010055#endif /* TIMER_SIMPLE_PLATFORM_H */