IEEE802_11_HEPhy.h

/************************************************************************************
* Copyright (C) 2023                                                               *
* TETCOS, Bangalore. India                                                         *
*                                                                                  *
* Tetcos owns the intellectual property rights in the Product and its content.     *
* The copying, redistribution, reselling or publication of any or all of the       *
* Product or its content without express prior written consent of Tetcos is        *
* prohibited. Ownership and / or any other right relating to the software and all  *
* intellectual property rights therein shall remain at all times with Tetcos.      *
*                                                                                  *
* Author: HESUOFDM@IITM                                               *
*                                                                                  *
* ---------------------------------------------------------------------------------*/
#ifndef _NETSIM_IEEE802_11AX_PHY_H_
#define _NETSIM_IEEE802_11AX_PHY_H_
#ifdef  __cplusplus
extern "C" {
#endif
 
    typedef enum enum_802_11_HE_FORMAT
    {
        HE_SU,
        ///< We are considered this method only.
    }HE_FORMAT;
 
 
    typedef enum enum_802_11_HE_CH_BANDWIDTH
    {
        HE_CBW20,      ///< 20 MHz 
        HE_CBW40,      ///< 40 MHz
        HE_CBW80,      ///< 80 MHz
        HE_CBW160,     ///< 160 MHz
    }HE_CH_BANDWIDTH;
 
 
 
    /// Guard interval is used in the transmission of the packet. 
    typedef enum enum_802_11_HE_GI_TYPE 
    {   
        HE_GI_3200NS, /// for 3200ns
        HE_GI_1600NS,       /// for 1600ns
        HE_GI_800NS,    /// for 800ns
    }HE_GI_TYPE;
 
 
 
    /// Table 27-13 Timing-related constants, Table 27-16 Frequently used parameters, Table 27-14 Subcarrier allocation related constants and Table 27-1 TXVECTOR and RXVECTOR parameters from IEEE Std 802.11 - 2024.pdf. Those fields that are relevant for HE SU PPDU have been included.
    typedef struct stru_802_11_OFDM_MIMO_HE_Parameters
    {
        double dRxSensitivity;
        PHY_MODULATION modulation;
        double dCodingRate;
        double dDataRate;
        int nNBPSC;
        int nNCBPS;
        int nNDBPS;
 
        int nChannelBandwidth;  // 20MHz or 40MHz or 80Mhz or 160Mhz
        int nFFT;           ///< FFT length
        int nNSD;           ///< NSD Number of data subcarriers per frequency segment
        int nNSP;           ///< NSP Number of pilot subcarriers per frequency segement
        int nNST;           ///< NST Total number of subcarriers per frequency segment
        int nNSR;           ///< NSR Highest data subcarrier index per frequency segment
        int nNDC;           ///< Number of Null Subcarriers at DC per segment
        
 
        double dDeltaF_PreHE; ///< dSubcarrierFrequencySpacing for Pre HE;  //312.5 kHz
        double dDeltaF;      ///<dSubcarrierFrequencySpacing; // 78.125 khz
        double dTDFT_PreHE; ///< IDFT/DFT period for pre HE 3.2
        double dTDFT;      ///< IDFT/DFT period 12.8
        double dTGI_PreHE;    ///< Guard interval duration 0.8 = Pre HE TDFT/4   
        double dTGIL_LTF;   ///< Guard interval duration for Legacy LTF
        double dTGI1;       ///< Base Guard interval duration for data field 0.8 us
        double dTGI2;      ///< Double guard interval 1.6 
        double dTGI4;      ///< Quadruple guard interval 3.2
        double dTGI_HE_LTF; ///< Guard interval duration for HE LTF
        double dTGI;        ///< Guard interval duration for Data Field
        double dTSYM1;        ///< TSYM: Symbol interval 13.6 =  TDFT + TGI  
        double dTSYM2;        ///< TSYM: Symbol interval 14.4 =  TDFT + TGI  
        double dTSYM4;        ///< TSYM: Symbol interval 16 =  TDFT + TGI  
        double dTSYM;      ///< OFDM symbol interval for HE PPDU field
        int nTL_STF;     ///< Non-HT short training sequence duration 8 = 10*TDFT/4 
        int nTL_LTF;     ///< Non-HT long training field duration 8 =2 * TDFT + TGI2  
        int nTL_SIG;     ///< Non-HT SIGNAL field duration 4   
        int nTRL_SIG;       ///< Repeated non HT signal field duration 4
        int nTHE_SIGA;     ///< HE SIGNAL A field duration 8 = 2 * 4 
        int nTHE_SIGB;         ///< HE SIGNAL B field duration TDFT_PreHE + TGI_PreHE = 3.2 + 0.8 = 4
        int nTHE_STF_NT; ///< HE short training field duration for HE SU PPDU 4 = 5 * 0.8
        double nTHE_LTF_1x;  ///< Duration of each 1x HE LTF OFDM without GI 3.2
        double nTHE_LTF_2x;  ///< Duration of each 2x HE LTF OFDM without GI 6.4
        double nTHE_LTF_4x;  ///< Duration of each 4x HE LTF OFDM without GI 12.8
        double nTHE_LTF;        ///< Duration of each OFDM Symbol without GI in HE LTF
        double nTHE_LTF_SYM;    ///< Duration of each OFDM Symbol with GI in HE LTF THE_LTF + TGI_HE_LTF
        int nNSERVICE;
        int nNTAIL;
        int nTSYML;       ///< OFDM symbol duration including GI prior to HE STF 4
        int nTPE;
        
 
        // Table 27-1 TXVECTOR and RXVECTOR parameters page 4139 - IEEE Std 802.11 - 2024.pdf
        HE_FORMAT nFormat;
        int nNonHtModulation;
        int nL_DATARATE;
        int nL_LENGTH;
        int nN_TX;  
        int nEXPANSION_MAT;
        int nCHAN_MAT;
        int nDelta_SNR;
        int nRCPI;
        int nSNR;
        int nCQI;
        int nNO_SIG_EXTN;   
        FEC_CODING nFEC_CODING;
        int nLDPC_EXTRA_SYMBOL;
        int nSTBC;
        HE_GI_TYPE nGI_TYPE;
        int nTXPWR_LEVEL_INDEX;
        int nRSSI;
        int nRSSI_LEGACY;
        int nMCS;
        int nDCM;
        int nREC_MCS;
        HE_CH_BANDWIDTH nCH_BANDWIDTH;
        int nAPEP_LENGTH;
        int nPSDU_LENGTH;
        int nNUM_STS;
        int nTXOP_DURATION;
        int nSPATIAL_REUSE;
        int nDOPPLER;
        int nRU_ALLOCATION;
        int nBEAMFORMED;
        int nHE_LTF_TYPE;
        int nNOMINAL_PACKET_PADDING;
        int nBEAM_CHANGE;
        int nBSS_COLOR;
        int nUPLINK_FLAG;
        int nSCRAMBLER_INITIAL_VALUE;
        int nTRIGGER_RESPONDING;
        int nMIDAMBLE_PERIODICITY;
        int nPOWER_BOOST_FACTOR;
        int nTIME_OF_DEPARTURE_REQUESTED;
        int nLTF_KEY;
        int nLTF_IV;
        int nLTF_REP;
        int nRANGING_FLAG;
        int nSECURE_LTF_FLAG;
        int nTX_WINDOW_FLAG;
        SMOOTHING nSMOOTHING;
        HT_SOUNDING nSOUNDING;
        AGGREGATION nAGGREGATION;
    }IEEE802_11_OFDM_MIMO_HE;
 
 
#ifdef  __cplusplus
}
#endif
#endif //_NETSIM_IEEE802_11AX_PHY_H_