DSPLib_lea.h

#ifndef __DSPLIB_LEA_H__
#define __DSPLIB_LEA_H__

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

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

#if defined(__MSP430_HAS_LEA__) && !defined(MSP_DISABLE_LEA)

#if __MSP430_HEADER_VERSION__ < 1192
#error "DSPLib: Device header file is out of date, please upgrade to the \
latest support package to use this version of DSPLib with LEA."
#endif

//******************************************************************************
//
//
//******************************************************************************
#define MSP_USE_LEA                 1

// LEA revision A.
#define MSP_LEA_REVISION_A          0

// LEA revision B.
#define MSP_LEA_REVISION_B          1

// LEA revision B.
#define MSP_LEA_REVISION_C          2

// Unknown revision of LEA.
#define MSP_LEA_REVISION_UNKNOWN    255

#if !defined(MSP_LEA_REVISION)

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_REVISION            MSP_LEA_REVISION_B

#endif //MSP_LEA_REVISION

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_CONVERT_ADDRESS(x)  ((uint16_t)(((uintptr_t)(x) >> 2) & 0xffff))

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_REVERT_ADDRESS(x)   ((uintptr_t)(((uint32_t)(x) << 2)))

// Cast read-only registers to const to avoid compiler warnings.
#define MSP_LEA_BOTTOM              (*((const uint16_t *)(&LEAMB)))
#define MSP_LEA_TOP                 (*((const uint16_t *)(&LEAMT)))

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_RANGE(x)            (((uintptr_t)(x) >= MSP_LEA_BOTTOM) \
                                        && ((uintptr_t)(x) < MSP_LEA_TOP))

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_ALIGNED(x,n)        (!((uint32_t)(x) & ((n)-1)))

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_VALID_ADDRESS(x,n)  (MSP_LEA_RANGE(x) & MSP_LEA_ALIGNED(x,n))

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_CONST_ZERO          0xA000

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_CONST_ONE           0xAC00

//******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_Q15_CONST_NEG_ONE   0xB000

 //******************************************************************************
//
//
//******************************************************************************
#define MSP_LEA_IQ31_CONST_NEG_ONE  0xE000

 //******************************************************************************
//
//
//******************************************************************************
#define LEACMD__INTERLEAVEEVENEVEN  (0x0000f000)

 //******************************************************************************
//
//
//******************************************************************************
#define LEACMD__INTERLEAVEEVENODD   (0x0000f001)

 //******************************************************************************
//
//
//******************************************************************************
#define LEACMD__INTERLEAVEODDEVEN   (0x0000f002)

 //******************************************************************************
//
//
//******************************************************************************
#define LEACMD__INTERLEAVEODDODD    (0x0000f003)

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_ADDMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_ADDLONGMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_SUBMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_SUBLONGMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_MPYMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_MPYLONGMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t reserved;
} MSP_LEA_MAC_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t reserved;
} MSP_LEA_MACLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
    uint16_t coeff;
    uint16_t order;
    int32_t scaleFactor;
} MSP_LEA_POLY_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
} MSP_LEA_MAX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
    uint16_t inputOffset;
    uint16_t reserved;
} MSP_LEA_MAXLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
} MSP_LEA_MAXUNSIGNED_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
    uint16_t inputOffset;
    uint16_t reserved;
} MSP_LEA_MAXLONGUNSIGNED_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
} MSP_LEA_MIN_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
    uint16_t inputOffset;
    uint16_t reserved;
} MSP_LEA_MINLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
    uint16_t inputOffset;
    uint16_t reserved;
} MSP_LEA_MINUNSIGNED_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t output;
    uint16_t inputOffset;
    uint16_t reserved;
} MSP_LEA_MINLONGUNSIGNED_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t outputOffset;
} MSP_LEA_MPYCOMPLEXMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t input2;
    uint16_t output;
    uint16_t input1Offset;
    uint16_t input2Offset;
    uint16_t reserved;
} MSP_LEA_MACCOMPLEXMATRIX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t rowSize;
    uint16_t colSize;
    uint16_t colVector;
    uint16_t output;
} MSP_LEA_MPYMATRIXROW_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t coeffs;
    uint16_t output;
    uint16_t tapLength;
    uint16_t bufferMask;
    uint16_t reserved;
} MSP_LEA_FIR_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t coeffs;
    uint16_t output;
    uint16_t tapLength;
    uint16_t bufferMask;
    uint16_t reserved;
} MSP_LEA_FIRLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t coeffs;
    uint16_t output;
    uint16_t tapLength;
    uint16_t bufferMask;
    uint16_t reserved;
} MSP_LEA_FIRCOMPLEX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t coeffs;
    uint16_t output;
    uint16_t tapLength;
    uint16_t bufferMask;
    uint16_t reserved;
} MSP_LEA_FIRLONGCOMPLEX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSizeBy2;
    uint16_t output;
    uint16_t state;
    uint16_t coeffs;
    uint16_t direction;
    uint16_t reserved;
} MSP_LEA_IIRBQ1_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSizeBy2;
    uint16_t output;
    uint16_t state;
    uint16_t coeffs;
} MSP_LEA_IIRBQ2_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t sqrtVectorSize;
    uint16_t reserved;
} MSP_LEA_BITREVERSECOMPLEX_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t sqrtVectorSize;
    uint16_t reserved;
} MSP_LEA_BITREVERSECOMPLEXLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSizeBy2;
    uint16_t log2Size;
} MSP_LEA_FFTCOMPLEXAUTOSCALING_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSizeBy2;
    uint16_t log2Size;
} MSP_LEA_FFTCOMPLEXFIXEDSCALING_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t log2Size;
} MSP_LEA_FFTCOMPLEXLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t log2Size;
} MSP_LEA_FFT_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t log2Size;
} MSP_LEA_FFTLONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t output;
    uint16_t channel;
    uint16_t numChannels;
    uint16_t vectorSize;
} MSP_LEA_INTERLEAVE_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t interleaveDepth;
    uint16_t output;
    uint16_t reserved;
} MSP_LEA_DEINTERLEAVE_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
typedef struct {
    uint16_t vectorSize;
    uint16_t interleaveDepth;
    uint16_t output;
    uint16_t reserved;
} MSP_LEA_DEINTERLEAVELONG_PARAMS;

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MIN[23];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MINUNSIGNED[23];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MINLONGMATRIX[20];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MINUNSIGNEDLONGMATRIX[20];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MAX[23];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MAXUNSIGNED[23];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MAXLONGMATRIX[20];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MAXUNSIGNEDLONGMATRIX[20];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MACLONGMATRIX[18];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_FFTCOMPLEXAUTOSCALING[58];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_FFTCOMPLEXLONG[64];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_MPYLONGMATRIX[17];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_IIRBQ1[31];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_IIRBQ2[32];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_IIRBQ2EXTENDED[47];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_FIRLONG[30];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_FIRCOMPLEXLONG[43];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_INTERLEAVEEVENEVEN[22];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_INTERLEAVEEVENODD[24];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_INTERLEAVEODDEVEN[22];

