X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fxran__timer_8h.html;fp=docs%2FAPI%2Fxran__timer_8h.html;h=662f4234f4c5f0535369644e29b84fbe814490d8;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/xran__timer_8h.html b/docs/API/xran__timer_8h.html new file mode 100644 index 0000000..662f423 --- /dev/null +++ b/docs/API/xran__timer_8h.html @@ -0,0 +1,461 @@ + + + + + + + +o-du/phy: xran_timer.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Macros | +Functions
+
+
xran_timer.h File Reference
+
+
+ +

This file provides interface to Timing for XRAN. +More...

+
#include <time.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+
+Include dependency graph for xran_timer.h:
+
+
+ + +
+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + + +
+
+

Go to the source code of this file.

+ + + + + + + + +

+Macros

#define MSEC_PER_SEC   1000L
 
#define XranIncrementSymIdx(sym_idx, numSymPerMs)   (((uint32_t)sym_idx >= (((uint32_t)numSymPerMs * MSEC_PER_SEC) - 1)) ? 0 : (uint32_t)sym_idx+1)
 
#define XranDecrementSymIdx(sym_idx, numSymPerMs)   (((uint32_t)sym_idx == 0) ? (((uint32_t)numSymPerMs * MSEC_PER_SEC)) - 1) : (uint32_t)sym_idx-1)
 
+ + + + + + + + + + + + + + + + + +

+Functions

uint64_t xran_tick (void)
 
unsigned long get_ticks_diff (unsigned long curr_tick, unsigned long last_tick)
 
long poll_next_tick (long interval_ns, unsigned long *used_tick)
 
long sleep_next_tick (long interval)
 
int timing_set_debug_stop (int value, int count)
 
int timing_get_debug_stop (void)
 
uint64_t timing_get_current_second (void)
 
int timing_set_numerology (uint8_t value)
 
+

Detailed Description

+

This file provides interface to Timing for XRAN.

+
Author
Intel Corporation
+ +

Definition in file xran_timer.h.

+

Macro Definition Documentation

+ +

◆ MSEC_PER_SEC

+ +
+
+ + + + +
#define MSEC_PER_SEC   1000L
+
+ +

Definition at line 40 of file xran_timer.h.

+ +
+
+ +

◆ XranDecrementSymIdx

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define XranDecrementSymIdx( sym_idx,
 numSymPerMs 
)   (((uint32_t)sym_idx == 0) ? (((uint32_t)numSymPerMs * MSEC_PER_SEC)) - 1) : (uint32_t)sym_idx-1)
+
+ +

Definition at line 43 of file xran_timer.h.

+ +
+
+ +

◆ XranIncrementSymIdx

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define XranIncrementSymIdx( sym_idx,
 numSymPerMs 
)   (((uint32_t)sym_idx >= (((uint32_t)numSymPerMs * MSEC_PER_SEC) - 1)) ? 0 : (uint32_t)sym_idx+1)
+
+ +

Definition at line 42 of file xran_timer.h.

+ +
+
+

Function Documentation

+ +

◆ get_ticks_diff()

+ +
+
+ + + + + + + + + + + + + + + + + + +
unsigned long get_ticks_diff (unsigned long curr_tick,
unsigned long last_tick 
)
+
+ +

Definition at line 138 of file xran_timer.c.

+
+Here is the caller graph for this function:
+
+
+ + + +
+ +
+
+ +

◆ poll_next_tick()

+ +
+
+ + + + + + + + + + + + + + + + + + +
long poll_next_tick (long interval_ns,
unsigned long * used_tick 
)
+
+ +

Definition at line 146 of file xran_timer.c.

+
+Here is the call graph for this function:
+
+
+ + + +
+ +
+
+ +

◆ sleep_next_tick()

+ +
+
+ + + + + + + + +
long sleep_next_tick (long interval)
+
+ +

Definition at line 246 of file xran_timer.c.

+ +
+
+ +

◆ timing_get_current_second()

+ +
+
+ + + + + +
+ + + + + + + + +
uint64_t timing_get_current_second (void )
+
+inline
+
+ +

Definition at line 88 of file xran_timer.c.

+
+Here is the caller graph for this function:
+
+
+ + + +
+ +
+
+ +

◆ timing_get_debug_stop()

+ +
+
+ + + + + + + + +
int timing_get_debug_stop (void )
+
+ +

Definition at line 111 of file xran_timer.c.

+ +
+
+ +

◆ timing_set_debug_stop()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int timing_set_debug_stop (int value,
int count 
)
+
+ +

Definition at line 99 of file xran_timer.c.

+ +
+
+ +

◆ timing_set_numerology()

+ +
+
+ + + + + + + + +
int timing_set_numerology (uint8_t value)
+
+ +

Definition at line 93 of file xran_timer.c.

+
+Here is the caller graph for this function:
+
+
+ + + + + + + + +
+ +
+
+ +

◆ xran_tick()

+ +
+
+ + + + + + + + +
uint64_t xran_tick (void )
+
+ +

Definition at line 131 of file xran_timer.c.

+
+Here is the caller graph for this function:
+
+
+ + + +
+ +
+
+
+ + + +