rl_device.h
1 /****************************************************************************************
2  * FileName : rl_device.h
3  *
4  * Description : This file defines the functions required to Control mmwave radar Device.
5  *
6  ****************************************************************************************
7  * (C) Copyright 2014, Texas Instruments Incorporated. - TI web address www.ti.com
8  *---------------------------------------------------------------------------------------
9  *
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * Neither the name of Texas Instruments Incorporated nor the names of its
21  * contributors may be used to endorse or promote products derived from this
22  * software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
26  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
28  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 /****************************************************************************************
38 * FILE INCLUSION PROTECTION
39 ****************************************************************************************
40 */
41 #ifndef RL_DEVICE_H
42 #define RL_DEVICE_H
43 
44 /****************************************************************************************
45 * INCLUDE FILES
46 ****************************************************************************************
47 */
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 #include <ti/control/mmwavelink/include/rl_protocol.h>
54 #include <ti/control/mmwavelink/include/rl_sensor.h>
55 
56 /****************************************************************************************
57 * MACRO DEFINITIONS
58 ****************************************************************************************
59 */
60 
61 /******************************************************************************
62  * TYPE-DEFINE STRUCT/ENUM/UNION DEFINITIONS
63  ******************************************************************************
64  */
65 
66 
70 #define RL_DEV_I_FIRST (0x0U)
71 #define RL_DEV_Q_FIRST (0x1U)
72 #define RL_DEV_IQSWAP_MAX (0x2U)
73 
77 #define RL_DEV_CH_INTERLEAVED (0x0U)
78 #define RL_DEV_CH_NON_INTERLEAVED (0x1U)
79 #define RL_DEV_CH_INTERLEAVE_MAX (0x2U)
80 
81 
85 typedef struct rlFileData
86 {
90  rlUInt32_t chunkLen;
94  rlUInt16_t fData[RL_CMD_PL_LEN_MAX/2U];
96 
97 
101 typedef struct rlMcuClkCfg
102 {
103 #ifndef MMWL_BIG_ENDIAN
104 
110  rlUInt8_t mcuClkCtrl;
119  rlUInt8_t mcuClkSrc;
130  rlUInt8_t srcClkDiv;
134  rlUInt8_t reserved;
135 #else
136 
144  rlUInt8_t mcuClkSrc;
151  rlUInt8_t mcuClkCtrl;
155  rlUInt8_t reserved;
166  rlUInt8_t srcClkDiv;
167 #endif
169 
173 typedef struct rlPmicClkCfg
174 {
175 #ifndef MMWL_BIG_ENDIAN
176 
182  rlUInt8_t pmicClkCtrl;
190  rlUInt8_t pmicClkSrc;
201  rlUInt8_t srcClkDiv;
213  rlUInt8_t modeSel;
214 #else
215 
222  rlUInt8_t pmicClkSrc;
229  rlUInt8_t pmicClkCtrl;
241  rlUInt8_t modeSel;
252  rlUInt8_t srcClkDiv;
253 #endif
254 
263  rlUInt32_t freqSlope;
264 #ifndef MMWL_BIG_ENDIAN
265 
269  rlUInt8_t minNdivVal;
274  rlUInt8_t maxNdivVal;
284  rlUInt8_t clkDitherEn;
288  rlUInt8_t reserved;
289 #else
290 
294  rlUInt8_t maxNdivVal;
299  rlUInt8_t minNdivVal;
303  rlUInt8_t reserved;
313  rlUInt8_t clkDitherEn;
314 #endif
316 
320 typedef struct rllatentFault
321 {
357  rlUInt32_t testEn1;
367  rlUInt32_t testEn2;
368 #ifndef MMWL_BIG_ENDIAN
369 
374  rlUInt8_t repMode;
381  rlUInt8_t testMode;
382 #else
383 
389  rlUInt8_t testMode;
395  rlUInt8_t repMode;
396 #endif
397 
400  rlUInt16_t reserved;
402 
406 typedef struct rlperiodicTest
407 {
415  rlUInt32_t periodicity;
423  rlUInt32_t testEn;
424 #ifndef MMWL_BIG_ENDIAN
425 
430  rlUInt8_t repMode;
434  rlUInt8_t reserved0;
435 #else
436 
439  rlUInt8_t reserved0;
445  rlUInt8_t repMode;
446 #endif
447 
450  rlUInt16_t reserved1;
452 
456 typedef struct rltestPattern
457 {
458 #ifndef MMWL_BIG_ENDIAN
459 
465  rlUInt8_t testPatGenCtrl;
470  rlUInt8_t testPatGenTime;
471 #else
472 
476  rlUInt8_t testPatGenTime;
483  rlUInt8_t testPatGenCtrl;
484 #endif
485 
496  rlUInt16_t testPatrnPktSize;
500  rlUInt32_t numTestPtrnPkts;
509  rlUInt32_t testPatRx0Icfg;
519  rlUInt32_t testPatRx0Qcfg;
529  rlUInt32_t testPatRx1Icfg;
539  rlUInt32_t testPatRx1Qcfg;
549  rlUInt32_t testPatRx2Icfg;
559  rlUInt32_t testPatRx2Qcfg;
569  rlUInt32_t testPatRx3Icfg;
579  rlUInt32_t testPatRx3Qcfg;
583  rlUInt32_t reserved;
585 
589 typedef struct rlDevDataFmtCfg
590 {
606  rlUInt16_t rxChannelEn;
610  rlUInt16_t adcBits;
614  rlUInt16_t adcFmt;
615 #ifndef MMWL_BIG_ENDIAN
616 
622  rlUInt8_t iqSwapSel;
630  rlUInt8_t chInterleave;
631 #else
632 
639  rlUInt8_t chInterleave;
646  rlUInt8_t iqSwapSel;
647 #endif
648 
651  rlUInt32_t reserved;
653 
657 typedef struct rlDevDataPathCfg
658 {
659 #ifndef MMWL_BIG_ENDIAN
660 
665  rlUInt8_t intfSel;
679  rlUInt8_t transferFmtPkt0;
692  rlUInt8_t transferFmtPkt1;
701  rlUInt8_t cqConfig;
709  rlUInt8_t cq0TransSize;
717  rlUInt8_t cq1TransSize;
725  rlUInt8_t cq2TransSize;
729  rlUInt8_t reserved;
730 #else
731 
744  rlUInt8_t transferFmtPkt0;
750  rlUInt8_t intfSel;
759  rlUInt8_t cqConfig;
772  rlUInt8_t transferFmtPkt1;
780  rlUInt8_t cq2TransSize;
788  rlUInt8_t cq1TransSize;
792  rlUInt8_t reserved;
800  rlUInt8_t cq0TransSize;
801 #endif
803 
807 typedef struct rlDevLaneEnable
808 {
825  rlUInt16_t laneEn;
829  rlUInt16_t reserved;
831 
835 typedef struct rlDevDataPathClkCfg
836 {
837 #ifndef MMWL_BIG_ENDIAN
838 
843  rlUInt8_t laneClkCfg;
854  rlUInt8_t dataRate;
855 #else
856 
866  rlUInt8_t dataRate;
872  rlUInt8_t laneClkCfg;
873 #endif
874 
877  rlUInt16_t reserved;
879 
883 typedef struct rlDevLvdsLaneCfg
884 {
890  rlUInt16_t laneFmtMap;
919  rlUInt16_t laneParamCfg;
921 
925 typedef struct rlDevContStreamingModeCfg
926 {
930  rlUInt16_t contStreamModeEn;
934  rlUInt16_t reserved;
936 
940 typedef struct rlDevCsi2Cfg
941 {
984  rlUInt32_t lanePosPolSel;
985 #ifndef MMWL_BIG_ENDIAN
986 
991  rlUInt8_t lineStartEndDis;
995  rlUInt8_t reserved0;
996 #else
997 
1000  rlUInt8_t reserved0;
1006  rlUInt8_t lineStartEndDis;
1007 #endif
1008 
1011  rlUInt16_t reserved1;
1013 
1017 typedef struct rlDevHsiClk
1018 {
1028  rlUInt16_t hsiClk;
1032  rlUInt16_t reserved;
1033 }rlDevHsiClk_t;
1034 
1038 typedef struct rlDevHsiCfg
1039 {
1052 }rlDevHsiCfg_t;
1053 
1057 typedef struct rlDevConfig
1058 {
1059 #ifndef MMWL_BIG_ENDIAN
1060 
1066  rlUInt8_t aeCrcConfig;
1070  rlUInt8_t reserved0;
1071 #else
1072 
1075  rlUInt8_t reserved0;
1082  rlUInt8_t aeCrcConfig;
1083 #endif
1084 
1087  rlUInt16_t reserved1;
1091  rlUInt32_t reserved2;
1095  rlUInt32_t reserved3;
1097 
1101 typedef struct rlDebugSigEnConfig
1102 {
1110  rlUInt16_t clkOut;
1119  rlUInt16_t adcSignalOut;
1123  rlUInt32_t reserved0;
1127  rlUInt32_t reserved1;
1131  rlUInt32_t reserved2;
1133 
1137 typedef struct rlCsi2DelayDummyConfig
1138 {
1139 #ifndef MMWL_BIG_ENDIAN
1140 
1149  rlUInt8_t enableMode;
1153  rlUInt8_t reserved0;
1154 #else
1155 
1158  rlUInt8_t reserved0;
1168  rlUInt8_t enDisCfg;
1169 #endif
1170 
1173  rlUInt16_t reserved1;
1184  rlUInt16_t delayVal;
1188  rlUInt16_t reserved2;
1196  rlUInt16_t dummyVal;
1200  rlUInt16_t reserved3;
1204  rlUInt32_t reserved4;
1206 
1210 typedef struct rlDevInternalCfg
1211 {
1212  rlUInt32_t memAddr;
1213  rlUInt32_t value;
1215 
1220 typedef struct rlFillLUTParams
1221 {
1226  rlUInt16_t chirpParamIndex;
1231  rlUInt16_t chirpParamSize;
1235  rlUInt16_t inputSize;
1239  rlUInt16_t lutGlobalOffset;
1241 
1242 /******************************************************************************
1243  * FUNCTION PROTOTYPES
1244  ******************************************************************************
1245  */
1246 
1261 /* Device Interface Functions */
1262 MMWL_EXPORT rlReturnVal_t rlDevicePowerOn(rlUInt8_t deviceMap,
1263  rlClientCbs_t clientCb);
1264 MMWL_EXPORT rlReturnVal_t rlDeviceAddDevices(rlUInt8_t deviceMap);
1265 MMWL_EXPORT rlReturnVal_t rlDeviceRemoveDevices(rlUInt8_t deviceMap);
1266 MMWL_EXPORT rlReturnVal_t rlDevicePowerOff(void);
1267 
1268 /* RF/DSP Start Functions */
1269 MMWL_EXPORT rlReturnVal_t rlDeviceRfStart(rlUInt8_t deviceMap);
1270 
1271 /* File Download Functions */
1272 MMWL_EXPORT rlReturnVal_t rlDeviceFileDownload(rlUInt8_t deviceMap,
1273  rlFileData_t *data,
1274  rlUInt16_t remChunks);
1275 
1276 /* Get Version Functions */
1277 MMWL_EXPORT rlReturnVal_t rlDeviceGetMssVersion(rlUInt8_t deviceMap,
1278  rlFwVersionParam_t *data);
1279 MMWL_EXPORT rlReturnVal_t rlDeviceGetRfVersion(rlUInt8_t deviceMap,
1280  rlFwVersionParam_t *data);
1281 MMWL_EXPORT rlReturnVal_t rlDeviceGetVersion(rlUInt8_t deviceMap,
1282  rlVersion_t *data);
1283 MMWL_EXPORT rlReturnVal_t rlDeviceGetMmWaveLinkVersion(rlSwVersionParam_t *data);
1284 
1285 /* MCU Clock configuration Functions */
1286 MMWL_EXPORT rlReturnVal_t rlDeviceMcuClkConfig(rlUInt8_t deviceMap,
1287  rlMcuClkCfg_t *data);
1288 
1289 /* PMIC Clock configuration Functions */
1290 MMWL_EXPORT rlReturnVal_t rlDevicePmicClkConfig(rlUInt8_t deviceMap,
1291  rlPmicClkCfg_t *data);
1292 
1293 /* Latetnt fault test configuration Functions */
1294 MMWL_EXPORT rlReturnVal_t rlDeviceLatentFaultTests(rlUInt8_t deviceMap,
1295  rllatentFault_t *data);
1296 
1297 /* Periodic test configuration Functions */
1298 MMWL_EXPORT rlReturnVal_t rlDeviceEnablePeriodicTests(rlUInt8_t deviceMap,
1299  rlperiodicTest_t *data);
1300 
1301 /* Test pattern configuration Functions */
1302 MMWL_EXPORT rlReturnVal_t rlDeviceSetTestPatternConfig(rlUInt8_t deviceMap,
1303  rltestPattern_t *data);
1304 
1305 /* mmWaveLink Protocol configuration Functions */
1306 MMWL_EXPORT rlReturnVal_t rlDeviceConfigureCrc(rlCrcType_t crcType);
1307 MMWL_EXPORT rlReturnVal_t rlDeviceConfigureAckTimeout(rlUInt32_t ackTimeout);
1308 MMWL_EXPORT rlReturnVal_t rlDeviceSetRetryCount(rlUInt8_t retryCnt);
1309 
1310 /* Continuous streaming mode Functions */
1311 MMWL_EXPORT rlReturnVal_t rlDeviceSetContStreamingModeConfig(rlUInt8_t deviceMap,
1313 MMWL_EXPORT rlReturnVal_t rlDeviceGetContStreamingModeConfig(rlUInt8_t deviceMap,
1315 MMWL_EXPORT rlReturnVal_t rlDeviceSetMiscConfig(rlUInt8_t deviceMap,
1316  rlDevMiscCfg_t *data);
1317 MMWL_EXPORT rlReturnVal_t rlDeviceSetDebugSigEnableConfig(rlUInt8_t deviceMap,
1318  rlDebugSigEnCfg_t *data);
1319 MMWL_EXPORT rlReturnVal_t rlDeviceSetCsi2DelayDummyConfig(rlUInt8_t deviceMap,
1320  rlCsi2DelayDummyCfg_t *data);
1321 /* Get different fault status functions */
1322 MMWL_EXPORT rlReturnVal_t rlDeviceGetCpuFault(rlUInt8_t deviceMap, rlCpuFault_t *data);
1323 MMWL_EXPORT rlReturnVal_t rlDeviceGetEsmFault(rlUInt8_t deviceMap, rlMssEsmFault_t *data);
1324 
1347 /*data Path(LVDS/CSI2) configuration Functions */
1348 MMWL_EXPORT rlReturnVal_t rlDeviceSetDataFmtConfig(rlUInt8_t deviceMap,
1349  rlDevDataFmtCfg_t*data);
1350 MMWL_EXPORT rlReturnVal_t rlDeviceGetDataFmtConfig(rlUInt8_t deviceMap,
1351  rlDevDataFmtCfg_t*data);
1352 MMWL_EXPORT rlReturnVal_t rlDeviceSetDataPathConfig(rlUInt8_t deviceMap,
1353  rlDevDataPathCfg_t*data);
1354 MMWL_EXPORT rlReturnVal_t rlDeviceGetDataPathConfig(rlUInt8_t deviceMap,
1355  rlDevDataPathCfg_t*data);
1356 MMWL_EXPORT rlReturnVal_t rlDeviceSetLaneConfig(rlUInt8_t deviceMap,
1357  rlDevLaneEnable_t*data);
1358 MMWL_EXPORT rlReturnVal_t rlDeviceGetLaneConfig(rlUInt8_t deviceMap,
1359  rlDevLaneEnable_t*data);
1360 MMWL_EXPORT rlReturnVal_t rlDeviceSetDataPathClkConfig(rlUInt8_t deviceMap,
1361  rlDevDataPathClkCfg_t*data);
1362 MMWL_EXPORT rlReturnVal_t rlDeviceGetDataPathClkConfig(rlUInt8_t deviceMap,
1363  rlDevDataPathClkCfg_t*data);
1364 MMWL_EXPORT rlReturnVal_t rlDeviceSetLvdsLaneConfig(rlUInt8_t deviceMap,
1365  rlDevLvdsLaneCfg_t*data);
1366 MMWL_EXPORT rlReturnVal_t rlDeviceGetLvdsLaneConfig(rlUInt8_t deviceMap,
1367  rlDevLvdsLaneCfg_t*data);
1368 MMWL_EXPORT rlReturnVal_t rlDeviceSetHsiConfig(rlUInt8_t deviceMap,
1369  rlDevHsiCfg_t*data);
1370 MMWL_EXPORT rlReturnVal_t rlDeviceSetHsiClk(rlUInt8_t deviceMap,
1371  rlDevHsiClk_t*data);
1372 MMWL_EXPORT rlReturnVal_t rlDeviceSetCsi2Config(rlUInt8_t deviceMap,
1373  rlDevCsi2Cfg_t*data);
1374 MMWL_EXPORT rlReturnVal_t rlDeviceGetCsi2Config(rlUInt8_t deviceMap,
1375  rlDevCsi2Cfg_t*data);
1376 MMWL_EXPORT rlReturnVal_t rlDeviceSetInternalConf(rlUInt8_t deviceMap,
1377  rlUInt32_t memAddr, rlUInt32_t value);
1378 MMWL_EXPORT rlReturnVal_t rlDeviceGetInternalConf(rlUInt8_t deviceMap,
1379  rlUInt32_t memAddr, rlUInt32_t* value);
1380 MMWL_EXPORT rlReturnVal_t rlDeviceAdvFrameConfigApply(rlUInt8_t deviceMap,
1381  rlAdvFrameDataCfg_t* data);
1382 MMWL_EXPORT rlReturnVal_t rlDeviceFrameConfigApply(rlUInt8_t deviceMap,
1383  rlFrameApplyCfg_t* data);
1384 MMWL_EXPORT rlReturnVal_t rlDevSetFillLUTBuff(rlFillLUTParams_t *fillLUTParams, rlInt8_t *inData,
1385  rlInt8_t *outData, rlUInt16_t *LUTAddrOffset);
1386 
1387 
1393 #ifdef __cplusplus
1394 }
1395 #endif
1396 
1397 #endif
1398 /*
1399  * END OF RL_DEVICE_H
1400  */
1401 
rlUInt8_t transferFmtPkt0
Data out Format, b5:0 Packet 0 content selection 000001 - ADC_DATA_ONLY 000110 - CP_ADC_DATA ...
Definition: rl_device.h:679
MMWL_EXPORT rlReturnVal_t rlDevicePmicClkConfig(rlUInt8_t deviceMap, rlPmicClkCfg_t *data)
Sets the configurations for PMIC clock.
Definition: rl_device.c:1459
rlUInt16_t reserved
Reserved for future use .
Definition: rl_device.h:934
MMWL_EXPORT rlReturnVal_t rlDeviceSetDataFmtConfig(rlUInt8_t deviceMap, rlDevDataFmtCfg_t *data)
Sets LVDS/CSI2 Data output format.
Definition: rl_device.c:603
rlUInt16_t lutGlobalOffset
LUT offset within the entire 12kB buffer .
Definition: rl_device.h:1239
rlUInt8_t mcuClkSrc
This field specifies the source of the MCU clock. Applicable only in case of MCU clock enable....
Definition: rl_device.h:119
MMWL_EXPORT rlReturnVal_t rlDeviceRfStart(rlUInt8_t deviceMap)
Enables mmwave RF/Analog Sub system.
Definition: rl_device.c:325
mmWaveLink client callback structure
Definition: mmwavelink.h:1473
rlUInt16_t reserved2
Reserved for future use.
Definition: rl_device.h:1188
rlUInt16_t testPatrnPktSize
Number of ADC samples to capture for each RX Valid range: 64 to MAX_NUM_SAMPLES, Where MAX_NUM_SAMPLE...
Definition: rl_device.h:496
rlUInt32_t reserved
Reserved for future use.
Definition: rl_device.h:583
rlUInt16_t contStreamModeEn
Enable - 1, Disable - 0.
Definition: rl_device.h:930
MMWL_EXPORT rlReturnVal_t rlDeviceMcuClkConfig(rlUInt8_t deviceMap, rlMcuClkCfg_t *data)
Sets the configurations to setup the desired frequency of the MCU Clock.
Definition: rl_device.c:1413
rlUInt32_t freqSlope
Applicable only in case of PMIC clock enable. Else ignored. Bit[25:0] - Frequency slope value to be...
Definition: rl_device.h:263
rlUInt32_t testPatRx1Qcfg
This field specifies the values for Rx1, Q channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:539
rlUInt32_t lanePosPolSel
b2:0 - DATA_LANE0_POS Valid values (Should be a unique position if lane 0 is enabled,...
Definition: rl_device.h:984
MMWL_EXPORT rlReturnVal_t rlDeviceGetCsi2Config(rlUInt8_t deviceMap, rlDevCsi2Cfg_t *data)
Gets Csi2 data format Configuration.
Definition: rl_device.c:1223
rlUInt16_t dummyVal
Dummy Count value. Number of dummy bytes added per chirp For 12-bit ADC data, 12 * Dummy Value ...
Definition: rl_device.h:1196
MMWL_EXPORT rlReturnVal_t rlDeviceLatentFaultTests(rlUInt8_t deviceMap, rllatentFault_t *data)
Sets the configurations for latent fault test.
Definition: rl_device.c:1515
mmWaveLink firmware version structure
Definition: mmwavelink.h:2443
MMWL_EXPORT rlReturnVal_t rlDeviceGetMmWaveLinkVersion(rlSwVersionParam_t *data)
Get mmWaveLink Version.
Definition: rl_device.c:551
rlUInt16_t clkOut
0 : NO_CLK_OUT, Disable clock out signal 1 : REF_CLK_OUT, Reference clock out enable 2 : APLL_CLK...
Definition: rl_device.h:1110
MMWL_EXPORT rlReturnVal_t rlDeviceSetTestPatternConfig(rlUInt8_t deviceMap, rltestPattern_t *data)
Setup for test pattern to be generated.
Definition: rl_device.c:1608
MMWL_EXPORT rlReturnVal_t rlDeviceSetDataPathClkConfig(rlUInt8_t deviceMap, rlDevDataPathClkCfg_t *data)
Sets LVDS Clock Configuration.
Definition: rl_device.c:885
rlUInt8_t chInterleave
Channel interleaving of the samples stored in the ADC buffer to be transferred out on the data path...
Definition: rl_device.h:630
Structure used for filling chirp LUT parameter buffer for Advanced chirp configuration....
Definition: rl_device.h:1220
rlUInt8_t srcClkDiv
This field specifies the division factor to be applie to source clock. Applicable only in case of P...
Definition: rl_device.h:201
MMWL_EXPORT rlReturnVal_t rlDeviceSetContStreamingModeConfig(rlUInt8_t deviceMap, rlDevContStreamingModeCfg_t *data)
Sets Continous Streaming Mode Configuration.
Definition: rl_device.c:1077
MMWL_EXPORT rlReturnVal_t rlDeviceRemoveDevices(rlUInt8_t deviceMap)
Removes connected mmwave devices.
Definition: rl_device.c:202
rlUInt8_t reserved
Reserved for future use.
Definition: rl_device.h:729
rlDevDataPathCfg_t * dataPath
Data path config.
Definition: rl_device.h:1047
rlUInt16_t reserved
Reserved for future use.
Definition: rl_device.h:1032
rlUInt16_t rxChannelEn
RX Channel Bitmap b0 RX0 Channel Enable 0 Disable RX Channel 0 1 Enable RX Channel 0 b1 RX1 C...
Definition: rl_device.h:606
mmwave radar data path config.
Definition: rl_device.h:657
MMWL_EXPORT rlReturnVal_t rlDeviceSetHsiClk(rlUInt8_t deviceMap, rlDevHsiClk_t *data)
Sets High Speed Interface Clock.
Definition: rl_device.c:1372
rlUInt8_t lineStartEndDis
CSI2 Line Start and End 1 - Disable 0 - Enable.
Definition: rl_device.h:991
rlUInt32_t testPatRx2Icfg
This field specifies the values for Rx2, I channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:549
rlUInt8_t aeCrcConfig
Set CRC type of Async Event message from MSS to Host 0 - 16 Bit CRC 1 - 32 Bit CRC 2 - 64 Bit C...
Definition: rl_device.h:1066
Continous streaming mode configuration.
Definition: rl_device.h:925
rlUInt16_t laneParamCfg
Lane Parameter configurations b0 - 0(LSB first), 1(MSB first) b1 - 0(Packet End Pulse Disable),...
Definition: rl_device.h:919
MMWL_EXPORT rlReturnVal_t rlDeviceEnablePeriodicTests(rlUInt8_t deviceMap, rlperiodicTest_t *data)
Sets the configurations for periodic test.
Definition: rl_device.c:1561
rlUInt32_t reserved1
Reserved for future use.
Definition: rl_device.h:1127
mmwave radar high speed Data path configuraiton
Definition: rl_device.h:1038
DataPath clock configuration.
Definition: rl_device.h:835
mmwave radar high speed clock configuration
Definition: rl_device.h:1017
CSI2 delay dummy structure.
Definition: rl_device.h:1137
rlUInt8_t reserved0
Reserved for future use.
Definition: rl_device.h:1153
mmwave radar device latent fault test
Definition: rl_device.h:320
rlUInt32_t testEn1
Bits Definition 0 RESERVED 1 DMA self-test 2 RESERVED 3 RTI self-test 4 RESERVED 5 EDMA s...
Definition: rl_device.h:357
rlUInt8_t cq0TransSize
Number of samples (in 16 bit halfwords) of CQ0 data to be transferred. Valid range [32 halfwords to 1...
Definition: rl_device.h:709
rlUInt8_t intfSel
Data Path Interface, 0x0 CSI2 interface selected 0x1 LVDS interface selected .
Definition: rl_device.h:665
rlUInt16_t adcFmt
ADC out format - 0(Real), 1(Complex), 2(Complex with Image band), 3(Pseudo Real)
Definition: rl_device.h:614
mmwave radar device config
Definition: rl_device.h:1057
MMWL_EXPORT rlReturnVal_t rlDeviceGetRfVersion(rlUInt8_t deviceMap, rlFwVersionParam_t *data)
Get mmWave RF ROM and patch version.
Definition: rl_device.c:462
LVDS Lane configuration.
Definition: rl_device.h:883
MMWL_EXPORT rlReturnVal_t rlDeviceGetMssVersion(rlUInt8_t deviceMap, rlFwVersionParam_t *data)
Get mmWave Master SS version.
Definition: rl_device.c:425
rlUInt32_t testPatRx3Icfg
This field specifies the values for Rx3, I channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:569
rlUInt16_t reserved
Reserved for future use.
Definition: rl_device.h:877
rlUInt16_t chirpParamIndex
Chirp Parameter Index Valid range: 0 to 9 .
Definition: rl_device.h:1226
rlUInt16_t reserved1
Reserved for future use.
Definition: rl_device.h:450
rlUInt8_t reserved
Reserved for future use.
Definition: rl_device.h:288
Frame config API parameters.
Definition: rl_sensor.h:1246
rlUInt16_t laneFmtMap
Lane format 0x0000 Format map 0 (Rx0,Rx1,...) 0x0001 Format map 1 (Rx3,Rx2,......
Definition: rl_device.h:890
rlUInt8_t repMode
Value Definition 0 Report is sent every monitoring period 1 Report is sent only on a failure .
Definition: rl_device.h:430
MMWL_EXPORT rlReturnVal_t rlDeviceFileDownload(rlUInt8_t deviceMap, rlFileData_t *data, rlUInt16_t remChunks)
Download mmwave Firmware/Patches over SPI.
Definition: rl_device.c:365
mmwave radar test pattern config
Definition: rl_device.h:456
rlUInt8_t testMode
Value Definition 0 Production mode. Latent faults are tested and any failures are reported 1 Char...
Definition: rl_device.h:381
rlUInt32_t testEn2
Bits Definition 0 RESERVED 1 RESERVED 2 RESERVED 3 VIM RAM parity test 4 SCI boot time test...
Definition: rl_device.h:367
rlUInt8_t dataRate
Data rate selection 0001b - 600 Mbps (DDR only) 0010b - 450 Mbps (SDR, DDR) 0011b - 400 Mbps (D...
Definition: rl_device.h:854
rlUInt8_t modeSel
This field specifies the mode of operation for the PMIC clock generation. Applicable only in case o...
Definition: rl_device.h:213
rlUInt32_t numTestPtrnPkts
Number of test pattern packets to send, for infinite packets set it to 0.
Definition: rl_device.h:500
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.
Definition: rl_device.c:1703
CSI2 configuration.
Definition: rl_device.h:940
rlDevDataPathClkCfg_t * dataPathClk
Data path clock configuration.
Definition: rl_device.h:1051
rlUInt32_t periodicity
1 LSB = 1 ms Periodicity at which tests need to be run Minimum value is 40 ms Maximum value is 15...
Definition: rl_device.h:415
rlUInt32_t reserved
Reserved for future use.
Definition: rl_device.h:651
rlUInt8_t reserved0
Reserved for future use.
Definition: rl_device.h:1070
rlUInt8_t iqSwapSel
I/Q Swap selection for complex outputs 0 Sample interleave mode - I first 1 Sample interleave mod...
Definition: rl_device.h:622
MMWL_EXPORT rlReturnVal_t rlDeviceConfigureAckTimeout(rlUInt32_t ackTimeout)
Configures the Acknowledgement timeout in mmWaveLink Driver.
Definition: rl_device.c:1915
MMWL_EXPORT rlReturnVal_t rlDeviceAdvFrameConfigApply(rlUInt8_t deviceMap, rlAdvFrameDataCfg_t *data)
Sets Advance Frame data path Configuration.
Definition: rl_device.c:2081
rlUInt16_t inputSize
No of elements/data in the buffer .
Definition: rl_device.h:1235
mmwave radar data path lane enable
Definition: rl_device.h:807
Debug signals enable structure.
Definition: rl_device.h:1101
MMWL_EXPORT rlReturnVal_t rlDeviceSetLaneConfig(rlUInt8_t deviceMap, rlDevLaneEnable_t *data)
Sets Lane enable Configuration.
Definition: rl_device.c:791
rlUInt16_t reserved1
Reserved for future use.
Definition: rl_device.h:1087
rlUInt8_t cq1TransSize
Number of samples (in 16 bit halfwords) of CQ1 data to be transferred. Valid range [32 halfwords to 1...
Definition: rl_device.h:717
rlUInt32_t testPatRx0Qcfg
This field specifies the values for Rx0, Q channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:519
rlUInt32_t reserved3
Reserved for future use.
Definition: rl_device.h:1095
rlUInt8_t testPatGenCtrl
This field controls the enable-disable of the generation of the test pattern. Value Description 0...
Definition: rl_device.h:465
MMWL_EXPORT rlReturnVal_t rlDeviceFrameConfigApply(rlUInt8_t deviceMap, rlFrameApplyCfg_t *data)
Sets Frame data path Configuration.
Definition: rl_device.c:2130
rlUInt16_t reserved1
Reserved for future use.
Definition: rl_device.h:1011
MMWL_EXPORT rlReturnVal_t rlDeviceGetDataPathConfig(rlUInt8_t deviceMap, rlDevDataPathCfg_t *data)
Gets data path Configuration.
Definition: rl_device.c:744
MMWL_EXPORT rlReturnVal_t rlDeviceSetHsiConfig(rlUInt8_t deviceMap, rlDevHsiCfg_t *data)
: This function sets the High Speed Interface(LVDS/CSI2) clock, lane, data rate and data format
Definition: rl_device.c:1272
mmwave radar periodicity test config
Definition: rl_device.h:406
rlUInt16_t delayVal
Delay Count value. Mode DELAY_VAL Definition 0 NA 1 1 LSB = 20 ns delay Delay Added = (DELAY_...
Definition: rl_device.h:1184
MMWL_EXPORT rlReturnVal_t rlDeviceSetCsi2Config(rlUInt8_t deviceMap, rlDevCsi2Cfg_t *data)
Sets CSI2 data format Configuration.
Definition: rl_device.c:1176
rlUInt32_t testPatRx3Qcfg
This field specifies the values for Rx3, Q channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:579
rlUInt8_t reserved
Reserved for future use.
Definition: rl_device.h:134
rlUInt32_t chunkLen
File data length.
Definition: rl_device.h:90
mmwave radar data format config
Definition: rl_device.h:589
mmwave radar device MCU Clock output
Definition: rl_device.h:101
rlUInt8_t testPatGenTime
Number of system clocks (200 MHz) between successive samples for the test pattern gen....
Definition: rl_device.h:470
mmwave radar device PMIC Clock output
Definition: rl_device.h:173
rlUInt32_t testPatRx0Icfg
This field specifies the values for Rx0, I channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:509
rlUInt16_t reserved
Reserved for future use.
Definition: rl_device.h:829
Structure to hold the MSS ESM Fault data structure for event RL_DEV_AE_MSS_ESMFAULT_SB.
Definition: mmwavelink.h:1703
MMWL_EXPORT rlReturnVal_t rlDeviceSetMiscConfig(rlUInt8_t deviceMap, rlDevMiscCfg_t *data)
Setup misc. device configurations.
Definition: rl_device.c:1655
rlUInt16_t adcSignalOut
Bits Description b0 ADC_VALID, ADC valid signal enabled in GPIO_0 b31:1 RESERVED Value Descript...
Definition: rl_device.h:1119
rlUInt32_t reserved0
Reserved for future use.
Definition: rl_device.h:1123
MMWL_EXPORT rlReturnVal_t rlDevicePowerOn(rlUInt8_t deviceMap, rlClientCbs_t clientCb)
Bring mmwave Device Out of Reset.
Definition: rl_device.c:100
rlUInt8_t transferFmtPkt1
Data out Format, b5:0 Packet 1 content selection 000000 - Suppress Packet 1 001110 - CP_CQ_DATA...
Definition: rl_device.h:692
rlUInt16_t reserved1
Reserved for future use.
Definition: rl_device.h:1173
rlUInt8_t minNdivVal
Applicable only in case of PMIC clock enable. Else ignored. Min allowed divider value (depends upon...
Definition: rl_device.h:269
MMWL_EXPORT rlReturnVal_t rlDeviceGetInternalConf(rlUInt8_t deviceMap, rlUInt32_t memAddr, rlUInt32_t *value)
Reads Internal Configuration Memory.
Definition: rl_device.c:2010
rlUInt16_t reserved3
Reserved for future use.
Definition: rl_device.h:1200
rlUInt32_t reserved2
Reserved for future use.
Definition: rl_device.h:1091
rlUInt32_t testEn
Bit value definition: 1 - Enable, 0 - Disable Bit Monitoring type 0 PERIODIC_CONFG_REGISTER_READ_...
Definition: rl_device.h:423
rlUInt16_t chirpParamSize
Chirp Parameter Size Mainly applicable for Start Frequency, Idle Time and ADC Start Time .
Definition: rl_device.h:1231
rlUInt8_t cqConfig
This field specifies the data size of CQ samples on the lanes. b1:0 Data size 00 12 bits 01 14 ...
Definition: rl_device.h:701
mmwavelink software version structure
Definition: mmwavelink.h:2585
rlUInt8_t repMode
Value Definition 0 Report is sent after test completion 1 Report is send only upon a failure .
Definition: rl_device.h:374
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 ...
Definition: rl_device.c:1761
rlUInt32_t testPatRx2Qcfg
This field specifies the values for Rx2, Q channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:559
MMWL_EXPORT rlReturnVal_t rlDeviceGetEsmFault(rlUInt8_t deviceMap, rlMssEsmFault_t *data)
Get MasterSS ESM fault status.
Definition: rl_device.c:1854
MMWL_EXPORT rlReturnVal_t rlDevicePowerOff(void)
Shutdown mmwave Device.
Definition: rl_device.c:262
rlUInt8_t pmicClkCtrl
This field controls the enable - disable of the PMIC clock. Value Description 0x0 Disable PMIC cl...
Definition: rl_device.h:182
rlUInt32_t reserved4
Reserved for future use.
Definition: rl_device.h:1204
rlUInt32_t testPatRx1Icfg
This field specifies the values for Rx1, I channel. Applicable only in case of test pattern enable....
Definition: rl_device.h:529
File Dowload data structure.
Definition: rl_device.h:85
Structure to hold the MSS/radarSS CPU Fault data strucutre for event RL_DEV_AE_MSS_CPUFAULT_SB and RL...
Definition: mmwavelink.h:2273
Radar Internal configuration.
Definition: rl_device.h:1210
rlUInt32_t reserved2
Reserved for future use.
Definition: rl_device.h:1131
rlUInt16_t reserved
Reserved for future use.
Definition: rl_device.h:400
rlUInt16_t laneEn
Lane Enable Bitmap b0 Lane 0 Enable 0 Disable lane 0 1 Enable lane 0 b1 Lane 1 Enable 0 Dis...
Definition: rl_device.h:825
rlUInt8_t reserved0
Reserved for future use.
Definition: rl_device.h:995
rlUInt8_t laneClkCfg
Clock COnfiguration 0 -SDR Clock 1 - DDR Clock (Only valid value for CSI2) .
Definition: rl_device.h:843
mmwavelink version structure
Definition: mmwavelink.h:2659
rlUInt16_t adcBits
ADC out bits - 0(12 Bits), 1(14 Bits), 2(16 Bits)
Definition: rl_device.h:610
rlUInt8_t srcClkDiv
This field specifies the division factor to be applied to source clock. Applicable only in case of ...
Definition: rl_device.h:130
MMWL_EXPORT rlReturnVal_t rlDeviceSetDataPathConfig(rlUInt8_t deviceMap, rlDevDataPathCfg_t *data)
Sets LVDS/CSI2 Path Configuration.
Definition: rl_device.c:697
MMWL_EXPORT rlReturnVal_t rlDeviceGetContStreamingModeConfig(rlUInt8_t deviceMap, rlDevContStreamingModeCfg_t *data)
Gets continuous Streaming Mode Configuration.
Definition: rl_device.c:1129
rlUInt8_t enableMode
This field decides if the Delay or Dummy option is enabled or disabled Mode Definition 0 - No Del...
Definition: rl_device.h:1149
MMWL_EXPORT rlReturnVal_t rlDeviceGetDataFmtConfig(rlUInt8_t deviceMap, rlDevDataFmtCfg_t *data)
Gets LVDS/CSI2 Data output format.
Definition: rl_device.c:651
Advance Frame data config API parameters. This structure is only applicable when mmWaveLink instance ...
Definition: rl_sensor.h:1334
rlUInt8_t maxNdivVal
Applicable only in case of PMIC clock enable. Else ignored. Max allowed divider value (depends upon...
Definition: rl_device.h:274
MMWL_EXPORT rlReturnVal_t rlDeviceConfigureCrc(rlCrcType_t crcType)
Configures the CRC Type in mmWaveLink Driver.
Definition: rl_device.c:1898
rlUInt8_t reserved0
Reserved for future use.
Definition: rl_device.h:434
rlUInt16_t hsiClk
High Speed Interface Clock configurations. Below table indicates possible values for different data r...
Definition: rl_device.h:1028
rlUInt8_t mcuClkCtrl
This field controls the enable - disable of the MCU clock. Value Description 0x0 Disable MCU cloc...
Definition: rl_device.h:110
rlUInt8_t cq2TransSize
Number of samples (in 16 bit halfwords) of CQ2 data to be transferred. Valid range [32 halfwords to 1...
Definition: rl_device.h:725
MMWL_EXPORT rlReturnVal_t rlDeviceSetRetryCount(rlUInt8_t retryCnt)
: Set the command retry count
Definition: rl_device.c:1933
MMWL_EXPORT rlReturnVal_t rlDevSetFillLUTBuff(rlFillLUTParams_t *fillLUTParams, rlInt8_t *inData, rlInt8_t *outData, rlUInt16_t *LUTAddrOffset)
Filling chirp LUT parameter buffer for Advanced chirp configuration.
Definition: rl_device.c:2188
MMWL_EXPORT rlReturnVal_t rlDeviceAddDevices(rlUInt8_t deviceMap)
Bring mmwave Device Out of Reset.
Definition: rl_device.c:175
MMWL_EXPORT rlReturnVal_t rlDeviceGetLaneConfig(rlUInt8_t deviceMap, rlDevLaneEnable_t *data)
Gets Lane enable Configuration.
Definition: rl_device.c:838
rlDevDataFmtCfg_t * datafmt
Data format config.
Definition: rl_device.h:1043
rlUInt8_t pmicClkSrc
This field specifies the source of the PMIC clock. Applicable only in case of PMIC clock enable....
Definition: rl_device.h:190
rlUInt8_t clkDitherEn
Applicable only in case of PMIC clock enable. Else ignored. This field controls the enable-disable ...
Definition: rl_device.h:284
MMWL_EXPORT rlReturnVal_t rlDeviceSetInternalConf(rlUInt8_t deviceMap, rlUInt32_t memAddr, rlUInt32_t value)
Writes Internal Configuration Memory.
Definition: rl_device.c:1956
MMWL_EXPORT rlReturnVal_t rlDeviceGetCpuFault(rlUInt8_t deviceMap, rlCpuFault_t *data)
Get MasterSS CPU fault status.
Definition: rl_device.c:1807
MMWL_EXPORT rlReturnVal_t rlDeviceGetVersion(rlUInt8_t deviceMap, rlVersion_t *data)
Get mmWave Hardware, Firmware/patch and mmWaveLink version.
Definition: rl_device.c:494

Copyright 2020, Texas Instruments Incorporated