X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fstruct___runtime_config.html;fp=docs%2FAPI%2Fstruct___runtime_config.html;h=18696f4ee508f5446594d7841b4ac6105b5ceffa;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/struct___runtime_config.html b/docs/API/struct___runtime_config.html new file mode 100644 index 0000000..18696f4 --- /dev/null +++ b/docs/API/struct___runtime_config.html @@ -0,0 +1,1425 @@ + + + + + + + +o-du/phy: _RuntimeConfig Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Data Fields
+
+
_RuntimeConfig Struct Reference
+
+
+ +

#include <config.h>

+
+Collaboration diagram for _RuntimeConfig:
+
+
Collaboration graph
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

uint8_t appMode
 
uint8_t xranCat
 
uint8_t numCC
 
uint8_t numAxc
 
uint8_t numUlAxc
 
uint32_t antElmTRx
 
uint32_t muMimoUEs
 
uint32_t DlLayersPerUe
 
uint32_t UlLayersPerUe
 
uint32_t ttiPeriod
 
uint32_t testVect
 
struct ether_addr o_du_addr
 
struct ether_addr o_ru_addr
 
struct ether_addr tmp_addr
 
uint32_t instance_id
 
uint32_t io_core
 
uint32_t mtu
 
int numSlots
 
char ant_file [XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
 
char prach_file [XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
 
char dl_bfw_file [XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
 
char ul_bfw_file [XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
 
char ul_srs_file [XRAN_MAX_SECTOR_NR *XRAN_MAX_ANT_ARRAY_ELM_NR][512]
 
uint8_t enablePrach
 
uint8_t prachOffset
 
uint8_t prachConfigIndex
 
uint8_t iqswap
 
uint8_t nebyteorderswap
 
uint8_t compression
 
uint16_t totalBfWeights
 
uint8_t enableSrs
 
uint16_t srsSymMask
 
uint16_t maxFrameId
 
uint16_t Tadv_cp_dl
 
uint16_t T2a_min_cp_dl
 
uint16_t T2a_max_cp_dl
 
uint16_t T2a_min_cp_ul
 
uint16_t T2a_max_cp_ul
 
uint16_t T2a_min_up
 
uint16_t T2a_max_up
 
uint16_t Ta3_min
 
uint16_t Ta3_max
 
uint16_t T1a_min_cp_dl
 
uint16_t T1a_max_cp_dl
 
uint16_t T1a_min_cp_ul
 
uint16_t T1a_max_cp_ul
 
uint16_t T1a_min_up
 
uint16_t T1a_max_up
 
uint16_t Ta4_min
 
uint16_t Ta4_max
 
uint8_t enableCP
 
uint8_t cp_vlan_tag
 
uint8_t up_vlan_tag
 
int32_t debugStop
 
int32_t debugStopCount
 
int32_t bbdevMode
 
int32_t DynamicSectionEna
 
int32_t GPS_Alpha
 
int32_t GPS_Beta
 
uint8_t mu_number
 
uint32_t nDLAbsFrePointA
 
uint32_t nULAbsFrePointA
 
uint32_t nDLBandwidth
 
uint32_t nULBandwidth
 
uint32_t nDLFftSize
 
uint32_t nULFftSize
 
uint8_t nFrameDuplexType
 
uint8_t nTddPeriod
 
struct xran_slot_config sSlotConfig [XRAN_MAX_TDD_PERIODICITY]
 
struct xran_prb_map PrbMapDl
 
struct xran_prb_map PrbMapUl
 
+

Detailed Description

+

Run time configuration of application

+ +

Definition at line 34 of file config.h.

+

Field Documentation

+ +

◆ ant_file

+ +
+
+ + + + +
char ant_file[XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
+
+

file to use for test vector

+ +

Definition at line 59 of file config.h.

+ +
+
+ +

◆ antElmTRx

+ +
+
+ + + + +
uint32_t antElmTRx
+
+

Number of antenna elements for TX and RX

+ +

Definition at line 41 of file config.h.

+ +
+
+ +

◆ appMode

+ +
+
+ + + + +
uint8_t appMode
+
+

Application mode: lls-CU or RU

+ +

Definition at line 36 of file config.h.

+ +
+
+ +

◆ bbdevMode

+ +
+
+ + + + +
int32_t bbdevMode
+
+ +

Definition at line 108 of file config.h.

+ +
+
+ +

◆ compression

+ +
+
+ + + + +
uint8_t compression
+
+

enable use case with compression

+ +

Definition at line 75 of file config.h.

+ +
+
+ +

◆ cp_vlan_tag

+ +
+
+ + + + +
uint8_t cp_vlan_tag
+
+

C-plane vlan tag

+ +

Definition at line 103 of file config.h.

+ +
+
+ +

◆ debugStop

+ +
+
+ + + + +
int32_t debugStop
+
+ +

Definition at line 106 of file config.h.

+ +
+
+ +

◆ debugStopCount

+ +
+
+ + + + +
int32_t debugStopCount
+
+ +

Definition at line 107 of file config.h.

+ +
+
+ +

◆ dl_bfw_file

+ +
+
+ + + + +
char dl_bfw_file[XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
+
+

file with beamforming weights for DL streams

+ +

Definition at line 62 of file config.h.

+ +
+
+ +

◆ DlLayersPerUe

+ +
+
+ + + + +
uint32_t DlLayersPerUe
+
+

Number of DL layer per UE

+ +

Definition at line 44 of file config.h.

+ +
+
+ +

◆ DynamicSectionEna

+ +
+
+ + + + +
int32_t DynamicSectionEna
+
+ +

Definition at line 109 of file config.h.

+ +
+
+ +

◆ enableCP

+ +
+
+ + + + +
uint8_t enableCP
+
+

enable C-plane

+ +

Definition at line 102 of file config.h.

+ +
+
+ +

◆ enablePrach

+ +
+
+ + + + +
uint8_t enablePrach
+
+

enable PRACH

+ +

Definition at line 68 of file config.h.

+ +
+
+ +

◆ enableSrs

+ +
+
+ + + + +
uint8_t enableSrs
+
+

enable SRS (valid for Cat B only)

+ +

Definition at line 79 of file config.h.

+ +
+
+ +

◆ GPS_Alpha

+ +
+
+ + + + +
int32_t GPS_Alpha
+
+ +

Definition at line 110 of file config.h.

+ +
+
+ +

◆ GPS_Beta

+ +
+
+ + + + +
int32_t GPS_Beta
+
+ +

Definition at line 111 of file config.h.

+ +
+
+ +

◆ instance_id

+ +
+
+ + + + +
uint32_t instance_id
+
+

Instance ID of application

+ +

Definition at line 53 of file config.h.

+ +
+
+ +

◆ io_core

+ +
+
+ + + + +
uint32_t io_core
+
+

Core used for IO

+ +

Definition at line 54 of file config.h.

+ +
+
+ +

◆ iqswap

+ +
+
+ + + + +
uint8_t iqswap
+
+

do swap of IQ before send to ETH

+ +

Definition at line 73 of file config.h.

+ +
+
+ +

◆ maxFrameId

+ +
+
+ + + + +
uint16_t maxFrameId
+
+

max value of frame id

+ +

Definition at line 82 of file config.h.

+ +
+
+ +

◆ mtu

+ +
+
+ + + + +
uint32_t mtu
+
+

maximum transmission unit (MTU) is the size of the largest protocol data unit (PDU) that can be communicated in a single xRAN network layer transaction. supported 1500 bytes and 9600 bytes (Jumbo Frame)

+ +

Definition at line 56 of file config.h.

+ +
+
+ +

◆ mu_number

+ +
+
+ + + + +
uint8_t mu_number
+
+

Mu numner as per 3GPP

+ +

Definition at line 113 of file config.h.

+ +
+
+ +

◆ muMimoUEs

+ +
+
+ + + + +
uint32_t muMimoUEs
+
+

Number of UEs (with 1 RX ant)/beams

+ +

Definition at line 42 of file config.h.

+ +
+
+ +

◆ nDLAbsFrePointA

+ +
+
+ + + + +
uint32_t nDLAbsFrePointA
+
+

Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000

+ +

Definition at line 114 of file config.h.

+ +
+
+ +

◆ nDLBandwidth

+ +
+
+ + + + +
uint32_t nDLBandwidth
+
+

Carrier bandwidth for in MHz. Value: 5->400

+ +

Definition at line 116 of file config.h.

+ +
+
+ +

◆ nDLFftSize

+ +
+
+ + + + +
uint32_t nDLFftSize
+
+

DL FFT size

+ +

Definition at line 118 of file config.h.

+ +
+
+ +

◆ nebyteorderswap

+ +
+
+ + + + +
uint8_t nebyteorderswap
+
+

do swap of byte order from host byte order to network byte order. ETH

+ +

Definition at line 74 of file config.h.

+ +
+
+ +

◆ nFrameDuplexType

+ +
+
+ + + + +
uint8_t nFrameDuplexType
+
+ +

Definition at line 122 of file config.h.

+ +
+
+ +

◆ nTddPeriod

+ +
+
+ + + + +
uint8_t nTddPeriod
+
+ +

Definition at line 123 of file config.h.

+ +
+
+ +

◆ nULAbsFrePointA

+ +
+
+ + + + +
uint32_t nULAbsFrePointA
+
+

Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000

+ +

Definition at line 115 of file config.h.

+ +
+
+ +

◆ nULBandwidth

+ +
+
+ + + + +
uint32_t nULBandwidth
+
+

Carrier bandwidth for in MHz. Value: 5->400

+ +

Definition at line 117 of file config.h.

+ +
+
+ +

◆ nULFftSize

+ +
+
+ + + + +
uint32_t nULFftSize
+
+

UL FFT size

+ +

Definition at line 119 of file config.h.

+ +
+
+ +

◆ numAxc

+ +
+
+ + + + +
uint8_t numAxc
+
+

Number of Antenna Carriers per CC

+ +

Definition at line 39 of file config.h.

+ +
+
+ +

◆ numCC

+ +
+
+ + + + +
uint8_t numCC
+
+

Number of CC per ports supported by RU

+ +

Definition at line 38 of file config.h.

+ +
+
+ +

◆ numSlots

+ +
+
+ + + + +
int numSlots
+
+

number of slots in IQ vector

+ +

Definition at line 58 of file config.h.

+ +
+
+ +

◆ numUlAxc

+ +
+
+ + + + +
uint8_t numUlAxc
+
+

Number of Antenna Carriers per CC for UL (Cat B)

+ +

Definition at line 40 of file config.h.

+ +
+
+ +

◆ o_du_addr

+ +
+
+ + + + +
struct ether_addr o_du_addr
+
+

lls-CU Ethernet Mac Address

+ +

Definition at line 49 of file config.h.

+ +
+
+ +

◆ o_ru_addr

+ +
+
+ + + + +
struct ether_addr o_ru_addr
+
+

RU Ethernet Mac Address

+ +

Definition at line 50 of file config.h.

+ +
+
+ +

◆ prach_file

+ +
+
+ + + + +
char prach_file[XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
+
+

file to use for test vector

+ +

Definition at line 60 of file config.h.

+ +
+
+ +

◆ prachConfigIndex

+ +
+
+ + + + +
uint8_t prachConfigIndex
+
+

TS36.211 - Table 5.7.1-2 : PRACH Configuration Index

+ +

Definition at line 72 of file config.h.

+ +
+
+ +

◆ prachOffset

+ +
+
+ + + + +
uint8_t prachOffset
+
+

Sets the PRACH position in frequency / subcarrier position, n_PRBoffset^RA and is expressed as a physical resource block number. Set by SIB2, prach-FreqOffset in E-UTRA.

+ +

Definition at line 69 of file config.h.

+ +
+
+ +

◆ PrbMapDl

+ +
+
+ + + + +
struct xran_prb_map PrbMapDl
+
+ +

Definition at line 125 of file config.h.

+ +
+
+ +

◆ PrbMapUl

+ +
+
+ + + + +
struct xran_prb_map PrbMapUl
+
+ +

Definition at line 126 of file config.h.

+ +
+
+ +

◆ srsSymMask

+ +
+
+ + + + +
uint16_t srsSymMask
+
+

SRS symbol mask [014] within S/U slot [0-13] def is 13

+ +

Definition at line 80 of file config.h.

+ +
+
+ +

◆ sSlotConfig

+ +
+
+ + + + +
struct xran_slot_config sSlotConfig[XRAN_MAX_TDD_PERIODICITY]
+
+ +

Definition at line 124 of file config.h.

+ +
+
+ +

◆ T1a_max_cp_dl

+ +
+
+ + + + +
uint16_t T1a_max_cp_dl
+
+ +

Definition at line 94 of file config.h.

+ +
+
+ +

◆ T1a_max_cp_ul

+ +
+
+ + + + +
uint16_t T1a_max_cp_ul
+
+ +

Definition at line 96 of file config.h.

+ +
+
+ +

◆ T1a_max_up

+ +
+
+ + + + +
uint16_t T1a_max_up
+
+ +

Definition at line 98 of file config.h.

+ +
+
+ +

◆ T1a_min_cp_dl

+ +
+
+ + + + +
uint16_t T1a_min_cp_dl
+
+ +

Definition at line 93 of file config.h.

+ +
+
+ +

◆ T1a_min_cp_ul

+ +
+
+ + + + +
uint16_t T1a_min_cp_ul
+
+ +

Definition at line 95 of file config.h.

+ +
+
+ +

◆ T1a_min_up

+ +
+
+ + + + +
uint16_t T1a_min_up
+
+ +

Definition at line 97 of file config.h.

+ +
+
+ +

◆ T2a_max_cp_dl

+ +
+
+ + + + +
uint16_t T2a_max_cp_dl
+
+ +

Definition at line 86 of file config.h.

+ +
+
+ +

◆ T2a_max_cp_ul

+ +
+
+ + + + +
uint16_t T2a_max_cp_ul
+
+ +

Definition at line 88 of file config.h.

+ +
+
+ +

◆ T2a_max_up

+ +
+
+ + + + +
uint16_t T2a_max_up
+
+ +

Definition at line 90 of file config.h.

+ +
+
+ +

◆ T2a_min_cp_dl

+ +
+
+ + + + +
uint16_t T2a_min_cp_dl
+
+ +

Definition at line 85 of file config.h.

+ +
+
+ +

◆ T2a_min_cp_ul

+ +
+
+ + + + +
uint16_t T2a_min_cp_ul
+
+ +

Definition at line 87 of file config.h.

+ +
+
+ +

◆ T2a_min_up

+ +
+
+ + + + +
uint16_t T2a_min_up
+
+ +

Definition at line 89 of file config.h.

+ +
+
+ +

◆ Ta3_max

+ +
+
+ + + + +
uint16_t Ta3_max
+
+ +

Definition at line 92 of file config.h.

+ +
+
+ +

◆ Ta3_min

+ +
+
+ + + + +
uint16_t Ta3_min
+
+ +

Definition at line 91 of file config.h.

+ +
+
+ +

◆ Ta4_max

+ +
+
+ + + + +
uint16_t Ta4_max
+
+ +

Definition at line 100 of file config.h.

+ +
+
+ +

◆ Ta4_min

+ +
+
+ + + + +
uint16_t Ta4_min
+
+ +

Definition at line 99 of file config.h.

+ +
+
+ +

◆ Tadv_cp_dl

+ +
+
+ + + + +
uint16_t Tadv_cp_dl
+
+ +

Definition at line 84 of file config.h.

+ +
+
+ +

◆ testVect

+ +
+
+ + + + +
uint32_t testVect
+
+

Test Signal to send

+ +

Definition at line 48 of file config.h.

+ +
+
+ +

◆ tmp_addr

+ +
+
+ + + + +
struct ether_addr tmp_addr
+
+

Temp Ethernet Mac Address

+ +

Definition at line 51 of file config.h.

+ +
+
+ +

◆ totalBfWeights

+ +
+
+ + + + +
uint16_t totalBfWeights
+
+

The total number of beamforming weights on RU

+ +

Definition at line 77 of file config.h.

+ +
+
+ +

◆ ttiPeriod

+ +
+
+ + + + +
uint32_t ttiPeriod
+
+

TTI period

+ +

Definition at line 47 of file config.h.

+ +
+
+ +

◆ ul_bfw_file

+ +
+
+ + + + +
char ul_bfw_file[XRAN_MAX_SECTOR_NR *XRAN_MAX_ANTENNA_NR][512]
+
+

file with beamforming weights for UL streams

+ +

Definition at line 63 of file config.h.

+ +
+
+ +

◆ ul_srs_file

+ +
+
+ + + + +
char ul_srs_file[XRAN_MAX_SECTOR_NR *XRAN_MAX_ANT_ARRAY_ELM_NR][512]
+
+

file with SRS content for UL antenna elements

+ +

Definition at line 65 of file config.h.

+ +
+
+ +

◆ UlLayersPerUe

+ +
+
+ + + + +
uint32_t UlLayersPerUe
+
+

Number of UL layer per UE

+ +

Definition at line 45 of file config.h.

+ +
+
+ +

◆ up_vlan_tag

+ +
+
+ + + + +
uint8_t up_vlan_tag
+
+

U-plane vlan tag

+ +

Definition at line 104 of file config.h.

+ +
+
+ +

◆ xranCat

+ +
+
+ + + + +
uint8_t xranCat
+
+

xran mode: Categoty A | Category B

+ +

Definition at line 37 of file config.h.

+ +
+
+
The documentation for this struct was generated from the following file: +
+ + + +