/*******************************************************************************
*
*  File name:              zl5011xPki.h
*
*  Version:                17
*
*  Author:                 PJE
*
*  Date created:           16/04/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*
*  Revision History:
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     18/04/2002  PJE      Done easy bits - compile OK.
*  2     17/05/2002  PJE      tested most.
*  3     21/05/2002  PJE      tested rest.
*  4     05/06/2002  PJE      review items done.
*  6     06/06/2002  PJE      PKI review items tested.
*  7     24/06/2002  PJE      review items complete.
*  8     11/07/2002  PJE      new fns PkiEnable(Disable)PcsInterrupt
*  9     11/07/2002  PJE      forgot to update this header
*  10    12/07/2002  PJE      prototypes PkiEnable(Disable)PcsInterrupt
*  11    07/10/2002  PJE      new fns zl5011xPkiEnable/DisableWrapInterrupts
*                             zl5011xPkiGetPcsStatus
*  12    25/10/2002  PJE      API tidy up
*  13    31/10/2002  MRC      Added variants + minor fixes
*  14    03/04/2003  MRC      Removed enable / disable int fns
*  15    08/09/2003  APL      Removed reset fn
*  16    06/09/2004  APL      Added functions to convert port number to support
*                                new device variants
*  17    13/09/2004  APL      Renamed port mapping functions following review
*
*******************************************************************************/

#ifndef _ZL5011X_PKI_H_
#define _ZL5011X_PKI_H_

#ifdef __cplusplus
extern "C" {
#endif

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

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

/*****************   EXPORTED GLOBAL VARIABLE DECLARATIONS   ******************/

/*****************   EXTERNAL FUNCTION DECLARATIONS   *************************/
extern zlStatusE zl5011xPkiInit(zl5011xParamsS *zl5011xParams);
extern zlStatusE zl5011xPkiConfigure(zl5011xParamsS *zl5011xParams,
                                   Uint8T  portNum,
                                   Uint8T * macAddress,
                                   Uint32T   pktLength,
                                   zl5011xMacTypeE macType,
                                    zl5011xBooleanE filterBroadcast,
                                    zl5011xBooleanE filterMulticast,
                                    zl5011xBooleanE filterWrongUnicast,
                                   zl5011xBooleanE vlanEnabled,
                                   zl5011xBooleanE macStats64bits);
extern zlStatusE zl5011xPkiSetMacAddress(zl5011xParamsS *zl5011xParams,
                                   Uint8T  portNum,
                                   Uint8T * macAddress);
extern zlStatusE zl5011xPkiSetMaxPacketLength(zl5011xParamsS *zl5011xParams,
                                             Uint8T  portNum,
                                             Uint32T   pktLength );
extern zlStatusE zl5011xPkiEnablePort(zl5011xParamsS *zl5011xParams,
                                     Uint8T  portNum,
                                     zl5011xBooleanE portEnabled );
extern zlStatusE zl5011xPkiSetVlanMode(zl5011xParamsS *zl5011xParams,
                                     Uint8T  portNum,
                                     zl5011xBooleanE    vlanEnabled );
extern zlStatusE zl5011xPkiSetInterfaceType(zl5011xParamsS *zl5011xParams,
                                     Uint8T  portNum,
                                     zl5011xMacTypeE macType );
extern zlStatusE zl5011xPkiSetPacketFiltering(zl5011xParamsS *zl5011xParams,
                                             Uint8T  portNum,
                                             zl5011xBooleanE filterBroadcast,
                                             zl5011xBooleanE filterMulticast,
                                             zl5011xBooleanE filterWrongUnicast);
extern zlStatusE zl5011xPkiSetWrapInterruptMask(zl5011xParamsS *zl5011xParams,
                                             Uint8T  portNum,
                                             Uint32T WrapMask);
extern zlStatusE zl5011xPkiGetEtherStats(zl5011xParamsS *zl5011xParams,
                                        Uint8T      portNum,
                                        zl5011xEtherStatsS * pEtherStats);
extern zlStatusE zl5011xPkiGetIfStats(zl5011xParamsS *zl5011xParams,
                                     Uint8T           portNum,
                                     zl5011xIfStatsS *  pIfStats);
extern zlStatusE zl5011xPkiGetWrapStatus(zl5011xParamsS *zl5011xParams,
                                             Uint8T   portNum,
                                             Uint32T  *pStatsWraps);
extern zlStatusE zl5011xPkiUpdateCounters(zl5011xParamsS *zl5011xParams,
                                         Uint8T  portNum);
extern zlStatusE zl5011xPkiReadCounters(zl5011xParamsS *zl5011xParams,
                                         Uint8T  portNum);
extern zlStatusE zl5011xPkiPhyRead(zl5011xParamsS *zl5011xParams,
                                  Uint8T         phyId,
                                  Uint8T         phyRegister,
                                  Uint16T      * pPhyReadData);
extern zlStatusE zl5011xPkiPhyWrite(zl5011xParamsS *zl5011xParams,
                                  Uint8T         phyId,
                                  Uint8T         phyRegister,
                                  Uint16T        phyWriteData);
extern zlStatusE zl5011xPkiEnablePcsInterrupt(zl5011xParamsS *zl5011xParams,
                                             Uint8T   portNum);
extern zlStatusE zl5011xPkiDisablePcsInterrupt(zl5011xParamsS *zl5011xParams,
                                             Uint8T   portNum);
extern zlStatusE zl5011xPkiGetPcsStatus(zl5011xParamsS *zl5011xParams,
                                 Uint32T *pIntrStatus);

/* Helpers to convert between internal and external port numbers depending on device variant */
extern zlStatusE zl5011xPkiExternalPortToInternal(zl5011xParamsS *zl5011xParams,
                                 Uint8T *internalPort,
                                 Uint8T externalPort);
extern zlStatusE zl5011xPkiInternalPortToExternal(zl5011xParamsS *zl5011xParams,
                                 Uint8T internalPort,
                                 Uint8T *externalPort);


#ifdef __cplusplus
}
#endif

#endif /* _ZL5011X_PKI_H_ */