o-du/phy
Intel O-RAN/X-RAN Generated Doxygen Documentation
Data Structures | Functions | Variables
xran_pkt_cp.h File Reference

This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in XRAN-FH.CUS.0-v02.01. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  xran_radioapp_udComp_header
 
struct  xran_cp_radioapp_common_header
 
struct  xran_cp_radioapp_frameStructure
 
struct  xran_cp_radioapp_section_header
 
struct  xran_cp_radioapp_section_ext_hdr
 
struct  xran_cp_radioapp_section_ext1
 
struct  xran_cp_radioapp_section_ext2
 
struct  xran_cp_radioapp_section_ext3_first
 
struct  xran_cp_radioapp_section_ext3_non_first
 
struct  xran_cp_radioapp_section_ext4
 
struct  xran_cp_radioapp_section_ext5
 
struct  xran_cp_radioapp_section0_header
 
struct  xran_cp_radioapp_section0
 
struct  xran_cp_radioapp_section1_header
 
struct  xran_cp_radioapp_section1
 
struct  xran_cp_radioapp_section3_header
 
struct  xran_cp_radioapp_section3
 
struct  xran_cp_radioapp_section5_header
 
struct  xran_cp_radioapp_section5
 
struct  xran_cp_radioapp_section6_header
 
struct  xran_cp_radioapp_section6
 
struct  xran_cp_radioapp_section7_header
 

Functions

struct xran_radioapp_udComp_header __attribute__ ((__packed__))
 

Variables

uint8_t udCompMeth
 
uint8_t udIqWidth
 
uint32_t startSymbolId
 
uint32_t slotId
 
uint32_t subframeId
 
uint32_t frameId
 
uint32_t filterIndex
 
uint32_t payloadVer
 
uint32_t dataDirection
 
uint8_t numOfSections
 
uint8_t sectionType
 
uint8_t uScs
 
uint8_t fftSize
 
union {
   struct {
      uint32_t   reserved:16
 
      uint32_t   numSymbol:4
 
      uint32_t   reMask:12
 
   }   s0
 
   struct {
      uint32_t   beamId:15
 
      uint32_t   ef:1
 
      uint32_t   numSymbol:4
 
      uint32_t   reMask:12
 
   }   s1
 
   struct {
      uint32_t   beamId:15
 
      uint32_t   ef:1
 
      uint32_t   numSymbol:4
 
      uint32_t   reMask:12
 
   }   s3
 
   struct {
      uint32_t   ueId:15
 
      uint32_t   ef:1
 
      uint32_t   numSymbol:4
 
