===================================================================
* FirmwareUpgrade Patch
* Greg Brown March 30th, 2006
* ==================================================================
patch for the firmware upgrade script.

Who should upgrade?
You will want to install this patch for any patches listed in the version details section.

Installation:
Replace existing files under X:\ServiceShell\scripts\device with the files below.  (X - The drive letter may very between C and D depending on workstation install location).

FirmwareUpgrade.spt
CommonUtilities.inc
errors.inc

Version Details:

Version 4.92

- Added support for GMCE TH2 downloads.  Added support for splot version 4.83
- Added a fast MCE download option - available with service host 3.1.0 or newer
- Added warning when only MCE main code is selected to be loaded without boot code

Version 4.53

- Added license command to NVS backup in place of the feature command

Version 4.48

_ Added another check when upgrading a TH1.X to version 1.97 relating to platesetters.

Version 4.43

- Added support for upgrading head TH1.X to version 1.97
- Added checks for MPE model type.  If the type changes during a MPE firmware upgrade the script warns the user.

Version 4.34

- Modified the download command to inlude quotes around the path name.  This will allow downloads to complete even when the Service Shell install path has a space in it.  Using quotes removed backwards compatibility of this script with older Service Host versions (versions 2.2 or earlier).

Version 4.32

- Fixed a bug with head upgrades. The head upgrade nvs command was not being performed with MPE devices.


Version 4.17

- Fixed a bug when downloading a firmware component that resets the MCE board followed by a TFX head download

Version 4.14

- Added support for 1.95 TH1.X head downloads 

Version 4.09      

- Bug fix with downloading to Magnus VLF devices 

Version 4.06      

- Accomidated change in Magnus VLF device names

Version 4.05      

- Bug fix with LIONEL boards    

Version 4.04

- Bug fix for downloading LIONEL firmware on 6383 devices.

Version 4.04

- Bug fix for downloading LIONEL firmware on 6383 devices.

Version 4.02

- Bug fix: NVS is now erased before loading main MCE firmware when using the board replace feature.  NVS was not being erased if other MCE components were loaded before the main code was loaded.

Version 3.45

- added support for backing up the TFX head as per the instructions in the TFX release notes before a firmware upgrade.

Version 3.43 

 - auto download retry squence for MCE and head firmware downloads.  MCE NVS max upload retry is 8.  MCE and Head Firmware max download retry is 2.

Version 3.37

 - support for upgrading TH1.X 1.93 head code

Version 3.32

1. This script version includes these features:

 - support for mutliple satellite boards of the same type
   (This is only applicable to the continuous load spectrum which has two genine boards)
 - support for the MCE VLF/VLFAL satellite boards
 - support for upgrading TH1.X 1.92 head code
 - support for upgrades for Base VLF MPE firmware version 1.53 to 3.00.  
   (Version 3.0 requires a new MPE board with more memory)

   Procedure to upgrade to VLF TS MPE firmware to version 3.00 is as follows:
   1) Aquire to 2 Meg MPE board part number: 503-00075A-01
   2) Upgrade the firmware to version 1.53.  
   3) Make sure you do the NVS upgrade.  Confirm that 'set config ver' contains "version = 1530400"
      A nvs upgrade sets this NVS value to the current version of firmware running on the device 
      which should be 1.53.
   3) Create a backup of the NVS.
   4) Use the "Replace MPE Board" feature of the FirmwareUpgrade script.  
      This feature will load code onto your new board plus the NVS file you created in step 3.  
      Once the backup is loaded, the script will do the "autoloader startup" command, set sys pbin 1, 
      nvs save pbin, followed by a NVS upgrade 1.10. 

2. This script version includes these fixes: 

 - fix for downgrading from mce boot code version 1.12 to 1.09.  The order which the script upgrades/downgrades firmware is boot, post, xilinx, ovwr and finally main.

*************************************************************************************************************************

Known Problems:

This script will error out with function undefined if you run this script in a 2.4SP1 or earlier version of service shell client connected to a 2.5 version service host.  Recommendation - upgrade service shell client or use the workstation to upgrade firmware.  The workstation should have matching client and host versions.  

This problem will only encountered if a user is connecting remotely to a system with a laptop that is running Service shell client older than version 2.5 to service host version 2.5.
