rl_device.h

/****************************************************************************************
 * FileName     : rl_device.h
 *
 * Description  : This file defines the functions required to Control mmwave radar Device.
 *
 ****************************************************************************************
 * (C) Copyright 2014, Texas Instruments Incorporated. - TI web address www.ti.com
 *---------------------------------------------------------------------------------------
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *    Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  OWNER OR CONTRIBUTORS
 *  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT,  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 */
/****************************************************************************************
* FILE INCLUSION PROTECTION
****************************************************************************************
*/
#ifndef RL_DEVICE_H
#define RL_DEVICE_H

/****************************************************************************************
* INCLUDE FILES
****************************************************************************************
*/

#ifdef __cplusplus
extern "C" {
#endif

#include <ti/control/mmwavelink/include/rl_protocol.h>

/****************************************************************************************
* MACRO DEFINITIONS
****************************************************************************************
*/

/******************************************************************************
 * TYPE-DEFINE STRUCT/ENUM/UNION DEFINITIONS
 ******************************************************************************
 */


#define RL_DEV_I_FIRST                  (0x0U)
#define RL_DEV_Q_FIRST                  (0x1U)
#define RL_DEV_IQSWAP_MAX               (0x2U)

#define RL_DEV_CH_INTERLEAVED           (0x0U)
#define RL_DEV_CH_NON_INTERLEAVED       (0x1U)
#define RL_DEV_CH_INTERLEAVE_MAX        (0x2U)


typedef struct rlFileData
{
    rlUInt32_t chunkLen;
    rlUInt16_t fData[RL_CMD_PL_LEN_MAX/2U];
}rlFileData_t;


typedef struct rlMcuClkCfg
{
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t mcuClkCtrl;
    rlUInt8_t mcuClkSrc;
    rlUInt8_t srcClkDiv;
    rlUInt8_t reserved;
#else

    rlUInt8_t mcuClkSrc;
    rlUInt8_t mcuClkCtrl;
    rlUInt8_t reserved;
    rlUInt8_t srcClkDiv;
#endif
}rlMcuClkCfg_t;

typedef struct rlPmicClkCfg
{
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t pmicClkCtrl;
    rlUInt8_t pmicClkSrc;
    rlUInt8_t srcClkDiv;
    rlUInt8_t modeSel;
#else

    rlUInt8_t pmicClkSrc;
    rlUInt8_t pmicClkCtrl;
    rlUInt8_t modeSel;
    rlUInt8_t srcClkDiv;
#endif

    rlUInt32_t freqSlope;
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t minNdivVal;
    rlUInt8_t maxNdivVal;
    rlUInt8_t clkDitherEn;
    rlUInt8_t reserved;
#else

    rlUInt8_t maxNdivVal;
    rlUInt8_t minNdivVal;
    rlUInt8_t reserved;
    rlUInt8_t clkDitherEn;
#endif
}rlPmicClkCfg_t;

typedef struct rllatentFault
{
    rlUInt32_t testEn1;
    rlUInt32_t testEn2;
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t  repMode;
    rlUInt8_t  testMode;
#else

    rlUInt8_t  testMode;
    rlUInt8_t  repMode;
#endif

    rlUInt16_t reserved;

}rllatentFault_t;

typedef struct rlperiodicTest
{   
    rlUInt32_t periodicity;
    rlUInt32_t testEn;
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t  repMode;
    rlUInt8_t  reserved0;
#else

    rlUInt8_t  reserved0;
    rlUInt8_t  repMode;
#endif

    rlUInt16_t reserved1;
}rlperiodicTest_t;

typedef struct rltestPattern
{
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t  testPatGenCtrl;
    rlUInt8_t  testPatGenTime;
#else

    rlUInt8_t  testPatGenTime;
    rlUInt8_t  testPatGenCtrl;
#endif

    rlUInt16_t testPatrnPktSize;
    rlUInt32_t numTestPtrnPkts;
    rlUInt32_t testPatRx0Icfg;
    rlUInt32_t testPatRx0Qcfg;
    rlUInt32_t testPatRx1Icfg;
    rlUInt32_t testPatRx1Qcfg;
    rlUInt32_t testPatRx2Icfg;
    rlUInt32_t testPatRx2Qcfg;
    rlUInt32_t testPatRx3Icfg;
    rlUInt32_t testPatRx3Qcfg;
    rlUInt32_t reserved;
}rltestPattern_t;

typedef struct rlDevDataFmtCfg
{
    rlUInt16_t rxChannelEn;
    rlUInt16_t adcBits;
    rlUInt16_t adcFmt;
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t iqSwapSel;
    rlUInt8_t chInterleave;
#else

    rlUInt8_t chInterleave;
    rlUInt8_t iqSwapSel;
#endif

    rlUInt32_t reserved;
}rlDevDataFmtCfg_t;

typedef struct rlDevDataPathCfg
{
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t intfSel;
    rlUInt8_t transferFmtPkt0;
    rlUInt8_t transferFmtPkt1;
    rlUInt8_t cqConfig;
    rlUInt8_t cq0TransSize;
    rlUInt8_t cq1TransSize;
    rlUInt8_t cq2TransSize;
    rlUInt8_t reserved;
#else

    rlUInt8_t transferFmtPkt0;
    rlUInt8_t intfSel;
    rlUInt8_t cqConfig;
    rlUInt8_t transferFmtPkt1;
    rlUInt8_t cq2TransSize;
    rlUInt8_t cq1TransSize;
    rlUInt8_t reserved;
    rlUInt8_t cq0TransSize;
#endif
}rlDevDataPathCfg_t;

typedef struct rlDevLaneEnable
{
    rlUInt16_t laneEn;
    rlUInt16_t reserved;
}rlDevLaneEnable_t;

typedef struct rlDevDataPathClkCfg
{
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t laneClkCfg;
    rlUInt8_t dataRate;
#else

    rlUInt8_t dataRate;
    rlUInt8_t laneClkCfg;
#endif

    rlUInt16_t reserved;
}rlDevDataPathClkCfg_t;

typedef struct rlDevLvdsLaneCfg
{
    rlUInt16_t laneFmtMap;
    rlUInt16_t laneParamCfg;
}rlDevLvdsLaneCfg_t;

typedef struct rlDevContStreamingModeCfg
{
    rlUInt16_t contStreamModeEn;
    rlUInt16_t reserved;
}rlDevContStreamingModeCfg_t;

typedef struct rlDevCsi2Cfg
{
    rlUInt32_t lanePosPolSel;
    rlUInt32_t reserved1;
}rlDevCsi2Cfg_t;

typedef struct rlDevHsiClk
{
    rlUInt16_t hsiClk;
    rlUInt16_t reserved;
}rlDevHsiClk_t;

typedef struct rlDevHsiCfg
{
    rlDevDataFmtCfg_t *datafmt;
    rlDevDataPathCfg_t *dataPath;
    rlDevDataPathClkCfg_t *dataPathClk;
}rlDevHsiCfg_t;

typedef struct rlDevConfig
{
#ifndef MMWL_BIG_ENDIAN

    rlUInt8_t aeCrcConfig;
    rlUInt8_t reserved0;
#else

    rlUInt8_t reserved0;
    rlUInt8_t aeCrcConfig;
#endif

    rlUInt16_t reserved1;
    rlUInt32_t reserved2;
    rlUInt32_t reserved3;
}rlDevMiscCfg_t;

/******************************************************************************
 * FUNCTION PROTOTYPES
 ******************************************************************************
 */

/* Device Interface Functions */
MMWL_EXPORT rlReturnVal_t rlDevicePowerOn(rlUInt8_t deviceMap,
                                          rlClientCbs_t clientCb);
MMWL_EXPORT rlReturnVal_t rlDeviceAddDevices(rlUInt8_t deviceMap);
MMWL_EXPORT rlReturnVal_t rlDeviceRemoveDevices(rlUInt8_t deviceMap);
MMWL_EXPORT rlReturnVal_t rlDevicePowerOff(void);

/* RF/DSP Start Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceRfStart(rlUInt8_t deviceMap);

/* File Download Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceFileDownload(rlUInt8_t deviceMap,
                                               rlFileData_t *data,
                                               rlUInt16_t remChunks);

/* Get Version Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceGetMssVersion(rlUInt8_t deviceMap,
                                                rlFwVersionParam_t *data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetRfVersion(rlUInt8_t deviceMap,
                                               rlFwVersionParam_t *data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetVersion(rlUInt8_t deviceMap,
                                             rlVersion_t *data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetMmWaveLinkVersion(rlSwVersionParam_t *data);

/* MCU Clock configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceMcuClkConfig(rlUInt8_t deviceMap,
                                               rlMcuClkCfg_t *data);

/* PMIC Clock configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDevicePmicClkConfig(rlUInt8_t deviceMap,
                                                rlPmicClkCfg_t *data);

/* Latetnt fault test configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceLatentFaultTests(rlUInt8_t deviceMap,
                                                   rllatentFault_t *data);

/* Periodic test configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceEnablePeriodicTests(rlUInt8_t deviceMap,
                                                      rlperiodicTest_t *data);

/* Test pattern configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceSetTestPatternConfig(rlUInt8_t deviceMap,
                                                       rltestPattern_t *data);

/* mmWaveLink Protocol configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceConfigureCrc(rlCrcType_t crcType);
MMWL_EXPORT rlReturnVal_t rlDeviceConfigureAckTimeout(rlUInt32_t ackTimeout);

/* Continuous streaming mode Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceSetContStreamingModeConfig(rlUInt8_t deviceMap,
                                                             rlDevContStreamingModeCfg_t *data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetContStreamingModeConfig(rlUInt8_t deviceMap,
                                                             rlDevContStreamingModeCfg_t *data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetMiscConfig(rlUInt8_t deviceMap,
                                                rlDevMiscCfg_t *data);

/*data Path(LVDS/CSI2) configuration Functions */
MMWL_EXPORT rlReturnVal_t rlDeviceSetDataFmtConfig(rlUInt8_t deviceMap,
                                                   rlDevDataFmtCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetDataFmtConfig(rlUInt8_t deviceMap,
                                                   rlDevDataFmtCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetDataPathConfig(rlUInt8_t deviceMap,
                                                    rlDevDataPathCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetDataPathConfig(rlUInt8_t deviceMap,
                                                    rlDevDataPathCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetLaneConfig(rlUInt8_t deviceMap,
                                                rlDevLaneEnable_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetLaneConfig(rlUInt8_t deviceMap,
                                                rlDevLaneEnable_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetDataPathClkConfig(rlUInt8_t deviceMap,
                                                       rlDevDataPathClkCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetDataPathClkConfig(rlUInt8_t deviceMap,
                                                       rlDevDataPathClkCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetLvdsLaneConfig(rlUInt8_t deviceMap,
                                                    rlDevLvdsLaneCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetLvdsLaneConfig(rlUInt8_t deviceMap,
                                                    rlDevLvdsLaneCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetHsiConfig(rlUInt8_t deviceMap,
                                               rlDevHsiCfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetHsiClk(rlUInt8_t deviceMap,
                                            rlDevHsiClk_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceSetCsi2Config(rlUInt8_t deviceMap,
                                                rlDevCsi2Cfg_t*data);
MMWL_EXPORT rlReturnVal_t rlDeviceGetCsi2Config(rlUInt8_t deviceMap,
                                                rlDevCsi2Cfg_t*data);



#ifdef __cplusplus
}
#endif

#endif
/*
 * END OF RL_DEVICE_H
 */