mmwave radar RF/Sensor Monitoring module More...

Functions
MMWL_EXPORT rlReturnVal_t	rlRfDigMonEnableConfig (rlUInt8_t deviceMap, rlMonDigEnables_t *data)
	Sets the consolidated configuration of all digital monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfDigMonPeriodicConfig (rlUInt8_t deviceMap, rlDigMonPeriodicConf_t *data)
	Sets the consolidated configuration. More...

MMWL_EXPORT rlReturnVal_t	rlRfAnaMonConfig (rlUInt8_t deviceMap, rlMonAnaEnables_t *data)
	This function contains the consolidated configuration of all analog monitoring. The enabled monitoring functions are executed with a periodicity of CAL_MON_TIME_UNITS (rlRfCalMonTimeUntConf_t.calibMonTimeUnit) number of logical frames. The host should ensure that all the enabled monitors can be completed in the available inter-frame times, based on the monitoring durations. The time taken for each monitoring is not defined in this document. More...

MMWL_EXPORT rlReturnVal_t	rlRfTempMonConfig (rlUInt8_t deviceMap, rlTempMonConf_t *data)
	This API configure the on chip temperature monitors and report the soft results from the monitor. The corresponding monitors are collectively named TEMPERATURE_MONITOR. These monitors observe the temperature near various RF analog and digital modules using temperature sensors and GPADC and compare them against configurable thresholds. The report is sent as an async event RL_RF_AE_MON_TEMPERATURE_REPORT_SB. Sets information related to temperature monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfRxGainPhMonConfig (rlUInt8_t deviceMap, rlRxGainPhaseMonConf_t *data)
	This API is to set RX gain and phase monitoring config to device. More...

MMWL_EXPORT rlReturnVal_t	rlRfRxNoiseMonConfig (rlUInt8_t deviceMap, rlRxNoiseMonConf_t *data)
	Sets information related to RX noise monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfRxIfStageMonConfig (rlUInt8_t deviceMap, rlRxIfStageMonConf_t *data)
	Sets information related to RX IF filter attenuation monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfTxBallbreakMonConfig (rlUInt8_t deviceMap, rlAllTxBallBreakMonCfg_t *data)
	Sets information related to TX ball break detection. More...

MMWL_EXPORT rlReturnVal_t	rlRfTxGainPhaseMismatchMonConfig (rlUInt8_t deviceMap, rlTxGainPhaseMismatchMonConf_t *data)
	Sets information related to TX gain and phase mismatch monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfTxBpmMonConfig (rlUInt8_t deviceMap, rlAllTxBpmMonConf_t *data)
	Sets information related to TX BPM monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfSynthFreqMonConfig (rlUInt8_t deviceMap, rlSynthFreqMonConf_t *data)
	Sets information related to synthesizer frequency. More...

MMWL_EXPORT rlReturnVal_t	rlRfExtAnaSignalsMonConfig (rlUInt8_t deviceMap, rlExtAnaSignalsMonConf_t *data)
	Sets information related to external DC signals monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfTxIntAnaSignalsMonConfig (rlUInt8_t deviceMap, rlAllTxIntAnaSignalsMonConf_t *data)
	Sets information related to TX Internal Analog Signals monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfRxIntAnaSignalsMonConfig (rlUInt8_t deviceMap, rlRxIntAnaSignalsMonConf_t *data)
	Sets information related to RX Internal Analog Signals monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfPmClkLoIntAnaSignalsMonConfig (rlUInt8_t deviceMap, rlPmClkLoIntAnaSignalsMonConf_t *data)
	Sets information related to Power Management, Clock generation and LO distribution. More...

MMWL_EXPORT rlReturnVal_t	rlRfGpadcIntAnaSignalsMonConfig (rlUInt8_t deviceMap, rlGpadcIntAnaSignalsMonConf_t *data)
	Sets information related to GPADC Internal Analog Signals monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfPllContrlVoltMonConfig (rlUInt8_t deviceMap, rlPllContrVoltMonConf_t *data)
	Sets information related to APLL and Synthesizer's control voltage signals monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfDualClkCompMonConfig (rlUInt8_t deviceMap, rlDualClkCompMonConf_t *data)
	Sets information related to the DCC based clock frequency monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfRxIfSatMonConfig (rlUInt8_t deviceMap, rlRxSatMonConf_t *data)
	Sets information related to RX saturation detector monitoring. More...