//******************************************************************************
//
//
//******************************************************************************
extern const uint32_t MSP_LEA_INTERLEAVEODDODD[24];

//******************************************************************************
//
//
//******************************************************************************
extern volatile uint16_t msp_lea_ifg;

//******************************************************************************
//
//
//******************************************************************************
extern volatile uint16_t msp_lea_locked;

//******************************************************************************
//
//
//******************************************************************************
extern void msp_lea_init(void);

//******************************************************************************
//
//
//******************************************************************************
static inline void msp_lea_invokeCommand(uint16_t cmdId)
{
    /* Save interrupt state and disable interrupts. */
    uint16_t interruptState = __get_interrupt_state();
    __disable_interrupt();

    /* Clear interrupt flag and invoke the command. */
    msp_lea_ifg = 0;
    LEAPMCB = cmdId | LEAITFLG1;
    
#if defined(MSP_DISABLE_LPM0)
#warning "DSPLib: LPM0 is disabled, undefine MSP_DISABLE_LPM0 to enable LPM0."
    /* Do not enter LPM0, poll interrupt flags for command completion. */
    __bis_SR_register(GIE);
    while(!msp_lea_ifg);
#elif ((MSP_LEA_REVISION==MSP_LEA_REVISION_A) && !defined(MSP_ENABLE_LPM0))
    /* Do not enter LPM0, poll interrupt flags for command completion. */
    __bis_SR_register(GIE);
    while(!msp_lea_ifg);
#else
    /* Enter LPM0 and wait for command complete interrupt to wake the device. */
    __bis_SR_register(GIE+LPM0_bits);
#endif

    /* Restore original interrupt state. */
    __set_interrupt_state(interruptState);
}

//******************************************************************************
//
//
//******************************************************************************
static inline void *msp_lea_allocMemory(uint16_t length)
{
    LEACNF2 -= length;
    return (void *)MSP_LEA_REVERT_ADDRESS(LEACNF2);
}

//******************************************************************************
//
//
//******************************************************************************
static inline void msp_lea_freeMemory(uint16_t length)
{
    LEACNF2 += length;
}

//******************************************************************************
//
//
//******************************************************************************
static inline bool msp_lea_acquireLock(void)
{
#ifndef MSP_DISABLE_DIAGNOSTICS
    bool status;

    /* Save interrupt state and disable interrupts. */
    uint16_t interruptState = __get_interrupt_state();
    __disable_interrupt();

    /* Check LEA-SC busy flag and DSPLib lock flags. */
    if ((LEACNF1 & LEABUSY) || msp_lea_locked) {
        status = false;
    }
    else {
        status = true;
        msp_lea_locked = true;
    }

    /* Restore interrupt state and return status. */
    __set_interrupt_state(interruptState);
    return status;
#endif //MSP_DISABLE_DIAGNOSTICS
}

//******************************************************************************
//
//
//******************************************************************************
static inline void msp_lea_freeLock(void)
{
#ifndef MSP_DISABLE_DIAGNOSTICS
    msp_lea_locked = false;
#endif //MSP_DISABLE_DIAGNOSTICS
}

//******************************************************************************
//
//
//******************************************************************************
extern void msp_lea_initCommandTable(void);

//******************************************************************************
//
//
//******************************************************************************
extern uint16_t msp_lea_getRevision(void);

//******************************************************************************
//
//
//******************************************************************************
extern uint16_t msp_lea_loadCommand(
                    uint16_t commandId, const void *command, uint16_t length);

#endif

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

#endif // __DSPLIB_LEA_H__