alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 1 | /* |
| 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 Sisodia | 659fcd9 | 2021-05-19 10:30:06 +0100 | [diff] [blame] | 17 | #ifndef TIMER_SIMPLE_PLATFORM_H |
| 18 | #define TIMER_SIMPLE_PLATFORM_H |
alexander | 31ae9f0 | 2022-02-10 16:15:54 +0000 | [diff] [blame] | 19 | #include <stdint.h> |
alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 20 | |
Kshitij Sisodia | 659fcd9 | 2021-05-19 10:30:06 +0100 | [diff] [blame] | 21 | /* Container for timestamp for simple platform. */ |
| 22 | typedef struct _generic_time_counter { |
alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 23 | uint64_t counter_systick; |
alexander | 31ae9f0 | 2022-02-10 16:15:54 +0000 | [diff] [blame] | 24 | } base_time_counter; |
alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 25 | |
| 26 | /** |
| 27 | * @brief Resets the counters. |
| 28 | */ |
| 29 | void timer_reset(void); |
| 30 | |
| 31 | /** |
| 32 | * @brief Gets the current counter values. |
| 33 | * @returns counter struct. |
| 34 | **/ |
alexander | 31ae9f0 | 2022-02-10 16:15:54 +0000 | [diff] [blame] | 35 | base_time_counter get_time_counter(void); |
alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 36 | |
| 37 | /** |
| 38 | * @brief Gets the cycle counts elapsed between start and end. |
| 39 | * @return difference in counter values as 32 bit unsigned integer. |
| 40 | */ |
alexander | 31ae9f0 | 2022-02-10 16:15:54 +0000 | [diff] [blame] | 41 | uint64_t get_cycle_count_diff(base_time_counter *start, base_time_counter *end); |
alexander | 3c79893 | 2021-03-26 21:42:19 +0000 | [diff] [blame] | 42 | |
| 43 | /** |
| 44 | * @brief Enables or triggers cycle counting mechanism, if required |
| 45 | * by the platform. |
| 46 | */ |
| 47 | void start_cycle_counter(void); |
| 48 | |
| 49 | /** |
| 50 | * @brief Stops cycle counting mechanism, if required by the platform. |
| 51 | */ |
| 52 | void stop_cycle_counter(void); |
| 53 | |
Kshitij Sisodia | 659fcd9 | 2021-05-19 10:30:06 +0100 | [diff] [blame] | 54 | #endif /* TIMER_SIMPLE_PLATFORM_H */ |