Main Page Modules Alphabetical List Data Structures File List Data Fields Globals # IxNpeDl.h File Reference This file contains the public API of the IXP425 NPE Downloader component. More... Go to the source code of this file.
## Data Structures
struct | IxNpeDlImageId
| Image Id to identify each image contained in an image library. More...
## Defines
#define | IX_NPEDL_PARAM_ERR
| NpeDl function return value for a parameter error.
#define | IX_NPEDL_RESOURCE_ERR
| NpeDl function return value for a resource error.
#define | IX_NPEDL_CRITICAL_NPE_ERR
| NpeDl function return value for a Critical NPE error occuring during download. Assume NPE is left in unstable condition if this value is returned.
#define | IX_NPEDL_CRITICAL_MICROCODE_ERR
| 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_NPEIMAGE_FIELD_MASK
| Mask for NPE Image ID's Field.
#define | IX_NPEDL_NPEIMAGE_BIT_LOC_NPEID
| Location of NPE ID field in term of bit.
#define | IX_NPEDL_NPEIMAGE_BIT_LOC_FUNCTIONALITYID
| Location of Functionality ID field in term of bit.
#define | IX_NPEDL_NPEIMAGE_BIT_LOC_MAJOR
| Location of Major Release Number field in term of bit.
#define | IX_NPEDL_NPEIMAGE_BIT_LOC_MINOR
| Location of Minor Release Number field in term of bit.
#define | IX_NPEDL_NPEIMAGE_NPEA_HSS0
| NPE Image Id for NPE-A with HSS-0 Only feature. It supports 32 channelized and 4 packetized.
#define | IX_NPEDL_NPEIMAGE_NPEA_HSS0_ATM_SPHY_1_PORT
| NPE Image Id for NPE-A with HSS-0 and ATM feature. For HSS, it supports 16/32 channelized and 4/0 packetized. For ATM, it supports AAL5, AAL0 and OAM for UTOPIA SPHY, 1 logical port, 32 VCs. It also has Fast Path support.
#define | IX_NPEDL_NPEIMAGE_NPEA_HSS0_ATM_MPHY_1_PORT
| NPE Image Id for NPE-A with HSS-0 and ATM feature. For HSS, it supports 16/32 channelized and 4/0 packetized. For ATM, it supports AAL5, AAL0 and OAM for UTOPIA MPHY, 1 logical port, 32 VCs. It also has Fast Path support.
#define | IX_NPEDL_NPEIMAGE_NPEA_ATM_MPHY_12_PORT
| NPE Image Id for NPE-A with ATM-Only feature. It supports AAL5, AAL0 and OAM for UTOPIA MPHY, 12 logical ports, 32 VCs. It also has Fast Path support.
#define | IX_NPEDL_NPEIMAGE_NPEA_HSS_2_PORT
| NPE Image Id for NPE-A with HSS-0 and HSS-1 feature. Each HSS port supports 32 channelized and 4 packetized.
#define | IX_NPEDL_NPEIMAGE_NPEA_DMA
| NPE Image Id for NPE-A with DMA-Only feature.
#define | IX_NPEDL_NPEIMAGE_NPEA_WEP
| NPE Image Id for NPE-A with ARC4 and WEP CRC engines.
#define | IX_NPEDL_NPEIMAGE_NPEB_ETH
| NPE Image Id for NPE-B with Ethernet-Only feature.
#define | IX_NPEDL_NPEIMAGE_NPEB_ETH_FPATH
| NPE Image Id for NPE-B with Ethernet and Fast Path feature.
#define | IX_NPEDL_NPEIMAGE_NPEB_DMA
| NPE Image Id for NPE-B with DMA-Only feature.
#define | IX_NPEDL_NPEIMAGE_NPEC_ETH
| NPE Image Id for NPE-C with Eth-Only feature.
#define | IX_NPEDL_NPEIMAGE_NPEC_CRYPTO
| NPE Image Id for NPE-C with Crypto-Only feature. For Crypto, it supports DES, SHA-1, MD5.
#define | IX_NPEDL_NPEIMAGE_NPEC_CRYPTO_AES
| NPE Image Id for NPE-C with Crypto-Only feature. For Crypto, it supports AES, DES, SHA-1, MD5.
#define | IX_NPEDL_NPEIMAGE_NPEC_CRYPTO_ETH
| NPE Image Id for NPE-C with Crypto and Eth feature. For Crypto, it supports DES, SHA-1, MD5.
#define | IX_NPEDL_NPEIMAGE_NPEC_CRYPTO_AES_ETH
| NPE Image Id for NPE-C with Crypto and Eth feature. For Crypto, it supports AES, DES, SHA-1, MD5.
#define | IX_NPEDL_NPEIMAGE_NPEC_CRYPTO_AES_CCM
| NPE Image Id for NPE-C with Crypto-Only feature. For Crypto, it supports AES, CCM, DES, SHA-1, MD5.
#define | IX_NPEDL_NPEIMAGE_NPEC_CRYPTO_AES_CCM_ETH
| NPE Image Id for NPE-C with Crypto and Eth feature. For Crypto, it supports AES, CCM, DES, SHA-1, MD5. For Ethernet, MAC address learning disabled (but filtering is still enabled).
#define | IX_NPEDL_NPEIMAGE_NPEC_DMA
| NPE Image Id for NPE-C with DMA-Only feature.
#define | ixNpeDlMicrocodeImageOverride(x)
| Map old terminology that uses term "image" to new term "image library".
#define | IxNpeDlVersionId
| Map old terminology that uses term "version" to new term "image".
#define | ixNpeDlVersionDownload(x, y)
| Map old terminology that uses term "version" to new term "image".
#define | ixNpeDlAvailableVersionsCountGet(x)
| Map old terminology that uses term "version" to new term "image".
#define | ixNpeDlAvailableVersionsListGet(x, y)
| Map old terminology that uses term "version" to new term "image".
#define | ixNpeDlLoadedVersionGet(x, y)
| Map old terminology that uses term "version" to new term "image".
#define | clientImage
| Map old terminology that uses term "image" to new term "image library".
#define | versionIdPtr
| Map old terminology that uses term "version" to new term "image".
#define | numVersionsPtr
| Map old terminology that uses term "version" to new term "image".
#define | versionIdListPtr
| Map old terminology that uses term "version" to new term "image".
#define | IxNpeDlBuildId
| Map old terminology that uses term "buildId" to new term "functionalityId".
#define | buildId
| Map old terminology that uses term "buildId" to new term "functionalityId".
#define | IX_NPEDL_MicrocodeImage
| Map old terminology that uses term "image" to new term "image library".
## Typedefs
typedef UINT8 | IxNpeDlFunctionalityId
| Used to make up Functionality ID field of Image Id.
typedef UINT8 | IxNpeDlMajor
| Used to make up Major Release field of Image Id.
typedef UINT8 | IxNpeDlMinor
| Used to make up Minor Revision field of Image Id.
## Enumerations
enum | IxNpeDlNpeId { IX_NPEDL_NPEID_NPEA, IX_NPEDL_NPEID_NPEB, IX_NPEDL_NPEID_NPEC, IX_NPEDL_NPEID_MAX }
| NpeId numbers to identify NPE A, B or C. More...
## Functions
PUBLIC IX_STATUS | ixNpeDlNpeInitAndStart (UINT32 npeImageId)
| Stop, reset, download microcode (firmware) and finally start NPE.
PUBLIC IX_STATUS | ixNpeDlCustomImageNpeInitAndStart (UINT32 *imageLibrary, UINT32 npeImageId)
| Stop, reset, download microcode (firmware) and finally start NPE.
PUBLIC IX_STATUS | ixNpeDlLoadedImageFunctionalityGet (IxNpeDlNpeId npeId, UINT8 *functionalityId)
| Gets the functionality of the image last loaded on a particular NPE.
IX_STATUS | ixNpeDlMicrocodeImageLibraryOverride (UINT32 *clientImageLibrary)
| This instructs NPE Downloader to use client-supplied microcode image library.
PUBLIC IX_STATUS | ixNpeDlImageDownload (IxNpeDlImageId *imageIdPtr, BOOL verify)
| Stop, reset, download microcode and finally start NPE.
PUBLIC IX_STATUS | ixNpeDlAvailableImagesCountGet (UINT32 *numImagesPtr)
| Get the number of Images available in a microcode image library.
PUBLIC IX_STATUS | ixNpeDlAvailableImagesListGet (IxNpeDlImageId *imageIdListPtr, UINT32 *listSizePtr)
| Get a list of the images available in a microcode image library.
PUBLIC IX_STATUS | ixNpeDlLoadedImageGet (IxNpeDlNpeId npeId, IxNpeDlImageId *imageIdPtr)
| Gets the Id of the image currently loaded on a particular NPE.
PUBLIC IX_STATUS | ixNpeDlLatestImageGet (IxNpeDlNpeId npeId, IxNpeDlFunctionalityId functionalityId, IxNpeDlImageId *imageIdPtr)
| This instructs NPE Downloader to get Id of the latest version for an image that is specified by the client.
PUBLIC IX_STATUS | ixNpeDlNpeStopAndReset (IxNpeDlNpeId npeId)
| Stops and Resets an NPE.
PUBLIC IX_STATUS | ixNpeDlNpeExecutionStart (IxNpeDlNpeId npeId)
| Starts code execution on a NPE.
PUBLIC IX_STATUS | ixNpeDlNpeExecutionStop (IxNpeDlNpeId npeId)
| Stops code execution on a NPE.
IX_STATUS | ixNpeDlUnload (void)
| This function will uninitialise the IxNpeDl component.
PUBLIC void | ixNpeDlStatsShow (void)
| This function will display run-time statistics from the IxNpeDl component.
PUBLIC void | ixNpeDlStatsReset (void)
| This function will reset the statistics of the IxNpeDl component.
## Detailed Description This file contains the public API of the IXP425 NPE Downloader component. Date: 14 December 2001 Version: Revision 1.26 -- Intel Copyright Notice -- Copyright 2001-2003 Intel Corporation All Rights Reserved. The source code contained or described herein and all documents related to the source code ("Material") are owned by Intel Corporation or its suppliers or licensors. Title to the Material remains with Intel Corporation or its suppliers and licensors. The Material is protected by worldwide copyright and trade secret laws and treaty provisions. No part of the Material may be used, copied, reproduced, modified, published, uploaded, posted, transmitted, distributed, or disclosed in any way except in accordance with the applicable license agreement . No license under any patent, copyright, trade secret or other intellectual property right is granted to or conferred upon you by disclosure or delivery of the Materials, either expressly, by implication, inducement, estoppel, except in accordance with the applicable license agreement. Unless otherwise agreed by Intel in writing, you may not remove or alter this notice or any other notice embedded in Materials by Intel or Intel's suppliers or licensors in any way. For further details, please see the file README.TXT distributed with this software. -- End Intel Copyright Notice -- Definition in file IxNpeDl.h.
Automatically generated from sources. © Intel Corp. 2003