;===========================================================================
;===========================================================================
;===========================================================================
;
;
;	BURNBOOT.TXT		BURNBOOT TOOL INITIATION FILE
;
;				01.15.2004
;
;				Revision 1.7
;
;	Burboot is a tool that needs to be invoked in the factory to optimze,
;	i.e., speed up the 1st boot process experienced by the end-user.
;	
;
;	This file resides in <Recovery-Partition>:\MiniNT\System32\BurnBoot.txt
;
;	It is designed to be updated-ONLY by Burn-in process used at each factory.
;
;	WARNING : UPDATE by line-editing desired keys ONLY
; 	*******   Do ***NOT*** update by replacing or overwriting w/ another version.
;
;
;	Psuedo-code listed at the end-of the file.
;
; 	DEFAULT, RECOMMENDED values shown below with -> on the left:
;
;

[DEFAULT]


; REV CONTROL : Following BurnBoot.txt file Version key will ensure that correct, 
; 		compatible version of BurnBoot Tool block. These 2 objects will
;		be revised in lockstep.
;
VERSION = 1.7


; START_BURNBOOT : Set this key to "ON" just before initiating BurnBoot process
;
;	During BurnBoot processing, value will be set to ON.
;
;	When BurnBoot process finishes successfully, value will be set to DONE.
;
;	value =  ->OFF | ON | DONE
;
START_BURNBOOT =DONE



; RETURN CODE : On Exit: BURNBOOT will return following values when done:
;
;	RETURN_CODE = PASS does NOT include REIMAGE status, if REIMAGE is enabled.
;
; 	If RETURN_CODE is "PASS" without FINISH_TIME, it indicates a failure.
;
;	value = NOT_YET_STARTED | RUNNING | PASS | FAIL
;
RETURN_CODE =PASS


; Log the product & model on which the burnboot tool was run.
;
;	This is used by MLCRC tool to lockout multi-sku gold-crc-file checking 
;	against a sku-specific or unit-specific image.
;
;	MODEL 		= -> <blank> | <model>
;	MODEL_PRODUCT_# = -> <blank> | <model_product#>
;
MODEL           =SR1268AN
MODEL_PRODUCT_# =PL421AA-ABG


; Log BurnBoot process start time, finish time and time taken:
;
;	FINISH_TIME does **NOT** include RE_IMAGE time, if REIMAGE is enabled.
;
;	START_TIME  = -> <blank> | <time and date>
;	FINISH_TIME = -> <blank> | <time and date>
;	TIME_TAKEN  = -> <blank> | <hour:min:sec>
;
START_TIME  = 9:38:39.46 Fri 24/09/2004
FINISH_TIME = 9:49:49.04 Fri 09/24/2004
TIME_TAKEN  =




; Specify if the top slot ODD Tray should be ejected as a visual indication of 
; a successful BurnBoot processing:
;
; 	If this parameter is missing, the default action will be taken.
;
;	value = ->NO | YES
;
EJECT_TRAY_ON_SUCCESS = NO


