/** * @file IxNpeDl.h * * @date 14 December 2001 * @brief This file contains the public API of the IXP400 NPE Downloader *        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 --*//** * @defgroup IxNpeDl IXP400 NPE-Downloader (IxNpeDl) API * * @brief The Public API for the IXP400 NPE Downloader * * @{ */#ifndef IXNPEDL_H#define IXNPEDL_H/* * Put the user defined include files required */#include "IxOsalTypes.h"#include "IxNpeMicrocode.h"/* * #defines for function return types, etc. *//** * @def IX_NPEDL_PARAM_ERR * * @brief NpeDl function return value for a parameter error */#define IX_NPEDL_PARAM_ERR               2/** * @def IX_NPEDL_RESOURCE_ERR * * @brief NpeDl function return value for a resource error */#define IX_NPEDL_RESOURCE_ERR            3/** * @def IX_NPEDL_CRITICAL_NPE_ERR * * @brief NpeDl function return value for a Critical NPE error occuring during          download. Assume NPE is left in unstable condition if this value is          returned or NPE is hang / halt. */#define IX_NPEDL_CRITICAL_NPE_ERR        4/** * @def IX_NPEDL_CRITICAL_MICROCODE_ERR * * @brief NpeDl function return value for a Critical Microcode error *        discovered during download. Assume NPE is left in unstable condition *        if this value is returned. */#define IX_NPEDL_CRITICAL_MICROCODE_ERR  5/** * @def IX_NPEDL_DEVICE_ERR * * @brief NpeDl function return value when image being downloaded *        is not meant for the device in use */#define IX_NPEDL_DEVICE_ERR 6 /** * @defgroup NPEImageID IXP400 NPE Image ID Definition * * @ingroup IxNpeDl * * @brief Definition of NPE Image ID to be passed to ixNpeDlNpeInitAndStart() *        as input of type UINT32 which has the following fields format: * *               Field [Bit Location] <BR> *               -------------------- <BR> *               Device ID [31 - 28] <BR> *               NPE ID [27 - 24] <BR> *               NPE Functionality ID [23 - 16] <BR> *               Major Release Number [15 -  8] <BR> *               Minor Release Number [7 - 0] <BR> * * * @{ *//** * @def IX_NPEDL_NPEIMAGE_FIELD_MASK * * @brief Mask for NPE Image ID's Field * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define IX_NPEDL_NPEIMAGE_FIELD_MASK  0xff/** * @def IX_NPEDL_NPEIMAGE_NPEID_MASK * * @brief Mask for NPE Image NPE ID's Field * */#define IX_NPEDL_NPEIMAGE_NPEID_MASK  0xf/** * @def IX_NPEDL_NPEIMAGE_DEVICEID_MASK * * @brief Mask for NPE Image Device ID's Field * */#define IX_NPEDL_NPEIMAGE_DEVICEID_MASK  0xf/** * @def IX_NPEDL_NPEIMAGE_BIT_LOC_NPEID * * @brief Location of NPE ID field in term of bit. * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define IX_NPEDL_NPEIMAGE_BIT_LOC_NPEID  24/** * @def IX_NPEDL_NPEIMAGE_BIT_LOC_FUNCTIONALITYID * * @brief Location of Functionality ID field in term of bit. * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define IX_NPEDL_NPEIMAGE_BIT_LOC_FUNCTIONALITYID  16/** * @def IX_NPEDL_NPEIMAGE_BIT_LOC_MAJOR * * @brief Location of Major Release Number field in term of bit. * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define IX_NPEDL_NPEIMAGE_BIT_LOC_MAJOR  8/** * @def IX_NPEDL_NPEIMAGE_BIT_LOC_MINOR * * @brief Location of Minor Release Number field in term of bit. * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define IX_NPEDL_NPEIMAGE_BIT_LOC_MINOR  0/** * @} addtogroup NPEImageID *//** * @def ixNpeDlMicrocodeImageOverride(x) * * @brief  Map old terminology that uses term "image" to new term *        "image library" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define ixNpeDlMicrocodeImageOverride(x) ixNpeDlMicrocodeImageLibraryOverride(x)/** * @def IxNpeDlVersionId * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define IxNpeDlVersionId IxNpeDlImageId/** * @def ixNpeDlVersionDownload * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define ixNpeDlVersionDownload(x,y) ixNpeDlImageDownload(x,y)/** * @def ixNpeDlAvailableVersionsCountGet * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define ixNpeDlAvailableVersionsCountGet(x) ixNpeDlAvailableImagesCountGet(x)/** * @def ixNpeDlAvailableVersionsListGet * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define ixNpeDlAvailableVersionsListGet(x,y) ixNpeDlAvailableImagesListGet(x,y) /** * @def ixNpeDlLoadedVersionGet * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define ixNpeDlLoadedVersionGet(x,y) ixNpeDlLoadedImageGet(x,y) /** * @def clientImage * * @brief  Map old terminology that uses term "image" to new term *        "image library" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define clientImage clientImageLibrary /** * @def versionIdPtr * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define versionIdPtr imageIdPtr /** * @def numVersionsPtr * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define numVersionsPtr numImagesPtr/** * @def versionIdListPtr * * @brief  Map old terminology that uses term "version" to new term *        "image" * * @warning <b>THIS #define HAS BEEN DEPRECATED AND SHOULD NOT BE USED.</b> *       It will be removed in a future release. *       See @ref ixNpeDlNpeInitAndStart for more information. */#define versionIdListPtr imageIdListPtr/** * @def IxNpeDlBuildId *