Front Haul Interface Library update to third seed code contribution
[o-du/phy.git] / fhi_lib / lib / api / xran_timer.h
1 /******************************************************************************
2 *
3 *   Copyright (c) 2019 Intel.
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 *
17 *******************************************************************************/
18
19 /**
20  * @brief This file provides interface to Timing for XRAN.
21  *
22  * @file xran_timer.h
23  * @ingroup group_lte_source_xran
24  * @author Intel Corporation
25  *
26  **/
27
28 #ifndef _XRAN_TIMER_H
29 #define _XRAN_TIMER_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include <time.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <stdint.h>
39
40 #define MSEC_PER_SEC 1000L
41
42 #define XranIncrementSymIdx(sym_idx, numSymPerMs)  (((uint32_t)sym_idx >= (((uint32_t)numSymPerMs * MSEC_PER_SEC) - 1)) ? 0 : (uint32_t)sym_idx+1)
43 #define XranDecrementSymIdx(sym_idx, numSymPerMs)  (((uint32_t)sym_idx == 0) ? (((uint32_t)numSymPerMs * MSEC_PER_SEC)) - 1) : (uint32_t)sym_idx-1)
44
45 uint64_t xran_tick(void);
46 unsigned long get_ticks_diff(unsigned long curr_tick, unsigned long last_tick);
47 long poll_next_tick(long interval_ns, unsigned long *used_tick);
48 long sleep_next_tick(long interval);
49 int timing_set_debug_stop(int value, int count);
50 int timing_get_debug_stop(void);
51 inline uint64_t timing_get_current_second(void);
52 int timing_set_numerology(uint8_t value);
53
54 #ifdef __cplusplus
55 }
56 #endif
57
58 #endif