The LAN Firmware Update Tool allows the user to download firmware patches to the following cards: Ethernet (802.3), Token Ring (802.5), and FDDI (NIO-B and GSC).
To update the firmware on a device, make sure the firmware update file is on the Unit Under Test (UUT), select the device at the main STM window, select the firmware update file (at the main STM window or in the firmware update tool), then start the update process.
CAUTION: Make sure to select the correct firmware file for the device! Updating a device with incorrect firmware can make the device permanently unusable and data could be lost.
File Commands
SelectFile(SF) - Selects the file to use to perform the firmware
update
Save (SAV) - Saves the tool's main window
Print (PRN) - Prints the tool's main window
Exit (EX) - Exits tool and returns to main STM prompt
Update Commands
StartUpdate (SU) - Start the firmware update process using the
selected file
Help Commands
Help (HE) - Displays online help for the Firmware Update Tool
Version (VERS)- Displays version and copyright information
Control-C - Interrupt or abort execution of tool; escape to the user
interface
Many devices such as tape drives, disk drives and LAN cards contain firmware (software built in to the device). The firmware usually contains instructions and data critical to the operation of the device, for example, low-level routines and ID information.
At times, it may be necessary to update the firmware on the device. For example, the manufacturer of the device may release a new version of firmware with enhanced routines or bug fixes.
The firmware update tool checks to see that the selected firmware update file exists. If possible, it verifies that the file is appropriate for the selected device. However, the firmware update tool user should always make sure that the file is correct, as supplied by the manufacturer.
Serious problems may result if an incorrect file is specified. If the firmware update tool does not detect that the file is incorrect, the device could become corrupted and unusable; all data on the device may be lost.
Once the actual downloading of the file is started, the Control C, the selA (Abort) and selI (Interrupt) commands are disabled. The reason for this is that the firmware would be left with remnants of two download files; the original and the one currently being downloaded.
To avoid an "Abort" or "Interrupt" leaving the device in a corrupted state, the firmware update tool does not respond to these commands during critical downloading phases (for example, when the device driver is active).
If problems are experienced, consult the Troubleshooting help topic.
To update the firmware on a device:
NOTE: The firmware file MUST be on the Unit Under Test (UUT), that is, on the computer attached to the device.
CAUTION: Make sure to select the correct firmware file for the device! Updating a device with incorrect firmware can make the device permanently unusable and data could be lost.
NOTE: The Control C and the selA (Abort) or selI (Interrupt) commands are enabled except during critical phases of the update process.
If problems are encountered, see the Troubleshooting help topic.
For more explicit instructions refer to the help for the main STM interface; see the topic "To Update the Firmware on a Specific Device" under "On Tasks".
Problems may occur with the device being updated, the firmware update file, or the actual update process.
Make sure the device is in a valid state.
Make sure the file is correct for the device being updated!
Make sure the file is on the Unit Under Test (UUT). For example, if the user interface is being run on a computer in New York and the device to be updated is attached to a computer in Paris, the file should be on the computer in Paris.
Check the device, ensure the firmware update file is valid, then try to run the update process again.
For detailed information on the problem, consult the Failure Log (if any) and the Test Activity Log, accessible from the STM main window.
The following commands are listed in the format command (accelerator). These commands can be entered at the LAN FW Download Tool main prompt:
The following commands can be entered at any tool dialog prompt:
Choose one of the above topics to find out more about these commands.
Use the "Save" (SAV) command to save the contents of the Tool's main window to a file. (Only the most recent 200 lines can be saved.)
Use the "Print" (PRN) command to print the contents of the Tool's main window. (Only the most recent 200 lines can be printed.)
The exit command can be entered at the main tool prompt. It is used to leave the firmware update tool.
The selectfile command and the associated !!sf!! accelerator can be used at the main tool prompt. They are used to select the file to use to perform the firmware update. This command can be used to scan several files to determine the appropriate file to use for the firmware update.
CAUTION: Make sure to select the correct firmware file for the device! Updating a device with incorrect firmware can make the device permanently unusable and data could be lost.
Once a firmware file is selected, the tool displays information about the file:
Use the startupdate (su) command to perform the firmware update.
The startupdate command and the associated !!su!! accelerator can be entered at the main tool prompt. They are used to start the firmware update process using the selected file.
If a file has not yet been selected using the selectfile (sf) command, this command requests a file be selected in the same manner as if the selectfile command were to be invoked.
Before the tool performs the update, a prompt is generated which requires the user to confirm continuation of the firmware update.
NOTE: The Control C and the selA (Abort) or selI (Interrupt) commands are enabled except during critical phases of the update process.
As the update process continues, the tool displays progress messages in its window. After the firmware update is complete, the device is reset. Leaving the firmware update tool is accomplished with the exit command.
The help command can be entered at the main tool prompt, or any tool dialog prompt.
When it is entered at the main tool prompt, it starts this help interaction.
When it is entered at a tool dialog prompt, it will display the help for that tool dialog prompt.
The version command can be entered at the main tool prompt. It displays the version and copyright information for the firmware update tool.
The cancel command can be entered at any tool dialog prompt. It will abort the current dialog and return to the main tool prompt.
The esctoui command can be entered at the main tool prompt or any tool dialog prompt. It will disconnect from the currently executing tool and return to the main UI command level. Reconnecting to the tool is accomplished by using the attach command in the UI.
Hitting Control C (CNTL C) while the tool is executing will cause the following dialog to be displayed:
Interrupted: Enter selA to Abort Tool
selI to Interrupt Tool
selE to Escape to Main UI Command Level
selC to Continue
Selection:
The A selection allows the tool to be aborted, halting its execution., The tool will be requested to abort and the state of the tool execution in the system map will be set to ABORT_PENDING. When the tool actually exits, it's state will be set to ABORTED.
To avoid an "Abort" leaving the device in a corrupted state, the firmware update tool does not respond to Abort during critical phases (for example, when the device driver is active).
The E selection allows the user to disconnect from the currently executing tool and return to the main UI command level. To reconnect to the tool, the attach command is utilized from the UI.
The I selection interrupts the tool.
When the tool receives the interrupt, it stops whatever it is doing and asks you if you want to continue with the operation. If the reply is "Continue", the tool resumes what it was doing at the time of the interrupt. If the reply is "Abort", it terminates the operation and returns to the tool prompt.
The tool may not immediately receive the interrupt as it could be in the middle of an operation that should not or cannot be interrupted. The interrupt will be received as soon as the tool completes the operation.
It is possible but not advisable to use the Interrupt command during the update process. In general, this command should be avoided unless absolutely necessary since there is a small chance that firmware on the device could become corrupted.
To avoid an "Interrupt" leaving the device in a corrupted state, the firmware update tool does not respond to Interrupt during critical phases (for example, when the device driver is active).
When the tool is already in the process of returning to the main tool prompt, it ignores user interrupts.
The C selection allows the user to continue with tool execution. The tool will continue execution just as if the Control C had not been hit.