/* bootInit.c - ROM initialization module *//* Copyright 1989-1998 Wind River Systems, Inc. */#include "copyright_wrs.h"/*modification history--------------------04w,10feb99,db   Fix to ensure that default bootline gets copied for		 standalone and rom-resident images(SPR #21763).04v,05oct98,jmp  doc: cleanup.04u,17apr98,cdp  backed out 04t and made absEntry volatile for ARM.04t,16apr98,cdp  for ARM, make UNCOMPRESS entry point in RAM.04s,20mar98,cdp  make ROM_COPY_SIZE subject to #ifndef.04r,11nov97,cdp  ARM7TDMI_T: force romStart to call entry point in Thumb state.		 (SPR# 9716)04q,14jul97,tam  changed remaining references to bfillLong to fillLong. 04p,12feb97,dat  Added USER_RESERVED_MEM, SYS_MEM_TOP, SYS_MEM_BOTTOM, SPR 803004o,04feb97,ms   fixed compiler warning about protoype for bcopyLongs.04o,28nov96,cdp  added ARM support.04n,03sep96,hdn  added the compression support for pc[34]86 BSP.04m,19aug96,ms   added UNCMP_RTN macro to use inflate instead of uncompress04l,21jun96,jmb  long modhist -- deleted entries prior to 1994.  SPR #652803k,10jun96,tam  added rom resident support for PPC architecture. 03j,14may96,dat  fixed compiler warnings for copyLongs, fillLongs. SPR #653603i,06mar96,tpr  changed absEntry to be volatile for PowerPC.03h,22aug95,hdn  added support for I80X86.03g,14mar95,caf  restored mips resident rom support (SPR #3856).03f,16feb95,jdi  doc format change.03f,23may95,yao  define binArrayStart and binArrayEnd for PowerPC		 because tools don't prepend "_".03e,09dec94,caf  undid mod 03a, use sdata for resident roms (SPR #3856).03d,22jun94,caf  undid 16-byte alignment portion of mod 03c, below.03c,14jun94,cd   corrected definitions of etext, edata and end.	   +caf  for R4000 resident ROMs: data starts on 16-byte boundary.		 for R4000 uncompressed ROMs: added volatile to absEntry type.*//*DESCRIPTIONThis module provides a generic boot ROM facility.  The target-specificromInit.s module performs the minimal preliminary board initialization andthen jumps to the C routine romStart().  This routine, still executing outof ROM, copies the first stage of the startup code to a RAM address andjumps to it.  The next stage clears memory and then uncompresses theremainder of ROM into the final VxWorks ROM image in RAM.A modified version of the Public Domain \f3zlib\fP library is used touncompress the VxWorks boot ROM executable linked with it.  Compressingobject code typically achieves over 55% compression, permitting muchlarger systems to be burned into ROM.  The only expense is the added fewseconds delay while the first two stages complete.ROM AND RAM MEMORY LAYOUTExample memory layout for a 1-megabyte board:.CS    --------------  0x00100000 = LOCAL_MEM_SIZE = sysMemTop()    |            |    |    RAM     |    |  0 filled  |    |            |    |------------| = (romInit+ROM_COPY_SIZE) or binArrayStart    | ROM image  |    |----------- |  0x00090000  = RAM_HIGH_ADRS    | STACK_SAVE |    |------------|    |            |  0x00080000  = 0.5 Megabytes    |            |    |            |    | 0 filled   |    |            |    |            |  0x00001000  = RAM_ADRS & RAM_LOW_ADRS    |            |    |            |  exc vectors, bp anchor, exc msg, bootline    |            |    |            |    --------------  0x00000000  = LOCAL_MEM_LOCAL_ADRS.CE.CS    --------------    |    ROM     |    |            |  0xff8xxxxx  = binArrayStart    |            |    |            |  0xff800008  = ROM_TEXT_ADRS    --------------  0xff800000  = ROM_BASE_ADRS.CESEE ALSO:inflate(), romInit(), and deflateAUTHORThe original compression software for zlib was written by Jean-loup Gaillyand Mark Adler. See the manual pages of inflate and deflate formore information on their freely available compression software.*/#include "vxWorks.h"#include "sysLib.h"#include "config.h"#include "errno.h"#include "sioLib.h"#define	UNCMP_RTN	inflate#ifndef USER_RESERVED_MEM#   define USER_RESERVED_MEM 0#endif/* * If memory is to be cleared, it will be cleared from SYS_MEM_BOTTOM * up to (but not including) SYS_MEM_TOP, except for text and data segments. * The user reserved area is not cleared. */#define	SYS_MEM_TOP \	(LOCAL_MEM_LOCAL_ADRS + LOCAL_MEM_SIZE - USER_RESERVED_MEM)#define SYS_MEM_BOTTOM \	(LOCAL_MEM_LOCAL_ADRS + RESERVED)IMPORT void	romInit ();IMPORT STATUS	UNCMP_RTN ();IMPORT void	usrInit ();IMPORT void	sysInitAlt ();IMPORT void	start ();#if	((CPU_FAMILY == MIPS) || (CPU_FAMILY==PPC))#define	binArrayStart	_binArrayStart#define	binArrayEnd	_binArrayEnd#define	RESIDENT_DATA	RAM_DST_ADRS#else#define	RESIDENT_DATA	(&sdata)IMPORT char	sdata;			/* defined in romInit.s */#endifIMPORT UCHAR	binArrayStart [];	/* compressed binary image */IMPORT UCHAR	binArrayEnd;		/* end of compressed binary image */IMPORT char	etext [];		/* defined by the loader */IMPORT char	edata [];		/* defined by the loader */IMPORT char	end [];			/* defined by the loader */#ifndef RAM_DST_ADRS                	/* default uncompress dest. */#define RAM_DST_ADRS        RAM_HIGH_ADRS#endif/* If the boot code is in RAM and the RAM is already initialized, * clearing the RAM is not necessary.  Macro BOOTCODE_IN_RAM is * used not to clear the RAM. */#ifdef	BOOTCODE_IN_RAM			/* not to clear RAM */#undef	ROM_TEXT_ADRS#undef	ROM_BASE_ADRS#define	ROM_TEXT_ADRS	((UINT)romInit)#define	ROM_BASE_ADRS	((UINT)romInit)#endif	/* BOOTCODE_IN_RAM */#if	defined (UNCOMPRESS) || defined (ROM_RESIDENT)#ifndef ROM_COPY_SIZE#define	ROM_COPY_SIZE	(ROM_SIZE - (ROM_TEXT_ADRS - ROM_BASE_ADRS))#endif#endif	/* UNCOMPRESS */#define ROM_OFFSET(adr)	(((UINT)adr - (UINT)romInit) + ROM_TEXT_ADRS)/* forward declarations */LOCAL void copyLongs (FAST UINT *source, FAST UINT *destination, UINT nlongs);#ifndef	BOOTCODE_IN_RAMLOCAL void fillLongs (FAST UINT *buf, UINT nlongs, FAST UINT val);#endif	/* BOOTCODE_IN_RAM *//********************************************************************************* romStart - generic ROM initialization** This is the first C code executed after reset.** This routine is called by the assembly start-up code in romInit().* It clears memory, copies ROM to RAM, and possibly invokes the uncompressor.* It then jumps to the entry point of the uncompressed object code.** RETURNS: N/A*/void romStart    (    FAST int startType		/* start type */    )    {#if ((CPU_FAMILY==SPARC) || (CPU_FAMILY==MIPS) || (CPU_FAMILY==I80X86) || \     (CPU_FAMILY==PPC) || (CPU_FAMILY==ARM))    volatile			/* to force absolute adressing //(::volatile) FUNCPTR absEntry; */#endif /* (CPU_FAMILY==SPARC) */    FUNCPTR absEntry;		/* to avoid PC Relative Jump Subroutine */    #if     (CPU_FAMILY==ARM) && (!defined(ROM_RESIDENT))    VOIDFUNCPTR ramfillLongs = fillLongs;     /* force call to RAM */    #define fillLongs(a,b,c) ramfillLongs(a,b,c)#endif  /* (CPU_FAMILY==ARM) */    /*     * Copy from ROM to RAM, minus the compressed image     * if compressed boot ROM which relies on binArray     * appearing last in DATA segment.     */#ifdef ROM_RESIDENT    /* If ROM resident code, then copy only data segment     * from ROM to RAM, initialize memory and jump     * to usrInit.     */    #if  (CPU_FAMILY == SPARC)    copyLongs ((UINT *)(etext + 8), (UINT *) RESIDENT_DATA,#elif	((CPU_FAMILY == MIPS) || (CPU_FAMILY == PPC))    copyLongs ((UINT *)(etext + 0), (UINT *) RESIDENT_DATA,#else    copyLongs ((UINT *)(etext + 4), (UINT *) RESIDENT_DATA,#endif		 ((UINT) edata - (UINT) RESIDENT_DATA) / sizeof (long));#else	/* ROM_RESIDENT */#ifdef UNCOMPRESS#if	(CPU_FAMILY == MIPS)    /*     * copy text to uncached locations to avoid problems with     * copy back caches     */    ((FUNCPTR)ROM_OFFSET(copyLongs)) (ROM_TEXT_ADRS, (UINT)K0_TO_K1(romInit),		ROM_COPY_SIZE / sizeof (long));#else	/* CPU_FAMILY == MIPS */    ((FUNCPTR)ROM_OFFSET(copyLongs)) (ROM_TEXT_ADRS, (UINT)romInit,		ROM_COPY_SIZE / sizeof (long));#endif	/* CPU_FAMILY == MIPS */#else	/* UNCOMPRESS */#if	(CPU_FAMILY == MIPS)    /*     * copy text to uncached locations to avoid problems with     * copy back caches     * copy the entire data segment because there is no way to ensure that     * binArray is the last thing in the data segment because of GP relative     * addressing     */    ((FUNCPTR)ROM_OFFSET(copyLongs)) (ROM_TEXT_ADRS, (UINT)K0_TO_K1(romInit),		((UINT)edata - (UINT)romInit) / sizeof (long));#else	/* CPU_FAMILY == MIPS */    ((FUNCPTR)ROM_OFFSET(copyLongs)) (ROM_TEXT_ADRS, (UINT)romInit,		((UINT)binArrayStart - (UINT)romInit) / sizeof (long));#endif	/* CPU_FAMILY == MIPS */#endif	/* UNCOMPRESS */#endif	/* ROM_RESIDENT */#if	(CPU_FAMILY != MIPS) && (!defined (BOOTCODE_IN_RAM))    /* clear all memory if cold booting */    if (startType & BOOT_CLEAR)	{#ifdef ROM_RESIDENT	/* Clear memory not loaded with text & data.	 *	 * We are careful about initializing all memory (except	 * STACK_SAVE bytes) due to parity error generation (on	 * some hardware) at a later stage.  This is usually	 * caused by read accesses without initialization.	 */	fillLongs ((UINT *)SYS_MEM_BOTTOM,		((UINT) RESIDENT_DATA - STACK_SAVE - (UINT)SYS_MEM_BOTTOM)		/ sizeof(long), 0);	fillLongs (((UINT *) edata),		((UINT)SYS_MEM_TOP - ((UINT) edata)) / sizeof(long), 0);#else	/* ROM_RESIDENT */	fillLongs ((UINT *)(SYS_MEM_BOTTOM),		((UINT)romInit - STACK_SAVE - (UINT)SYS_MEM_BOTTOM) /		sizeof(long), 0);#if     defined (UNCOMPRESS)	fillLongs ((UINT *)((UINT)romInit + ROM_COPY_SIZE),		    ((UINT)SYS_MEM_TOP - ((UINT)romInit + ROM_COPY_SIZE))		    / sizeof(long), 0);#else	fillLongs ((UINT *)binArrayStart,		((UINT)SYS_MEM_TOP - (UINT)binArrayStart) / sizeof (long), 0);#endif 	/* UNCOMPRESS */#endif 	/* ROM_RESIDENT */	/* 	 * Ensure the boot line is null. This is necessary for those	 * targets whose boot line is excluded from cleaning.	 */	*(BOOT_LINE_ADRS) = EOS;	}#endif	/* (CPU_FAMILY != MIPS) && (!defined (BOOTCODE_IN_RAM)) */    /* jump to VxWorks entry point (after uncompressing) */#if	defined (UNCOMPRESS) || defined (ROM_RESIDENT)#if	(CPU_FAMILY == I960)    absEntry = (FUNCPTR)sysInitAlt;			/* reinit proc tbl */#else    absEntry = (FUNCPTR)usrInit;			/* on to bootConfig */#endif	/* CPU_FAMILY == I960 */#else    {#if	(CPU_FAMILY == MIPS)    volatile FUNCPTR absUncompress = (FUNCPTR) UNCMP_RTN;    if ((absUncompress) ((UCHAR *)ROM_OFFSET(binArrayStart),			 (UCHAR *)K0_TO_K1(RAM_DST_ADRS),			 (int)((UINT)&binArrayEnd - (UINT)binArrayStart)) != OK)#elif	(CPU_FAMILY == I80X86) || (CPU_FAMILY == ARM)    volatile FUNCPTR absUncompress = (FUNCPTR) UNCMP_RTN;    if ((absUncompress) ((UCHAR *)ROM_OFFSET(binArrayStart),	            (UCHAR *)RAM_DST_ADRS, &binArrayEnd - binArrayStart) != OK)#else    if (UNCMP_RTN ((UCHAR *)ROM_OFFSET(binArrayStart),	            (UCHAR *)RAM_DST_ADRS, &binArrayEnd - binArrayStart) != OK)#endif	/* (CPU_FAMILY == MIPS) */	return;		/* if we return then ROM's will halt */    absEntry = (FUNCPTR)RAM_DST_ADRS;			/* compressedEntry () */    }#endif	/* defined UNCOMPRESS || defined ROM_RESIDENT */#if	(CPU == ARM7TDMI_T)    absEntry = (FUNCPTR)((UINT32)absEntry | 1);		/* force Thumb state */#endif	/* (CPU == ARM7TDMI_T) */    (absEntry) (startType);    }#if     (CPU_FAMILY==ARM) && (!defined(ROM_RESIDENT))#undef fillLongs#endif  /* (CPU_FAMILY==ARM) *//********************************************************************************* copyLongs - copy one buffer to another a long at a time** This routine copies the first <nlongs> longs from <source> to <destination>.*/LOCAL void copyLongs (source, destination, nlongs)    FAST UINT *source;		/* pointer to source buffer      */    FAST UINT *destination;	/* pointer to destination buffer */    UINT nlongs;		/* number of longs to copy       */    {    FAST UINT *dstend = destination + nlongs;    while (destination < dstend)	*destination++ = *source++;    }#ifndef	BOOTCODE_IN_RAM/********************************************************************************* fillLongs - fill a buffer with a value a long at a time** This routine fills the first <nlongs> longs of the buffer with <val>.*/LOCAL void fillLongs (buf, nlongs, val)    FAST UINT *buf;	/* pointer to buffer              */    UINT nlongs;	/* number of longs to fill        */    FAST UINT val;	/* char with which to fill buffer */    {    FAST UINT *bufend = buf + nlongs;    while (buf < bufend)	*buf++ = val;    }#endif	/* BOOTCODE_IN_RAM */