Data Fields
rlAdvChirpCfg_t Struct Reference

Advanced chirp configuration structure. More...

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

Data Fields

rlUInt8_t chirpParamIdx
 Chirp parameter that the current API configures. The mapping and availability of dither modes are as below:
Index Parameter Delta Dither LUT Dither
0 CHIRP_PROFILE_SELECT NO YES
1 CHIRP_FREQ_START_VAR YES YES
2 CHIRP_FREQ_SLOPE_VAR YES YES
3 CHIRP_IDLE_TIME_VAR YES YES
4 CHIRP_ADC_START_TIME_VAR YES YES
5 CHIRP_TX_EN NO YES
6 CHIRP_BPM_VAL NO YES
7 TX0_PHASE_SHIFTER YES YES
8 TX1_PHASE_SHIFTER YES YES
9 TX2_PHASE_SHIFTER YES YES
Others Reserved
The parameters referred to here are the same as the ones with the name referred to in AWR_CHIRP_CONF_SET_SB and in AWR_PERCHIRPPHASESHIFT_CONF_SB.
.
 
rlUInt8_t resetMode
 Reset mode of the programmed pattern
Mode Definition
0 Reset at end of frame
1 Reset at end of sub-frame
2 Reset at end of burst
Others Reserved
It indicates when the fixed delta accumulation (Delta Dither) or the programmed dither pattern from LUT (LUT Dither) resets back to its initial value. This is a global reset occurs for all the chirp parameters. This value should be same for all chirp parameter.
.
 
rlUInt16_t reserved0
 Reserved for future use.
 
rlUInt32_t reserved1
 Reserved for future use.
 
rlUInt16_t deltaResetPeriod
 Reset the delta increment (Delta Dither) sequence every M chirps
Index Parameter
0 Reset only as per RESET MODE option
1 Delta increment is disabled
2-32768 Reset every M chirps in addition to RESET MODE option
The reset period should be integer multiple of DELTA_PARAM_UPDATE_PERIOD (N)
Range : 0-32768
.
 
rlUInt16_t deltaParamUpdatePeriod
 The chirp parameter will be incremented by SFn_CHIRP_PARAM_DELTA (Delta Dither) every N chirps.
Index Parameter
0 Delta increment is disabled
1-N The fixed delta value will be incremented once after every N chirps.
Range : 0-16384
.
 
rlInt32_t sf0ChirpParamDelta
 This field indicates the delta increment (Delta Dither) value for sub-frame 0 (Also applicable for legacy frame config API) that should be accumulated and added to each chirp based on update period N.
This accumulated fixed dither value which increments every N chirps is added to LUT dither value derived for same chirp, The sum of accumulated dither and LUT dither derived for each chirp is added to profile setting of same chirp parameter in HW.
As some parameters may need signed values, all the Bytes in this field should be populated with appropriate sign extension.
Refer to the Fixed Delta Chirp Parameter LUT description table Table for the definition of this field when each parameter is selected. This feature is enabled only for certain chirp parameter types as defined in this table.
.
 
rlInt32_t sf1ChirpParamDelta
 This field indicates the delta increment (Delta Dither) value for sub-frame 1 (Also applicable for legacy frame config API) that should be accumulated and added to each chirp based on update period N.
This accumulated fixed dither value which increments every N chirps is added to LUT dither value derived for same chirp, The sum of accumulated dither and LUT dither derived for each chirp is added to profile setting of same chirp parameter in HW.
As some parameters may need signed values, all the Bytes in this field should be populated with appropriate sign extension.
Refer to the Fixed Delta Chirp Parameter LUT description table Table for the definition of this field when each parameter is selected. This feature is enabled only for certain chirp parameter types as defined in this table.
.
 
rlInt32_t sf2ChirpParamDelta
 This field indicates the delta increment (Delta Dither) value for sub-frame 2 (Also applicable for legacy frame config API) that should be accumulated and added to each chirp based on update period N.
