Data Structures
Here are the data structures with brief descriptions:
 CrlAdcBitFormat_tADC Bit and ADC Output format Configuration
 CrlAdcOutCfg_tADC format and payload justification Configuration
 CrlAdvFrameCfg_tAdvance Frame Sequence config API parameters rlAdvFrameCfg, 148 bytes
 CrlAdvFrameDataCfg_tAdvance Frame data config API parameters. This strcutre is only applicable when mmWaveLink instance is running on External Host and connected to AWR1243 device
 CrlAdvFrameSeqCfg_tAdvance Frame Sequence config API parameters rlAdvFrameCfg, 148 bytes
 CrlAllTxBallBreakMonCfg_tTX ballbreak monitoring configuration
 CrlAllTxBpmMonConf_tTX BPM monitoring configuration
 CrlAllTxIntAnaSignalsMonConf_tInternal signals in the TX path monitoring configuration
 CrlAllTxPowMonConf_tTX power monitoring configuration
 CrlAnalogFaultReportData_tAnalog fault strucure for event RL_RF_AE_ANALOG_FAULT_SB
 CrlAsyncEvt_tRHCP Async Event structure
 CrlBpmChirpCfg_tBinary phase modulation common configuration
 CrlBpmCommonCfg_tBinary phase modulation common configuration
 CrlBpmKCounterSel_tBinary phase modulation KCounter configuration
 CrlBpmModeCfg_tBinary phase modulation mode configuration
 CrlBssEsmFault_tStructure to hold the BSS ESM Fault data strucutre for event RL_RF_AE_ESMFAULT_SB
 CrlCalDataGetCfg_tGet calibration data configuration structure
 CrlCalDataStore_tCalibration data which application will receive from radarSS and will feed in to the Device in next power up to avoid calibration
 CrlCalibrationData_tStructure to store all Calibration data chunks which device provides in response of rlRfCalibDataStore API. Applcation needs to provide same structure to rlRfCalibDataRestore API to restore calibration data to the device
 CrlCalMonTimingErrorReportData_tCalibration monitoring timing error data for event RL_RF_AE_MON_TIMING_FAIL_REPORT_SB
 CrlChanCfg_tRx/Tx Channel Configuration
 CrlChirpCfg_tChirp config API parameters. This structure contains fine dithering to coarse profile defined in rlProfileCfg_t. It also includes the selection of Transmitter and binary phase modulation for a chirp.
 CrlChirpPhShiftPerTx_tDynamic per chirp phase shifter configuration for each TX
 CrlChirpRow_tChirp row configuration, radarSS stores each chirp config in memory in 3 rows
 CrlClientCbs_tMmWaveLink client callback structure
 CrlCmdParserCbs_tMmWaveLink callback functions for Command parser
 CrlComDevInx_tCommunication handle and device-index for deifferent devices connected to Host
 CrlComIfCbs_tCommunication interface(SPI, MailBox, UART etc) callback functions
 CrlContModeCfg_tContinous Mode config API parameters
 CrlContModeEn_tContinous Mode Enable API parameters
 CrlCpuFault_tStructure to hold the MSS/radarSS CPU Fault data strucutre for event RL_DEV_AE_MSS_CPUFAULT_SB and RL_RF_AE_CPUFAULT_SB
 CrlCrcCbs_tMmWaveLink CRC callback function
 CrlDbgCb_tMmWaveLink debug callback structure
 CrlDevContStreamingModeCfg_tContinous streaming mode configuration
 CrlDevCsi2Cfg_tCSI2 configuration
 CrlDevDataFmtCfg_tMmwave radar data format config
 CrlDevDataPathCfg_tMmwave radar data path config
 CrlDevDataPathClkCfg_tDataPath clock configuration
 CrlDevHsiCfg_tMmwave radar high speed Data path configuraiton
 CrlDevHsiClk_tMmwave radar high speed clock configuration
 CrlDeviceCtrlCbs_tMmWaveLink Device Control, Interrupt callback functions
 CrlDevLaneEnable_tMmwave radar data path lane enable
 CrlDevLvdsLaneCfg_tLVDS Lane configuration
 CrlDfeRxStatReport_tThe DFE Statistics for Rx Channel for particular profile
 CrlDfeStatReport_tThe DFE Statistics Report Contents
 CrlDigLatentFaultReportData_tLatent fault digital monitoring status data for event RL_RF_AE_DIG_LATENTFAULT_REPORT_AE_SB
 CrlDigMonPeriodicConf_tDigital monitoring latent fault reporting configuration
 CrlDigPeriodicReportData_tThis async event is sent periodically to indicate the status of periodic digital monitoring tests.Event: RL_RF_AE_MON_DIG_PERIODIC_REPORT_SB
 CrlDriverData_tMmwave radar Driver Global Structure
 CrlDriverMsg_tMmwave radar Driver Payload
 CrlDriverOpcode_tMmwave radar Driver Opcode
 CrlDriverRespMsg_tThe passing message type of Tx task of API module
 CrlDualClkCompMonConf_tInternal signals for DCC based clock monitoring configuration
 CrlDynChirpCfg_tDynamic chirp configuration for 16 chirp configurations
 CrlDynChirpEnCfg_tDynamic chirp enable configuration
 CrlDynPerChirpPhShftCfg_tDynamic per chirp phase shifter configuration
 CrlDynPwrSave_tDynamic power saving API parameters
 CrlErrorResp_tMmWaveLink API Error Sub block structure
 CrlEventCbs_tMmWaveLink Asynchronous event callback function
 CrlExtAnaSignalsMonConf_tExternal analog signals monitoring configuration
 CrlFileData_tFile Dowload data structure
 CrlFixPayloadSb_tRHCP Payload Structure
 CrlFrameApplyCfg_tFrame config API parameters
 CrlFrameCfg_tFrame config API parameters
 CrlFrameTrigger_tFrame Trigger API parameters RL_RF_FRAMESTARTSTOP_CONF_SB
 CrlFunctionParams_tMmwave radar Driver Function Params
 CrlFwVersionParam_tMmWaveLink firmware version structure
 CrlGpAdcCfg_tAPI radarSS GPADC API MEAS SET SBC M_API_AR_RF_GPADC_API_SET_SB
 CrlGpAdcData_tGPADC measurement data for sensors
 CrlGpadcIntAnaSignalsMonConf_tInternal signals for GPADC monitoring configuration
 CrlGpAdcSamples_tNum of samples to collect for API GPADC sensors sampleCnt : Number of samples to collect @625KHz
 CrlHdrFlags_tCommand op-code ID contains 4 fields (16 bits) Bit 10-15: Reserved Bit 8-9: Operation - Set/Get. Bit 4-7: Operation Type Bit 0-3: Direction
 CrlInitComplete_tMmWaveLink Init Complete data structure for event RL_DEV_AE_MSSPOWERUPDONE_SB
 CrlInterChirpBlkCtrlCfg_tInter Chirp block control configuration
 CrlInterRxGainPhConf_tInter-Rx gain and phase offset configuration
 CrllatentFault_tMmwave radar device latent fault test
 CrlLogCtx_tMmwave Logging functions
 CrlLoopbackBurst_tLoopback burst set configuration
 CrlLowPowerModeCfg_tLow Power mode configuration
 CrlMcuClkCfg_tMmwave radar device MCU Clock output
 CrlMonAnaEnables_tAnalog monitoring configuration
 CrlMonDccClkFreqRep_tThis is the Monitoring report which RadarSS sends to the host, containing information about the relative frequency measurements. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_DCC_CLK_FREQ_REPORT
 CrlMonDigEnables_tDigital monitoring configuration
 CrlMonExtAnaSigRep_tThis is the Monitoring report which RadarSS sends to the host, containing the external signal voltage values measured using the GPADC. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_EXT_ANALOG_SIG_REPORT
 CrlMonGpadcIntAnaSigRep_tThis is the Monitoring report which RadarSS sends to the host, containing information about Internal PM, CLK and LO subsystems' internal analog signals. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_GPADC_INT_ANA_SIG_REPORT
 CrlMonPllConVoltRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured PLL control voltage values during explicit monitoring chirps. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_PLL_CONTROL_VOLT_REPORT
 CrlMonPmclkloIntAnaSigRep_tThis is the Monitoring report which RadarSS sends to the host, containing information about Internal PM, CLK and LO subsystems' internal analog signals. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_PMCLKLO_INT_ANA_SIG_REPORT
 CrlMonReportHdrData_tThe report header includes common information across all enabled monitors like current FTTI number and current temperature. event: RL_RF_AE_MON_REPORT_HEADER_SB
 CrlMonRxGainPhRep_tThis API is a Monitoring report which RadarSS sends to the host, containing the measured RX gain and phase values. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_RX_GAIN_PHASE_REPORT
 CrlMonRxIfStageRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured RX IF filter attenuation values at the given IF frequencies. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_RX_IF_STAGE_REPORT
 CrlMonRxIntAnaSigRep_tThis is the Monitoring report which RadarSS sends to the host, containing information about Internal RX internal analog signals. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_RX_INT_ANALOG_SIG_REPORT
 CrlMonRxMixrInPwrRep_tThis is the Monitoring report which the xWR device sends to the host, containing the measured RX mixer input voltage swing values. The xWR device sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_RX_MIXER_IN_PWR_REPORT
 CrlMonRxNoiseFigRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured RX noise figure values corresponding to the full IF band of a profile. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_RX_NOISE_FIG_REPORT
 CrlMonSynthFreqRep_tThis is the Monitoring report which RadarSS sends to the host, containing information related to measured frequency error during the chirp. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_SYNTHESIZER_FREQ_REPORT
 CrlMonTempReportData_tThis is the Monitoring report which RadarSS sends to the host, containing the measured temperature near various RF analog and digital modules. The xWR device sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event:RL_RF_AE_MON_TEMPERATURE_REPORT_SB
 CrlMonTxBallBreakRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured TX reflection coefficient's magnitude values, meant for detecting TX ball break. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Same strucuture is applicable for Tx0/Tx1/Tx2 ball break report. Event: RL_RF_AE_MON_TXn_BALLBREAK_REPORT
 CrlMonTxBpmRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured TX1 BPM error values. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Same structure is applicable for Tx0/Tx1/Tx2 BPM report data. Event: RL_RF_AE_MON_TXn_BPM_REPORT
 CrlMonTxGainPhaMisRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured Tx gain and phase mismatch values during an explicit monitoring chirp. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Event: RL_RF_AE_MON_TX_GAIN_MISMATCH_REPORT
 CrlMonTxIntAnaSigRep_tThis is the Monitoring report which RadarSS sends to the host, containing information about Internal TX internal analog signals. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Same structure is applicable for Tx0/Tx1/Tx2 monitoring report. Event: RL_RF_AE_MON_TXn_INT_ANA_SIG_REPORT
 CrlMonTxPowRep_tThis is the Monitoring report which RadarSS sends to the host, containing the measured TX power values during an explicit monitoring chirp. RadarSS sends this to host at the programmed periodicity or when failure occurs, as programmed by the configuration API SB. Same structure is application for Tx0/Tx1/Tx2 power report. Event: RL_RF_AE_MON_TXn_POWER_REPORT
 CrlMssBootErrStatus_tStructure to hold the MSS Boot error status data strucutre when booted over SPI for event RL_DEV_AE_MSS_BOOTERRSTATUS_SB
 CrlMssEsmFault_tStructure to hold the MSS ESM Fault data strucutre for event RL_DEV_AE_MSS_ESMFAULT_SB
 CrlMssLatentFaultReport_tStructure to hold the test status report of the latent fault tests data strucutre for event RL_DEV_AE_MSS_LATENTFLT_TEST_REPORT_SB
 CrlMssPeriodicTestStatus_tStructure to hold data strucutre for test status of the periodic tests for event RL_DEV_AE_MSS_PERIODIC_TEST_STATUS_SB
 CrlMssRfErrStatus_tStructure to hold data strucutre for RF-error status send by MSS for event RL_DEV_AE_MSS_RF_ERROR_STATUS_SB
 CrlOpcode_tCommand op-code ID contains 4 fields (16 bits) Bit 10-15: Reserved Bit 8-9: Operation - Set/Get. Bit 4-7: Operation Type Bit 0-3: Direction
 CrlOsiCbs_tOS services callback functions
 CrlOsiMsgQCbs_tOS message queue/Spawn callback functions
 CrlOsiMutexCbs_tOS mutex callback functions
 CrlOsiSemCbs_tOS semaphore callback functions
 CrlPayloadSb_tRHCP Payload Structure
 CrlperiodicTest_tMmwave radar periodicity test config
 CrlPhShiftCalDataGetCfg_tGet phase shift calibration data configuration structure
 CrlPhShiftCalibrationData_tStructure to store all Phase shifter calibration data chunks which device provides in response of rlRfPhShiftCalibDataStore API. Applcation needs to provide same structure to rlRfPhShiftCalibDataRestore API to restore calibration data to the device
 CrlPhShiftCalibrationStore_tPhase shift calibration data which application will receive from radarSS and will feed in to the Device in next power up to avoid calibration
 CrlPllContrVoltMonConf_tInternal signals for PLL control voltage monitoring configuration
 CrlPmClkLoIntAnaSignalsMonConf_tInternal signals for PM, CLK and LO monitoring configuration
 CrlPmicClkCfg_tMmwave radar device PMIC Clock output
 CrlProfileCfg_tProfile config API parameters. A profile contains coarse parameters of FMCW chirp such as start frequency, chirp slope, ramp time, idle time etc. Fine dithering values need to be programmed in chirp configuration rlChirpCfg_t
 CrlProtHeader_tRHCP protocol header structure
 CrlRcvAdcData_tThis async event is in response to the command (RL_DEV_CONFIG_SET_MSG: RL_DEV_RX_DATA_PATH_CONF_SET_SB) which indicates ADC data needs to be transferred over SPI. This async event contains the ADC data followed by more such async events for additional data. SB-ID : RL_DEV_AE_MSS_ADC_DATA_SB
 CrlReadBuf_tMmwave radar Driver Protocol header read buffer
 CrlRecvdGpAdcData_tSensors GPADC measurement data for event RL_RF_AE_GPADC_MEAS_DATA_SB
 CrlRfApllCalDone_tAPI APLL closed loop cal Status Get Sub block structure
 CrlRfBootStatusCfg_tBSS Bootup status data structure
 CrlRfCalMonFreqLimitConf_tRadar RF Calibration monitoring Frequency Limit configuration
 CrlRfCalMonTimeUntConf_tRadar RF Calibration monitoring time unit configuration
 CrlRfDevCfg_tAPI RF device Config SBC M_API_AR_RF_DEV_CONF_SBC
 CrlRfDieIdCfg_tDie ID data structure
 CrlRfIFLoopbackCfg_tRadar RF IF loopback configuration
 CrlRfInitCalConf_tRadar RF Init Calibration configuration
 CrlRfInitComplete_tMmWaveLink RF Init Complete data structure for event RL_RF_AE_INITCALIBSTATUS_SB
 CrlRfLdoBypassCfg_tRadar RF LDO bypass enable/disable configuration
 CrlRfMiscConf_tRadar RF Miscconfiguration
 CrlRfPALoopbackCfg_tRadar RF PA loopback configuration
 CrlRfPhaseShiftCfg_tRadar RF Phase Shift enable/disable configuration
 CrlRfProgFiltCoeff_tArray of coefficients for the RF programmable filter
 CrlRfProgFiltConf_tRadar RF programmable filter configuration
 CrlRfPSLoopbackCfg_tRadar RF Phase shift loopback configuration
 CrlRfRunTimeCalibReport_tMmWaveLink RF Run time calibration report for event RL_RF_AE_RUN_TIME_CALIB_REPORT_SB
 CrlRfRxSaturationCqData_tRX ADC and IF saturation information
 CrlRfSigImgPowerCqData_tRX signal and image band energy statistics
 CrlRfTempData_tRF characterization Time and Temperature data structure
 CrlRfTxFreqPwrLimitMonConf_tTx freq and power limit configuration
 CrlRhcpMsg_tRHCP message structure
 CrlRunTimeCalibConf_tRadar RF Run time calibration configuration
 CrlRxGainPhaseMonConf_tRX gain and phase monitoring configuration
 CrlRxGainTempLutData_tRX gain temperature LUT inject
 CrlRxGainTempLutReadReq_tRX gain temperature LUT read
 CrlRxIfStageMonConf_tRX IF stage monitoring configuration
 CrlRxMixInPwrMonConf_tRX mixer input power monitoring configuration
 CrlRxNoiseMonConf_tRX noise monitoring configuration
 CrlRxSatMonConf_tRX saturation monitoring configuration
 CrlSigImgMonConf_tSignal and image band energy monitoring configuration
 CrlStartComplete_tMmWaveLink RF Start Complete data structure for event RL_DEV_AE_RFPOWERUPDONE_SB
 CrlSubFrameCfg_tAdvance Frame config API Subframe configuration
 CrlSubFrameDataCfg_tSub Frame data config API parameters
 CrlSubFrameStartCfg_tSub-frame trigger API
 CrlSwVersionParam_tMmwavelink software version structure
 CrlSyncPattern_tRHCP SYNC Pattern Structure
 CrlSynthFreqMonConf_tSynthesizer frequency monitoring configuration
 CrlTempMonConf_tTemperature sensor monitoring configuration
 CrltestPattern_tMmwave radar test pattern config
 CrlTestSource_tTest source config API parameters E_API_AR_TEST_SOURCE_CONF_SB
 CrlTestSourceAntPos_tThe Antenna position parameter structure
 CrlTestSourceEnable_tTest source Enable API parameters RL_RF_TEST_SOURCE_ENABLE_SB
 CrlTestSourceObject_tThe Object position and signal strength parameter structure
 CrlTimerCbs_tMmWaveLink Timer callback functions
 CrlTxBallbreakMonConf_tTX ballbreak monitoring configuration
 CrlTxBpmMonConf_tTX BPM monitoring configuration
 CrlTxGainPhaseMismatchMonConf_tTX gain and phase mismatch monitoring configuration
 CrlTxGainTempLutData_tTX gain temperature LUT inject
 CrlTxGainTempLutReadReq_tTX gain temperature LUT read
 CrlTxIntAnaSignalsMonConf_tInternal signals in the TX path monitoring configuration
 CrlTxPowMonConf_tTX power monitoring configuration
 CrlVersion_tMmwavelink version structure
 CrlVmonErrStatus_tThis sub block indicates fault in analog supplies or LDO short circuit condition. Once a fault is detected the functionality cannot be resumed from then on and the sensor needs to be re-started. This Async Event is generated with SB-ID RL_DEV_AE_MSS_VMON_ERROR_STATUS_SB
 CrlWordParam_tChirp start, end Index parameters for rlGetChirpConfig
Copyright 2018, Texas Instruments Incorporated