*******************************************************************************
*                   Quick Guide to Update the ESX-TC3G                        *
*******************************************************************************

To perform an update, follow the steps:

  1. Customizing the configuration file (config.ttl)
  2. Executing the start script (depending on the OS):
		- Windows start script = tc3g_updater_for_windos.bat
		- Linux start script = tc3g_updater_for_linux (check if file permission '-x' is already set)
  3. Follow the instructions on the screen.

For further information, please refer to the ESX-TC3G User Manual.

*******************************************************************************
*                   TC3G software update package for windows                  *
*******************************************************************************

Introduction
============
This package contains all data files and tools to update the software of a TC3G.

Don't unzip the updater on your desktop!

Folder structure
================
After unpacking the archive this folder structure should exist:
    data:             Contains the data files for the TC3G (Uboot binary, Kernel binary,
                      Root file system image, Flattened device tree blob)
    scripts:          TeraTerm scripts that do the work
    tftp:             Contains the Tftpd32 program (a open source tftp server)
    tterm:            Contains the TeraTerm program (a open source terminal program)
    tc3g_updater:     Executable which starts the update process
    config:           General settings for the update process
    readme:           Help file

Configuration
=============

Hardware setup:
---------------
Connect the RS232 interface of the TC3G board to your host PC. The whole update can be
downloaded via this line. Due to the limited speed of the RS232 (@115 kBaud) the update
takes about 15 to 30 minutes.
For a faster download additionally connect the ethernet interface of the TC3G
directly to your host PC (Crossover cable!) or to your private / companies network via router or switch and
use the TFTP download feature. This variant will be much for faster

To test the RS232 connection open a terminal program on the host PC (e.g Hyperterm or the
TeraTerm (supplied in the tterm folder)) and setup the serial port where the TC3G is
connected to with this settings: 115200 baud, 1 stop bit, no parity bit, no handshake.
Switch on the power supply of the TC3G controller. You should see the boot messages
of the Uboot and Linux kernel in the terminal.

Prepare for Update:
===================
Open the config.tll file with your preferred editor.
The settings file is seperated in sectors like "Select COM port" or "network settings for TFTP data download".
First you must choose the correct COM port of your PC in section "Select COM port".
Remove the ";"  character in front of the line to activate the COM port. Don't activate more
than one COM port!!
In the next chapter it's possible to set network parameters if you prefer update via LAN.
In this case, set variable VarTftpDownload = 1, and also set your IP settings for server (PC) and
client (TC3G). The choosen TC3G IP will be only used for update. After updating the TC3G, dhcp mechanismus
will be used by default.
In the last chapter "; components to be installed", it's possible to select components which shall be
updated.
In case you are at development time leave configuration setting VarRootFileSystemStatus to 1 and your
TC3G System becomes RW, else change it to 0 (zero) and the system becomes read only (RO).

Last step befor update TC3G System, save your settings and close the file.

Start Update
============
Switch off the TC3G. Start the batch file tc3g_updater_for_windows.bat to start the update.
The batch file opens the Tftpd32 and the TeraTerm programs and starts the update script.
Switch on the controller when the script prompts for it.

*****************************************************************************************
CAUTION: Do not interrupt the update process!!! For the update a valid Uboot must be
         installed on the TC3G. If the update process is interrupted during update
         of the Uboot (next to last update step, takes only few seconds), it is not possible
         to access the board from an external interface any more. The controller has
         to be sent back to STW for  reprogramming.
         Interrupting the update process during any other step is not too critical, since
         it can just be restarted.
*****************************************************************************************


Logging / Trouble shooting
==========================
The complete data traffic between the host PC and the TC3G is logged into the file
tc3g_updater.log. If any problem during the update occur please contact STW and
attach the log file.
