dopplerprochwa.h

Go to the documentation of this file.

/*
 *  
 *  NOTE:
 *      (C) Copyright 2023 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 DOPPLERPROCHWA_H_
#define DOPPLERPROCHWA_H_
 
/* Standard Include Files. */
#include <stdint.h>
#include <stdlib.h>
#include <stddef.h>
#include <string.h>
#include <stdio.h>
#include <math.h>
 
/* mmWave SDK Driver/Common Include Files */
#include <drivers/hwa.h>
 
/* DPIF Components Include Files */
#include <datapath/dpif/dpif_detmatrix.h>
#include <datapath/dpif/dpif_radarcube.h>
#include <datapath/dpedma/v0/dpedmahwa.h>
#include <datapath/dpedma/v0/dpedma.h>
 
/* mmWave SDK Data Path Include Files */
#include <datapath/dpif/dp_error.h>
#include <datapath/dpu/dopplerproc/v0/dopplerproc_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DPU_DOPPLERPROCHWA_EINVAL                  (DP_ERRNO_DOPPLER_PROC_BASE-1)
 
#define DPU_DOPPLERPROCHWA_ENOMEM                  (DP_ERRNO_DOPPLER_PROC_BASE-2)
 
#define DPU_DOPPLERPROCHWA_EINPROGRESS             (DP_ERRNO_DOPPLER_PROC_BASE-3)
 
#define DPU_DOPPLERPROCHWA_EHWARES                 (DP_ERRNO_DOPPLER_PROC_BASE-4)
 
#define DPU_DOPPLERPROCHWA_ESEMA                   (DP_ERRNO_DOPPLER_PROC_BASE-5)
 
#define DPU_DOPPLERPROCHWA_ESEMASTATUS             (DP_ERRNO_DOPPLER_PROC_BASE-6)
 
#define DPU_DOPPLERPROCHWA_EEXCEEDHWAMEM           (DP_ERRNO_DOPPLER_PROC_BASE-7)
 
#define DPU_DOPPLERPROCHWA_ECUBEFORMAT             (DP_ERRNO_DOPPLER_PROC_BASE-8)
 
#define DPU_DOPPLERPROCHWA_EDETMFORMAT             (DP_ERRNO_DOPPLER_PROC_BASE-9)
 
#define DPU_DOPPLERPROCHWA_EDETMSIZE               (DP_ERRNO_DOPPLER_PROC_BASE-10)
 
#define DPU_DOPPLERPROCHWA_EWINDSIZE               (DP_ERRNO_DOPPLER_PROC_BASE-11)
 
#define DPU_DOPPLERPROCHWA_MAX_NUM_HWA_PARAMSET 12
 
#define DPU_DOPPLERPROCHWA_NUM_HWA_PARAMSET_PER_RANGE_BIN 2
 
#define DPU_DOPPLERPROCHWA_NUM_HWA_MEMBANKS  4
 
#define DPU_DOPPLERPROCHWA_FIRST_SCALING_DISABLED ((uint8_t)0U)
 
#define DPU_DOPPLERPROCHWA_FIRST_SCALING_ENABLED ((uint8_t)1U)
 
         
typedef void*  DPU_DopplerProcHWA_Handle;
 
typedef struct DPU_DopplerProcHWA_InitCfg_t
{
    HWA_Handle  hwaHandle;
    
}DPU_DopplerProcHWA_InitParams;
 
typedef volatile struct DPU_DopplerProcHWA_HwaSumOutput_t
{
    int32_t   sumIm;        
    int32_t   sumRe;        
}  DPU_DopplerProcHWA_HwaSumOutput;
 
typedef struct DPU_DopplerProcHWA_HwaCfg_t
{
    uint8_t     winSym;
 
    uint32_t    windowSize;
 
    int32_t     *window;
 
    uint32_t    winRamOffset;
    
    uint32_t    paramSetStartIdx;
 
    uint8_t     dmaTrigSrcPingChan;
    
    uint8_t     dmaTrigSrcPongChan;
}DPU_DopplerProcHWA_HwaCfg;
 
typedef struct DPU_DopplerProcHWA_EdmaCfg_t
{
    EDMA_Handle edmaHandle;
    
    DPU_DopplerProc_Edma edmaIn;
 
    DPU_DopplerProc_Edma edmaOutDetectionMatrix;
    
    DPU_DopplerProc_Edma edmaHotSig;
}DPU_DopplerProcHWA_EdmaCfg;
 
typedef struct DPU_DopplerProcHWA_HW_Resources_t
{
    DPU_DopplerProcHWA_EdmaCfg edmaCfg;
    
    DPU_DopplerProcHWA_HwaCfg  hwaCfg;
    
    DPIF_RadarCube radar_1D_FFT_Cube;
 
    DPIF_DetMatrix detMatrix;
 
    /* 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;
}DPU_DopplerProcHWA_HW_Resources;
 
typedef struct DPU_DopplerProcHWA_compressCfg_t
{
 
    uint8_t     compressionFactor;
 
    /* number of complex samples to compress */
    uint32_t numComplexElements;
 
} DPU_DopplerProcHWA_compressCfg;
 
typedef struct DPU_DopplerProcHWA_StaticConfig_t
{
    uint8_t     numTxAntennas;
    
    uint8_t     numRxAntennas;
    
    uint8_t     numVirtualAntennas; 
    
    uint16_t    numRangeBins;
    
    uint16_t    numDopplerChirps;
    
    uint16_t    numDopplerBins;
    
    uint8_t     log2NumDopplerBins;
 
    uint8_t    doppFFT_is16b;
    
    bool        isDetMatrixLogScale;
 
    bool isCompressionEnabled;
 
    DPU_DopplerProcHWA_compressCfg compressCfg;
    
}DPU_DopplerProcHWA_StaticConfig;
 
typedef struct DPU_DopplerProcHWA_Config_t
{
    DPU_DopplerProcHWA_HW_Resources  hwRes;
    
    DPU_DopplerProcHWA_StaticConfig  staticCfg;
    
}DPU_DopplerProcHWA_Config;
 
 
typedef struct DPU_DopplerProcHWA_OutParams_t
{
    DPU_DopplerProc_stats  stats;
}DPU_DopplerProcHWA_OutParams;
 
 
DPU_DopplerProcHWA_Handle DPU_DopplerProcHWA_init(DPU_DopplerProcHWA_InitParams *initCfg, int32_t* errCode);
int32_t DPU_DopplerProcHWA_process(DPU_DopplerProcHWA_Handle handle, DPU_DopplerProcHWA_OutParams *outParams);
int32_t DPU_DopplerProcHWA_deinit(DPU_DopplerProcHWA_Handle handle);
int32_t DPU_DopplerProcHWA_config(DPU_DopplerProcHWA_Handle handle, DPU_DopplerProcHWA_Config *cfg);
int32_t DPU_DopplerProcHWA_GetNumUsedHwaParamSets(DPU_DopplerProcHWA_Handle handle, uint8_t *numUsedHwaParamSets);
 
#ifdef __cplusplus
}
#endif
 
#endif