rangeprochwa.h

Go to the documentation of this file.

/*
 *  
 *  NOTE:
 *      (C) Copyright 2018 - 2022 Texas Instruments, Inc.
 *
 *  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.
 */
 
/**************************************************************************
 *************************** Include Files ********************************
 **************************************************************************/
#ifndef RANGEPROCHWA_H
#define RANGEPROCHWA_H
 
/* Standard Include Files. */
#include <stdint.h>
#include <stdlib.h>
#include <stddef.h>
#include <string.h>
#include <stdio.h>
 
/* MCU Plus SDK Drivers include files */
#include <drivers/hwa.h>
 
/* mmWave SDK Data Path Include Files */
#include <datapath/dpif/dpif_adcdata.h>
#include <datapath/dpif/dpif_radarcube.h>
#include <datapath/dpif/dp_error.h>
#include <datapath/dpedma/v0/dpedmahwa.h>
#include <datapath/dpedma/v0/dpedma.h>
#include <datapath/dpu/rangeproc/v0/rangeproc_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DPU_RANGEPROCHWA_NUM_HWA_PARAM_SETS             4U
 
#define DPU_RANGEPROCHWA_DCRANGESIGMEAN_BYTE_ALIGNMENT_DSP 8U
 
#define DPU_RANGEPROCHWA_DCRANGESIGMEAN_BYTE_ALIGNMENT_R5F 4U
 
#define DPU_RANGEPROCHWA_RADARCUBE_BYTE_ALIGNMENT_R5F    CSL_CACHE_L1D_LINESIZE
 
#define DPU_RANGEPROCHWA_RADARCUBE_BYTE_ALIGNMENT_DSP    (sizeof(int16_t))
 
#define DPU_RANGEPROCHWA_EINVAL                  (DP_ERRNO_RANGE_PROC_BASE-1)
 
#define DPU_RANGEPROCHWA_ENOMEM                  (DP_ERRNO_RANGE_PROC_BASE-2)
 
#define DPU_RANGEPROCHWA_EINTERNAL               (DP_ERRNO_RANGE_PROC_BASE-3)
 
#define DPU_RANGEPROCHWA_ENOTIMPL                (DP_ERRNO_RANGE_PROC_BASE-4)
 
#define DPU_RANGEPROCHWA_EINPROGRESS             (DP_ERRNO_RANGE_PROC_BASE-5)
 
#define DPU_RANGEPROCHWA_ECMD                    (DP_ERRNO_RANGE_PROC_BASE-6)
 
#define DPU_RANGEPROCHWA_ESEMA                   (DP_ERRNO_RANGE_PROC_BASE-7)
 
#define DPU_RANGEPROCHWA_EDCREMOVAL              (DP_ERRNO_RANGE_PROC_BASE-8)
 
#define DPU_RANGEPROCHWA_EADCBUF_INTF            (DP_ERRNO_RANGE_PROC_BASE-9)
 
#define DPU_RANGEPROCHWA_ERADARCUBE_INTF         (DP_ERRNO_RANGE_PROC_BASE-10)
 
#define DPU_RANGEPROCHWA_EWINDOW                 (DP_ERRNO_RANGE_PROC_BASE-11)
 
#define DPU_RANGEPROCHWA_EBUTTERFLYSCALE         (DP_ERRNO_RANGE_PROC_BASE-12)
 
 #define DPU_RANGEPROCHWA_EEDMA_ERROR         (DP_ERRNO_RANGE_PROC_BASE-13)
 
typedef uint32_t DPU_RangeProcHWA_InputMode;
#define DPU_RangeProcHWA_InputMode_MAPPED              (uint32_t) 0U
#define DPU_RangeProcHWA_InputMode_ISOLATED            (uint32_t) 1U  
#define DPU_RangeProcHWA_InputMode_HWA_INTERNAL_MEM    (uint32_t) 2U
 
typedef uint32_t DPU_RangeProcHWA_Cmd;
#define DPU_RangeProcHWA_Cmd_dcRangeCfg         (uint32_t) 0
#define DPU_RangeProcHWA_Cmd_triggerProc        (uint32_t) 1
 
typedef struct DPU_RangeProcHWA_FFTtuning_t{
    uint16_t    fftOutputDivShift;
 
    uint16_t    numLastButterflyStagesToScale;
 
}DPU_RangeProcHWA_FFTtuning;
 
 
typedef struct DPU_RangeProcHWA_HwaConfig_t
{
    uint8_t         paramSetStartIdx;
 
    uint8_t         numParamSet;
 
    uint8_t         hwaWinSym;
 
    uint16_t        hwaWinRamOffset;
 
    DPU_RangeProcHWA_InputMode      dataInputMode;
 
    uint8_t        dmaTrigSrcChan[2];
 
    uint8_t         hardwareTrigSrc;
 
}DPU_RangeProcHWA_HwaConfig;
 
typedef struct DPU_RangeProcHWA_EDMAInputConfig_t
{
    DPEDMA_2LinkChanCfg        dataIn;
 
    DPEDMA_ChanCfg        dataInSignature;
}DPU_RangeProcHWA_EDMAInputConfig;
 