This accumulated fixed dither value which increments every N chirps is added to LUT dither value derived for same chirp, The sum of accumulated dither and LUT dither derived for each chirp is added to profile setting of same chirp parameter in HW.
As some parameters may need signed values, all the Bytes in this field should be populated with appropriate sign extension.
Refer to the Fixed Delta Chirp Parameter LUT description table Table for the definition of this field when each parameter is selected. This feature is enabled only for certain chirp parameter types as defined in this table.
.
 
rlInt32_t sf3ChirpParamDelta
 This field indicates the delta increment (Delta Dither) value for sub-frame 3 (Also applicable for legacy frame config API) that should be accumulated and added to each chirp based on update period N.
This accumulated fixed dither value which increments every N chirps is added to LUT dither value derived for same chirp, The sum of accumulated dither and LUT dither derived for each chirp is added to profile setting of same chirp parameter in HW.
As some parameters may need signed values, all the Bytes in this field should be populated with appropriate sign extension.
Refer to the Fixed Delta Chirp Parameter LUT description table Table for the definition of this field when each parameter is selected. This feature is enabled only for certain chirp parameter types as defined in this table.
.
 
rlUInt32_t reserved2
 Reserved for future use.
 
rlUInt16_t lutResetPeriod
 Reset the LUT sequence (LUT Dither) every J chirps
Index Parameter
0 Reset only as per RESET MODE option
1 Fixed 0th indexed LUT value programmed for all chirps
2-32768 Reset every M chirps in addition to RESET MODE option
The reset period should be integer multiple of LUT_PARAM_UPDATE_PERIOD (K)
Range : 0-32768
.
 
rlUInt16_t lutParamUpdatePeriod
 The chirp parameter (LUT Dither) will be updated with new value from LUT every K chirps.
Index Parameter
0 Fixed 0th indexed LUT value programmed for all chirps
1-K Index to LUT will be incremented once after every K chirps and corresponding LUT value is used.
Range : 0-16384
.
 
rlUInt16_t lutPatternAddressOffset
 This field provides the start address offset within the Generic SW Chirp Parameter LUT which holds dither parameters (LUT Dither) for this CHIRP_PARAM_INDEX.
The first chirp of the burst/frame picks the dither from 0th index to LUT with this address offset and dithers for next chirps will be derived based on pattern configuration defined in this API.
Address offset has to be multiple 4 bytes (word boundary)
The Generic SW chirp parameters are described in Table and it can be loaded in to LUT using AWR_ADVANCE_CHIRP_GENERIC_LUT_LOAD_SB API.
.
 
rlUInt16_t numOfPatterns
 This field provides the number of unique dither parameters present in LUT.
This information is used to perform out of bound error check on index to LUT. (LUT Dither)
Range : 1-8192
.
 
rlUInt16_t lutBurstIndexOffset
 This field provides the LUT index start offset for subsequent bursts in advanced frame config API. The chirp LUT start index for each burst is determined as the chirp LUT start index of the previous burst plus BURST_LUT_INDEX_OFFSET. This feature helps to loop set of different chirps in subsequent bursts in a sub-frame.
Only relevant when using Advanced Frame Config API. Provides flexibility to have an offset in index to LUT (LUT Dither) from one burst to the next burst.
Index Parameter
0 No offset (default)
1-P LUT index start offset for each burst
. More...
 
rlUInt16_t lutSfIndexOffset
 This field provides the LUT index start offset for subsequent sub-frames in advanced frame config API. The chirp LUT start index for first burst in each SF is determined as the chirp LUT start index of the previous SF plus SF_LUT_INDEX_OFFSET. This feature helps to loop set of different chirps in subsequent sub-frames.
Only relevant when using Advanced Frame Config API. Provides flexibility to have an offset in index to LUT (LUT Dither) from one subframe to the next subframe.
Index Parameter
0 No offset (default)
1-P LUT index start offset for each sub-frame (SF)
. More...
 
