Functions
Device

Radar Device Management Module. More...

Functions

MMWL_EXPORT rlReturnVal_t rlDevicePowerOn (rlUInt8_t deviceMap, rlClientCbs_t clientCb)
 Bring mmwave Device Out of Reset. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceAddDevices (rlUInt8_t deviceMap)
 Bring mmwave Device Out of Reset. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceRemoveDevices (rlUInt8_t deviceMap)
 Removes connected mmwave devices. More...
 
MMWL_EXPORT rlReturnVal_t rlDevicePowerOff (void)
 Shutdown mmwave Device. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceRfStart (rlUInt8_t deviceMap)
 Enables mmwave RF/Analog Sub system. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceFileDownload (rlUInt8_t deviceMap, rlFileData_t *data, rlUInt16_t remChunks)
 Download mmwave Firmware/Patches over SPI. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetMssVersion (rlUInt8_t deviceMap, rlFwVersionParam_t *data)
 Get mmWave Master SS version. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetRfVersion (rlUInt8_t deviceMap, rlFwVersionParam_t *data)
 Get mmWave RF ROM and patch version. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetVersion (rlUInt8_t deviceMap, rlVersion_t *data)
 Get mmWave Hardware, Firmware/patch and mmWaveLink version. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetMmWaveLinkVersion (rlSwVersionParam_t *data)
 Get mmWaveLink Version. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceMcuClkConfig (rlUInt8_t deviceMap, rlMcuClkCfg_t *data)
 Sets the configurations to setup the desired frequency of the MCU Clock. More...
 
MMWL_EXPORT rlReturnVal_t rlDevicePmicClkConfig (rlUInt8_t deviceMap, rlPmicClkCfg_t *data)
 Sets the configurations for PMIC clock. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceLatentFaultTests (rlUInt8_t deviceMap, rllatentFault_t *data)
 Sets the configurations for latent fault test. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceEnablePeriodicTests (rlUInt8_t deviceMap, rlperiodicTest_t *data)
 Sets the configurations for periodic test. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceSetTestPatternConfig (rlUInt8_t deviceMap, rltestPattern_t *data)
 Setup for test pattern to be generated. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceConfigureCrc (rlCrcType_t crcType)
 Configures the CRC Type in mmWaveLink Driver. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceConfigureAckTimeout (rlUInt32_t ackTimeout)
 Configures the Acknowledgement timeout in mmWaveLink Driver. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceSetRetryCount (rlUInt8_t retryCnt)
 : Set the command retry count More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceSetContStreamingModeConfig (rlUInt8_t deviceMap, rlDevContStreamingModeCfg_t *data)
 Sets Continous Streaming Mode Configuration. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetContStreamingModeConfig (rlUInt8_t deviceMap, rlDevContStreamingModeCfg_t *data)
 Gets continuous Streaming Mode Configuration. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceSetMiscConfig (rlUInt8_t deviceMap, rlDevMiscCfg_t *data)
 Setup misc. device configurations. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceSetDebugSigEnableConfig (rlUInt8_t deviceMap, rlDebugSigEnCfg_t *data)
 Information to enable the pin-mux to bring out debug signals for the chirp cycle. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceSetCsi2DelayDummyConfig (rlUInt8_t deviceMap, rlCsi2DelayDummyCfg_t *data)
 This API can be used to increase the time between the availability of chirp data and the transfer of chirp data over CSI2 interface. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetCpuFault (rlUInt8_t deviceMap, rlCpuFault_t *data)
 Get MasterSS CPU fault status. More...
 
MMWL_EXPORT rlReturnVal_t rlDeviceGetEsmFault (rlUInt8_t deviceMap, rlMssEsmFault_t *data)
 Get MasterSS ESM fault status. More...
 

Detailed Description

Radar Device Management Module.

The Device module has interface for Enabling and controlling Radar device. Configures the callbacks(SPI, Interrupt, OS etc) for communication with device It also allows Firmware download over SPI.

Related Files

Function Documentation

◆ rlDeviceAddDevices()

