Data Fields
rlFrameCfg_t Struct Reference

Frame config API parameters. More...

#include <control/mmwavelink/include/rl_sensor.h>

Data Fields

rlUInt16_t reserved0
 Reserved for Future use.
 
rlUInt16_t chirpStartIdx
 Start Index of Chirp Valid range = 0-511. More...
 
rlUInt16_t chirpEndIdx
 End Index of Chirp Valid range = chirpStartIdx-511. More...
 
rlUInt16_t numLoops
 Number of times to repeat from chirpStartIdx to chirpEndIdx in each frame,
valid range = 1 to 255
. More...
 
rlUInt16_t numFrames
 Number of frame to transmit
Valid Range 0 to 65535 (0 for infinite frames)
.
 
rlUInt16_t numAdcSamples
 Number of ADC samples to capture This parameter is required only for AWR1243/AWR2243/xWR6243 and configures the size of ADC samples per chirp to be sent on LVDS/CSI2 interface.
It should be configured as: For real/pseudo real ADC data - numADCSamples = rlProfileCfg_t.numAdcSamples
For complex1x/complex2x ADC data -
numADCSamples = (rlProfileCfg_t.numAdcSamples ) * 2
.
 
rlUInt32_t framePeriodicity
 Frame repitition period
PERIOD >= Sum total time of all chirps + InterFrameBlankTime, where, Sum total time of all chirps = Num Loops * Num chirps * Chirp Period.
InterFrameBlankTime is primarily for sensor calibration/monitoring, thermal control, transferring out any safety monitoring data if requested, hardware reconfiguration for next frame, re-triggering of next frame.
InterFrameBlankTime >= 300 μs typically.
Add 150 us to InterFrameBlankTime if data-path reconfiguration needed in frame boundary due to change in profile.
1 LSB = 5 ns
Valid range : 300 us to 1.342 s
.
 
rlUInt16_t triggerSelect
 Selects the mode for triggering start of transmission of frame
0x0001 SWTRIGGER (Software API based triggering):
Frame is triggered upon receiving rlSensorStart
There could be several tens of micro seconds uncertainty in triggering.
. More...
 
rlUInt16_t reserved1
 Reserved for Future use.
 
rlUInt32_t frameTriggerDelay
 Optional time delay from sync_in trigger to the occurance of frame chirps
Applicable only in SINGLECHIP sensor applications, as defined in rlChanCfg_t.
It is recommended only for staggering the transmission of multiple mmwave
sensors around the car for interference avoidance, if needed.
1 lsb = 5 ns
Typical range is 0 to 100 micro seconds.
.
 

Detailed Description

Frame config API parameters.

Definition at line 980 of file rl_sensor.h.

Field Documentation

◆ chirpEndIdx

rlUInt16_t rlFrameCfg_t::chirpEndIdx

End Index of Chirp Valid range = chirpStartIdx-511.

Note
: If ADVANCE_CHIRP_CONFIG_EN is set then this Field is not used/applicable.

Definition at line 995 of file rl_sensor.h.

◆ chirpStartIdx

rlUInt16_t rlFrameCfg_t::chirpStartIdx

Start Index of Chirp Valid range = 0-511.

Note
: If ADVANCE_CHIRP_CONFIG_EN is set then this Field is not used/applicable.

Definition at line 990 of file rl_sensor.h.

◆ numLoops

rlUInt16_t rlFrameCfg_t::numLoops

Number of times to repeat from chirpStartIdx to chirpEndIdx in each frame,
valid range = 1 to 255
.

Note
: If ADVANCE_CHIRP_CONFIG_EN is set then this field definition is modified.
ADVANCE_CHIRP_CONFIG mode: This field configures the total number of chirps in a frame L. This should be programmed as per below calculation.
L = X * Y, where X is 1 to 512 (HW RAM) and Y is 1 to 128 (HW loops)
The value of L should be a multiple of 4 (assuming each chirp is min 25us duration) i.e 1, 4, 8, 12, 16, 20, 24 ¦ 32768 (max).
The FW needs to prepare and update HW chirp RAM dynamically in advance chirp config API, this puts some restriction on minimum number of chirps in a burst/frame.
Valid range 1 to 32768

Definition at line 1010 of file rl_sensor.h.

◆ triggerSelect

rlUInt16_t rlFrameCfg_t::triggerSelect

Selects the mode for triggering start of transmission of frame
0x0001 SWTRIGGER (Software API based triggering):
Frame is triggered upon receiving rlSensorStart
There could be several tens of micro seconds uncertainty in triggering.
.

Note
: This mode is not applicable if this mmwave device is configured as
MULTICHIP_SLAVE in rlChanCfg_t
0x0002 HWTRIGGER (Hardware SYNC_IN based triggering):
Each frame is triggered by rising edge of pulse in SYNC_IN pin, after receiving rlSensorStart (this is to prevent spurious transmission). W.r.t. the SYNC_IN pulse, the actual transmission has ~160ns delay and 5ns uncertainty in SINGLECHIP and only a 300 ps uncertainty (due to tight inter-chip synchronization needed) in MULTICHIP sensor applications as defined in rlChanCfg_t.
For more details please refer to device datasheet.

Definition at line 1056 of file rl_sensor.h.


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

Copyright 2021, Texas Instruments Incorporated