o-du/phy: xran_pkt.h Source File

 /******************************************************************************
 *
 *   Copyright (c) 2019 Intel.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 *
 *******************************************************************************/

 /* ORAN-WG4.CUS.0-v01.00 O-RAN Fronthaul Working Group
                          Control, User and Synchronization Plane Specification
 */

 /*
  * Layer common to data and control packets
  */

 #ifndef _XRAN_PKT_H_
 #define _XRAN_PKT_H_

 #ifdef __cplusplus
 extern "C" {
 #endif

 #include <rte_common.h>
 #include <rte_ether.h>
 #include <rte_byteorder.h>

 #define ECPRI_MAX_PAYLOAD_SIZE 65535
 /* XRAN spec: For this encapsulation, either the eCPRI Ethertype or the IEEE 1914.3 Ethertype shall be use */
 #define XRAN_ETHER_TYPE 0xAEFE
 #define XRAN_ECPRI_VER      0x0001
 #define XRAN_PAYLOAD_VER    0x0001
 #define VLAN_ID  0
 #define VLAN_PCP 7
 enum ecpri_msg_type
 {
      ECPRI_IQ_DATA           = 0x00,
      ECPRI_BIT_SEQUENCE      = 0x01, /* msg type is not supported */
      ECPRI_RT_CONTROL_DATA   = 0x02,
      /* Below msg types are not supported */
      ECPRI_GEN_DATA_TRANSFER = 0x03,
      ECPRI_REMOTE_MEM_ACCESS = 0x04,
      ECPRI_DELAY_MEASUREMENT = 0x05,
      ECPRI_REMOTE_RESET      = 0x06,
      ECPRI_EVENT_INDICATION  = 0x07,
      ECPRI_MSG_TYPE_MAX
 };

 struct ecpri_seq_id
 {
     uint8_t seq_id:8;
     uint8_t sub_seq_id:7;
     uint8_t e_bit:1;
 } __rte_packed;


 struct xran_ecpri_cmn_hdr
 {
     uint8_t     ecpri_concat:1;
     uint8_t     ecpri_resv:3;
     uint8_t     ecpri_ver:4;
     uint8_t     ecpri_mesg_type;
     uint16_t    ecpri_payl_size;
 } __rte_packed;

 struct xran_ecpri_hdr
 {
     struct xran_ecpri_cmn_hdr cmnhdr;
     rte_be16_t ecpri_xtc_id;
     struct ecpri_seq_id ecpri_seq_id;
 } __rte_packed;


 enum xran_pkt_dir
 {
      XRAN_DIR_UL  = 0,
      XRAN_DIR_DL  = 1,
      XRAN_DIR_MAX
 };

 struct radio_app_common_hdr
 {
    /* Octet 9 */
    uint8_t filter_id:4;
    uint8_t payl_ver:3;
    uint8_t data_direction:1;
    /* Octet 10 */
    uint8_t frame_id:8;
    /* Octet 11 */
    /* Octet 12 */
    union {
        uint16_t value;
        struct {
            uint16_t symb_id:6;
            uint16_t slot_id:6;
            uint16_t subframe_id:4;
        };
    }sf_slot_sym;

 } __rte_packed;

 struct compression_hdr
 {
     uint8_t ud_iq_width:4;
     uint8_t ud_comp_meth:4;
 } __rte_packed;

 struct xran_pkt_comm_hdr
 {
     struct ether_hdr eth_hdr;
     struct xran_ecpri_hdr ecpri_hdr;
 } __rte_packed;

 #ifdef __cplusplus
 }
 #endif

 #endif
radio_app_common_hdr::data_direction
uint8_t data_direction
Definition: xran_pkt.h:173

+xran_ecpri_cmn_hdr::ecpri_concat
uint8_t ecpri_concat
Definition: xran_pkt.h:115

+ECPRI_BIT_SEQUENCE
Definition: xran_pkt.h:78

+xran_pkt_dir
xran_pkt_dir
Definition: xran_pkt.h:146

+ECPRI_REMOTE_RESET
Definition: xran_pkt.h:85

+ECPRI_DELAY_MEASUREMENT
Definition: xran_pkt.h:84

+radio_app_common_hdr::frame_id
uint8_t frame_id
Definition: xran_pkt.h:176

+ECPRI_RT_CONTROL_DATA
Definition: xran_pkt.h:79

+ecpri_seq_id::seq_id
uint8_t seq_id
Definition: xran_pkt.h:99

+XRAN_DIR_DL
Definition: xran_pkt.h:149

+xran_pkt_comm_hdr
Definition: xran_pkt.h:233

+cmnhdr
struct xran_cp_radioapp_common_header cmnhdr
Definition: xran_pkt_cp.h:214

+xran_ecpri_cmn_hdr::ecpri_ver
uint8_t ecpri_ver
Definition: xran_pkt.h:117

+ECPRI_EVENT_INDICATION
Definition: xran_pkt.h:86

+radio_app_common_hdr::payl_ver
uint8_t payl_ver
Definition: xran_pkt.h:170

+xran_ecpri_hdr
Definition: xran_pkt.h:130

+radio_app_common_hdr::value
uint16_t value
Definition: xran_pkt.h:181

+xran_ecpri_cmn_hdr::ecpri_resv
uint8_t ecpri_resv
Definition: xran_pkt.h:116

+xran_ecpri_cmn_hdr
Definition: xran_pkt.h:113

+radio_app_common_hdr::symb_id
uint16_t symb_id
Definition: xran_pkt.h:183

+ECPRI_REMOTE_MEM_ACCESS
Definition: xran_pkt.h:83

+compression_hdr::ud_iq_width
uint8_t ud_iq_width
Definition: xran_pkt.h:208

+ecpri_seq_id::e_bit
uint8_t e_bit
Definition: xran_pkt.h:101

+ecpri_seq_id::sub_seq_id
uint8_t sub_seq_id
Definition: xran_pkt.h:100

+compression_hdr::ud_comp_meth
uint8_t ud_comp_meth
Definition: xran_pkt.h:213

+__rte_packed
struct ecpri_seq_id __rte_packed

+ecpri_seq_id
Definition: xran_pkt.h:97

+xran_ecpri_hdr::ecpri_xtc_id
rte_be16_t ecpri_xtc_id
Definition: xran_pkt.h:133

+radio_app_common_hdr::slot_id
uint16_t slot_id
Definition: xran_pkt.h:185

+radio_app_common_hdr::subframe_id
uint16_t subframe_id
Definition: xran_pkt.h:189

+radio_app_common_hdr::filter_id
uint8_t filter_id
Definition: xran_pkt.h:165

+XRAN_DIR_MAX
Definition: xran_pkt.h:150

+ECPRI_GEN_DATA_TRANSFER
Definition: xran_pkt.h:82

+ECPRI_MSG_TYPE_MAX
Definition: xran_pkt.h:87

+xran_ecpri_cmn_hdr::ecpri_mesg_type
uint8_t ecpri_mesg_type
Definition: xran_pkt.h:118

+XRAN_DIR_UL
Definition: xran_pkt.h:148

+ECPRI_IQ_DATA
Definition: xran_pkt.h:77

+radio_app_common_hdr
Definition: xran_pkt.h:162

+compression_hdr
Definition: xran_pkt.h:206

+xran_ecpri_cmn_hdr::ecpri_payl_size
uint16_t ecpri_payl_size
Definition: xran_pkt.h:119

+