ixhssaccpcm_p.h

intel IXP400系列cpu（2.3版）的库文件

IX_STATUS 
ixHssAccPCMDisconnect (IxHssAccHssPort hssPortId, IxHssAccHdlcPort hdlcPortId);


/**
 * @fn IX_STATUS BOOL ixHssAccPCMIsDisconnectComplete (IxHssAccHssPort hssPortId, 
				 IxHssAccHdlcPort hdlcPortId)
 *
 * @brief This function is used to check if a particular HSS/HDLC port combination 
 *        is connected.
 *
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number on which the 
 * client that is to be disconnected is on
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the number of the HDLC port 
 * that is to be disconnected and it corresponds to the physical E1/T1 
 * channel i.e. 0, 1, 2, 3 
 *
 * @return 
 *         - IX_SUCCESS The function executed successfully
 *         - IX_FAIL The function did not execute successfully
 *         - IX_DISCONNECTING The function has iniated the disconnecting
 *                             procedure but it has not completed yet.
 * 
 */
BOOL 
ixHssAccPCMIsDisconnectComplete (IxHssAccHssPort hssPortId, 
				 IxHssAccHdlcPort hdlcPortId);


/**
 * @fn void ixHssAccPCMRxCallbackRun (IxHssAccHssPort hssPortId, 
                          IxHssAccHdlcPort hdlcPortId,
			  IX_OSAL_MBUF *buffer, unsigned numHssErrs, 
			  IxHssAccPktStatus pktStatus, UINT32 packetLength)
 *
 * @brief This function is used by the PCM to run the clients Rx Callback 
 * function.
 *
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number on which 
 * the client of whose Rx callback being run is on
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the number of the HDLC port 
 * of whose callback is to be run and it corresponds to the physical E1/T1 
 * channel i.e. 0, 1, 2, 3 
 * @param IX_OSAL_MBUF *buffer (in) - This is the mbuf of data which has been received 
 * for the client 
 * @param unsigned numHssErrs - This is the num of hss errors that has been 
 * received on this port
 * @param IxHssAccPktStatus pktStatus (in) - The status field returned to 
 * the client indicating the status of the packet.
 * 
 */
void 
ixHssAccPCMRxCallbackRun (IxHssAccHssPort hssPortId, IxHssAccHdlcPort hdlcPortId,
			  IX_OSAL_MBUF *buffer, unsigned numHssErrs, 
			  IxHssAccPktStatus pktStatus, UINT32 packetLength);

/**
 * @fn void ixHssAccPCMTxDoneCallbackRun (IxHssAccHssPort hssPortId, 
                              IxHssAccHdlcPort hdlcPortId, 
			      IX_OSAL_MBUF *buffer, unsigned numHssErrs, 
			      IxHssAccPktStatus pktStatus)
 *
 * @brief This function is used by the PCM to run the clients Tx Done 
 * Callback function.
 *
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number on which 
 * the client of whose Tx Done callback being run is on
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the number of the HDLC port of 
 * whose Tx Done callback being run is on and it corresponds to the physical
 * E1/T1 channel i.e. 0, 1, 2, 3 
 * @param IX_OSAL_MBUF *buffer (out) - This is the mbuf which the client supplied the
 * HssPktAcc layer with, when it contained data to Tx, it is now being 
 * returned to the client so it can be re-used.
 * @param unsigned numHssErrs (out) - This is the number of Hss errors that 
 * have occured, at the NPE level. 
 *
 */
void 
ixHssAccPCMTxDoneCallbackRun (IxHssAccHssPort hssPortId, IxHssAccHdlcPort hdlcPortId, 
			      IX_OSAL_MBUF *buffer, unsigned numHssErrs, 
			      IxHssAccPktStatus pktStatus);


/**
 * @fn void ixHssAccPCMRxFreeLowCallbackRun (IxHssAccHssPort hssPortId, 
                                             IxHssAccHdlcPort hdlcPortId);
 *
 * @brief This function is used by the PCM to run the clients Rx Free Callback 
 * function. This function is called when there is a low number of entries
 * in the RXFreeQMQ.
 *
 * @param IxHssAccHssPort hssPortId - This is the HSS port number on which the 
 * client of whose FreeLow callback being run is on
 * @param IxHssAccHdlcPort hdlcPortId - This is the number of the HDLC port 
 * of whose FreeLow callback being run is on and it corresponds to the 
 * physical E1/T1 channel i.e. 0, 1, 2, 3 
 *
 */
void 
ixHssAccPCMRxFreeLowCallbackRun (IxHssAccHssPort hssPortId, 
				 IxHssAccHdlcPort hdlcPortId);


/**
 * @fn BOOL ixHssAccPCMCheckTxOk (IxHssAccHssPort hssPortId, 
                                  IxHssAccHdlcPort hdlcPortId);
 *
 * @brief This funtion is called to check if it is ok to transmit for a 
 * particular packetised client.  
 * 
 * @param IxHssAccHssPort hssPortId - This is the HSS port number on which this 
 * client who we want to know if transmission is ok for is running on.
 * @param IxHssAccHdlcPort hdlcPortId - This is the HDLC port number of the client 
 * who we want to know if transmission is ok for is running on 
 *
 * @return  - TRUE It is ok to perform a Tx on this port
 *          - FALSE It is not ok to perform a Tx on this port
 */
BOOL
ixHssAccPCMCheckTxOk (IxHssAccHssPort hssPortId, 
		      IxHssAccHdlcPort hdlcPortId);


