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

Header file for function to work with 5G NR frame structure and related routines. +More...

+
#include "xran_fh_o_du.h"
+
+Include dependency graph for xran_frame_struct.h:
+
+
+ + + +
+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + + + + + + + +
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

uint32_t xran_fs_get_tti_interval (uint8_t nMu)
 
uint32_t xran_fs_get_scs (uint8_t nMu)
 
uint16_t xran_fs_get_num_rbs (uint32_t nNumerology, uint32_t nBandwidth, uint32_t nAbsFrePointA)
 
uint32_t xran_fs_cal_nrarfcn (uint32_t nCenterFreq)
 
int32_t xran_fs_slot_limit (int32_t nSlotIdx)
 
void xran_fs_clear_slot_type (uint32_t nCcId)
 
int32_t xran_fs_set_slot_type (uint32_t nCcId, uint32_t nFrameDuplexType, uint32_t nTddPeriod, struct xran_slot_config *psSlotConfig)
 
int32_t xran_fs_get_slot_type (int32_t nCcId, int32_t nSlotIdx, int32_t nType)
 
uint32_t xran_fs_slot_limit_init (int32_t tti_interval_us)
 
uint32_t xran_fs_get_max_slot (void)
 
uint32_t xran_fs_get_max_slot_SFN (void)
 
int32_t xran_fs_get_symbol_type (int32_t nCellIdx, int32_t nSlotdx, int32_t nSymbIdx)
 
+

Detailed Description

+

Header file for function to work with 5G NR frame structure and related routines.

+
Author
Intel Corporation
+ +

Definition in file xran_frame_struct.h.

+

Function Documentation

+ +

◆ xran_fs_cal_nrarfcn()

+ +
+
+ + + + + + + + +
uint32_t xran_fs_cal_nrarfcn (uint32_t nCenterFreq)
+
+
Parameters
+ + +
[in]centerfrequency
+
+
+
Returns
NR-ARFCN
+

This calculates NR-ARFCN value according to center frequency

+ +

Definition at line 274 of file xran_frame_struct.c.

+ +
+
+ +

◆ xran_fs_clear_slot_type()

+ +
+
+ + + + + + + + +
void xran_fs_clear_slot_type (uint32_t nCcId)
+
+ +

Definition at line 339 of file xran_frame_struct.c.

+ +
+
+ +

◆ xran_fs_get_max_slot()

+ +
+
+ + + + + + + + +
uint32_t xran_fs_get_max_slot (void )
+
+ +

Definition at line 316 of file xran_frame_struct.c.

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

◆ xran_fs_get_max_slot_SFN()

+ +
+
+ + + + + + + + +
uint32_t xran_fs_get_max_slot_SFN (void )
+
+ +

Definition at line 321 of file xran_frame_struct.c.

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

◆ xran_fs_get_num_rbs()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
uint16_t xran_fs_get_num_rbs (uint32_t nNumerology,
uint32_t nBandwidth,
uint32_t nAbsFrePointA 
)
+
+
Parameters
+ + + + +
[in]nNumerology- Numerology determine sub carrier spacing, Value: 0->4 0: 15khz, 1: 30khz, 2: 60khz 3: 120khz, 4: 240khz
[in]nBandwidth- Carrier bandwidth for in MHz. Value: 5->400
[in]nAbsFrePointA- Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000
+
+
+
Returns
Number of RBs in cell
+

Returns number of RBs based on 38.101-1 and 38.101-2 for the cell

+ +

Definition at line 149 of file xran_frame_struct.c.

+ +
+
+ +

◆ xran_fs_get_scs()

+ +
+
+ + + + + + + + +
uint32_t xran_fs_get_scs (uint8_t nMu)
+
+ +

Definition at line 121 of file xran_frame_struct.c.

+ +
+
+ +

◆ xran_fs_get_slot_type()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int32_t xran_fs_get_slot_type (int32_t nCcId,
int32_t nSlotIdx,
int32_t nType 
)
+
+ +

Definition at line 477 of file xran_frame_struct.c.

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

◆ xran_fs_get_symbol_type()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int32_t xran_fs_get_symbol_type (int32_t nCellIdx,
int32_t nSlotdx,
int32_t nSymbIdx 
)
+
+ +

Definition at line 508 of file xran_frame_struct.c.

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

◆ xran_fs_get_tti_interval()

+ +
+
+ + + + + + + + +
uint32_t xran_fs_get_tti_interval (uint8_t nMu)
+
+ +

Definition at line 108 of file xran_frame_struct.c.

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

◆ xran_fs_set_slot_type()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int32_t xran_fs_set_slot_type (uint32_t nCcId,
uint32_t nFrameDuplexType,
uint32_t nTddPeriod,
struct xran_slot_config * psSlotConfig 
)
+
+ +

Definition at line 346 of file xran_frame_struct.c.

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

◆ xran_fs_slot_limit()

+ +
+
+ + + + + + + + +
int32_t xran_fs_slot_limit (int32_t nSlotIdx)
+
+ +

Definition at line 326 of file xran_frame_struct.c.

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

◆ xran_fs_slot_limit_init()

+ +
+
+ + + + + + + + +
uint32_t xran_fs_slot_limit_init (int32_t tti_interval_us)
+
+ +

Definition at line 309 of file xran_frame_struct.c.

+
+Here is the caller graph for this function:
+
+
+ + + + + + + + +
+ +
+
+
+ +
+Generated by   +doxygen + 1.8.13 +
+ +