MMWL_EXPORT rlReturnVal_t	rlRfRxSigImgMonConfig (rlUInt8_t deviceMap, rlSigImgMonConf_t *data)
	Sets information related to signal and image band energy. More...

MMWL_EXPORT rlReturnVal_t	rlRfAnaFaultInjConfig (rlUInt8_t deviceMap, rlAnaFaultInj_t *data)
	Sets information related to RF fault injection. More...

Detailed Description

mmwave radar RF/Sensor Monitoring module

mmWave Device monitoring can be configured through a set of APIs defined in this section. Note that these APIs cover the RF/Analog related monitoring mechanisms. There are separate monitoring mechanisms for the digital logic (including the processor, memory, etc.) which are internal to the device and not explicitly enabled through these APIs.
The monitoring APIs are structured as follows:

There are common configuration APIs that control the overall periodicity of monitoring, as well as, enable/disable control for each monitoring mechanism.
Then, for each monitoring mechanism there is an individual API to allow the application to set an appropriate threshold for declaring failure from that monitoring.
Also, for each monitoring mechanism, there is an individual API to report soft (raw) values from that monitoring.
The Raw, Failure or Periodic Monitoring report are sent to application using asynchronous events.

Below is the list of Monitors and corresponding duration in microseconds

Monitoring Duration
Monitors	Duration(us)
Temperature	200
RX gain phase (assumes 1 RF frequency)	1250
RX noise figure (assumes 1 RF frequency)	250
RX IF stage (assumes 1 RF frequency)	1000
TX power (assumes 1 TX, 1 RF frequency)	200
TX ballbreak (assumes 1 TX)	250
TX gain phase mismatch (assumes 1 TX, 1 RF frequency)	400
TX BPM	575
Synthesizer frequency	0
External analog signals (all 6 GPADC channels enabled)	150
TX Internal analog signals (assumes 1 TX)	200
RX internal analog signals	1700
PMCLKLO internal analog signals	400
GPADC internal signals	50
PLL control voltage	210
Dual clock comparator (assumes 6 clock comparators)	110
RX saturation detector	0
RX signal and image band monitor	0
RX mixer input power	350
DFE statistics	100
Report formatting	700
Watchdog idle period	10% of FTTI duration

  Related Files
 - rl_monitoring.c

Function Documentation

rlReturnVal_t rlRfAnaFaultInjConfig	(	rlUInt8_t	deviceMap,
		rlAnaFaultInj_t *	data
	)

Sets information related to RF fault injection.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Fault injection config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a fault injection configuration API.

Note: 1: Supported in xWR1243 ES3.0 and xWR1642 ES2.0 onwards.; 2: This API is not supported in IWR6843 ES1.0

Definition at line 1180 of file rl_monitoring.c.

rlReturnVal_t rlRfAnaMonConfig	(	rlUInt8_t	deviceMap,
		rlMonAnaEnables_t *	data
	)

This function contains the consolidated configuration of all analog monitoring. The enabled monitoring functions are executed with a periodicity of CAL_MON_TIME_UNITS (rlRfCalMonTimeUntConf_t.calibMonTimeUnit) number of logical frames. The host should ensure that all the enabled monitors can be completed in the available inter-frame times, based on the monitoring durations. The time taken for each monitoring is not defined in this document.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Monitor analog enable configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

Sets the consolidated configuration of all analog monitoring.

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 166 of file rl_monitoring.c.

rlReturnVal_t rlRfDigMonEnableConfig	(	rlUInt8_t	deviceMap,
		rlMonDigEnables_t *	data
	)

Sets the consolidated configuration of all digital monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Monitor digital enable configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API SB sets the consolidated configuration of all digital monitoring.

Note: 1: Supported in xWR1243 ES3.0 and xWR1642 ES2.0 onwards.; 2: This API is not supported in IWR6843 ES1.0

Definition at line 90 of file rl_monitoring.c.

rlReturnVal_t rlRfDigMonPeriodicConfig	(	rlUInt8_t	deviceMap,
		rlDigMonPeriodicConf_t *	data
	)

Sets the consolidated configuration.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Digital monitor periodic configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

Sets the consolidated configuration of all periodic digital monitoring within radar sub-system.

Note: 1: Supported in xWR1243 ES3.0 and xWR1642 ES2.0 onwards.; 2: This API is not supported in IWR6843 ES1.0

