X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fstructradio__app__common__hdr.html;fp=docs%2FAPI%2Fstructradio__app__common__hdr.html;h=011095543ea52be92638aaf2101a5092af4889cf;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/structradio__app__common__hdr.html b/docs/API/structradio__app__common__hdr.html new file mode 100644 index 0000000..0110955 --- /dev/null +++ b/docs/API/structradio__app__common__hdr.html @@ -0,0 +1,266 @@ + + + + + + + +o-du/phy: radio_app_common_hdr Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Data Fields
+
+
radio_app_common_hdr Struct Reference
XRAN Packet definitions and functions
+
+
+ +

#include <xran_pkt.h>

+
+Collaboration diagram for radio_app_common_hdr:
+
+
Collaboration graph
+
+ + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

uint8_t filter_id:4
 
uint8_t payl_ver:3
 
uint8_t data_direction:1
 
uint8_t frame_id:8
 
union {
   uint16_t   value
 
   struct {
      uint16_t   symb_id:6
 
      uint16_t   slot_id:6
 
      uint16_t   subframe_id:4
 
   } 
 
} sf_slot_sym
 
+

Detailed Description

+

Structure holds components of radio application header 5.4.4 Coding of Information Elements - Application Layer, Common for U-plane as per 6.3.2 DL/UL Data

+ +

Definition at line 162 of file xran_pkt.h.

+

Field Documentation

+ +

◆ data_direction

+ +
+
+ + + + +
uint8_t data_direction
+
+

This parameter indicates the gNB data direction.

+ +

Definition at line 173 of file xran_pkt.h.

+ +
+
+ +

◆ filter_id

+ +
+
+ + + + +
uint8_t filter_id
+
+

This parameter defines an index to the channel filter to be used between IQ data and air interface, both in DL and UL. For most physical channels filterIndex =0000b is used which indexes the standard channel filter, e.g. 100MHz channel filter for 100MHz nominal carrier bandwidth. (see 5.4.4.3 for more)

+ +

Definition at line 165 of file xran_pkt.h.

+ +
+
+ +

◆ frame_id

+ +
+
+ + + + +
uint8_t frame_id
+
+

This parameter is a counter for 10 ms frames (wrapping period 2.56 seconds)

+ +

Definition at line 176 of file xran_pkt.h.

+ +
+
+ +

◆ payl_ver

+ +
+
+ + + + +
uint8_t payl_ver
+
+

This parameter defines the payload protocol version valid for the following IEs in the application layer. In this version of the specification payloadVersion=001b shall be used.

+ +

Definition at line 170 of file xran_pkt.h.

+ +
+
+ +

◆ sf_slot_sym

+ +
+
+ + + + +
union { ... } sf_slot_sym
+
+ +
+
+ +

◆ slot_id

+ +
+
+ + + + +
uint16_t slot_id
+
+

This parameter is the slot number within a 1ms sub-frame. All slots in one sub-frame are counted by this parameter, slotId running from 0 to Nslot-1. In this version of the specification the maximum Nslot=16, All other values of the 6 bits are reserved for future use.

+ +

Definition at line 185 of file xran_pkt.h.

+ +
+
+ +

◆ subframe_id

+ +
+
+ + + + +
uint16_t subframe_id
+
+

This parameter is a counter for 1 ms sub-frames within 10ms frame.

+ +

Definition at line 189 of file xran_pkt.h.

+ +
+
+ +

◆ symb_id

+ +
+
+ + + + +
uint16_t symb_id
+
+

This parameter identifies the first symbol number within slot, to which the information of this message is applies.

+ +

Definition at line 183 of file xran_pkt.h.

+ +
+
+ +

◆ value

+ +
+
+ + + + +
uint16_t value
+
+ +

Definition at line 181 of file xran_pkt.h.

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.13 +
+ +