typedef struct DPU_RangeProcHWA_EDMAOutputConfigPath_t
{
    DPEDMA_ChanCfg        dataOutMajor;
 
    DPEDMA_ChanCfg        dataOutMinor;
 
    DPEDMA_2LinkChanCfg evtDecim;
 
}DPU_RangeProcHWA_EDMAOutputConfigPath;
 
 
 
 
typedef struct DPU_RangeProcHWA_EDMAOutputConfig_t
{
 
    DPU_RangeProcHWA_EDMAOutputConfigPath     path[2];
    uint32_t dummySrc;
    uint32_t dummyDst;
 
}DPU_RangeProcHWA_EDMAOutputConfig;
 
 
typedef struct DPU_RangeProcHWA_HW_Resources_t
{
    EDMA_Handle         edmaHandle;
 
    DPU_RangeProcHWA_HwaConfig      hwaCfg;
 
    DPU_RangeProcHWA_EDMAInputConfig edmaInCfg;
 
    DPU_RangeProcHWA_EDMAOutputConfig edmaOutCfg;
 
    /* NOTE: Application needs to provide address of the EDMA interrupt object.
     * This needs to be done as there might be multiple subframes configured
     * and each subframe needs EDMA interrupt to be registered.
     */
    Edma_IntrObject *intrObj;
 
    cmplx32ImRe_t       *dcRangeSigMean;
 
    uint32_t            dcRangeSigMeanSize;
 
    DPIF_RadarCube      radarCube;
 
    DPIF_RadarCube      radarCubeMinMot;
}DPU_RangeProcHWA_HW_Resources;
 
typedef struct DPU_RangeProcHWA_compressCfg_t
{
 
    uint8_t     compressionFactor;
 
    /* number of complex samples to compress */
    uint32_t numComplexElements;
 
} DPU_RangeProcHWA_compressCfg;
 
typedef struct DPU_RangeProcHWA_StaticConfig_t
{
    uint8_t     numTxAntennas;
 
    uint8_t     numVirtualAntennas;
 
    uint16_t    numRangeBins;
 
//    uint16_t    numFFTBins;
    uint16_t    rangeFftSize;
 
    uint16_t    isChirpDataReal;
 
    uint16_t    numChirpsPerFrame;
 
    uint16_t    numDopplerChirpsPerFrame;
 
    uint16_t    numDopplerChirpsPerProc;
 
    uint16_t    numMinorMotionChirpsPerFrame;
 
    uint16_t    numFramesPerMinorMotProc;
 
    int32_t    *window;
 
    uint32_t    windowSize;
 
    DPIF_ADCBufData     ADCBufData;
 
    uint8_t     resetDcRangeSigMeanBuffer;
 
    DPU_RangeProcHWA_FFTtuning    rangeFFTtuning;
 
    bool        isBpmEnabled;
 
    bool        enableMajorMotion;
 
    bool        enableMinorMotion;
 
    uint32_t    frmCntrModNumFramesPerMinorMot;
 
    uint8_t    lowPowerMode;
 
    bool isCompressionEnabled;
 
    DPU_RangeProcHWA_compressCfg compressCfg;
    
}DPU_RangeProcHWA_StaticConfig;
 
typedef struct DPU_RangeProcHWA_DynamicConfig_t
{
    DPU_RangeProc_CalibDcRangeSigCfg *calibDcRangeSigCfg;
}DPU_RangeProcHWA_DynamicConfig;
 
typedef struct DPU_RangeProcHWA_Config_t
{
    DPU_RangeProcHWA_HW_Resources   hwRes;
 
    DPU_RangeProcHWA_StaticConfig   staticCfg;
 
    DPU_RangeProcHWA_DynamicConfig  dynCfg;
}DPU_RangeProcHWA_Config;
 
typedef struct DPU_RangeProcHWA_InitParams_t
{
    HWA_Handle          hwaHandle;
}DPU_RangeProcHWA_InitParams;
 
typedef struct DPU_RangeProcHWA_OutParams_t
{
    bool                endOfChirp;
 
    DPU_RangeProc_stats  stats;
}DPU_RangeProcHWA_OutParams;
 
typedef void* DPU_RangeProcHWA_Handle ;
 
/*================================================================
               rangeProcHWA DPU exposed APIs            
 ================================================================*/
DPU_RangeProcHWA_Handle DPU_RangeProcHWA_init
(
    DPU_RangeProcHWA_InitParams     *initParams,
    int32_t*                        errCode
);
 
int32_t DPU_RangeProcHWA_config
(
    DPU_RangeProcHWA_Handle     handle,
    DPU_RangeProcHWA_Config*    rangeHwaCfg
);
 
int32_t DPU_RangeProcHWA_process
(
    DPU_RangeProcHWA_Handle     handle,
    DPU_RangeProcHWA_OutParams* outParams
);
 
int32_t DPU_RangeProcHWA_control
(
    DPU_RangeProcHWA_Handle handle,
    DPU_RangeProcHWA_Cmd    cmd,
    void*                   arg,
    uint32_t                argSize
);
 
int32_t DPU_RangeProcHWA_deinit
(
    DPU_RangeProcHWA_Handle     handle
);
 
int32_t DPU_RangeProcHWA_GetNumUsedHwaParamSets
(
    DPU_RangeProcHWA_Handle    handle,
    uint8_t *numUsedHwaParamSets
);
 
#ifdef __cplusplus
}
#endif
 
#endif