Definition at line 126 of file rl_monitoring.c.

rlReturnVal_t rlRfDualClkCompMonConfig	(	rlUInt8_t	deviceMap,
		rlDualClkCompMonConf_t *	data
	)

Sets information related to the DCC based clock frequency monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Dual clock comp monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to the DCC based clock frequency monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_DCC_CLK_FREQ_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 1027 of file rl_monitoring.c.

rlReturnVal_t rlRfExtAnaSignalsMonConfig	(	rlUInt8_t	deviceMap,
		rlExtAnaSignalsMonConf_t *	data
	)

Sets information related to external DC signals monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- External anlog signal monitor config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to external DC signals monitoring (available only in xWR1642 & xWR1843). Once configured, radarSS will send Async event (RL_RF_AE_MON_EXT_ANALOG_SIG_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 727 of file rl_monitoring.c.

rlReturnVal_t rlRfGpadcIntAnaSignalsMonConfig	(	rlUInt8_t	deviceMap,
		rlGpadcIntAnaSignalsMonConf_t *	data
	)

Sets information related to GPADC Internal Analog Signals monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- GPADC internal analog signal monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to GPADC Internal Analog Signals monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_GPADC_INT_ANA_SIG_REPORT) to report monitoring data.

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 946 of file rl_monitoring.c.

rlReturnVal_t rlRfPllContrlVoltMonConfig	(	rlUInt8_t	deviceMap,
		rlPllContrVoltMonConf_t *	data
	)

Sets information related to APLL and Synthesizer's control voltage signals monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- PLL control voltage monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to APLL and Synthesizer's control voltage signals monitoring Once configured, radarSS will send Async event (RL_RF_AE_MON_PLL_CONTROL_VOLT_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 987 of file rl_monitoring.c.

rlReturnVal_t rlRfPmClkLoIntAnaSignalsMonConfig	(	rlUInt8_t	deviceMap,
		rlPmClkLoIntAnaSignalsMonConf_t *	data
	)

Sets information related to Power Management, Clock generation and LO distribution.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- PMCLK internal analog signal monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to Power Management,Clock generation and LO distribution circuits' Internal Analog Signals monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_PMCLKLO_INT_ANA_SIG_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 905 of file rl_monitoring.c.

rlReturnVal_t rlRfRxGainPhMonConfig	(	rlUInt8_t	deviceMap,
		rlRxGainPhaseMonConf_t *	data
	)

This API is to set RX gain and phase monitoring config to device.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Rx gain phase monitoring configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This is a monitoring configuration API, containing information related to RX gain and phase monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_RX_GAIN_PHASE_REPORT) to report monitoring data.

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 244 of file rl_monitoring.c.

rlReturnVal_t rlRfRxIfSatMonConfig	(	rlUInt8_t	deviceMap,
		rlRxSatMonConf_t *	data
	)

Sets information related to RX saturation detector monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Rx saturation monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to RX saturation detector monitoring.

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 1065 of file rl_monitoring.c.

rlReturnVal_t rlRfRxIfStageMonConfig	(	rlUInt8_t	deviceMap,
		rlRxIfStageMonConf_t *	data
	)

Sets information related to RX IF filter attenuation monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Rx IF stage monitoring configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to RX IF filter attenuation monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_RX_IF_STAGE_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 323 of file rl_monitoring.c.

rlReturnVal_t rlRfRxIntAnaSignalsMonConfig	(	rlUInt8_t	deviceMap,
		rlRxIntAnaSignalsMonConf_t *	data
	)

Sets information related to RX Internal Analog Signals monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Rx internal analog signal monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to RX Internal Analog Signals monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_RX_INT_ANALOG_SIG_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 864 of file rl_monitoring.c.

rlReturnVal_t rlRfRxNoiseMonConfig	(	rlUInt8_t	deviceMap,
		rlRxNoiseMonConf_t *	data
	)

Sets information related to RX noise monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Rx noise monitor configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This is a monitoring configuration API, containing information related to RX noise monitoring of a profile. Once configured, radarSS will send Async event (RL_RF_AE_MON_RX_NOISE_FIG_REPORT) to report monitoring data.

Note: 1: The noise monitor reports the real receivers noise figure. In complex receiver modes (i.e., complex 1x, complex 2x and pseudoreal), the system noise figure is 3dB lower (better) than the reported.; 2: This API is not supported in IWR6843 ES1.0

