/** * @file IxNpeMh.c * * @author Intel Corporation * @date 18 Jan 2002 * * @brief This file contains the implementation of the public API for the * IXP425 NPE Message Handler component. * * * @par * IXP400 SW Release version 2.0 * * -- Copyright Notice -- * * @par * Copyright 2001-2005, Intel Corporation. * All rights reserved. * * @par * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright *    notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright *    notice, this list of conditions and the following disclaimer in the *    documentation and/or other materials provided with the distribution. * 3. Neither the name of the Intel Corporation nor the names of its contributors *    may be used to endorse or promote products derived from this software *    without specific prior written permission. * * @par * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * @par * -- End of Copyright Notice --*//* * Put the system defined include files required. *//* * Put the user defined include files required. */#include "IxOsal.h"#include "IxNpeMhMacros_p.h"#include "IxNpeMh.h"#include "IxNpeMhConfig_p.h"#include "IxNpeMhReceive_p.h"#include "IxNpeMhSend_p.h"#include "IxNpeMhSolicitedCbMgr_p.h"#include "IxNpeMhUnsolicitedCbMgr_p.h"/* * #defines and macros used in this file. *//* * Typedefs whose scope is limited to this file. *//* * Variable declarations global to this file only.  Externs are followed by * static variables. */PRIVATE BOOL ixNpeMhInitialized = FALSE;/* * Extern function prototypes. *//* * Static function prototypes. *//* * Function definition: ixNpeMhInitialize */PUBLIC IX_STATUS ixNpeMhInitialize (    IxNpeMhNpeInterrupts npeInterrupts){    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Entering "                     "ixNpeMhInitialize\n");    /* check the npeInterrupts parameter */    if ((npeInterrupts != IX_NPEMH_NPEINTERRUPTS_NO) &&        (npeInterrupts != IX_NPEMH_NPEINTERRUPTS_YES))    {        IX_NPEMH_ERROR_REPORT ("Illegal npeInterrupts parameter value\n");        return IX_FAIL;    }    /* parameters are ok ... */    /* initialize the Receive module */    ixNpeMhReceiveInitialize ();    /* initialize the Solicited Callback Manager module */    ixNpeMhSolicitedCbMgrInitialize ();    /* initialize the Unsolicited Callback Manager module */    ixNpeMhUnsolicitedCbMgrInitialize ();    /* initialize the Configuration module     *     * NOTE: This module was originally configured before the     * others, but the sequence was changed so that interrupts     * would only be enabled after the handler functions were     * set up.  The above modules need to be initialised to     * handle the NPE interrupts.  See SCR #2231.     */    ixNpeMhConfigInitialize (npeInterrupts);    ixNpeMhInitialized = TRUE;    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Exiting "                     "ixNpeMhInitialize\n");    return IX_SUCCESS;}/* * Function definition: ixNpeMhUnload */PUBLIC IX_STATUS ixNpeMhUnload (void){    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Entering "                     "ixNpeMhUnload\n");    if (!ixNpeMhInitialized)    {	return IX_FAIL;    }    /* Uninitialize the Configuration module */    ixNpeMhConfigUninit ();    ixNpeMhInitialized = FALSE;    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Exiting "                     "ixNpeMhUnload\n");    return IX_SUCCESS;}/* * Function definition: ixNpeMhUnsolicitedCallbackRegister */PUBLIC IX_STATUS ixNpeMhUnsolicitedCallbackRegister (    IxNpeMhNpeId npeId,    IxNpeMhMessageId messageId,    IxNpeMhCallback unsolicitedCallback){    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Entering "                     "ixNpeMhUnsolicitedCallbackRegister\n");    /* check that we are initialized */    if (!ixNpeMhInitialized)    {        IX_NPEMH_ERROR_REPORT ("IxNpeMh component is not initialized\n");        return IX_FAIL;    }    /* check the npeId parameter */    if (!ixNpeMhConfigNpeIdIsValid (npeId))    {        IX_NPEMH_ERROR_REPORT ("NPE ID invalid\n");        return IX_FAIL;    }    /* check the messageId parameter */    if ((messageId < IX_NPEMH_MIN_MESSAGE_ID)        || (messageId > IX_NPEMH_MAX_MESSAGE_ID))    {        IX_NPEMH_ERROR_REPORT ("Message ID is out of range\n");        return IX_FAIL;    }    /* the unsolicitedCallback parameter is allowed to be NULL */    /* parameters are ok ... */    /* get the lock to prevent other clients from entering */    ixNpeMhConfigLockGet (npeId);    /* save the unsolicited callback for the message ID */    ixNpeMhUnsolicitedCbMgrCallbackSave (        npeId, messageId, unsolicitedCallback);    /* release the lock to allow other clients back in */    ixNpeMhConfigLockRelease (npeId);    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Exiting "                     "ixNpeMhUnsolicitedCallbackRegister\n");    return IX_SUCCESS;}/* * Function definition: ixNpeMhUnsolicitedCallbackForRangeRegister */PUBLIC IX_STATUS ixNpeMhUnsolicitedCallbackForRangeRegister (    IxNpeMhNpeId npeId,    IxNpeMhMessageId minMessageId,    IxNpeMhMessageId maxMessageId,    IxNpeMhCallback unsolicitedCallback){    IxNpeMhMessageId messageId;    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Entering "                     "ixNpeMhUnsolicitedCallbackForRangeRegister\n");    /* check that we are initialized */    if (!ixNpeMhInitialized)    {        IX_NPEMH_ERROR_REPORT ("IxNpeMh component is not initialized\n");        return IX_FAIL;    }    /* check the npeId parameter */    if (!ixNpeMhConfigNpeIdIsValid (npeId))    {        IX_NPEMH_ERROR_REPORT ("NPE ID invalid\n");        return IX_FAIL;    }    /* check the minMessageId parameter */    if ((minMessageId < IX_NPEMH_MIN_MESSAGE_ID)        || (minMessageId > IX_NPEMH_MAX_MESSAGE_ID))    {        IX_NPEMH_ERROR_REPORT ("Min message ID is out of range\n");        return IX_FAIL;    }    /* check the maxMessageId parameter */    if ((maxMessageId < IX_NPEMH_MIN_MESSAGE_ID)        || (maxMessageId > IX_NPEMH_MAX_MESSAGE_ID))    {        IX_NPEMH_ERROR_REPORT ("Max message ID is out of range\n");        return IX_FAIL;    }    /* check the semantics of the message range parameters */    if (minMessageId > maxMessageId)    {        IX_NPEMH_ERROR_REPORT ("Min message ID greater than max message "                               "ID\n");        return IX_FAIL;    }    /* the unsolicitedCallback parameter is allowed to be NULL */    /* parameters are ok ... */    /* get the lock to prevent other clients from entering */    ixNpeMhConfigLockGet (npeId);    /* for each message ID in the range ... */    for (messageId = minMessageId; messageId <= maxMessageId; messageId++)    {        /* save the unsolicited callback for the message ID */        ixNpeMhUnsolicitedCbMgrCallbackSave (            npeId, messageId, unsolicitedCallback);    }    /* release the lock to allow other clients back in */    ixNpeMhConfigLockRelease (npeId);    IX_NPEMH_TRACE0 (IX_NPEMH_FN_ENTRY_EXIT, "Exiting "                     "ixNpeMhUnsolicitedCallbackForRangeRegister\n");