xran_pkt.h

Go to the documentation of this 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