rlReturnVal_t rlDeviceAddDevices ( rlUInt8_t  deviceMap)

Bring mmwave Device Out of Reset.

Parameters
[in]deviceMap- bitmap of devices to be connected
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Bring mmwave Device Out of Reset. Application should wait for async event subBlock RL_DEV_AE_MSSPOWERUPDONE_SB before issuing any other APIs. This API is valid only for cascade mode of AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 175 of file rl_device.c.

◆ rlDeviceConfigureAckTimeout()

rlReturnVal_t rlDeviceConfigureAckTimeout ( rlUInt32_t  ackTimeout)

Configures the Acknowledgement timeout in mmWaveLink Driver.

Parameters
[in]ackTimeout- ACK timeout, 0 - No ACK
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Configures the Acknowledgement timeout in mmWaveLink Driver, 0 - Disable ACK

Definition at line 1915 of file rl_device.c.

◆ rlDeviceConfigureCrc()

rlReturnVal_t rlDeviceConfigureCrc ( rlCrcType_t  crcType)

Configures the CRC Type in mmWaveLink Driver.

Parameters
[in]crcType- CRC Types
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Configures the CRC Type in mmWaveLink Driver

Definition at line 1898 of file rl_device.c.

◆ rlDeviceEnablePeriodicTests()

rlReturnVal_t rlDeviceEnablePeriodicTests ( rlUInt8_t  deviceMap,
rlperiodicTest_t data 
)

Sets the configurations for periodic test.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for periodic test Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Sets the configurations for periodic test. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1561 of file rl_device.c.

◆ rlDeviceFileDownload()

rlReturnVal_t rlDeviceFileDownload ( rlUInt8_t  deviceMap,
rlFileData_t data,
rlUInt16_t  remChunks 
)

Download mmwave Firmware/Patches over SPI.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- File Chunk
[in]remChunks- Number of remaining Chunks
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Download mmwave Firmware/Patches over SPI. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 365 of file rl_device.c.

◆ rlDeviceGetContStreamingModeConfig()

rlReturnVal_t rlDeviceGetContStreamingModeConfig ( rlUInt8_t  deviceMap,
rlDevContStreamingModeCfg_t data 
)

Gets continuous Streaming Mode Configuration.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[out]data- Container for continuous Streaming Mode Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Gets continuous Streaming Mode Configuration. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor

Definition at line 1129 of file rl_device.c.

◆ rlDeviceGetCpuFault()

rlReturnVal_t rlDeviceGetCpuFault ( rlUInt8_t  deviceMap,
rlCpuFault_t data 
)

Get MasterSS CPU fault status.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for MasterSS CPU fault status
Returns
rlReturnVal_t Success - 0, Failure - Error Code

This API gets the MasterSS CPU fault status. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1807 of file rl_device.c.

◆ rlDeviceGetEsmFault()

rlReturnVal_t rlDeviceGetEsmFault ( rlUInt8_t  deviceMap,
rlMssEsmFault_t data 
)

Get MasterSS ESM fault status.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for MasterSS ESM fault status
Returns
rlReturnVal_t Success - 0, Failure - Error Code

This API gets the MasterSS ESM fault status. This API is valid only for AWR1243 and AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1854 of file rl_device.c.

◆ rlDeviceGetMmWaveLinkVersion()

rlReturnVal_t rlDeviceGetMmWaveLinkVersion ( rlSwVersionParam_t data)

Get mmWaveLink Version.

Parameters
[out]data- Container for Version Information
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Get mmWaveLink Version

Definition at line 551 of file rl_device.c.

◆ rlDeviceGetMssVersion()

rlReturnVal_t rlDeviceGetMssVersion ( rlUInt8_t  deviceMap,
rlFwVersionParam_t data 
)

Get mmWave Master SS version.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[out]data- Container for Version Information
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Get mmWave Master SS version. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 425 of file rl_device.c.

◆ rlDeviceGetRfVersion()

rlReturnVal_t rlDeviceGetRfVersion ( rlUInt8_t  deviceMap,
rlFwVersionParam_t data 
)

