xran_pkt_cp.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_CP_H_
#define _XRAN_PKT_CP_H_

#ifdef __cplusplus
extern "C" {
#endif


/**********************************************************************
 * Common structures for C/U-plane
 **********************************************************************/
struct xran_radioapp_udComp_header {
    uint8_t     udCompMeth:4;           
    uint8_t     udIqWidth:4;            
    } __attribute__((__packed__));


/**********************************************************************
 * Definition of C-Plane Protocol 5.4
 **********************************************************************/
struct xran_cp_radioapp_common_header {     /* 6bytes, first 4bytes need the conversion for byte order */
    uint32_t    startSymbolId:6;        
    uint32_t    slotId:6;               
    uint32_t    subframeId:4;           
    uint32_t    frameId:8;              
    uint32_t    filterIndex:4;          
    uint32_t    payloadVer:3;           
    uint32_t    dataDirection:1;        
    uint8_t     numOfSections;          
    uint8_t     sectionType;            
    } __attribute__((__packed__));

struct xran_cp_radioapp_frameStructure {
    uint8_t     uScs:4;                 
    uint8_t     fftSize:4;              
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_header {    /* 8bytes, need the conversion for byte order */
    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:8;              
    uint32_t    startPrbc:10;           
    uint32_t    symInc:1;               
    uint32_t    rb:1;                   
    uint32_t    sectionId:12;           
    } __attribute__((__packed__));


struct xran_cp_radioapp_section_ext_hdr {
    /* 12 bytes, need to convert byte order for two parts respectively
     *  - 2 and 8 bytes, reserved1 would be OK if it is zero
     */
    uint16_t     extLen:8;          
    uint16_t     extType:7;         
    uint16_t     ef:1;              
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_ext1 {
    /* variable length, need to be careful to convert byte order
     *   - does not need to convert first 3 bytes */
    uint8_t     extType:7;          
    uint8_t     ef:1;               
    uint8_t     extLen;             
    /* bfwCompHdr */
    uint8_t     bfwCompMeth:4;      
    uint8_t     bfwIqWidth:4;       
    /*
     *
     *
     * bfwCompParam
     * (bfwI,  bfwQ)+
     *    ......
     * zero padding for 4-byte alignment
     */
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_ext2 {
    /* variable length, need to be careful to convert byte order
     *   - first 4 bytes can be converted at once
     */
    uint32_t    bfZe3ddWidth:3;     
    uint32_t    bfAz3ddWidth:3;     
    uint32_t    bfaCompResv1:2;
    uint32_t    bfZePtWidth:3;      
    uint32_t    bfAzPtWidth:3;      
    uint32_t    bfaCompResv0:2;
    uint32_t    extLen:8;           
    uint32_t    extType:7;          
    uint32_t    ef:1;               
    /*
     * would be better to use bit manipulation directly to add these parameters
     *
     * bfAzPt: var by bfAzPtWidth
     * bfZePt: var by bfZePtWidth
     * bfAz3dd: var by bfAz3ddWidth
     * bfZe3dd: var by bfZe3ddWidth
     * bfAzSI:5 (including zero-padding for unused bits)
     * bfZeSI:3
     * padding for 4-byte alignment
     *
     */
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_ext3_first {
    /* 16 bytes, need to convert byte order for two parts
     *   - 8 / 8 bytes
     */
    uint32_t    reserved1:8;
    uint32_t    crsSymNum:4;        
    uint32_t    reserved0:3;
    uint32_t    crsShift:1;         
    uint32_t    crsReMask:12;       
    uint32_t    txScheme:4;         
    uint32_t    numLayers:4;        
    uint32_t    layerId:4;          
    uint32_t    codebookIndex:8;    
    uint32_t    extLen:8;           
    uint32_t    extType:7;          
    uint32_t    ef:1;               
    uint16_t    beamIdAP3;          
    uint16_t    beamIdAP2;          
    uint16_t    beamIdAP1;          
    uint16_t    reserved2;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_ext3_non_first {
    /* 4 bytes, need to convert byte order at once */
    uint32_t    numLayers:4;        
    uint32_t    layerId:4;          
    uint32_t    codebookIndex:8;    
    uint32_t    extLen:8;           
    uint32_t    extType:7;          
    uint32_t    ef:1;               
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_ext4 {
    /* 4 bytes, need to convert byte order at once */
    uint32_t    modCompScaler:15;   
    uint32_t    csf:1;              
    uint32_t    extLen:8;           
    uint32_t    extType:7;          
    uint32_t    ef:1;               
    } __attribute__((__packed__));

#if 0

struct xran_cp_radioapp_section_ext5_1 {
    /* 8 bytes, need to convert byte order at once */
    uint32_t    reserved:20;
    uint32_t    mcScaleOffset:15;   
    uint32_t    csf:1;              
    uint32_t    mcScaleReMask:12;   
    uint32_t    extLen:8;           
    uint32_t    extType:7;          
    uint32_t    ef:1;               
    } __attribute__((__packed__));

struct xran_cp_radioapp_section_ext5_2 {
    /* 12 bytes, need to convert byte order for two parts respectively
     *  - 2 and 8 bytes, reserved1 would be OK if it is zero
     */
    uint16_t     extLen:8;          
    uint16_t     extType:7;         
    uint16_t     ef:1;              
    uint32_t    reserved0:8;
    uint32_t    mcScaleOffset2:15;  
    uint32_t    csf2:1;             
    uint32_t    mcScaleReMask2:12;  
    uint32_t    mcScaleOffset1:15;  
    uint32_t    csf1:1;             
    uint32_t    mcScaleReMask1:12;  
    uint16_t    reserved1;
    } __attribute__((__packed__));
#endif

struct xran_cp_radioapp_section_ext5 {
    uint32_t    reserved0:8;
    uint32_t    mcScaleOffset2:15;  
    uint32_t    csf2:1;             
    uint32_t    mcScaleReMask2:12;  
    uint32_t    mcScaleOffset1:15;  
    uint32_t    csf1:1;             
    uint32_t    mcScaleReMask1:12;  
    } __attribute__((__packed__));

/**********************************************************
 * Scheduling and Beam-forming Commands 5.4.2
 **********************************************************/
struct xran_cp_radioapp_section0_header {   // 12bytes (6+2+1+2+1)
    struct xran_cp_radioapp_common_header cmnhdr;
    uint16_t    timeOffset;             
    struct xran_cp_radioapp_frameStructure  frameStructure;
    uint16_t    cpLength;               
    uint8_t     reserved;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section0 {          // 8bytes (4+4)
    struct xran_cp_radioapp_section_header hdr;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section1_header {   // 8bytes (6+1+1)
    struct xran_cp_radioapp_common_header cmnhdr;
    struct xran_radioapp_udComp_header udComp;
    uint8_t     reserved;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section1 {          // 8bytes (4+4)
    struct xran_cp_radioapp_section_header hdr;

    // section extensions               // 5.4.6 & 5.4.7
    //  .........
    } __attribute__((__packed__));

struct xran_cp_radioapp_section3_header {   // 12bytes (6+2+1+2+1)
    struct xran_cp_radioapp_common_header cmnhdr;
    uint16_t    timeOffset;             
    struct xran_cp_radioapp_frameStructure  frameStructure;
    uint16_t    cpLength;               
    struct xran_radioapp_udComp_header udComp;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section3 {          // 12bytes (4+4+4)
    struct xran_cp_radioapp_section_header hdr;
    uint32_t    freqOffset:24;          
    uint32_t    reserved:8;

    // section extensions               // 5.4.6 & 5.4.7
    //  .........
    } __attribute__((__packed__));

struct xran_cp_radioapp_section5_header {   // 8bytes (6+1+1)
    struct xran_cp_radioapp_common_header cmnhdr;
    struct xran_radioapp_udComp_header udComp;
    uint8_t     reserved;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section5 {
    struct xran_cp_radioapp_section_header hdr;

    // section extensions               // 5.4.6 & 5.4.7
    //  .........
    } __attribute__((__packed__));

struct xran_cp_radioapp_section6_header {   // 8bytes (6+1+1)
    struct xran_cp_radioapp_common_header cmnhdr;
    uint8_t     numberOfUEs;            
    uint8_t     reserved;
    } __attribute__((__packed__));

struct xran_cp_radioapp_section6 {
    uint32_t    regularizationFactor:16;
    uint32_t    ueId:15;                
    uint32_t    ef:1;                   
    uint8_t     startPrbch:2;           
    uint8_t     symInc:1;               
    uint8_t     rb:1;                   
    uint8_t     reserved:4;
    uint8_t     startPrbcl:8;           
    uint8_t     numPrbc:8;              
    // ciIQsamples start from here      // 5.4.5.13 channel information I and Q values
    //  .........
    //
    // section extensions               // 5.4.6 & 5.4.7
    //  .........
    } __attribute__((__packed__));

struct xran_cp_radioapp_section7_header {
    struct xran_cp_radioapp_common_header cmnhdr;
    uint16_t    reserved;
    uint8_t     laaMsgLen:4;            
    uint8_t     laaMsgType:4;           
    // Payload start from here          // 5.4.5.16 ~ 5.4.5.32
    } __attribute__((__packed__));

#ifdef __cplusplus
}
#endif

#endif  /* _XRAN_PKT_CP_H_ */