zoomproc.h

Go to the documentation of this file.

/*
 *  
 *  NOTE:
 *      (C) Copyright 2018 - 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 ZOOMPROC_H_
#define ZOOMPROC_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>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DPU_ZOOMPROC_NUM_HWA_PARAM_SETS             1U
 
#define DPU_ZOOMPROC_EINVAL                  (DP_ERRNO_ZOOM_PROC_BASE-1)
 
#define DPU_ZOOMPROC_ENOMEM                  (DP_ERRNO_ZOOM_PROC_BASE-2)
 
#define DPU_ZOOMPROC_EINTERNAL               (DP_ERRNO_ZOOM_PROC_BASE-3)
 
#define DPU_ZOOMPROC_ENOTIMPL                (DP_ERRNO_ZOOM_PROC_BASE-4)
 
#define DPU_ZOOMPROC_EINPROGRESS             (DP_ERRNO_ZOOM_PROC_BASE-5)
 
#define DPU_ZOOMPROC_ECMD                    (DP_ERRNO_ZOOM_PROC_BASE-6)
 
#define DPU_ZOOMPROC_ESEMA                   (DP_ERRNO_ZOOM_PROC_BASE-7)
 
typedef uint32_t DPU_ZoomProc_InputMode;
#define DPU_ZoomProc_InputMode_MAPPED              (uint32_t) 0U
#define DPU_ZoomProc_InputMode_ISOLATED            (uint32_t) 1U  
#define DPU_ZoomProc_InputMode_HWA_INTERNAL_MEM    (uint32_t) 2U
 
typedef struct DPU_ZoomProc_HwaConfig_t
{
    uint8_t         paramSetStartIdx;
 
    uint8_t         numParamSet;
 
    DPU_ZoomProc_InputMode      dataInputMode;
 
    uint8_t        dmaTrigSrcChan;
 
}DPU_ZoomProc_HwaConfig;
 
typedef struct DPU_ZoomProc_EDMAInputConfig_t
{
    DPEDMA_ChanCfg        dataIn;
 
    DPEDMA_ChanCfg        dataInSignature;
}DPU_ZoomProc_EDMAInputConfig;
 
typedef struct DPU_ZoomProc_EDMAOutputConfig_t
{
    DPEDMA_ChanCfg        dataOutZoom;
 
}DPU_ZoomProc_EDMAOutputConfig;
 
 
typedef struct DPU_ZoomProc_HW_Resources_t
{
    EDMA_Handle         edmaHandle;
 
    DPU_ZoomProc_HwaConfig      hwaCfg;
 
    DPU_ZoomProc_EDMAInputConfig edmaInCfg;
 
    DPU_ZoomProc_EDMAOutputConfig edmaOutCfg;
 
    Edma_IntrObject *intrObj;
 
    cmplx32ImRe_t   *zoomDftOut;
 
    uint32_t        zoomDftOutSize;
 
    uint16_t        *zoomInRbin;
 
}DPU_ZoomProc_HW_Resources;
 
typedef struct DPU_ZoomProc_StaticConfig_t
{
    uint8_t     numTxAntennas;
 
    uint8_t     numVirtualAntennas;
 
    bool        isTestMode;
 
    /* Number of ADC samples */
    //uint16_t    numAdcSamples;
 
    float       freqRes;
 
    float       zoomRngFactor; // 3.0e8 * chirpRampTime/(2 * chirpBandwidth)
 
    uint16_t    numRangeBins;
 
    uint16_t    numDftBins;
 
    uint16_t    zoomFftSize;
 
    uint16_t    zoomSamplesOneSide;
 
    uint16_t    interpFactor;
 
    uint16_t    *peakLoc;
 
    uint16_t    numChirpsPerFrame;
 
    DPIF_ADCBufData     ADCBufData;
 
     uint8_t    lowPowerMode;
}DPU_ZoomProc_StaticConfig;
 
typedef struct DPU_ZoomProc_Config_t
{
    DPU_ZoomProc_HW_Resources   hwRes;
 
    DPU_ZoomProc_StaticConfig   staticCfg;
 
}DPU_ZoomProc_Config;
 
typedef struct DPU_ZoomProc_InitParams_t
{
    HWA_Handle          hwaHandle;
}DPU_ZoomProc_InitParams;
 
typedef struct DPU_ZoomProc_OutParams_t
{
    float  zoomRangeMeas;
 
    bool      endOfChirp;
}DPU_ZoomProc_OutParams;
 
typedef void* DPU_ZoomProc_Handle ;
 
typedef struct ZoomProcObj_t
{
    DPU_ZoomProc_InitParams     initParms;
 
    EDMA_Handle                 edmaHandle;
 
    DPU_ZoomProc_StaticConfig    params;
 
    DPU_ZoomProc_HwaConfig      hwaCfg;
 
    bool                    isTestMode;
 
    uint8_t                 dataInTrigger;
 
    uint8_t                 dataOutTrigger;
 
    SemaphoreP_Object       edmaDoneSemaHandle;
 
    SemaphoreP_Object       hwaDoneSemaHandle;
 
    uint32_t                hwaMemBankAddr[SOC_HWA_NUM_MEM_BANKS];
 
    cmplx16ImRe_t           *ADCdataBuf;
 
    cmplx32ImRe_t           *zoomDftOut;
 
    uint16_t                *zoomInRbin;
    
    uint8_t                 dataOutZoomChan;
 
    bool                    inProgress;
 
    uint32_t                numProcess;
 
    uint32_t                numEdmaDataOutCnt;
 
}ZoomProcObj;
 
/*================================================================
               zoomProc DPU exposed APIs            
 ================================================================*/
DPU_ZoomProc_Handle DPU_ZoomProc_init
(
    DPU_ZoomProc_InitParams     *initParams,
    int32_t*                        errCode
);
 
int32_t DPU_ZoomProc_config
(
    DPU_ZoomProc_Handle     handle,
    DPU_ZoomProc_Config*    zoomCfg
);
 
int32_t DPU_ZoomProc_process
(
    DPU_ZoomProc_Handle     handle,
    DPU_ZoomProc_OutParams* outParams
);
 
int32_t DPU_ZoomProc_deinit
(
    DPU_ZoomProc_Handle     handle
);
 
#ifdef __cplusplus
}
#endif
 
#endif