Get mmWave RF ROM and patch version.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[out]data- Container for Version Information
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Get mmWave RF ROM and patch version

Definition at line 462 of file rl_device.c.

◆ rlDeviceGetVersion()

rlReturnVal_t rlDeviceGetVersion ( rlUInt8_t  deviceMap,
rlVersion_t data 
)

Get mmWave Hardware, Firmware/patch and mmWaveLink version.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[out]data- Container for Version Information
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Get mmWave Hardware, Firmware/patch and mmWaveLink version

Definition at line 494 of file rl_device.c.

◆ rlDeviceLatentFaultTests()

rlReturnVal_t rlDeviceLatentFaultTests ( rlUInt8_t  deviceMap,
rllatentFault_t data 
)

Sets the configurations for latent fault test.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for latent fault test Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Sets the configurations for latent fault test. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor. This API should not be issued when functional frames are running, these are destructive tests.

Note
1: The MSS latent self tests are destructive tests, which would cause corruption in ongoing SPI/mailbox transactions and which generates N-Error signal while performing ESM G2 error checks. The MIBSPI ECC tests (b13,b14) can be destructive tests if there is an ongoing MIBSPI communication. It is recommended not to run these self tests in functional mode of operation.
2: It is recommended to wait for the latent fault test report asynchronous event after issuing this API. The MSS latent self tests cannot be issued back to back without waiting for the test report event.

Definition at line 1515 of file rl_device.c.

◆ rlDeviceMcuClkConfig()

rlReturnVal_t rlDeviceMcuClkConfig ( rlUInt8_t  deviceMap,
rlMcuClkCfg_t data 
)

Sets the configurations to setup the desired frequency of the MCU Clock.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for MCU clock Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Sets the configurations to setup the desired frequency of the MCU Clock. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1413 of file rl_device.c.

◆ rlDevicePmicClkConfig()

rlReturnVal_t rlDevicePmicClkConfig ( rlUInt8_t  deviceMap,
rlPmicClkCfg_t data 
)

Sets the configurations for PMIC clock.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for PMIC clock Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Sets the configurations for PMIC clock. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1459 of file rl_device.c.

◆ rlDevicePowerOff()

rlReturnVal_t rlDevicePowerOff ( void  )

Shutdown mmwave Device.

Returns
rlReturnVal_t Success - 0, Failure - Error Code

Stops mmwave operations and also shuts down mmwave device

Definition at line 262 of file rl_device.c.

◆ rlDevicePowerOn()

rlReturnVal_t rlDevicePowerOn ( rlUInt8_t  deviceMap,
rlClientCbs_t  clientCb 
)

Bring mmwave Device Out of Reset.

Parameters
[in]deviceMap- bitmap of all the connected Device
[in]clientCb- Client Callbacks for OS/SPI/Interrupts etc
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Bring mmwave Device Out of Reset. Application should wait for async event of subBlock RL_DEV_AE_MSSPOWERUPDONE_SB (in case of AWR1243/AWR2243) before issuing any other APIs

Definition at line 100 of file rl_device.c.

◆ rlDeviceRemoveDevices()

rlReturnVal_t rlDeviceRemoveDevices ( rlUInt8_t  deviceMap)

Removes connected mmwave devices.

Parameters
[in]deviceMap- Bitmap of mmwave devices to be disconnected
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Removes mmwave devices and also shuts down the devices. This API is valid only for cascade mode of AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 202 of file rl_device.c.

◆ rlDeviceRfStart()

rlReturnVal_t rlDeviceRfStart ( rlUInt8_t  deviceMap)

Enables mmwave RF/Analog Sub system.

Parameters
[in]deviceMap- Bitmap of devices to send the message
Returns
rlReturnVal_t Success - 0, Failure - Error Code

It enables RF/Analog Subsystem.

Definition at line 325 of file rl_device.c.

◆ rlDeviceSetContStreamingModeConfig()

rlReturnVal_t rlDeviceSetContStreamingModeConfig ( rlUInt8_t  deviceMap,
rlDevContStreamingModeCfg_t data 
)

