/*******************************************************************************
*
*  File name:              zl5011xMm.h
*
*  Version:                12
*
*  Author:                 PJE
*
*  Date created:           03/04/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*
*  Revision History:
*
*  Rev:  Date:       Author:     Comments:
*  1     03/04/2002  PJE      Creation
*  2     03/04/2002  PJE      Update
*  3     04/04/2002  PJE      Update
*  4     30/04/2002  MRC      Changed MM init, so that it does not return
*                                the MBIST results.
*  5     13/06/2002  PJE      Update
*  6     14/06/2002  PJE      MmAlloc & MmFree coded.
*  7     11/07/2002  PJE      Chip simplified- functions removed.
*  8     18/07/2002  MRC      Added set heap fn
*  9     19/07/2002  MRC      Update alloc fn
*  10    25/10/2002  PJE      API tidy up
*  11    31/10/2002  MRC      Added variants + minor fixes
*  12    22/01/2003  MRC      Tidied up
*
*******************************************************************************/

#ifndef _ZL5011X_MM_H_
#define _ZL5011X_MM_H_

#ifdef __cplusplus
extern "C" {
#endif
/*add to prevent mm test 2005.9.14*/
#ifndef _NO_PACKET_MEMORY_TEST
#define _NO_PACKET_MEMORY_TEST   1
#endif
/*****************   INCLUDE FILES   ******************************************/


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


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


/*****************   DATA STRUCTURES   ****************************************/
typedef enum
{
   ZL5011X_MM_BLOCK_ID= 2
}zl5011xBlockIdE;
/*****************   EXPORTED GLOBAL VARIABLE DECLARATIONS   ******************/


/*****************   EXTERNAL FUNCTION DECLARATIONS   *************************/
extern zlStatusE zl5011xMmInit(zl5011xParamsS *zl5011xParams);

extern zlStatusE zl5011xMmConfigure( zl5011xParamsS *zl5011xParams,
                                    zl5011xExtMemChipSizeE    extMemChipSize);
extern zlStatusE zl5011xMmSetGranuleDataBase( zl5011xParamsS *zl5011xParams,
                                    Uint32T    granBaseAddr);
extern zlStatusE zl5011xMmSetGranuleDescriptorBase( zl5011xParamsS *zl5011xParams,
                                    Uint32T    granDescBaseAddr);
extern zlStatusE zl5011xMmSetArbitrationBurstLength( zl5011xParamsS *zl5011xParams,
                                    Uint32T    extMemBurstLength);
extern zlStatusE zl5011xMmTestPacketMemory( zl5011xParamsS *zl5011xParams,
                                             Uint32T    startAddr,
                                             Uint32T    memSize);
extern zlStatusE zl5011xMmControlExternalMemory( zl5011xParamsS *zl5011xParams,
                                    zl5011xExtMemReadinessE     extMemReadiness);
extern zlStatusE zl5011xMmSetParityMode( zl5011xParamsS *zl5011xParams,
                                    zl5011xExtMemParityE     extMemParity);
extern zlStatusE zl5011xMmSetParityErrorThreshold( zl5011xParamsS *zl5011xParams,
                                    Uint32T      extMemParityTripPoint);
extern zlStatusE zl5011xMmGetParityStatus( zl5011xParamsS  *zl5011xParams,
                                         Uint8T        *pExtMemParityCount,
                                         zl5011xBooleanE *pExtMemParityFailed);
extern zlStatusE zl5011xMmAlloc(zl5011xParamsS  *zl5011xParams,
      Uint32T allocSize, Uint32T *pMemory);
extern zlStatusE zl5011xMmFree( zl5011xParamsS  *zl5011xParams,
                                Uint32T         pMemory);

extern zlStatusE zl5011xMmSetHeap(zl5011xParamsS  *zl5011xParams, Uint32T startHeap, Uint32T endHeap);

#ifdef __cplusplus
}
#endif

#endif /* _ZL5011X_MM_H_ */