/*===========================================================================
  Module:		
     IQView_defines.h

  Description:	
     This header file defines names used when extracting results from the IQV 
     tester interface.

  ===========================================================================*/

#ifndef IQVIEW_DEFINES_H
#define IQVIEW_DEFINES_H

/*===========================================================================
  Definitions
  ===========================================================================*/
  
enum IQV_GROUP_ENUM
{
  IQV_GROUP_0,                                        /* Reserved */
  IQV_GROUP_1,                                        /* Reserved */
  IQV_GROUP_FFT,                                      /* Generic FFT Analysis */
  IQV_GROUP_CCDF_ANALYSIS,                            /* CCDF Analysis */
  IQV_GROUP_OFDM_POWER_RAMP,                          /* OFDM Power Ramp Analysis */
  IQV_GROUP_802_11_B_POWER_RAMP,                      /* 802.11 B Power Ramp Analysis */
  IQV_GROUP_SIDE_LOBE,                                /* General Spectrum Analysis, 
                                                         includes 11B side lobe and 11a,g 
                                                         spectrum analysis */
  IQV_GROUP_802_11_B_ANALYSIS,                        /* 802.11 B Analysis */
  IQV_GROUP_OFDM_ANALYSIS,                            /* OFDM Analysis */
  IQV_GROUP_9,                                        /* Reserved */
  IQV_GROUP_WAVE_ANALYSIS,                            /* Wave Analysis */
  IQV_GROUP_CW_ANALYSIS,                              /* Continuous Wave Analysis */
  IQV_GROUP_POWER_ANALYSIS,                           /* Returns RMS Power in dB. */
  IQV_GROUP_13,                                       /* Reserved */
  IQV_GROUP_14,                                       /* Reserved */
  IQV_GROUP_15,                                       /* Reserved */
  IQV_GROUP_16,                                       /* Reserved */
  IQV_GROUP_17,                                       /* Reserved */
  IQV_GROUP_18,                                       /* Reserved */
  IQV_GROUP_MISC_CMD,                                 /* Reserved for IQV_misc_cmd. */
  IQV_LAST_GROUP
};

/*===========================================================================
  Values can be retrieved with the following functions:
  - IQV_result
  - IQV_result_real
  
  Vectors can be retrieved with the following functions:
  - IQV_result_data_real (real part of a vector)
  - IQV_result_data_imag (imaginary part of a vector)
  
  ===========================================================================*/

/*===========================================================================
  Results returned after running IQV_data_analysis of group
  IQV_GROUP_WAVE_ANALYSIS.
  ===========================================================================*/
/* DC DC value. Value is returned. */
#define IQV_RES_DC_DC               "DC.DC"           

/* DC RMS value. Value is returned. */
#define IQV_RES_DC_RMS              "DC.rms"  

/* DC Minimum value. Value is returned. */
#define IQV_RES_DC_MIN              "DC.min"          

/* DC Maximum value. Value is returned. */
#define IQV_RES_DC_MAX              "DC.max"         

/* DC Peak to Peak value. Value is returned. */
#define IQV_RES_DC_PP               "DC.pp"          

/* DC RMS for I Channel. Value is returned. */
#define IQV_RES_DC_RMS_I            "DC.rms_I"       

/* DC RMS for Q Channel. Value is returned. */
#define IQV_RES_DC_RMS_Q            "DC.rms_Q"       

/* AC DC value. Value is returned. */
#define IQV_RES_AC_DC               "AC.DC"           

/* AC RMS value. Value is returned. */
#define IQV_RES_AC_RMS              "AC.rms"          

/* AC Minimum value. Value is returned. */
#define IQV_RES_AC_MIN              "AC.min"          

/* AC Maximum value. Value is returned. */
#define IQV_RES_AC_MAX              "AC.max"         

/* AC Peak to Peak value. Value is returned. */
#define IQV_RES_AC_PP               "AC.pp"          

/* AC RMS for I Channel. Value is returned. */
#define IQV_RES_AC_RMS_I            "AC.rms_I"       

/* AC RMS for Q Channel. Value is returned. */
#define IQV_RES_AC_RMS_Q            "AC.rms_Q"       

/* AC RMS value in dB. Value is returned. */
#define IQV_RES_RMS_DB              "rms_db"         

/*===========================================================================
  Results returned after running IQV_data_analysis specifically for group
  IQV_GROUP_OFDM_ANALYSIS.
  ===========================================================================*/

/* EVM for data part of frame. Value is returned. */
#define IQV_RES_EVM_DATA            "evm.data"		  

/* EVM for pilot part of frame. Value is returned. */
#define IQV_RES_EVM_PILOT           "evm.pilot"		  

/* The PSDU data. 0/1 values. Includes the MAC Header 
and the FCS, if present. Real vector is returned. */								
#define IQV_RES_OFDM_PSDU_RX        "ofdm.psdu_rx"	

/* Provides the approximate starting locations of each packet detected in 
the input data. If no packet detected, this is an empty vector. 
Real vector is returned. */
#define IQV_RES_OFDM_START_POINTERS "ofdm.start_pointers"   

/* Provides the approximate end location of each packet pointed to in 
IQV_RES_OFDM_START_POINTERS. In this release this vector is always empty. 
Real vector is returned. */
#define IQV_RES_OFDM_STOP_POINTERS  "ofdm.stop_pointers"    

/* 64 element complex vector that represents the FFT output of the 2 long 
symbols in the PLCP pre-amble of the OFDM signal. 
Real vector is returned. */
#define IQV_RES_OFDM_HHEST          "ofdm.HHest"	