Sets Continous Streaming Mode Configuration.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for Continous Streaming Mode Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

This function configures the transfer of captured ADC samples continuously without missing any sample to an external host. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Note
: Continuous streaming mode is useful for RF lab characterization and debug. In this mode, the device is configured to transmit a single continuous wave tone at a specific RF frequency continuously

Definition at line 1077 of file rl_device.c.

◆ rlDeviceSetCsi2DelayDummyConfig()

rlReturnVal_t rlDeviceSetCsi2DelayDummyConfig ( rlUInt8_t  deviceMap,
rlCsi2DelayDummyCfg_t data 
)

This API can be used to increase the time between the availability of chirp data and the transfer of chirp data over CSI2 interface.

Parameters
[in]data- Container for CSI2 delay dummy Configuration
[in]deviceMap- Bitmap of devices to send the message
Returns
rlReturnVal_t Success - 0, Failure - Error Code

It can also be used to add configurable amount of dummy data per chirp at the end of actual chirp data.

Note
1 : The user should configure the delay (and the dummy count) such that the chirp data transmission is completed before the start of next chirp's data transmission. Excessive delay or dummy count may lead to fault which will be reported by MSS
2 : The change in Delay value configuration will reflect immediately. But any change in Dummy value configuration will reflect only after frame configuration.
3 : There is some delay T0 (even without enabling this API) between the chirp data availability to data transmission. The delay added by this API is in addition to this T0. T0 depends on ADC Sampling rate, CSI Data rate and whether the CSI Line-Start-Line-End is enabled or not. The programmer needs to account for this delay while selecting the configuration values for this API.

Definition at line 1761 of file rl_device.c.

◆ rlDeviceSetDebugSigEnableConfig()

rlReturnVal_t rlDeviceSetDebugSigEnableConfig ( rlUInt8_t  deviceMap,
rlDebugSigEnCfg_t data 
)

Information to enable the pin-mux to bring out debug signals for the chirp cycle.

Parameters
[in]data- Container for debug signals Configuration
[in]deviceMap- Bitmap of devices to send the message
Returns
rlReturnVal_t Success - 0, Failure - Error Code

It contains the information to enable the pin-mux to bring out debug signals for the chirp cycle. CLK_OUT signal will be output on OSC_CLKOUT pin and ADC_SIG_OUT will be output on GPIO_0 pin.

Definition at line 1703 of file rl_device.c.

◆ rlDeviceSetMiscConfig()

rlReturnVal_t rlDeviceSetMiscConfig ( rlUInt8_t  deviceMap,
rlDevMiscCfg_t data 
)

Setup misc. device configurations.

Parameters
[in]data- Container for device Configuration
[in]deviceMap- Bitmap of devices to send the message
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Set misc. device configurations of MasterMSS, where currently it set CRC type for async event message sent by MSS to Host. This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1655 of file rl_device.c.

◆ rlDeviceSetRetryCount()

rlReturnVal_t rlDeviceSetRetryCount ( rlUInt8_t  retryCnt)

: Set the command retry count

Parameters
[in]retryCnt- Retry count [0: no retry, n: no. of retries] value limit to RL_API_CMD_RETRY_COUNT(3)
Returns
rlReturnVal_t Success - 0, Failure - Error Code(-2)

Set the retry count to global rlDriverData_t structure.

Definition at line 1933 of file rl_device.c.

◆ rlDeviceSetTestPatternConfig()

rlReturnVal_t rlDeviceSetTestPatternConfig ( rlUInt8_t  deviceMap,
rltestPattern_t data 
)

Setup for test pattern to be generated.

Parameters
[in]deviceMap- Bitmap of devices to send the message
[in]data- Container for periodic test Configuration
Returns
rlReturnVal_t Success - 0, Failure - Error Code

Set the configurations to setup the test pattern to be generated and transferred over the selected high speed interface (LVDS/CSI2). This API is valid only for AWR1243/AWR2243 mmWave device when mmWaveLink instance is running on External Host Processor.

Definition at line 1608 of file rl_device.c.


Copyright 2020, Texas Instruments Incorporated