AWECoreUtils.h

Go to the documentation of this file.

/*******************************************************************************
*
*               AWE Utilities
*               ---------------
*
********************************************************************************
*     AWECoreUtils.h
********************************************************************************
*
*     Description:  AudioWeaver Utilities and Helper Functions
*
*     Copyright:    (c) 2007-2021 DSP Concepts, Inc. All rights reserved.
*                   3235 Kifer Road
*                   Santa Clara, CA 95054
*
*******************************************************************************/
 
#ifndef AWECOREUTILS_H
#define AWECOREUTILS_H
 
#include "ProxyIDs.h"
#include "Errors.h"
#include "TargetProcessor.h"
 
#ifdef  __cplusplus
extern "C" {
#endif
 
/*------------------ PACKET ROUTING MACROS - MULTI-INSTANCE ONLY  ------------------*/
 
/* Maximum number of AWECore instances able to be configured on a single target */
#define MAX_PROCESSING_INSTANCES (256)
 
#define PACKET_LENGTH_WORDS(x) (x[0]>>16)
 
#define PACKET_LENGTH_BYTES(x) ((x[0]>>16) * sizeof(x[0]))
 
#define PACKET_INSTANCEID(x) (x[0] >> 8) & 0xff
 
#define PACKET_OPCODE(x) ((INT32)x[0] & 0xffU)
 
#define AWB_DONE 1
 
#define AWB_NOT_DONE 0
 
#define AWE_DESTROY_CMD 0x0002000CU
 
typedef enum
{
    /* --- States for receiving a command --- */
 
    tMS_Rx_CmdSTX,          /* Receive Command STX */
    tMS_Rx_CmdSeq,          /* Receive Command Sequence ID */
    tMS_Rx_CmdData,         /* Receive Command Data */
 
    /* --- States for sending a response --- */
    tMS_Tx_RspSTX,          /* Send Response STX */
    tMS_Tx_RspSeq,          /* Send Response Sequence ID */
    tMS_Tx_RspData,         /* Send Response Data */
    tMS_Tx_Done
 
} tMsgState;
 
/*-----------------------------SPI/UART HELPER FUNCTIONS------------------------------------- */
/*The following helper functions are currently not working, but they demonstrate how our UART/SPI state machine works*/
 
/* ----------------------------------------------------------------------------
 *   Types
 * ------------------------------------------------------------------------- */
#define INCOMPLETE_PACKET               0
#define COMPLETE_NEW_PACKET             1
#define COMPLETE_REPEATED_PACKET        2
 
void tuningResetByteEncoderUART(void);
 
INT32 tuningDecodeByteUART(UINT32 *packetBuffer, UINT8 ch);
 
 INT32 tuningEncodeByteUART(UINT32 *packetBuffer, UINT8 * ch);
 
//BOOL awe_tuningRxCmdWordSPI(AWEInstance *pAWE, UINT32 word);
 
//BOOL awe_tuningGetReplyWordSPI(AWEInstance *pAWE, UINT32 * word);
 
/*-----------------------------END SPI/UART HELPER FUNCTIONS------------------------------------- */
 
void ComputeCheckSumPublic(UINT32 * pPacketBuffer);
 
void GenerateInstanceTableReply(UINT32 * pPacketBuffer, UINT32 numInstances, UINT32 * pInstanceTable);
 
#if !defined(float_to_fract32) && !defined(FLOAT_TO_FRACT32_DEFINED)
#define FLOAT_TO_FRACT32_DEFINED
INT32 float_to_fract32(FLOAT32 x);
#endif 
 
#if !defined(fract32_to_float) && !defined(FRACT32_TO_FLOAT_DEFINED)
#define FRACT32_TO_FLOAT_DEFINED
FLOAT32 fract32_to_float(INT32 x);
#endif
 
INT32 awe_getNextAWBCmd(const UINT32 *pArray, UINT32 arraySize, UINT32 * pErrorOffset, UINT32 *pPacketBuffer);
 
#ifdef  __cplusplus
}
#endif
 
#endif  // AWECOREUTILS_H