apu.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       apu.h
 *
 *  Description:    Defines and prototypes for the APU peripheral.
 *
 *  Copyright (c) 2024-2025 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1) Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2) 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.
 *
 *  3) Neither the name of the copyright holder 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 HOLDER 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 I25N
 *  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 __APU_H__
#define __APU_H__

//*****************************************************************************
//
//
//*****************************************************************************

#include <stdint.h>
#include <stdbool.h>

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
//
// Enum defines for the APU_API register, to control APU operation.
//
//*****************************************************************************
enum APUApi
{
    APU_API_NOP               = 0x0000,
    APU_API_CONFIG            = 0x0001,
    APU_API_DOTPROD           = 0x0002,
    APU_API_VECTMULT          = 0x0003,
    APU_API_VECTSUM           = 0x0004,
    APU_API_MATMATMULT        = 0x0005,
    APU_API_UNITCIRC          = 0x0006,
    APU_API_SYMMATRIXVECTPROD = 0x0007,
    APU_API_MATRIXMULT        = 0x0008,
    APU_API_HERMATRIXMULT     = 0x0009,
    APU_API_SYMMATRIXMULT     = 0x000A,
    APU_API_MATRIXSUM         = 0x000B,
    APU_API_SCALARMULT        = 0x000C,
    APU_API_MATRIXSCALARSUM   = 0x000D,
    APU_API_POLAR             = 0x000E,
    APU_API_CARTESIAN         = 0x000F,
    APU_API_COVMATRIX         = 0x0010,
    APU_API_EIGEN             = 0x0011,
    APU_API_R2C               = 0x0012,
    APU_API_MATRIXNORM        = 0x0013,
    APU_API_FFT               = 0x0014,
    APU_API_DCT               = 0x0015,
    APU_API_SORT              = 0x0016,
    APU_API_GAUSS             = 0x0017,
    APU_API_HERMLO            = 0x0018,
    APU_API_MAXMIN            = 0x0019,
};

//****************************************************************************
// Generic Definition
//****************************************************************************
#define APU_FBA_ENABLE         1 
#define APU_FBA_DISABLE        0 
#define APU_MEMORY_INTERLEAVED 1 
#define APU_MEMORY_MIRRORED    0 

#define APU_HEAP_ADDR 0x03CE 

//****************************************************************************
// Operator definitions
//****************************************************************************
#define APU_OP_R2C   0 
#define APU_OP_R2CC  1 
#define APU_OP_R2CA  2 
#define APU_OP_R2CCA 3 
#define APU_OP_RA    4 
#define APU_OP_IMA   5 
#define APU_OP_ABS   6 

#define APU_OP_ADD 0 
#define APU_OP_SUB 1 

#define APU_OP_MIN 0 
#define APU_OP_MAX 1 

// Macro to convert absolute-address to offset-address used by APU
#define APU_GET_DATA_MEM_OFFSET(x) ((uint32_t)x - (uint32_t)APURAM_DATA0_BASE) >> 3
// Macro to convert offset-address used by APU to absolute-address
#define APU_GET_DATA_MEM_ABS(x)    ((uint32_t)APURAM_DATA0_BASE + (((uint32_t)x) << 3))

//*****************************************************************************
//
// API Functions and prototypes
//
//*****************************************************************************

//****************************************************************************
// Generic Utils
//****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
void APUWaitOnIrq(void);

//*****************************************************************************
//
//
//*****************************************************************************
bool APUOperationDone(void);

//*****************************************************************************
//
//
//*****************************************************************************
void APUWaitOp(void);

//*****************************************************************************
//
//
//*****************************************************************************
void APUSetConfig(uint32_t memConfig);

//*****************************************************************************
//
//
//*****************************************************************************
void APUNop(void);

//****************************************************************************
// Generic Linear Algebra
//****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorDot(uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorDotConj(uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorMult(uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorScalarMult(uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorMultConj(uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorSum(uint16_t N, void *pInputA, void *pInputB, uint16_t op, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorScalarSum(uint16_t N, void *pInputA, void *pInputB, uint16_t op, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorCart2Pol(uint16_t N, void *pInput, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorPol2Cart(uint16_t N, void *pInput, void *pResult, void *pTemp);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorSort(uint16_t N, void *pInput);

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixMult(uint16_t M, uint16_t N, uint16_t P, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixMultHerm(uint16_t M, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixMultSym(uint16_t M, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixSum(uint16_t M, uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixScalarMult(uint16_t M, uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixScalarSum(uint16_t M, uint16_t N, void *pInputA, void *pInputB, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUMatrixNorm(uint16_t M, uint16_t N, void *pInput, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
void APUSpSmoothCovMatrix(uint16_t N, void *pInput, uint16_t L, void *pResult, uint16_t fb);

//*****************************************************************************
//
//
//*****************************************************************************
void APUJacobiEVD(uint16_t N, void *pInput, void *pResultV, uint16_t maxIter, float minSum, float epsTol);

//*****************************************************************************
//
//
//*****************************************************************************
void APUGaussJordanElim(uint16_t M, uint16_t N, void *pInput, float epsTol);

//*****************************************************************************
//
//
//*****************************************************************************
void APUConfigFft(uint16_t N, void *pX);

//*****************************************************************************
//
//
//*****************************************************************************
void APUComputeFft(uint16_t N, void *pX);

//*****************************************************************************
//
//
//*****************************************************************************
void APUComputeIfft(uint16_t N, void *pX);

//*****************************************************************************
//
//
//*****************************************************************************
void APUUnitCircle(uint16_t N, uint16_t M, uint16_t phase, uint16_t conj, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorMaxMin(uint16_t N, void *pInput, float thresh, uint16_t op, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUVectorR2C(uint16_t N, void *pInputA, void *pInputB, uint16_t op, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************
void APUHermLo(uint16_t N, void *pInput, void *pResult);

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//*****************************************************************************
//
//
//*****************************************************************************

#endif //  __APU_H__