/****************************************************************************
*
* $Source: /cvs/mds/cust/microchip/dspic30f/include/testing.h,v $
* $Revision: 1.4 $
*
* Copyright 2002, Microchip, Inc.  All rights reserved.
*
* Interface to testing framework...
*
* $Log: testing.h,v $
****************************************************************************/

#ifndef	__TEST_FRAMEWORK__	/* [ */
#define	__TEST_FRAMEWORK__

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

/* External headers. */

#include	"dsp.h"			/* DSP Library interface */

/*...........................................................................*/

/* Local defines. */

/*...........................................................................*/

/* Local types. */

/*...........................................................................*/

/* Type definitions. */
typedef	enum {
   VMAX = 0,				/* VectorMax */
   VMIN = 1+VMAX,			/* VectorMin */
   VNEG = 1+VMIN,			/* VectorNegate */
   VSCL = 1+VNEG,			/* VectorScale */
   VADD = 1+VSCL,			/* VectorAdd */
   VSUB = 1+VADD,			/* VectorSubtract */
   VMUL = 1+VSUB,			/* VectorMultiply */
   VDOT = 1+VMUL,			/* VectorDotProduct */
   VPOW = 1+VDOT,			/* VectorPower */
   VCON = 1+VPOW,			/* VectorConvolve */
   VCOR = 1+VCON,			/* VectorCorrelate */
   MSCL = 1+VCOR,			/* MatrixScale */
   MTRP = 1+MSCL,			/* MatrixTranspose */
   MINV = 1+MTRP,			/* MatrixInvert */
   MADD = 1+MINV,			/* MatrixAdd */
   MSUB = 1+MADD,			/* MatrixSubtract */
   MMUL = 1+MSUB,			/* MatrixMultiply */
   WBAR = 1+MMUL,			/* BartlettWindowing */
   WBLK = 1+WBAR,			/* BlackmanWindowing */
   WHAM = 1+WBLK,			/* HammingWindowing */
   WHAN = 1+WHAM,			/* HanningWindowing */
   WKSR = 1+WHAN,			/* KaiserWindowing */
   FIRF = 1+WKSR,			/* FIR */
   FDEC = 1+FIRF,			/* FIRDecimate */
   FINT = 1+FDEC,			/* FIRInterpolate */
   FLMS = 1+FINT,			/* FIRLMS */
   FLMSN = 1+FLMS,			/* FIRLMSNorm */
   FLAT = 1+FLMSN,			/* FIRLattice */
   IIRC = 1+FLAT,			/* IIRCanonic */
   IIRT = 1+IIRC,			/* IIRTransposed */
   ILAT = 1+IIRT,			/* IIRLattice */
   ILAT_AP = 1+ILAT,			/* IIRLatticeAP (all pole) */
   FFT_OOP = 1+ILAT_AP,			/* FFTComplex (out of place) */
   FFT_IP = 1+FFT_OOP,			/* FFTComplex (in place) */
   IFFT_OOP = 1+FFT_IP,			/* IFFTComplex (out of place) */
   IFFT_IP = 1+IFFT_OOP,		/* IFFTComplex (in place) */
   DCT_OOP = 1+IFFT_IP,			/* DCT (out of place) */
   DCT_IP = 1+DCT_OOP,			/* DCT (in place) */
   NOT_A_CODE=-1			/* unknown operation */
} OPER_CODE;

typedef	enum {
   EVMAX = 0,				/* error in VectorMax */
   EVMIN = 1+EVMAX,			/* error in VectorMin */
   EVNEG = 1+EVMIN,			/* error in VectorNegate */
   EVSCL = 1+EVNEG,			/* error in VectorScale */
   EVADD = 1+EVSCL,			/* error in VectorAdd */
   EVSUB = 1+EVADD,			/* error in VectorSubtract */
   EVMUL = 1+EVSUB,			/* error in VectorMultiply */
   EVDOT = 1+EVMUL,			/* error in VectorDotProduct */
   EVPOW = 1+EVDOT,			/* error in VectorPower */
   EVCON = 1+EVPOW,			/* error in VectorConvolve */
   EVCOR = 1+EVCON,			/* error in VectorCorrelate */
   EMSCL = 1+EVCOR,			/* error in MatrixScale */
   EMTRP = 1+EMSCL,			/* error in MatrixTranspose */
   EMINV = 1+EMTRP,			/* error in MatrixInvert */
   EMADD = 1+EMINV,			/* error in MatrixAdd */
   EMSUB = 1+EMADD,			/* error in MatrixSubtract */
   EMMUL = 1+EMSUB,			/* error in MatrixMultiply */
   EWBAR = 1+EMMUL,			/* error in BartlettWindowing */
   EWBLK = 1+EWBAR,			/* error in BlackmanWindowing */
   EWHAM = 1+EWBLK,			/* error in HammingWindowing */
   EWHAN = 1+EWHAM,			/* error in HanningWindowing */
   EWKSR = 1+EWHAN,			/* error in KaiserWindowing */
   EFIRF = 1+EWKSR,			/* error in FIR */
   EFDEC = 1+EFIRF,			/* error in FIRDecimate */
   EFINT = 1+EFDEC,			/* error in FIRInterpolate */
   EFLMS = 1+EFINT,			/* error in FIRLMS */
   EFLMSN = 1+EFLMS,			/* error in FIRLMSNorm */
   EFLAT = 1+EFLMSN,			/* error in FIRLattice */
   EIIRC = 1+EFLAT,			/* error in IIRCanonic */
   EIIRT = 1+EIIRC,			/* error in IIRTransposed */
   EILAT = 1+EIIRT,			/* error in IIRLattice */
   EILAT_AP = 1+EILAT,			/* error in IIRLatticeAP */
   EFFT_OOP = 1+EILAT_AP,		/* error in FFTComplex (out of place) */
   EFFT_IP = 1+EFFT_OOP,		/* error in FFTComplex (in place) */
   EIFFT_OOP = 1+EFFT_IP,		/* error in IFFTComplex (out of place)*/
   EIFFT_IP = 1+EIFFT_OOP,		/* error in IFFTComplex (in place) */
   EDCT_OOP = 1+EIFFT_IP,		/* error in DCT (out of place) */
   EDCT_IP = 1+EDCT_OOP,		/* error in DCT (in place) */
   EFOPEN = 1+EDCT_IP,			/* error in 'fopen' */
   ENOT_A_CODE=-1			/* error because of unknown code */
} ERROR_CODE;

typedef	enum {
   HIBRID = 0,				/* data array and scale value */
   UNARY = 1+HIBRID,			/* unary operation */
   BINARY = 1+UNARY,			/* binary operation */
   NOT_A_MODE=-1			/* unknown operational mode */
} OPER_MODE;

/*...........................................................................*/

/****************************************************************************
*
* Interface to test function prototypes. 
*
****************************************************************************/

/* Test function prototypes. */


float Fract2Float (			/* Converts fractional into float */
   fractional aVal			/* fract value in range {-1, 1-2^-15} */
);

/*...........................................................................*/

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

#endif	/* ] __TEST_FRAMEWORK__ */

/***************************************************************************/
/* EOF */