      uint32_t   reMask:12
 
   }   s5
 
u
 
uint32_t numPrbc
 
uint32_t startPrbc
 
uint32_t symInc
 
uint32_t rb
 
uint32_t sectionId
 
uint16_t extLen
 
uint16_t extType
 
uint8_t bfwCompMeth
 
uint8_t bfwIqWidth
 
uint32_t bfZe3ddWidth
 
uint32_t bfAz3ddWidth
 
uint32_t bfaCompResv1
 
uint32_t bfZePtWidth
 
uint32_t bfAzPtWidth
 
uint32_t bfaCompResv0
 
uint32_t reserved1
 
uint32_t crsSymNum
 
uint32_t reserved0
 
uint32_t crsShift
 
uint32_t crsReMask
 
uint32_t txScheme
 
uint32_t numLayers
 
uint32_t layerId
 
uint32_t codebookIndex
 
uint16_t beamIdAP3
 
uint16_t beamIdAP2
 
uint16_t beamIdAP1
 
uint16_t reserved2
 
uint32_t modCompScaler
 
uint32_t csf
 
uint32_t mcScaleOffset2
 
uint32_t csf2
 
uint32_t mcScaleReMask2
 
uint32_t mcScaleOffset1
 
uint32_t csf1
 
uint32_t mcScaleReMask1
 
struct xran_cp_radioapp_common_header cmnhdr
 
uint16_t timeOffset
 
struct xran_cp_radioapp_frameStructure frameStructure
 
uint16_t cpLength
 
struct xran_cp_radioapp_section_header hdr
 
struct xran_radioapp_udComp_header udComp
 
uint32_t freqOffset
 
uint8_t numberOfUEs
 
uint32_t regularizationFactor
 
uint8_t startPrbch
 
uint8_t startPrbcl
 
uint8_t laaMsgLen
 
uint8_t laaMsgType
 

Detailed Description

This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in XRAN-FH.CUS.0-v02.01.

Author
Intel Corporation

Definition in file xran_pkt_cp.h.

Function Documentation

◆ __attribute__()

struct xran_cp_radioapp_section7_header __attribute__ ( (__packed__)  )

Variable Documentation

◆ beamId

uint32_t beamId

5.4.5.9 beam identifier

Definition at line 221 of file xran_pkt_cp.h.

◆ beamIdAP1

uint16_t beamIdAP1

5.4.7.3.8 beam id to be used for antenna port 1

Definition at line 232 of file xran_pkt_cp.h.

◆ beamIdAP2

uint16_t beamIdAP2

5.4.7.3.9 beam id to be used for antenna port 2

Definition at line 231 of file xran_pkt_cp.h.

◆ beamIdAP3

uint16_t beamIdAP3

5.4.7.3.10 beam id to be used for antenna port 3

Definition at line 230 of file xran_pkt_cp.h.

◆ bfaCompResv0

uint32_t bfaCompResv0

Definition at line 222 of file xran_pkt_cp.h.

◆ bfaCompResv1

uint32_t bfaCompResv1

Definition at line 219 of file xran_pkt_cp.h.

◆ bfAz3ddWidth

uint32_t bfAz3ddWidth

5.4.7.2.1 beamforming azimuth beamwidth parameter bitwidth, Table 5-20

Definition at line 218 of file xran_pkt_cp.h.

◆ bfAzPtWidth

uint32_t bfAzPtWidth

5.4.7.2.1 beamforming azimuth pointing parameter bitwidth, Table 5-18

Definition at line 221 of file xran_pkt_cp.h.

◆ bfwCompMeth

uint8_t bfwCompMeth

5.4.7.1.1 Beamforming weight Compression method

Definition at line 220 of file xran_pkt_cp.h.

◆ bfwIqWidth

uint8_t bfwIqWidth

5.4.7.1.1 Beamforming weight IQ bit width

Definition at line 221 of file xran_pkt_cp.h.

◆ bfZe3ddWidth

uint32_t bfZe3ddWidth

5.4.7.2.1 beamforming zenith beamwidth parameter bitwidth, Table 5-21

Definition at line 217 of file xran_pkt_cp.h.

◆ bfZePtWidth

uint32_t bfZePtWidth

5.4.7.2.1 beamforming zenith pointing parameter bitwidth, Table 5-19

Definition at line 220 of file xran_pkt_cp.h.

◆ cmnhdr

Definition at line 214 of file xran_pkt_cp.h.

◆ codebookIndex

uint32_t codebookIndex

5.4.7.3.1 precoder codebook used for transmission

Definition at line 225 of file xran_pkt_cp.h.

◆ cpLength

uint16_t cpLength

5.4.4.14 cyclic prefix length

Definition at line 218 of file xran_pkt_cp.h.

◆ crsReMask

uint32_t crsReMask

5.4.7.3.5 CRS resource element mask

Definition at line 221 of file xran_pkt_cp.h.

◆ crsShift

uint32_t crsShift

5.4.7.3.7 CRS shift used for DL transmission

Definition at line 220 of file xran_pkt_cp.h.

◆ crsSymNum

uint32_t crsSymNum

5.4.7.3.6 CRS symbol number indication

Definition at line 218 of file xran_pkt_cp.h.

◆ csf

uint32_t csf

5.4.7.4.1 constellation shift flag

Definition at line 216 of file xran_pkt_cp.h.

◆ csf1

uint32_t csf1

5.4.7.5.2 constellation shift flag

Definition at line 219 of file xran_pkt_cp.h.

◆ csf2

uint32_t csf2

5.4.7.5.2 constellation shift flag

Definition at line 216 of file xran_pkt_cp.h.

◆ dataDirection

uint32_t dataDirection

5.4.4.1 data direction (gNB Tx/Rx)

Definition at line 220 of file xran_pkt_cp.h.

◆ ef

uint32_t ef

5.4.5.8 extension flag

5.4.6.2 extension flag

Definition at line 222 of file xran_pkt_cp.h.

◆ extLen

uint32_t extLen

5.4.6.3 extension length, in 32bits words

Definition at line 217 of file xran_pkt_cp.h.

◆ extType

uint32_t extType

5.4.6.1 extension type

Definition at line 218 of file xran_pkt_cp.h.

◆ fftSize

uint8_t fftSize

FFT size, XRAN_FFTSIZE_xxx

Definition at line 215 of file xran_pkt_cp.h.

◆ filterIndex

uint32_t filterIndex

5.4.4.3 filter index, XRAN_FILTERINDEX_xxxx

Definition at line 218 of file xran_pkt_cp.h.

◆ frameId

uint32_t frameId

5.4.4.4 frame identifier

Definition at line 217 of file xran_pkt_cp.h.

◆ frameStructure

struct xran_cp_radioapp_frameStructure frameStructure

Definition at line 217 of file xran_pkt_cp.h.

◆ freqOffset

uint32_t freqOffset

5.4.5.11 frequency offset

Definition at line 215 of file xran_pkt_cp.h.

◆ hdr

Definition at line 214 of file xran_pkt_cp.h.

◆ laaMsgLen

uint8_t laaMsgLen

5.4.5.15 LAA message length

Definition at line 216 of file xran_pkt_cp.h.

◆ laaMsgType

uint8_t laaMsgType

5.4.5.14 LAA message type

Definition at line 217 of file xran_pkt_cp.h.

◆ layerId

uint32_t layerId

5.4.7.3.2 Layer ID for DL transmission

Definition at line 224 of file xran_pkt_cp.h.

◆ mcScaleOffset1

uint32_t mcScaleOffset1

5.4.7.5.3 scaling value for modulation compression

Definition at line 218 of file xran_pkt_cp.h.

◆ mcScaleOffset2

uint32_t mcScaleOffset2

5.4.7.5.3 scaling value for modulation compression

Definition at line 215 of file xran_pkt_cp.h.

◆ mcScaleReMask1

uint32_t mcScaleReMask1

5.4.7.5.1 modulation compression power scale RE mask

Definition at line 220 of file xran_pkt_cp.h.

◆ mcScaleReMask2

uint32_t mcScaleReMask2

5.4.7.5.1 modulation compression power scale RE mask

Definition at line 217 of file xran_pkt_cp.h.

◆ modCompScaler

uint32_t modCompScaler

5.4.7.4.2 modulation compression scaler value

Definition at line 215 of file xran_pkt_cp.h.

◆ numberOfUEs

uint8_t numberOfUEs

5.4.4.11 number of UEs

Definition at line 215 of file xran_pkt_cp.h.

◆ numLayers

uint32_t numLayers

5.4.7.3.4 number of layers used for DL transmission

Definition at line 223 of file xran_pkt_cp.h.

◆ numOfSections

uint8_t numOfSections

5.4.4.8 number of sections

Definition at line 221 of file xran_pkt_cp.h.

◆ numPrbc

uint8_t numPrbc

5.4.5.6 number of contiguous PRBs per control section 0000 0000b = all PRBs

5.4.5.6 number of contiguous PRBs per control section

Definition at line 240 of file xran_pkt_cp.h.

◆ numSymbol

uint32_t numSymbol

5.4.5.7 number of symbols

Definition at line 217 of file xran_pkt_cp.h.

◆ payloadVer

uint32_t payloadVer

5.4.4.2 payload version, should be 1

Definition at line 219 of file xran_pkt_cp.h.

◆ rb

uint8_t rb

5.4.5.2 resource block indicator, XRAN_RBIND_xxx

Definition at line 243 of file xran_pkt_cp.h.

◆ regularizationFactor

uint32_t regularizationFactor

5.4.5.12 regularization Factor

Definition at line 214 of file xran_pkt_cp.h.

◆ reMask

uint32_t reMask

5.4.5.5 resource element mask

Definition at line 218 of file xran_pkt_cp.h.

◆ reserved

uint16_t reserved

Definition at line 216 of file xran_pkt_cp.h.

◆ reserved0

uint32_t reserved0

Definition at line 219 of file xran_pkt_cp.h.

◆ reserved1

uint32_t reserved1

Definition at line 217 of file xran_pkt_cp.h.

◆ reserved2

uint16_t reserved2

Definition at line 233 of file xran_pkt_cp.h.

◆ s0

struct { ... } s0

◆ s1

struct { ... } s1

◆ s3

struct { ... } s3

◆ s5

struct { ... } s5

◆ sectionId

uint32_t sectionId

5.4.5.1 section identifier

Definition at line 244 of file xran_pkt_cp.h.

◆ sectionType

uint8_t sectionType

5.4.4.9 section type

Definition at line 222 of file xran_pkt_cp.h.

◆ slotId

uint32_t slotId

5.4.4.6 slot identifier

Definition at line 215 of file xran_pkt_cp.h.

◆ startPrbc

uint32_t startPrbc

5.4.5.4 starting PRB of control section

Definition at line 241 of file xran_pkt_cp.h.

◆ startPrbch

uint8_t startPrbch

5.4.5.4 starting PRB of control section

Definition at line 217 of file xran_pkt_cp.h.

◆ startPrbcl

uint8_t startPrbcl

5.4.5.4 starting PRB of control section

Definition at line 221 of file xran_pkt_cp.h.

◆ startSymbolId

uint32_t startSymbolId

5.4.4.7 start symbol identifier

Definition at line 214 of file xran_pkt_cp.h.

◆ subframeId

uint32_t subframeId

5.4.4.5 subframe identifier

Definition at line 216 of file xran_pkt_cp.h.

◆ symInc

uint8_t symInc

5.4.5.3 symbol number increment command XRAN_SYMBOLNUMBER_xxxx

Definition at line 242 of file xran_pkt_cp.h.

◆ timeOffset

uint16_t timeOffset

5.4.4.12 time offset

Definition at line 215 of file xran_pkt_cp.h.

◆ txScheme

uint32_t txScheme

5.4.7.3.3 transmission scheme

Definition at line 222 of file xran_pkt_cp.h.

◆ u

union { ... } u

◆ udComp

Definition at line 215 of file xran_pkt_cp.h.

◆ udCompMeth

uint8_t udCompMeth

Compression method, XRAN_COMPMETHOD_xxxx

Definition at line 214 of file xran_pkt_cp.h.

◆ udIqWidth

uint8_t udIqWidth

IQ bit width, 1 ~ 16

Definition at line 215 of file xran_pkt_cp.h.

◆ ueId

uint32_t ueId

5.4.5.10 UE identifier

Definition at line 233 of file xran_pkt_cp.h.

◆ uScs

uint8_t uScs

sub-carrier spacing, XRAN_SCS_xxx

Definition at line 214 of file xran_pkt_cp.h.