**************************************************************************
* *
* Copyright (c) 2007 Broadcom Corporation. *
* This program contains proprietary and confidential information. All *
* rights reserved except as may be permitted by prior written consent. *
* *
**************************************************************************
Broadcom (R) Corporation
USHDIAG
Dos Diagnostics for USH (TPM and CV)
RELEASE 2.23
(8/27/2010)
RELEASE NOTES
These notes describe release 1.3 software for the Broadcom BCM5752, BCM5755
and BCM5880 TPM and BCM5880 CV via USB.
See the "Release Version Information Table" below.
=======================================
Software Compatibility
=======================================
This release of software supports:
- BCM5752 NIC/TPM with A0/A1/A2 step silicon versions (P11)
- BCM5755 NIC/TPM with A0 step silicon
- BCM5880 USH TPM/CV with A0 step silicon
=======================================
Upgrading from the Previous release
=======================================
It is highly recommended that you upgrade from any previous installations
of the Broadcom DOS Diagnostics.
-------------------------------------------------------------------------------
NOTE: The USHDIAG DOS diagnostic program replaces the TPMDIAG (tpmdiag.exe).
USHDIAG has the same functionality as TPMDIAG 4.0. Some of the commands have
changed slightly, but the functionality remains the same.
-------------------------------------------------------------------------------
=======================================
Using the Dos Diagnostics:
=======================================
The USHDIAG DOS diagnostics program is able to communicate with the TPM device or to a CV device via the J8 USB port.
The USHDIAG program is intended to replace the TPMDIAG program.
The USHDIAG program originated from the TPMDIAG 4.0 release.
The USHDIAG program has the added capibility to communicate to a CV device to issue downloads, diagnostic tests and any other necessary CV command.
The USHDIAG program by default accesses TPM device in memory mapped mode.
To access the TPM device in legacy I/O mode, use the -m option in the diagnostics to set the legacy I/O address.
To see how to use the -m option, use the ushdiag help screen ushdiag -h.
To access any CV command you must use the parameter ushdiag -u.
1. Copy the ushdiag.exe to a DOS bootable floppy disk or bootable DOS partition.
2. Boot up into the bootable DOS disk.
3. ushdiag -h lists the help screen.
4. Typing just ushdiag does a TPM self test and gives the result.
5. To see the complete list of options avaialble please use ushdiag -h.
6. The TPM firmware upgrade will only work on a tpm system that does not have the EK.
7. To run tpm commands from a vector file, use ushdiag -x <vector filename>, where
<vector filename> is the file that contains the tpm command. The file has 4 bytes
in each line and each byte is represented as xx where x is a hex digit (0 through F)
All lines in the file must have 4 bytes (fill with 0s if necessary).
8. To access the CV interface via USB, use the -u option.
9. There are two different CV diagnostic commands: a simple connectivity test and a complex diagnostic test.
10. The CV diagnostic simple connectivity test (-dt <testmask>) can test all interfaces (smart card, RFID, TPM, USB Host and CV) at once
or one at a time. The <testmask> is a hex number indicating which tests to preform. The bits are represented as follows:
bit 0 - Smart card; this tests for any smart card present.
bit 1 - Fingerprint; this tests the fingerprint sensor.
bit 2 - RFID; This tests for the presense of an RFID 14a card.
bit 3 - USB Host; This tests for the presence of a device attached to the Series "A" receptacle.
bit 4 - TPM; This tests for the presence of a TPM device.
bit 5 - CV; This tests the status of the CV.
11. The CV diagnostic complex test (-dte <testnumber> <param>) provides a more detailed diagnostic test on each interfaces (smart card, RFID, TPM, USB Host and CV).
The <testnumber> is a number indicating which test to preform. Some tests may require additional parameters. The numbers are described as follows:
1 - Smart card; This tests any smart card.
2 - Fingerprint; This tests the fingerprint sensor.
3 - RFID; This test requires an additional parameter: <rfid type>.
The <rfid type> is defined as: 1 - 14A, 2 - 14B and 3 - 15.
The RFID diagnostics was tested with the following card types: 14A, 14B, 15693(TI prestandard card).
4 - USB Host; Tests for the presence of USB devices. If USB devices are present, their deivece ID and vendor ID will be displayed. A FIB board is
needed to obtain the ID numbers.
5 - TPM; Tests the TPM device.
6 - CV; Test the status of the CV.
12. The CV interface also provides the ability to upgrade the SPI flash. An image file is loaded into the SPI flash beginning at the specified flash offset.
The command takes the following format:
ushdiag -u -flsh <filename> -o <offset>
13. The CV interface also provides the ability to load a flasher sbi. A flasher sbi can be loaded into RAM. This flasher sbi program will then wait for and
execute any flash upgrade functions. The command takes the following format:
ushdiag -u -f <filename>
14. The CV interface also provides the ability to load a PBA image. An specified image file is loaded into the PBA. The PBA is written to, read back and
then compaired to verify the the operation was performed properly.
The command takes the following format:
ushdiag -u -pba <filename>
15. The CV interface can display the various versions of the CV and USH via the -u -mjr or -u -mnr commands.
16. Added -ibm option. If there is a boot failure, ushdiag will indicate the fact and now propmt you for a USH image filename and flash offset and initiate
a flash update. The -ibm will not propmt you for a flash update when the boot fails.
17. Added -fw <filename>. This option will preform a firmware upgrade. The specified file will be loaded into the ush. As the file
is received it will be encrypted and burned into flash. The command will accept a USH image or a SBI/USH combination image. The image will be loaded
into flash at the specified offset via the -o <offset> option. If the image specified is a SBI/USH, the specified offset must be 0. If the image specified
is a USH, the specified offset must be 10000. Dots will be displayed to indicate the upgrade is in progress.
ushdiag -u -fw <filename> -o <offset>
18. Added -ac option. This command will check if the antenna is attached. This command is available for the USB/CV interface.
19. Added -fdt option. This command will issue a Fingerprint Diagnostic Test for the Upeck fingerprint sensor. This command is
available for the USB/CV interface.
20. Added -fmt option. This command will issue a Fingerprint Manufacturing Test for the Upeck fingerprint sensor. This command is
available for the USB/CV interface.
21. Added -dly option. This is the delay the Firmware Upgrade (-fw) command will wait after issuing the reboot-to-sbi and before
proceeding with the firmware upgrade.
22. Added -rst option. This is command will reset the USH and bring it back up to USH image.
23. Added -rsts option. This is command will reset the USH to SBI.
24. Added -sv option. This is short verbose turned off after USH is discovered.
25. Added -rfw option. This is a "remove flash warnings" command.\
26. Added -stat option. Displays cv status, remaining flash, version, and if cv_inited.
27. Added -ah option. Enables the Anti-Hammering feature. Once enabled can not be turned off.
28. Added -c0c1 option. Detects a CO Chip with CustomerID 1.
29. Added -de <devMask> option. Device Enable, enables the specified devices
bit 0 - Smart card
bit 1 - Fingerprint
bit 2 - RFID Radio
bit 3 - CV Only Radio
bit 4 - Radio Lock
bit 5 - WBDI
30. Added -dd <devMask> option. Device Disable, disables the specified devices
bit 0 - Smart card
bit 1 - Fingerprint
bit 2 - RFID Radio
bit 3 - CV Only Radio
bit 4 - Radio Lock
bit 5 - WBDI
31. Added -cid <hexid> option. Detects a CustomerID value of <hexid>, returns 0xd if true
32. Added -rmt <test> option. RFID manufacturing test
0 - 5 second test
1 - 1 minute test
2 - 3 minute test
33. Added -sid option. Tranmsit the corresponding RFID parameters to USH based on the sysid.
The RFID parameters are obtained from a file located in configuration files. There is
a default configuration file (rfiddflt.cfg) which will be used if a system specific file
does not exist. Ushdiag will first look for a system specific RFID configuration file; if
it does not find one, it will use the default configuration file (rfiddflt.cfg). The system
specific files are named rfidxxxx.cfg where xxxx is the system id in hex (no leading 0's).
34. Added -iscc option. Ignore SBI Custid Check when updating SBI (-flsh <filename> & -o 0).
35. Added -ccvo option. Clear CV Admin and CV objects.
36. Added -scp <type> option. Smart Card Presence.
a - Automatically set based on system id
n - Manually set to not present
p - Manually set to present
37. Added -rfp <type> option. RFID Presence.
n - Manually set to not present
p - Manually set to present
38. Added -pwr <mode> option. Set Power Management Sleep mode.
1 - No wake up (CV disabled).
2 - LPC will wake up system (CV disabled).
3 - USB or LPC Or SC will wake up system.
4 - USB or LPC will wake up system, SC will not wake up system.
39. Added -pwrst <delay> option. Set Power Management Idle Sleep delay time in ms.
How long system must be idle to go into sleep mode.
0 - never sleep.
> 0 - number of ms of idle that will cause USH to go to sleep.
40. Added -ugsbi option. This command will upgrade the appropriate SBI based on getCvVersions()
41. Added -ugbcm option. This command will upgrade the appropriate BCM based on getCvVersions()
42. Added -ugsbl option. This command will try to load the appropriate SBI. Since the USH is in SBL, we do not know the chip ID.
This option will load each SBI until the appropriate SBI is loaded. When the SBI resposeds to getCvVersions properly, we know
the proper SBI is loaded.
43. Added -cvpw <password> option. This command will allow you to enter the CV Admin password used for updating the PBA and clearing the CV Objects.
44. Added -ugpba option. This command will upgrade the appropriate PBA, based on getCvVersions()
45. Added -vft option. This command will test the validity FP sensor.
Returned extra data will be stored in the file "valxinfo.bin" located in the same directory.
46. Added -vfc option. This command will configure the validity FP sensor.
The configuration parameter will be obtained from the "valcfg.dat" file located in the firmware directory.
47. Added -fpcfg option. This command will configure the appropriate FP sensor.
If the sensor is validity, the configuration parameter will be obtained from the "valcfg.dat" file located in the firmware directory.
48. -mid <challenge string> option. This command will return the Machine ID keyed off of the <challenge string>.
=======================================
Contents of the Release
=======================================
*** Release Version Information Table ***
Product Version Previous Rel.
1. Broadcom USH DOS Diagnostics
(ushdiag.exe) 2.23 2.21
2. release.txt 2.23 2.21
=======================================
History
=======================================
ver date description
===============================================================================
2.23 2010/08/27 * Added delay when enable\disable CV Only Radio Mode for USH to reset.
* Added -mid command to get Machine ID.
2.22 2010/08/11 * Added delay when enable\disable WBDI for USH to reset.
2.21 2010/07/28 * Added -fpcfg command to configure the fp sensor.
* Changed the Validity default configuration to 2 (reverse).
* Display the current and desired validity configuration (-vfc & -fpcfg)
2.20 2010/06/28 * Checked in cv_fingerprint_test_out() and cv_enable_wbdi() into BCMPBA.
* Changed buffer length to cv_fingerprint_test_out().
2.19 2010/06/25 * Now use new cv_firmware_test_out() for validity test.
* Default Validity configuration is 2.
* Only allow 1 or 2 for validity configuration.
2.18 2010/06/08 * Added -vft command to test the validity fingerprint sensor.
This command will store the sensor extra data in "valxinfo.bin".
* Added -vfc command to configure the validity fingerprint sensor.
The configuration parameter will be obtained from "valcfg.dat" located in the firmware directory.
2.17 2010/05/17 * Close files when done with them.
2.16 2010/05/03 * Added logic for Radio Lock in the Device Enable/Disable command.
* Added logic for Validity FP sensor.
2.15 2010/01/04 * Now first look in the ..\firmware directory for the specified files.
If the files don't exist, then look in the current directory.
2.14 2009/12/18 * Fixed hang when running himem.sys in DRMK.
2.13 2009/12/08 * Added RFID Block Mode status to -stat command.
2.12 2009/12/07 * Now use the ..\firmware directory for the rfid config files (-sid).
* For 5882, use the rfiddfl2.cfg file for the rfid default configuration (-sid).
2.11 2009/11/25 * Modified -ccvo command to only prompt for password if CV Admin is set.
2.10 2009/11/23 * Forgot to check in library file for "Fixed physical presence in -ccvo command" fix (below).
Now Physical Presence works.
2.09 2009/11/18 * Fixed -ugsbl command to be able to load multiple SBLs in a row.
* Always ask for password in -ccvo command.
* Fixed physical presence in -ccvo command.
2.07 2009/10/07 * Added -ugpba command to automatically update the PBA with the appropriate PBA file.
* If CV Managed mode and password not entered (-cvpw) then prompt for password.
* If 5882 don't allow setting SC Presence.
* Fixed SBI file precheck for cust ID ff (only look at two last digits)
* When load SBI, check 5880 files before trying 5882 files.
* Modified ushfwug.bat and ushfwumg.bat to use -ugpba command.
2.03 2009/10/07 * Added -cvpw command to enter CV Admin password for pba update (-pba). Password can also be used with clear objects command (-ccvo).
2.02 2009/10/06 * GNATS5181: Fixed failure to update PBA when there was no CV Admin set.
2.01 2009/08/27 * Fixed CustID FF flash SBI problem (GNATS 5088). Changed Chip CustID from ff to ffffff so it will match the file CustID.
2.00 2009/07/24 * Added -ugsbi, -ugbcm and -ugsbl commands.
1.52 2009/05/29 * Added -pwr <mode> and -pwrst <delay> commands.
1.51 2009/02/05 * Added Envy (0x2c8) to automatically set SC NOT present (-scp a command).
1.50 2009/02/03 * Added support for CID FF SBI Update.
1.49 2008/10/07 * Added -rfp command to control RFID presence.
1.48 2008/08/28 * Modified -sid command comments to only display the RFID Config file name being used.
1.47 2008/08/26 * If AMG or MiniCooper: Set RFID to NOT present and don't set RFID configuration.
* Added text error messages to device enable/disable when device not present.
* Added text error messages for antihammering return status.
1.46 2008/08/18 * Now look for the RFID config files in the DOS (or current) directory.
1.45 2008/07/24 * Return error codes from diags to DOS
1.44 2008/07/08 * Send clear rfid user config flag to USH.
1.43 2008/07/08 * Added -scp command to control smartcard presence.
1.42 2008/07/07 * Added u16_tx_current_x & u16_mod_depth_x (where x=0-5) to rfid cfg file.
1.41 2008/07/02 * Added -ccvo command to clear the CV Admin and CV objects.
* Modified rfid cfg file to ignore line with '#' in it.
* Mark all programmed rfid parameters as valid.
* Don't clear cv objects when init CV Admin for PBA download.
1.40 2008/06/25 * Modified -sid to transmit RFID parameters to USH based on sysid.
1.39 2008/06/19 * Modified -sid to transmit sysid to USH.
1.38 2008/06/19 * Added -sid command which displays the system ID.
* Added -iscc command to ignore the custid check when updating the SBI.
* Added logic to only allow SBI update when the chip custid matches the fils custid.
1.37 2008/06/17 * Added -rmt <test> command which will run the specified rfid manufacturing test.
* Replaced "error status" with "return status".
1.36 2008/06/11 * Added -cid <hexid> command which will detect a customer id of <hexid>.
* Now check for anti-hammering errors on -flsh, -rst and -rsts commands, returns 0xe on error.
1.35 2008/06/06 * Broke up USH Version String into individual strings for -mjr display.
1.34 2008/06/05 * Larger USH Version String caused the ushdiag to crash on -mjr. Increased console output buffer.
1.33 2008/05/21 * Added -c0c1 command to check if C0 Chip with CustomerID 1.
* Added -de command to enable specified devices.
* Added -dd command to disable specified devices.
1.32 2008/05/12 * Added -ah command to enable Anti-Hammering. This feature is only applicable on C0 with CustomerID!=0.
Once this feature is enabled, it can not be disabled.
1.31 2008/04/29 * Removed cv_get_status access on power up.
* Added -stat command to display cv_status, cv_version, cv_flash_remaining, cv_init.
1.30 2008/04/16 * Return TPM_ERR when CV returns 0x73 on download or reset cmds. TPM enabled.
* On power up check if in SBI or boot strap and display appropriate message.
1.29 2008/04/15 * Added Diag Ind Test SC Java Card (-dte 7).
* Added RFID Diag Ind Tests: iClass 15 & Felica (-dte 3 5; -dte 3 6).
* If PBA update returns with Auth error then exit with USH_AUTH_ERR.
1.28 2008/04/08 * Removed Bx text in TPM -id command.
1.27 2008/04/03 * Removed patch to find ush with bogus handle.
* Added -rfw remove flash warnings.
* Increased USH versions buffer from 512 to 2048.
* If don't discover USH don't to cv_close.
1.26 2008/04/02 * Now allocate BulkOut and BulkIn buffers with malloc. Free buffers when exit. Show "!" when retry PBA packet.
1.25 2008/04/01 * Now allocate request block buffer with dos21_mem_alloc. Now load ES with AX from dos21_mem_alloc.
1.24 2008/03/31 * Fixed memory problem when updata 2m image.
1.23 2008/03/30 * If get 0xe error on PBA access, try again.
1.22 2008/03/28 * Fixed get USH versions (-mjror -mnr) when in SBI.
1.21 2008/03/27 * Added -sv command. Short Verbose turned off after USH is discovered.
1.20 2008/03/26 * Added -rsts command.
* Don't reset to SBI in firmware upgrade if in SBI.
* Removed read and verify in PBA update.
* Changed message to error in USB FindDevices.
1.19 2008/03/25 * Added reboot_ush command.
* Added dots for PBA access.
* Removed handle checking for getUshVersions.
* Removed some CV access if in bootloader.
* Modified BIOS discovery. If get bogus number of devices then assume found ush and force dev_handle of 1 (USH is always 1).
1.18 2008/03/20 * Added return codes.
* Changed the PBA CV Admin password from 'brcmush' to 'broadcom'
* Changed Max download size from 0x1000 to 0xc00
1.17 2008/03/14 * Added 'reboot' prior to issuing firmware upgrade in both USB and TPM.
* Added -dly command for USB delay after reboot before issuing download.
1.16 2008/03/06 * Changed the warning text regarding the flash update and firmware upgrade. Must shut down
and unplug the system for new image to take effect.
* Added Antenna Check (-ac) command.
* Added Upek Fingerprint Diagnostic Test (-fdt).
* Added Upek Fingerprint Manufacturing Test (-fmt).
1.15 2008/02/27 * Added iClass to RFID individual diag test.
1.14 2008/02/20 * Fixed TPM download: can now open read-only file, fixed file length, display dots for progress.
1.13 2008/02/14 * Added logic to also look for new USH PIDs 0x5800-0x5805.
1.12 2008/01/17 * Diag Grp/Ind USB tests now check for invalid devices (vid==0).
1.11 2008/01/09 * Added -fw <filename> option to provide firmware upgrade feature. As the file is received it will be encrypted and burned into flash.
The -o <offset> option is used to indicate if the image is a SBI/USH image (offset 0) or USH image (offset 10000).
example: ushdiag -u -fw ush.bin -o 10000
or ushdiag -u -fw sbiush.bin -o 0
1.10 2007/12/28 * Increased output buffer to 0x10000 for larger sbi files.
* If boot fails, force flash update to load new image. Prompt user for filename and offset.
* Added -ibm option to ignore force flash update when boot fails.
1.9 2007/12/21 * Increased input buffer on CvDiagGrp test API. Changed TPM ID text from 5880 Ax to 5880 Bx.
1.8 2007/12/18 * Increased console output buffer to 600. Was crashing on cvGetUshVer.
1.7 2007/12/14 * Print message to "load ush image" when no image present.
* Print message to "leave power on for 40 when power up" after update flash.
1.6 2007/12/04 * Enabled the Fingerprint test via cvdiaggrptest and cvdiagindtest commands.
1.5 2007/11/27 * Fixed the hang when issuing TPM commands.
* Added Fingerprint test and calibrate commands.
1.3 2007/11/02 * Changed the TPM chip label from 5872 to 5800.
1.2 2007/10/31 * Added PBA flash access command (-pba <flname>).
* On powerup also check if CV has been inited via cv_status(ADMIN). If doing PBA access and cv not inited, then do cv_init.
* Expanded version (-mjr/-mnr) command to get USH versions.
* Modified cv diag individual test to use individual tests. Added parameter to rfid individual test. USB individual test returns
device id and vendor id of attached devices.
1.1 2007/10/18 * Now use Dell BIOS USB driver (Must upgrade BIOS driver with INT15 service for USH)
1.0 2007/09/28 * Initial release
* Program originated from TPMDIAG 4.0.
* Fixed TPM library which did not see TPM enabled.
* Added USB driver and CV library.
* Added capibility to communicate to CV device via USB.
* Added CV download and diagnostic tests.
=======================================
Known issues:
=======================================
No Known Issues.
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.