/**
 * @fn BOOL ixHssAccPCMCheckReplenishOk (IxHssAccHssPort hssPortId, 
                                              IxHssAccHdlcPort hdlcPortId);
 *
 * @brief This funtion is called to check if it is ok to replenish RxFree 
 * mbufs for a packetised client
 * 
 * @param IxHssAccHssPort hssPortId - This is the HSS port number on which this 
 * client who we want to know if is ok to replenishish on.
 * @param IxHssAccHdlcPort hdlcPortId - This is the HDLC port number of the 
 * client who we want to know if  is ok to repleinsh on 
 *
 * @return     - TRUE It is ok to replenish the RxFree queue for this client
 *             - FALSE It is not ok to replenish the RxFree queue for this client
 */
BOOL
ixHssAccPCMCheckReplenishOk (IxHssAccHssPort hssPortId, 
			     IxHssAccHdlcPort hdlcPortId);


/**
 * @fn void ixHssAccPCMShow (void)
 *
 * @brief This funtion is called show to statistics of the PCM.  
 * 
 * @return void
 */
void 
ixHssAccPCMShow (void);


/**
 * @fn void ixHssAccPCMStatsInit (void);
 *
 * @brief This funtion is called to initialise the statistics of the PCM.  
 * 
 * @return void
 */
void 
ixHssAccPCMStatsInit (void);


/**
 * @fn IxQMgrQId ixHssAccPCMRxFreeQIdGet (IxHssAccHssPort hssPortId, 
                                          IxHssAccHdlcPort hdlcPortId)
 *
 * @brief This inline funtion is called to return an RxFree Q Id for a specified client.
 * 
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number of the 
 * RxFree Q Id we want to return
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the HDLC port number of the 
 * RxFree Q Id we want to return 
 *
 * @return IxQMgrQId -  The QId of the RxFree Q for the client whose HSS and HDLC port Id 
 */
IXHSSACCPCM_INLINE IxQMgrQId
ixHssAccPCMRxFreeQIdGet (IxHssAccHssPort hssPortId,
			 IxHssAccHdlcPort hdlcPortId);

/**
 * @fn IxQMgrQId ixHssAccPCMTxQIdGet (IxHssAccHssPort hssPortId, 
   IxHssAccHdlcPort hdlcPortId)
 *
 * @brief This inline funtion is called to return an Tx Q Id for a specified client.
 * 
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number of the 
 * Tx Q Id we want to return
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the HDLC port number of the 
 * Tx Q Id we want to return 
 *
 * @return IxQMgrQId -  The QId of the Tx Q for the client whose HSS and HDLC port Id 
 */

IXHSSACCPCM_INLINE IxQMgrQId
ixHssAccPCMTxQIdGet (IxHssAccHssPort hssPortId, IxHssAccHdlcPort hdlcPortId);

/**
 * @fn IX_STATUS ixHssAccPCMnoBuffersInUseCountInc(IxHssAccHssPort hssPortId,
                                IxHssAccHdlcPort hdlcPortId,
                                UINT32 count)
 *
 * @brief This function is called to increment the number of buffers in use
 * count for the client (HSS port and HDLC channel combination).
 *
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number of the client 
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the HDLC port number of the client
 * @param UINT32 count (in) - This is the count by which the number of buffers count
 * will be incremented for the client.
 *
 * @return 
 *         - IX_SUCCESS The function executed successfully
 *         - IX_FAIL The function did not execute successfully
 */
IX_STATUS 
ixHssAccPCMnoBuffersInUseCountInc(IxHssAccHssPort hssPortId,
            IxHssAccHdlcPort hdlcPortId,
            UINT32 count);

/**
 * @fn IX_STATUS ixHssAccPCMnoBuffersInUseCountDec(IxHssAccHssPort hssPortId, 
                                IxHssAccHdlcPort hdlcPortId, 
                                UINT32 count)
 *
 * @brief This function is called to decrement the number of buffers in use
 * count for the client (HSS port and HDLC channel combination).
 * @param IxHssAccHssPort hssPortId (in) - This is the HSS port number of the client 
 * @param IxHssAccHdlcPort hdlcPortId (in) - This is the HDLC port number of the client
 * @param UINT32 count (in) - This is the count by which the number of buffers count
 * will be decremented for the client.
 * 
 * @return 
 *         - IX_SUCCESS The function executed successfully
 *         - IX_FAIL The function did not execute successfully
 */
IX_STATUS 
ixHssAccPCMnoBuffersInUseCountDec(IxHssAccHssPort hssPortId, 
                IxHssAccHdlcPort hdlcPortId, 
                UINT32 count);

/**
 * @fn IX_STATUS ixHssAccPCMInit (void);
 *
 * @brief This function is called to initialise the PCM.
 * 
 * @return 
 *         - IX_SUCCESS The function executed successfully
 *         - IX_FAIL The function did not execute successfully
 */

IX_STATUS 
ixHssAccPCMInit (void);

/*
 * Inline functions
 */
 
/*
 * This inline funtion is called to return an RxFree Q Id for a specified client.
 */
IXHSSACCPCM_INLINE IxQMgrQId
ixHssAccPCMRxFreeQIdGet (IxHssAccHssPort hssPortId,
	                 IxHssAccHdlcPort hdlcPortId)
{
    return ixHssAccPCMRxFreeQId[hssPortId][hdlcPortId];
}

/*
 * This inline funtion is called to return an Tx Q Id for a specified client.
 */
IXHSSACCPCM_INLINE IxQMgrQId
ixHssAccPCMTxQIdGet (IxHssAccHssPort hssPortId, IxHssAccHdlcPort hdlcPortId)
{
    return ixHssAccPCMTxQId[hssPortId][hdlcPortId];
}

#endif /* IXHSSACCPCM_P_H */

/**
 * @} defgroup IXHSSACCPCM_p
 */