Data Fields
rlDeviceCtrlCbs_t Struct Reference

mmWaveLink Device Control, Interrupt callback functions More...

#include <control/mmwavelink/mmwavelink.h>

Data Fields

rlInt32_t(* rlDeviceEnable )(rlUInt8_t deviceIndex)
 Bring mmWave radar device out of Reset. More...
 
rlInt32_t(* rlDeviceDisable )(rlUInt8_t deviceIndex)
 Power off mmWave radar device. More...
 
void(* rlDeviceMaskHostIrq )(rlComIfHdl_t fd)
 Masks Host Interrupt. More...
 
void(* rlDeviceUnMaskHostIrq )(rlComIfHdl_t fd)
 Unmask Host Interrupt. More...
 
rlInt32_t(* rlDeviceWaitIrqStatus )(rlComIfHdl_t fd, rlUInt8_t highLow)
 Polls Host Interrupt Status. More...
 
rlUInt16_t(* rlCommIfAssertIrq )(rlUInt8_t highLow)
 It assert/de-assert Host IRQ hig/low on MSS to Host for SPI communication. More...
 

Detailed Description

mmWaveLink Device Control, Interrupt callback functions

Definition at line 1390 of file mmwavelink.h.

Field Documentation

◆ rlCommIfAssertIrq

rlUInt16_t(* rlDeviceCtrlCbs_t::rlCommIfAssertIrq)(rlUInt8_t highLow)

It assert/de-assert Host IRQ hig/low on MSS to Host for SPI communication.

Parameters
[in]highLow- High/low value for Host IRQ
Returns
rlUInt16_t Success - 0, Failure - Error code

It assert/de-assert Host IRQ hig/low on MSS to Host for SPI communication

Definition at line 1474 of file mmwavelink.h.

◆ rlDeviceDisable

rlInt32_t(* rlDeviceCtrlCbs_t::rlDeviceDisable)(rlUInt8_t deviceIndex)

Power off mmWave radar device.

Parameters
[in]deviceIndex- Index of the device to be disbaled
Returns
rlInt32_t Success - 0, Failure - Error code

Power off mmWave radar device. Implement this function to de-assert the Reset Pin in mmWave device

Definition at line 1418 of file mmwavelink.h.

◆ rlDeviceEnable

rlInt32_t(* rlDeviceCtrlCbs_t::rlDeviceEnable)(rlUInt8_t deviceIndex)

Bring mmWave radar device out of Reset.

Parameters
[in]deviceIndex- Index of the device to be enabled
Returns
rlInt32_t Success - 0, Failure - Error code

Bring mmWave radar device out of Reset. Implement this function to assert the nReset Pin in mmWave device. Optionally It might require to assert Sense on Power(SOP) Pins

Definition at line 1404 of file mmwavelink.h.

◆ rlDeviceMaskHostIrq

void(* rlDeviceCtrlCbs_t::rlDeviceMaskHostIrq)(rlComIfHdl_t fd)

Masks Host Interrupt.

Parameters
[in]fd- Handle of the device for which interrupt need to be masked

Masks Host Interrupt. If GPIO Interrupt is Level Triggered, host need to mask the interrupt until the interrupt is serviced

Definition at line 1430 of file mmwavelink.h.

◆ rlDeviceUnMaskHostIrq

void(* rlDeviceCtrlCbs_t::rlDeviceUnMaskHostIrq)(rlComIfHdl_t fd)

Unmask Host Interrupt.

Parameters
[in]fd- Handle of the device for which interrupt need to be unmasked

Unmask Host Interrupt. If GPIO Interrupt is Level Triggered, host need to unmask the interrupt once interrupt is processed

Definition at line 1442 of file mmwavelink.h.

◆ rlDeviceWaitIrqStatus

rlInt32_t(* rlDeviceCtrlCbs_t::rlDeviceWaitIrqStatus)(rlComIfHdl_t fd, rlUInt8_t highLow)

Polls Host Interrupt Status.

Parameters
[in]fd- Handle of the device for which interrupt need to be polled
[in]highLow- Wait for IRQ Level(high/low)
Returns
rlInt32_t IRQ Line Low - 0, IRQ Line High - 1

mmWave Radar device asserts host IRQ pin to get Host attention. After receiving host interrupt, host polls Host Interrupt Status, Low on Host IRQ indicate that mmWave device has written data on communication Interface. This callback should Wait for the IRQ status. The function waits for the IRQ Level(low/high) based on second argument returns once the IRQ Level occurs. If HostIRQ is not toggled within timeout (less than ackTimeout), it should return '-1' value so that it won't be blocked for infinite duration.

Definition at line 1461 of file mmwavelink.h.


The documentation for this struct was generated from the following file:

Copyright 2021, Texas Instruments Incorporated