/* Single element double vector */
/* 1 = PSDU CRC Check Failed, 0 = PSDU CRC Check Passed */
#define IQV_RES_OFDM_PSDU_CRC_FAIL  "ofdm.more_res.psdu_crc_fail"

/* Single element double vector */
/* 1 = PLCP CRC Check Passed, 0 = PLCP CRC Check Failed */
#define IQV_RES_OFDM_PLCP_CRC_OK    "ofdm.more_res.PLCP.crcok"

/* Double vector */
/* PLCP (binary) data as 1/0s. */
#define IQV_RES_OFDM_PLCP_DATA      "ofdm.more_res.PLCP.PLCP_bin"

/* Single element double vector */
/* Data rate in Mbps */
#define IQV_RES_OFDM_DATA_RATE_MBPS "ofdm.more_res.PLCP.Data_rate_Mbps"

/* Single element double vector */
/* Coding Rate */
#define IQV_RES_OFDM_CODING_RATE    "ofdm.more_res.PLCP.Rr"

/* Single element double vector */
/* Number of symbols */
#define IQV_RES_OFDM_NUMBER_SYMBOLS "ofdm.more_res.PLCP.Nspp"

/* Single element double vector */
/* Number of bytes in PSDU */
#define IQV_RES_OFDM_RX_LENGTH      "ofdm.more_res.PLCP.RX_length_oct"

/*===========================================================================
  Results returned after running IQV_data_analysis specifically for group
  IQV_GROUP_802_11_B_ANALYSIS.
  ===========================================================================*/

/* EVM peak value. Value is returned. */
#define IQV_RES_EVM_PEAK            "evm.pk"		  

/* The PSDU data. 0/1 values. Includes the MAC Header and the 
FCS, if present. Real vector is returned. */
#define IQV_RES_11B_PSDU_RX			"b11.psdu_rx"	  

/* Provides the approximate starting locations of each packet detected in the 
input data. If no packet detected, this is an empty vector. 
Real vector is returned. */
#define IQV_RES_11B_START_POINTERS	"b11.start_pointers"    

/* Provides the approximate end location of each packet pointed to in 
IQV_RES_OFDM_START_POINTERS. 
Real vector is returned. */
#define IQV_RES_11B_STOP_POINTERS	"b11.stop_pointers"     

/* Provides the start and end pointer for the packet selected by the 
analysis program for analysis. 
Real vector is returned. */
#define IQV_RES_11B_SELECT			"b11.select"	  

/* Represents the  values of the In-phase receiver channel at 19 samples 
per chip. Can be used to plot the eye-diagram by plotting samples 
(0:18)+n*19 on the same plot. Real vector is returned. */
#define IQV_RES_EYE_REAL			"b11.eye_real"	  

/* Same as IQV_RES_EYE_REAL, except for the Quadrature receiver channel. 
Real vector is returned. */
#define IQV_RES_EYE_IMAG			"b11.eye_imag"	  

/* Scrambler Initialization. 7 element (or empty) Real vector is returned. */
#define IQV_RES_SCRAMBLER_INIT      "b11.scrambler_init"

/* Double vector */
/* PLCP (binary) data as 1/0s. */
#define IQV_RES_11B_PLCP_DATA       "b11.PLCP_info.raw"

/* Single element double vector */
/* Bit Rate, see 802.11b standard */
#define IQV_RES_11B_BIT_RATE        "b11.PLCP_info.bit_rate"

/* Single element double vector */
/* Number of bytes in PSDU */
#define IQV_RES_11B_RX_LENGTH       "b11.PLCP_info.PSDU_length_oct"

/* Single element double vector */
/* Mod Type, see 802.11b standard */
#define IQV_RES_11B_MOD_TYPE        "b11.PLCP_info.mod_type"

/* Single element double vector */
/* Locked Clock, see 802.11b standard */
#define IQV_RES_11B_LOCKED_CLOCK    "b11.PLCP_info.locked_clock"

/* Single element double vector */
/* 1 = PLCP CRC Check Failed, 0 = PLCP CRC Check Passes */
#define IQV_RES_11B_PLCP_CRC_FAIL   "b11.PLCP_info.crc_fail"

/* Single element double vector */
/* 1 = PSDU CRC Check Failed, 0 = PSDU CRC Check Passes */
#define IQV_RES_11B_PSDU_CRC_FAIL   "b11.meas_out.crc_data_fail"

/* Single element double vector */
/* 1 = Long Preamble, 0 = Short Preamble */
#define IQV_RES_11B_LONG_PREAMBLE   "b11.db_stuff.long_preamble_flag"


/*===========================================================================
  Results returned after running IQV_data_analysis of groups
  IQV_GROUP_OFDM_ANALYSIS or IQV_GROUP_802_11_B_ANALYSIS.

  The power results in this section are also returned after BlueTooth Analysis.  
  ===========================================================================*/

 /* EVM for entire frame. Value is returned. */
#define IQV_RES_EVM_ALL             "evm.all"        

/* Frequency Error. Value is returned. */
#define IQV_RES_FREQ_ERR            "signal.freqerr"  
                                                      
/* Symbol Clock Error. Value is returned. */                                                      
#define IQV_RES_SYMBOL_CLOCK_ERR    "signal.symclockerr"

/* Frequency RMS Phase Noise. Value is returned. */
#define IQV_RES_RMS_PHASE_NOISE     "signal.rmspn"    

/* IQ Match Amplitude Error. Value is returned. */
#define IQV_RES_IQ_MATCH_AMP        "iqmatch.amp"     

/* IQ Match Amplitude Error in dB. Value is returned. */
#define IQV_RES_IQ_MATCH_AMP_DB      "iqmatch.amp_dB"