rlUInt8_t lutChirpParamSize
 This field is applicable only for LUT chirp parameters (LUT Dither) of type CHIRP_FREQ_START_VAR or CHIRP_IDLE_TIME_VAR or CHIRP_ADC_START_TIME_VAR. This feature can be used to reduce the size of the parameter in LUT if dynamic range of parameter is small.
LUT_CHIRP_PARAM_SIZE 0 1 2
CHIRP_FREQ_START_VAR 4 bytes 2 bytes 1 byte
CHIRP_IDLE_TIME_VAR 2 bytes 1 byte -
CHIRP_ADC_START_TIME_VAR 2 bytes 1 byte -
Range : 0-2
Default Value : 0 (default size)
.
 
rlUInt8_t lutChirpParamScale
 This field is applicable only for LUT chirp parameters (LUT Dither) of type CHIRP_FREQ_START_VAR or CHIRP_IDLE_TIME_VAR or CHIRP_ADC_START_TIME_VAR. This feature can be used to reduce the size of the parameter in LUT if granularity of the resolution can be increased.
Range : 0-16
The actual parameter value for the defined chirp is given by: 2^ LUT_CHIRP_PARAM_SCALE * LUT_PARAM_VALUE
Default Value : 0 (no scale)
.
 
rlUInt16_t maxTxPhShiftIntDither
 This field is applicable only if SFn_CHIRP_PARAM_DELTA increment (Delta Dither) is enabled for Phase shifter dithers. It controls the TX phase quantization. The device internal TX phase shifters are 6 bit. For deriving the internal 6 bit phase, the 16 bit CHIRP_PARAM_DELTA is accumulated in the firmware every chirp. The accumulator’s output is added with a random number from 0 to this field’s value. The 6 MSBs of the adder’s output are used as the internal 6 bit phase for that chirp.
Range : 0-4096
Default Value : 0 (no dither)
.
 
rlUInt32_t reserved3
 Reserved for future use.
 
rlUInt32_t reserved4
 Reserved for future use.
 

Detailed Description

Advanced chirp configuration structure.

Definition at line 4833 of file rl_sensor.h.

Field Documentation

◆ lutBurstIndexOffset

rlUInt16_t rlAdvChirpCfg_t::lutBurstIndexOffset

This field provides the LUT index start offset for subsequent bursts in advanced frame config API. The chirp LUT start index for each burst is determined as the chirp LUT start index of the previous burst plus BURST_LUT_INDEX_OFFSET. This feature helps to loop set of different chirps in subsequent bursts in a sub-frame.
Only relevant when using Advanced Frame Config API. Provides flexibility to have an offset in index to LUT (LUT Dither) from one burst to the next burst.
Index Parameter
0 No offset (default)
1-P LUT index start offset for each burst
.

Note
1 : The first burst in second or higher sub-frame is always indexing to SF_LUT_INDEX_OFFSET parameter in LUT.
2 : The LUT_RESET_PERIOD can not be more than number of chirps in a burst if this feature is used.

Definition at line 5040 of file rl_sensor.h.

◆ lutSfIndexOffset

rlUInt16_t rlAdvChirpCfg_t::lutSfIndexOffset

This field provides the LUT index start offset for subsequent sub-frames in advanced frame config API. The chirp LUT start index for first burst in each SF is determined as the chirp LUT start index of the previous SF plus SF_LUT_INDEX_OFFSET. This feature helps to loop set of different chirps in subsequent sub-frames.
Only relevant when using Advanced Frame Config API. Provides flexibility to have an offset in index to LUT (LUT Dither) from one subframe to the next subframe.
Index Parameter
0 No offset (default)
1-P LUT index start offset for each sub-frame (SF)
.

Note
1 : The first SF in advance frame is always indexing to 0th parameter in LUT.
2 : The LUT_RESET_PERIOD can not be more than number of chirps in a sub-frame if this feature is used.

Definition at line 5055 of file rl_sensor.h.


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

Copyright 2021, Texas Instruments Incorporated