VXLIB_tableLookup.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (C) 2023 Texas Instruments Incorporated - https://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.
 *
 ******************************************************************************/
 
#ifndef VXLIB_TABLELOOKUP_IXX_IXX_OXX_H_
#define VXLIB_TABLELOOKUP_IXX_IXX_OXX_H_
 
#include "../common/VXLIB_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
   int8_t funcStyle;
   uint32_t count;
   uint16_t offset;
 
} VXLIB_tableLookup_InitArgs;
 
int32_t VXLIB_tableLookup_getHandleSize(VXLIB_tableLookup_InitArgs *pKerInitArgs);
 
VXLIB_STATUS VXLIB_tableLookup_init(VXLIB_kernelHandle                handle,
                                    VXLIB_bufParams2D_t              *bufParamsIn,
                                    VXLIB_bufParams2D_t              *bufParamsOut,
                                    VXLIB_bufParams1D_t              *bufParamsLut,
                                    const VXLIB_tableLookup_InitArgs *pKerInitArgs);
 
VXLIB_STATUS
VXLIB_tableLookup_init_checkParams(VXLIB_kernelHandle                handle,
                                   const VXLIB_bufParams2D_t        *bufParamsIn,
                                   const VXLIB_bufParams2D_t        *bufParamsOut,
                                   const VXLIB_bufParams1D_t        *bufParamsLut,
                                   const VXLIB_tableLookup_InitArgs *pKerInitArgs);
 
VXLIB_STATUS
VXLIB_tableLookup_set(VXLIB_kernelHandle handle, void *restrict pLut);
VXLIB_STATUS VXLIB_tableLookup_exec_checkParams(VXLIB_kernelHandle handle,
                                                const void *restrict pIn,
                                                const void *restrict pOut,
                                                const void *restrict pLut);
 
VXLIB_STATUS
VXLIB_tableLookup_exec(VXLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut, void *restrict pLut);
 
void VXLIB_tableLookup_perfEst(VXLIB_kernelHandle                handle,
                               const VXLIB_bufParams2D_t        *bufParamsIn,
                               const VXLIB_bufParams2D_t        *bufParamsOut,
                               const VXLIB_bufParams1D_t        *bufParamsLut,
                               const VXLIB_tableLookup_InitArgs *pKerInitArgs,
                               size_t                           *archCycles,
                               size_t                           *estCycles);
 
#ifdef __cplusplus
}
#endif
 
#endif /* VXLIB_TABLELOOKUP_IXX_IXX_OXX_H_ */
/* ======================================================================== */
/*  End of file:  VXLIB_tableLookup.h                                       */
/* ======================================================================== */