; 
; Factory can/should specifiy what it wants BurnBoot to do when finished processing:
; 
;  Specify if you want BURNBOOT to 
;
;
;	A : shutdown (i.e. power-down; the next boot will be into user partition)
;
; 	B : stay powered up in Recovery Partition while showing a results DIALOG box
;
;       C : continue execution into a factory-specific odm.bat file
;    		- if exists,the file ODM.bat
;		  - should be placed in <Recovery-Partition>:\MiniNT\System32\
;    		  - will be executed after BurnBoot is finished processing
;		  - control passes to ODM.bat i.e. does **NOT** return to BurnBoot tool
;    		  - will be executed in the WinPE based Recovery Partition environment
;    		- Factory can use this odm.bat file to, 
;		  - e.g., boot into a diagnostics partition and continue burn-in
;
;    or D : reimage user partition into recovery partition after finishing optimizations.
;
;	    ReImage tool finishes w/ a dialog box asking user to click to shutdown.
;	
; 	    This flag is useful for and RECOMMENDED mainly/**ONLY** for sku specific images.
;           Re-Imaging takes ~60 minutes to process, which would slow down production.
;           Thus, it should NOT be used for Unit-specific image optimization during Burn-in.
;
;	    RETURN_CODE = PASS does **NOT** include REIMAGE status, if REIMAGE is enabled.
;
;           FINISH_TIME does **NOT** include RE_IMAGE time, if REIMAGE is enabled.
;	
;
;	value = ->SHUTDOWN | STAY_IN_RECOVERY_PARTITION | EXECUTE_ODM_BAT | REIMAGE
;
ON_FINISHING = SHUTDOWN


;=================================================================================
;
;
;	PSUEDO-CODE
;
; 	FOLLOWING IS THE PSUEDO-CODE FOR THE CONTROL FLOW BETWEEN 
;	THE BURN-IN ENVIRONMENT AND THE BURNBOOT PROCESS:
;
;
;;
;;	Factory Burn-in Environment 
;;		1 sets optional parameters	
;;		2 sets the flag START_BURNBOOT = ON
;;		3 forces next boot into the User partition
;;
;
;;
;; At this point, the unit is in Win XP based USER PARTITION
;;
;If (not START_BURNBOOT = ON ( i.e.  = OFF or DONE)) or (not START_BURNBOOT = NOT_YET_STARTED)
;  	continue normal end-user 1st boot or cold-boot.
; 
;Else, execute following burnboot process:
;
;	Set START_BURNBOOT = STARTED
;	Set START_TIME = <current time>
;	Set FINISH_TIME = <blank>
;	Set TIME_TAKEN = <blank>
;	Set RETURN_CODE = RUNNING
;
;  	Force Audit mode
;	(Unit actually does one more boot here)
;	Do all  optimizations; 
;	   display progress, step, time, etc as each optimization is done
;
;	Prepare for next boot into recovery partition
;	ReSeal (which also shutsdown; next boot is forced into Recovery Partition)
;
;	;
;	; At this point, the unit is in Win PE based RECOVERY PARTITION
;	;
;
;	Boot into Recovery Partition
;
;	Ensure that unit is in BurnBoot mode
;	
;	Ensure that any future boot ***using F10*** into Recovery Partition 
;	will do normal recovery tasks ( not burnboot again)
;
;	Ensure that any future boot done normally will enter User partition
;
;	; Update results in BurnBoot.txt file
;       ; 
;	Set START_BURNBOOT = DONE
;	Set RETURN_CODE = PASS
;	Set FINISH_TIME = <current time>
;	Set TIME_TAKEN = <time taken>
;
;	; Show results in a nice DIALOG BOX:
;	;
;	Display following results in Dialog Box for at least 30 seconds:
;
;	Tool name, tool rev#, start-time, finish-time, time-taken, result status
;
;	; Eject ODD tray if requested
;	;
;	If RETURN_CODE = PASS & EJECT_TRAY_ON_SUCCESS = ON, eject tray in top ODD
;	
;	; On finishing, do what factory wants:
;	;
;
;	If 	ON_FINISHING  = SHUTDOWN, 
;			shutdown
;
;
;	Else if ON_FINISHING = STAY_IN_RECOVERY_PARTITION,
;		stay powered-on in Recovery Partition 
;		with an extra Dialog Box 
;		with a button for shutdown to for powerdown
;
;	Else if ON_FINISHING  = EXECUTE_ODM_BAT,
;		If  file ODM.BAT exists, 
;			continue execution into odm designed & owned ODM.BAT
;			(in Win PE environment in RECOVERY PARTITION)
;		End-if
;
;	Else if ON_FINISHING = REIMAGE, 
;               ReImage user-partition contents into recovery partition
;		(ReImage tool takes ~60 minutes)
;		On finish, display a dialog box w/ shutdown button
;	End-if
;End-if
;
;;
;;	At this point, factory can ship the unit.
;;
;
;	End of Psuedo-code.
;
;===========================================================================


;
;
;	END OF BURNBOOT.TXT file
;
;===========================================================================
;===========================================================================
;===========================================================================