/*******************************************************************************
*
*  File name:              zl5011xDmaMpc.h
*
*  Version:                5
*
*  Author:                 ARW
*
*  Date created:           30/10/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*    This module provides the DMA prototype definitions for the micro specific
*    functions
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     30/10/2002  ARW      New file
*  2     31/10/2002  MRC      Added variants + minor fixes
*  3     21/03/2003  ARW      Added field to zl5011xDmaPropertiesS
*  4     03/09/2004  APL      Polarity fields in structure are type
*                             zl5011xPolarityE and not zl5011xBooleanE.
*  5     19/10/2004  APL      Added zl5011xIsDmaBufferDone and
*                             zl5011xDmaSetDescriptorInterruptFlag
*
*******************************************************************************/

#ifndef _ZL5011X_DMAMPC_H_
#define _ZL5011X_DMAMPC_H_

#ifdef __cplusplus
extern "C" {
#endif


/*****************   INCLUDE FILES   ******************************************/
#include "zl5011x.h"
#include "zl5011xCpu.h"
#include "zl5011xCpuMap.h"
#include "zl5011xCpq.h"

/*****************   # DEFINES   **********************************************/


/*****************   DATA TYPES   *********************************************/


/*****************   ENUMERATIONS    ******************************************/


/*****************   DATA STRUCTURES   ****************************************/
typedef struct zl5011xDmaPropertiesS
{
    Uint32T maxNumberOfChannels;
    Uint32T maxDescriptorChainSize;
    zl5011xDmaMsgPaddingE padding;
    zl5011xPolarityE dreqPolarity;
    zl5011xPolarityE dackPolarity;
    Uint32T deviceStopTimeout;
    Uint32T alignmentSize;
    Uint32T transferBufferSize;
    zl5011xBooleanE transaction64Bit;
}
zl5011xDmaPropertiesS;

/*****************   EXPORTED GLOBAL VARIABLE DECLARATIONS   ******************/
extern zl5011xDmaPropertiesS zl5011xDmaProps;

/*****************   EXTERNAL FUNCTION DECLARATIONS   *************************/
extern zl5011xDmaStatusE zl5011xDmaDetermineStatus(zl5011xDmaChannelS *dmaChannel);

extern zlStatusE zl5011xDmaIssueCommand(zl5011xDmaChannelS *dmaChannel,
                                               zl5011xDmaCommandE dmaCommand);

extern zlStatusE zl5011xDmaInitialise(zl5011xDmaChannelS *dmaChannel);

extern zl5011xDmaBufferStatusE zl5011xDmaReadBufferStatus(
                            zl5011xDmaChannelS *dmaChannel,Uint32T bufferNumber);

extern void zl5011xDmaFreeDescriptorBuffer(zl5011xDmaChannelS *dmaChannel);

extern void zl5011xDmaDisable(zl5011xDmaChannelS *dmaChannel);

extern void zl5011xDmaWriteSourceAddress(zl5011xDmaChannelS *dmaChannel,
                               Uint32T descriptorNumber, Uint32T sourceAddress);

extern void zl5011xDmaWriteDestinationAddress(zl5011xDmaChannelS *dmaChannel,
                          Uint32T descriptorNumber, Uint32T destinationAddress);

extern void zl5011xDmaWriteLength(zl5011xDmaChannelS *dmaChannel,
                               Uint32T descriptorNumber, Uint32T length);

extern Uint32T zl5011xDmaReadSourceAddress(zl5011xDmaChannelS *dmaChannel,
                               Uint32T descriptorNumber);

extern Uint32T zl5011xDmaReadDestinationAddress(zl5011xDmaChannelS *dmaChannel,
                               Uint32T descriptorNumber);

extern zl5011xBooleanE zl5011xIsDmaBufferDone(zl5011xDmaChannelS *dmaChannel);

extern void zl5011xDmaSetDescriptorInterruptFlag(zl5011xDmaChannelS *dmaChannel,
                     Uint16T bufferIndex, zl5011xBooleanE enable);

#ifdef __cplusplus
}
#endif

#endif /* _ZL5011X_DMAMPC_H_ */