* * @param IxNpeMhMessage message (in) - the message to get the ID of. * * @return the ID of the message */IxNpeMhMessageId ixNpeMhConfigMessageIdGet (    IxNpeMhMessage message);/** * @fn BOOL ixNpeMhConfigNpeIdIsValid (           IxNpeMhNpeId npeId) * * @brief This function checks to see if a NPE ID is valid. * * @param IxNpeMhNpeId npeId (in) - the NPE ID to validate. * * @return True if the NPE ID is valid, otherwise False. */BOOL ixNpeMhConfigNpeIdIsValid (    IxNpeMhNpeId npeId);/** * @fn void ixNpeMhConfigLockGet (           IxNpeMhNpeId npeId) * * @brief This function gets a lock for exclusive NPE interaction, and * disables the NPE's "outFIFO not empty" interrupt. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which to get the * lock and disable its interrupt. * * @return No return value. */void ixNpeMhConfigLockGet (    IxNpeMhNpeId npeId);/** * @fn void ixNpeMhConfigLockRelease (           IxNpeMhNpeId npeId) * * @brief This function releases a lock for exclusive NPE interaction, and * enables the NPE's "outFIFO not empty" interrupt. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which to release * the lock and enable its interrupt. * * @return No return value. */void ixNpeMhConfigLockRelease (    IxNpeMhNpeId npeId);/** * @fn BOOL ixNpeMhConfigInFifoIsEmpty (           IxNpeMhNpeId npeId) * * @brief This inline function checks if a NPE's inFIFO is empty. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which the inFIFO * will be checked. * * @return True if the inFIFO is empty, otherwise False. */IXNPEMHCONFIG_INLINE BOOL ixNpeMhConfigInFifoIsEmpty (    IxNpeMhNpeId npeId);/** * @fn BOOL ixNpeMhConfigInFifoIsFull (           IxNpeMhNpeId npeId) * * @brief This inline function checks if a NPE's inFIFO is full. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which the inFIFO * will be checked. * * @return True if the inFIFO is full, otherwise False. */IXNPEMHCONFIG_INLINE BOOL ixNpeMhConfigInFifoIsFull (    IxNpeMhNpeId npeId);/** * @fn BOOL ixNpeMhConfigOutFifoIsEmpty (           IxNpeMhNpeId npeId) * * @brief This inline function checks if a NPE's outFIFO is empty. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which the outFIFO * will be checked. * * @return True if the outFIFO is empty, otherwise False. */IXNPEMHCONFIG_INLINE BOOL ixNpeMhConfigOutFifoIsEmpty (    IxNpeMhNpeId npeId);/** * @fn BOOL ixNpeMhConfigOutFifoIsFull (           IxNpeMhNpeId npeId) * * @brief This inline function checks if a NPE's outFIFO is full. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which the outFIFO * will be checked. * * @return True if the outFIFO is full, otherwise False. */IXNPEMHCONFIG_INLINE BOOL ixNpeMhConfigOutFifoIsFull (    IxNpeMhNpeId npeId);/** * @fn IX_STATUS ixNpeMhConfigInFifoWrite (           IxNpeMhNpeId npeId,           IxNpeMhMessage message) * * @brief This function writes a message to a NPE's inFIFO.  The caller * must first check that the NPE's inFifo is not full. After writing the first  * word of the message, this function will keep polling NPE's inFIFO is not * full to write the second word. If inFIFO is not available after maximum  * retries (IX_NPE_MH_MAX_NUM_OF_RETRIES), this function will return TIMEOUT  * status to indicate NPE hang / halt. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which the inFIFO * will be written to. * @param IxNpeMhMessage message (in) - The message to write. * * @return The function returns a status indicating success, failure or timeout. */IX_STATUS ixNpeMhConfigInFifoWrite (    IxNpeMhNpeId npeId,    IxNpeMhMessage message);/** * @fn IX_STATUS ixNpeMhConfigOutFifoRead (           IxNpeMhNpeId npeId,           IxNpeMhMessage *message) * * @brief This function reads a message from a NPE's outFIFO.  The caller * must first check that the NPE's outFifo is not empty. After reading the first  * word of the message, this function will keep polling NPE's outFIFO is not * empty to read the second word. If outFIFO is empty after maximum  * retries (IX_NPE_MH_MAX_NUM_OF_RETRIES), this function will return TIMEOUT  * status to indicate NPE hang / halt. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE for which the outFIFO * will be read from. * @param IxNpeMhMessage message (out) - The message read. * * @return The function returns a status indicating success, failure or timeout. */IX_STATUS ixNpeMhConfigOutFifoRead (    IxNpeMhNpeId npeId,    IxNpeMhMessage *message);/** * @fn void ixNpeMhConfigShow (           IxNpeMhNpeId npeId) * * @brief This function will display the current state of the Configuration * module. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state * information for. * * @return No return value. */void ixNpeMhConfigShow (    IxNpeMhNpeId npeId);/** * @fn void ixNpeMhConfigShowReset (           IxNpeMhNpeId npeId) * * @brief This function will reset the current state of the Configuration * module. * * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state * information for. * * @return No return value. */void ixNpeMhConfigShowReset (    IxNpeMhNpeId npeId);/* * Inline functions */ /* * This inline function checks if a NPE's inFIFO is empty. */IXNPEMHCONFIG_INLINEBOOL ixNpeMhConfigInFifoIsEmpty (    IxNpeMhNpeId npeId){    UINT32 ifne;    volatile UINT32 *statusReg =        (UINT32 *)ixNpeMhConfigNpeInfo[npeId].statusRegister;    /* get the IFNE (InFifoNotEmpty) bit of the status register */    IX_NPEMH_REGISTER_READ_BITS (statusReg, &ifne, IX_NPEMH_NPE_STAT_IFNE);    /* if the IFNE status bit is unset then the inFIFO is empty */    return (ifne == 0);}/* * This inline function checks if a NPE's inFIFO is full. */IXNPEMHCONFIG_INLINEBOOL ixNpeMhConfigInFifoIsFull (    IxNpeMhNpeId npeId){    UINT32 ifnf;    volatile UINT32 *statusReg =        (UINT32 *)ixNpeMhConfigNpeInfo[npeId].statusRegister;    /* get the IFNF (InFifoNotFull) bit of the status register */    IX_NPEMH_REGISTER_READ_BITS (statusReg, &ifnf, IX_NPEMH_NPE_STAT_IFNF);    /* if the IFNF status bit is unset then the inFIFO is full */    return (ifnf == 0);}/* * This inline function checks if a NPE's outFIFO is empty. */IXNPEMHCONFIG_INLINEBOOL ixNpeMhConfigOutFifoIsEmpty (    IxNpeMhNpeId npeId){    UINT32 ofne;    volatile UINT32 *statusReg =        (UINT32 *)ixNpeMhConfigNpeInfo[npeId].statusRegister;    /* get the OFNE (OutFifoNotEmpty) bit of the status register */    IX_NPEMH_REGISTER_READ_BITS (statusReg, &ofne, IX_NPEMH_NPE_STAT_OFNE);    /* if the OFNE status bit is unset then the outFIFO is empty */    return (ofne == 0);}/* * This inline function checks if a NPE's outFIFO is full. */IXNPEMHCONFIG_INLINEBOOL ixNpeMhConfigOutFifoIsFull (    IxNpeMhNpeId npeId){    UINT32 ofnf;    volatile UINT32 *statusReg =        (UINT32 *)ixNpeMhConfigNpeInfo[npeId].statusRegister;    /* get the OFNF (OutFifoNotFull) bit of the status register */    IX_NPEMH_REGISTER_READ_BITS (statusReg, &ofnf, IX_NPEMH_NPE_STAT_OFNF);    /* if the OFNF status bit is unset then the outFIFO is full */    return (ofnf == 0);}#endif /* IXNPEMHCONFIG_P_H *//** * @} defgroup IxNpeMhConfig_p */