/** * @file IxNpeDlImageMgr.c * * @author Intel Corporation * @date 09 January 2002 * * @brief This file contains the implementation of the private API for the  *        IXP425 NPE Downloader ImageMgr module * *  * @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. */#include "IxOsal.h"/* * Put the user defined include files required. */#include "IxNpeDlImageMgr_p.h"#include "IxNpeDlMacros_p.h"/* * define the flag which toggles the firmare inclusion */#define IX_NPE_MICROCODE_FIRMWARE_INCLUDED 1#include "IxNpeMicrocode.h"/* * Indicates the start of an NPE Image, in new NPE Image Library format. * 2 consecutive occurances indicates the end of the NPE Image Library */#define NPE_IMAGE_MARKER 0xfeedf00d/* * Typedefs whose scope is limited to this file. *//* * FOR BACKWARD-COMPATIBILITY WITH OLD NPE IMAGE LIBRARY FORMAT * TO BE DEPRECATED IN A FUTURE RELEASE */typedef struct{    UINT32 size;    UINT32 offset;    UINT32 id;} IxNpeDlImageMgrImageEntry;/* * FOR BACKWARD-COMPATIBILITY WITH OLD NPE IMAGE LIBRARY FORMAT * TO BE DEPRECATED IN A FUTURE RELEASE */typedef union{    IxNpeDlImageMgrImageEntry image;    UINT32 eohMarker;} IxNpeDlImageMgrHeaderEntry;/* * FOR BACKWARD-COMPATIBILITY WITH OLD NPE IMAGE LIBRARY FORMAT * TO BE DEPRECATED IN A FUTURE RELEASE */typedef struct{    UINT32 signature;    /* 1st entry in the header (there may be more than one) */    IxNpeDlImageMgrHeaderEntry entry[1];} IxNpeDlImageMgrImageLibraryHeader;/* * NPE Image Header definition, used in new NPE Image Library format */typedef struct{    UINT32 marker;    UINT32 id;    UINT32 size;} IxNpeDlImageMgrImageHeader;/* module statistics counters */typedef struct{    UINT32 invalidSignature;    UINT32 imageIdListOverflow;    UINT32 imageIdNotFound;} IxNpeDlImageMgrStats;/* * Variable declarations global to this file only.  Externs are followed by * static variables. */static IxNpeDlImageMgrStats ixNpeDlImageMgrStats;/* default image */#ifdef IX_NPEDL_READ_MICROCODE_FROM_FILEstatic UINT32 *IxNpeMicroCodeImageLibrary = NULL;  /* Gets set to proper value at runtime */#elsestatic UINT32 *IxNpeMicroCodeImageLibrary = (UINT32 *)IxNpeMicrocode_array;#endif/* * static function prototypes. */PRIVATE BOOLixNpeDlImageMgrSignatureCheck (UINT32 *microCodeImageLibrary);PRIVATE void  ixNpeDlImageMgrImageIdFormat (UINT32 rawImageId, IxNpeDlImageId *imageId);PRIVATE BOOLixNpeDlImageMgrImageIdCompare (IxNpeDlImageId *imageIdA, 				 IxNpeDlImageId *imageIdB);				 PRIVATE BOOLixNpeDlImageMgrNpeFunctionIdCompare (IxNpeDlImageId *imageIdA,    				       IxNpeDlImageId *imageIdB);PRIVATE IX_STATUSixNpeDlImageMgrImageFind_legacy (UINT32 *imageLibrary,                                 UINT32 imageId,                                 UINT32 **imagePtr,                                 UINT32 *imageSize);/* * Function definition: ixNpeDlImageMgrMicrocodeImageLibraryOverride * * FOR BACKWARD-COMPATIBILITY WITH OLD NPE IMAGE LIBRARY FORMAT * AND/OR LEGACY API FUNCTIONS. TO BE DEPRECATED IN A FUTURE RELEASE */IX_STATUSixNpeDlImageMgrMicrocodeImageLibraryOverride (    UINT32 *clientImageLibrary){    IX_STATUS status = IX_SUCCESS;    IX_NPEDL_TRACE0 (IX_NPEDL_FN_ENTRY_EXIT, 		     "Entering ixNpeDlImageMgrMicrocodeImageLibraryOverride\n");    if (ixNpeDlImageMgrSignatureCheck (clientImageLibrary))    {	IxNpeMicroCodeImageLibrary = clientImageLibrary;    }    else    {	IX_NPEDL_ERROR_REPORT ("ixNpeDlImageMgrMicrocodeImageLibraryOverride: "			       "Client-supplied image has invalid signature\n");	status = IX_FAIL;    }    IX_NPEDL_TRACE1 (IX_NPEDL_FN_ENTRY_EXIT, 		     "Exiting ixNpeDlImageMgrMicrocodeImageLibraryOverride: status = %d\n",		     status);    return status;}/* * Function definition: ixNpeDlImageMgrImageListExtract * * FOR BACKWARD-COMPATIBILITY WITH OLD NPE IMAGE LIBRARY FORMAT * AND/OR LEGACY API FUNCTIONS. TO BE DEPRECATED IN A FUTURE RELEASE */IX_STATUSixNpeDlImageMgrImageListExtract (    IxNpeDlImageId *imageListPtr,    UINT32 *numImages){    UINT32 rawImageId;    IxNpeDlImageId formattedImageId;    IX_STATUS status = IX_SUCCESS;    UINT32 imageCount = 0;    IxNpeDlImageMgrImageLibraryHeader *header;    IX_NPEDL_TRACE0 (IX_NPEDL_FN_ENTRY_EXIT, 		     "Entering ixNpeDlImageMgrImageListExtract\n");    header = (IxNpeDlImageMgrImageLibraryHeader *) IxNpeMicroCodeImageLibrary;    if (ixNpeDlImageMgrSignatureCheck (IxNpeMicroCodeImageLibrary))    {	/* for each image entry in the image header ... */	while (header->entry[imageCount].eohMarker !=	       IX_NPEDL_IMAGEMGR_END_OF_HEADER)	{	    /*	     * if the image list container from calling function has capacity,	     * add the image id to the list 	     */	    if ((imageListPtr != NULL) && (imageCount < *numImages))	    {		rawImageId = header->entry[imageCount].image.id;	        ixNpeDlImageMgrImageIdFormat (rawImageId, &formattedImageId);		imageListPtr[imageCount] = formattedImageId;	    }	    /* imageCount reflects no. of image entries in image library header */	    imageCount++;  	}		/*	 * if image list container from calling function was too small to	 * contain all image ids in the header, set return status to FAIL	 */	if ((imageListPtr != NULL) && (imageCount > *numImages))	{	    status = IX_FAIL;	    IX_NPEDL_ERROR_REPORT ("ixNpeDlImageMgrImageListExtract: "				   "number of Ids found exceeds list capacity\n");	    ixNpeDlImageMgrStats.imageIdListOverflow++;	}	/* return number of image ids found in image library header */	*numImages = imageCount;      }    else    {	status = IX_FAIL;	IX_NPEDL_ERROR_REPORT ("ixNpeDlImageMgrImageListExtract: "			       "invalid signature in image\n");    }        IX_NPEDL_TRACE1 (IX_NPEDL_FN_ENTRY_EXIT, 		     "Exiting ixNpeDlImageMgrImageListExtract: status = %d\n",		     status);    return status;}/* * Function definition: ixNpeDlImageMgrImageLocate * * FOR BACKWARD-COMPATIBILITY WITH OLD NPE IMAGE LIBRARY FORMAT * AND/OR LEGACY API FUNCTIONS. TO BE DEPRECATED IN A FUTURE RELEASE */IX_STATUSixNpeDlImageMgrImageLocate (    IxNpeDlImageId *imageId,    UINT32 **imagePtr,    UINT32 *imageSize){    UINT32 imageOffset;    UINT32 rawImageId;    IxNpeDlImageId formattedImageId;    /* used to index image entries in image library header */    UINT32 imageCount = 0;       IX_STATUS status = IX_FAIL;    IxNpeDlImageMgrImageLibraryHeader *header;    IX_NPEDL_TRACE0 (IX_NPEDL_FN_ENTRY_EXIT,		     "Entering ixNpeDlImageMgrImageLocate\n");    header = (IxNpeDlImageMgrImageLibraryHeader *) IxNpeMicroCodeImageLibrary;    if (ixNpeDlImageMgrSignatureCheck (IxNpeMicroCodeImageLibrary))    {	/* for each image entry in the image library header ... */	while (header->entry[imageCount].eohMarker !=	       IX_NPEDL_IMAGEMGR_END_OF_HEADER)	{	    rawImageId = header->entry[imageCount].image.id;	    ixNpeDlImageMgrImageIdFormat (rawImageId, &formattedImageId);	    /* if a match for imageId is found in the image library header... */	    if (ixNpeDlImageMgrImageIdCompare (imageId, &formattedImageId))	    {		/*		 * get pointer to the image in the image library using offset from		 * 1st word in image library		 */		imageOffset = header->entry[imageCount].image.offset;		*imagePtr = &IxNpeMicroCodeImageLibrary[imageOffset];		/* get the image size */		*imageSize = header->entry[imageCount].image.size;		status = IX_SUCCESS;		break;	    }	    imageCount++;	}	if (status != IX_SUCCESS)	{	    IX_NPEDL_ERROR_REPORT ("ixNpeDlImageMgrImageLocate: "				   "imageId not found in image library header\n");	    ixNpeDlImageMgrStats.imageIdNotFound++;	}    }    else    {	IX_NPEDL_ERROR_REPORT ("ixNpeDlImageMgrImageLocate: "			       "invalid signature in image library\n");    }    IX_NPEDL_TRACE1 (IX_NPEDL_FN_ENTRY_EXIT,		     "Exiting ixNpeDlImageMgrImageLocate: status = %d\n", status);    return status;}/* * Function definition: ixNpeDlImageMgrLatestImageExtract