xran_pkt_up.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.
*
*******************************************************************************/

#ifndef _XRAN_PKT_UP_H_
#define _XRAN_PKT_UP_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "xran_pkt.h"

#define IQ_PAIR_NUM_IN_RB 12
#define MAX_DATA_SECTIONS_NUM 273
#define MAX_IQ_BIT_WIDTH 16

/* currently library supports I and Q sizes of 8 and 16 bits each */
#define IQ_BITS MAX_IQ_BIT_WIDTH

/*
 * Structure holding data section header fields
 * It is repeated for every section ID in xRAN packet
 */

struct data_section_hdr {
    union {
        uint32_t all_bits;
        struct {
            uint32_t     num_prbu:8;    
            uint32_t     start_prbu:10; 
            uint32_t     sym_inc:1;     
            uint32_t     rb:1;          
            uint32_t     sect_id:12;    
        };
    }fields;
} __rte_packed;


/*
 ******************************************************************************
 * @ingroup xran_up_pkt
 *
 * @description
 *       Structure holds compression header structure and field reserved for future use.
 *       reserved goes always with udCompHdr in u-plane pkt
 *       U-plane as per 6.3.2   DL/UL Data
 *****************************************************************************/
struct data_section_compression_hdr
{
    struct compression_hdr ud_comp_hdr;
    uint8_t rsrvd; 
    /* TODO: support for Block Floating Point compression */
    /* udCompMeth  0000b = no compression   absent*/
};

/*
 ******************************************************************************
 * @ingroup xran_up_pkt
 *
 * @description
 *       Structure holds the compression parameters by the compression header.
 *       may not be present by udCompMeth in 6.3.3.13
 *****************************************************************************/
union compression_params {
    struct block_fl_point {
        uint8_t exponent:4;
        uint8_t reserved:4;
        } blockFlPoint;
    struct block_scaling {
        uint8_t sblockScaler;
        } blockScaling;
    struct u_law {
        uint8_t compShift:4;
        uint8_t compBitWidth:4;
        } uLaw;
} __rte_packed;


/*
 ******************************************************************************
 * @ingroup xran_up_pkt
 *
 * @description
 *       Structure holds an IQ sample pair
 *       U-plane as per 6.3.2   DL/UL Data
 *       Each bit field size is defined with IQ_BITS macro
 *       Currently supported I and Q sizes are 8 and 16 bits
 *****************************************************************************/
struct rb_map
{
    int16_t i_sample:IQ_BITS; 
    int16_t q_sample:IQ_BITS; 
} __rte_packed;

struct xran_up_pkt_hdr
{
    struct xran_ecpri_hdr ecpri_hdr; 
    struct radio_app_common_hdr app_hdr; 
    struct data_section_hdr data_sec_hdr;
} __rte_packed;


struct eth_xran_up_pkt_hdr
{
    struct ether_hdr eth_hdr;
    struct xran_up_pkt_hdr xran_hdr;
}__rte_packed;

#ifdef __cplusplus
}
#endif

#endif