Definition at line 285 of file rl_monitoring.c.

rlReturnVal_t rlRfRxSigImgMonConfig	(	rlUInt8_t	deviceMap,
		rlSigImgMonConf_t *	data
	)

Sets information related to signal and image band energy.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Signal img monitoring config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to signal and image band energy. The Monitoring report is available as CQ1 (part of CQ) in CQ RAM. The application should transfer the report every chirp.

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 1104 of file rl_monitoring.c.

rlReturnVal_t rlRfSynthFreqMonConfig	(	rlUInt8_t	deviceMap,
		rlSynthFreqMonConf_t *	data
	)

Sets information related to synthesizer frequency.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	-Synthesizer frequency monitor configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to synthesizer frequency monitoring during chirping. Once configured, radarSS will send Async event (RL_RF_AE_MON_SYNTHESIZER_FREQ_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 689 of file rl_monitoring.c.

rlReturnVal_t rlRfTempMonConfig	(	rlUInt8_t	deviceMap,
		rlTempMonConf_t *	data
	)

This API configure the on chip temperature monitors and report the soft results from the monitor. The corresponding monitors are collectively named TEMPERATURE_MONITOR. These monitors observe the temperature near various RF analog and digital modules using temperature sensors and GPADC and compare them against configurable thresholds. The report is sent as an async event RL_RF_AE_MON_TEMPERATURE_REPORT_SB. Sets information related to temperature monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Temperature monitor configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

Sets information related to temperature monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_TEMPERATURE_REPORT_SB) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 208 of file rl_monitoring.c.

rlReturnVal_t rlRfTxBallbreakMonConfig	(	rlUInt8_t	deviceMap,
		rlAllTxBallBreakMonCfg_t *	data
	)

Sets information related to TX ball break detection.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Tx ballbreak monitor config

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to TX ball break detection. Once configured, radarSS will send Async event (RL_RF_AE_MON_TX0_BALLBREAK_REPORT, RL_RF_AE_MON_TX1_BALLBREAK_REPORT, RL_RF_AE_MON_TX2_BALLBREAK_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 456 of file rl_monitoring.c.

rlReturnVal_t rlRfTxBpmMonConfig	(	rlUInt8_t	deviceMap,
		rlAllTxBpmMonConf_t *	data
	)

Sets information related to TX BPM monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Tx BPM monitor configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to TX BPM monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_TX0_BPM_REPORT, RL_RF_AE_MON_TX1_BPM_REPORT, RL_RF_AE_MON_TX2_BPM_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 595 of file rl_monitoring.c.

rlReturnVal_t rlRfTxGainPhaseMismatchMonConfig	(	rlUInt8_t	deviceMap,
		rlTxGainPhaseMismatchMonConf_t *	data
	)

Sets information related to TX gain and phase mismatch monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Tx gain phase mismatch monitor configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to TX gain and phase mismatch monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_TX_GAIN_MISMATCH_REPORT) to report monitoring data

Note: 1: The TX2 has a fixed offset of -8dB gain and -8 degree phase with respect to TX0 and TX1 by design, user has to compensate these values in the gain and phase offset fields of this API for TX2.; 2: This API is not supported in IWR6843 ES1.0

Definition at line 555 of file rl_monitoring.c.

rlReturnVal_t rlRfTxIntAnaSignalsMonConfig	(	rlUInt8_t	deviceMap,
		rlAllTxIntAnaSignalsMonConf_t *	data
	)

Sets information related to TX Internal Analog Signals monitoring.

Parameters

[in]	deviceMap	- Bitmap of devices to send the message
[in]	data	- Tx internal analog signal monitoring configuration

Returns: rlReturnVal_t Success - 0, Failure - Error Code

This API is a Monitoring Configuration API, containing information related to TX Internal Analog Signals monitoring. Once configured, radarSS will send Async event (RL_RF_AE_MON_TX0_INT_ANA_SIG_REPORT RL_RF_AE_MON_TX1_INT_ANA_SIG_REPORT, RL_RF_AE_MON_TX2_INT_ANA_SIG_REPORT) to report monitoring data

Note: : This API is not supported in IWR6843 ES1.0

Definition at line 768 of file rl_monitoring.c.

Functions

Detailed Description

Function Documentation