===========================================================
CVDiag Utility
===========================================================
================
DESCRIPTION
================
The CVDiag Utility is a windows based utility that will provide three functions:
a. Display the operating status of the ControlVault.
b. Collect the ControlVault debug logs.
c. Calibrate the Upek Fingerprint Sensor.
The CVDiag.exe is a 32bit Windows application that will call one of four other
utilities (cvcv32.exe, cvcd64.exe, cvbip32.exe or cvbip64.exe), based on the
system configuration.
================
REQUIREMENTS
================
The Dell Driver Pack must be installed in order for the CVDiag to
communicate with the CV.
The CVDiag can only be run by a user with Administrator privileges.
NOTE: If running from Vista with User Account Control (UAC) enabled,
the CVDiag must be run as an Administrator.
================
GETTING STARTED
================
GUI:
====
From windows explorer, double click on CVDiag.exe to open the application.
ControlVault Status
-------------------
Status button: Press this button to update the ControlVault Status and ControlVault Version
display. This button will also update a CVStatus.log with more detailed ControlVault
status. This file is located in the same directory as the CVDiag.exe.
ControlVault Log Collection
---------------------------
Log Directory box: This box will display the last know ControlVault Log directory.
Enable Log button: Press this button to enable the ControlVault debug logging.
Once the logging has been enabled, the system must be reset to activate the logging mechanism.
If the logging mechanism has been enabled, this button will be disabled.
Disable Log button: Press this button to collect the ControlVault debug logs and disable
the ControlVault from further log collection. When this button is press, a new Log Directory will be
created where all the ControlVault logs will be moved. If the logging has been enabled, this button will be
enabled. If the logging has been disabled, this button will be disabled.
The number of logs collected depend on the system configuration. Here is a list of the possible logs collected:
1. CVStatus.log
2. CVUsrIfcLog.txt
3. CVUsrLibLog.txt
4. CVHostControlLog.txt
5. CVHostStorageLog.txt
6. bipbsp_log.txt
7. brcmbsp_log.txt
8. FPStubLibLogs.txt
Open button: Press this button to open the Log Directory to display all the collected logs.
Send button: Press this button to send all the collected ControlVault logs to an email address. This function will
create an email form with all the collected Logs. The user must enter the To Email address and press Send to email
the log files.
Utilities
---------
Calibrate FP button: Press this button to calibrate the Upek Fingerprint sensor. This button will only be enabled if a
Upek Fingerprint Sensor is detected.
Command Line:
=============
From the command prompt, go to the CVDiag utility directory and enter CVDiag.
If CVDiag is entered with no arguments, the utility will open in interactive GUI mode as described above.
If CVDiag is entered with one of the following arguments, then the command will be executed and CVDiag will exit.
CVDiag arguments:
-h or -?: This will display a list of the CVDiag syntax.
-stat: This argument is used to collect the ControlVault Status log (CVStatus.log).
-enlog: This argument is used to enable the logging of ControlVault modules.
The system must be reset to activate the log collection.
-dislog: This argument is used to collect the debug logs and disable the logging.
-cal: This argument is used to calibrate the Upek fingerprint sensor.
-smtp <SMTP Host> Send collected logs via the specified SMTP Host.
-to <To Email> Send collected logs to the specified email address.
-from <From Email> Send collected logs from the specified email address.
Enable Logging Example:
CVDiag -enlog
Disable Logging Example:
CVDiag -dislog
Calibrate Upek Fingerprint Sensor Example:
CVDiag -cal
Email Collected Logs Example:
CVDiag -to cs@abc.com -from cust@xyz.com -smtp smtp.xyz.com
================
RETURN CODES
================
0x00 USH_RC_SUCCESS
Succeeded
0x01 USH_RC_SUCCESS_RESET
Succeeded, must restart the system for the firmware to take affect
0x02 USH_RC_CANCELED
Operation canceled
0x03 USH_RC_INVALID_PARAMETER
Invalid argument
0x04 USH_RC_MISSING_PARAMETER
Argument missing parameter
0x05 USH_RC_INIT_CHK_ERR
Failed anti-hammering pre-check, restart system and try again
0x06 USH_RC_FILE_ERR
Missing file
0x07 USH_RC_ERROR
Generic error
0x08 USH_RC_NOUSH_ERR
Did not detect USH
0x09 USH_RC_AUTH_ERR
Authentication error
0x0a USH_RC_TPM_ERR
TPM error
0x0b USH_RC_AH_ERR
Anti-hammering error
0x0c USH_RC_TASK_ERR
Could not terminate necessary tasks
0x0d USH_RC_DLL_ERR
DLL mismatch
0x0e USH_RC_LOADSBI_ERR
Could not load SBI (running from Bootstrap)
0x0f USH_RC_CHIP_ID_ERR
Unknown chip ID
0x10 USH_RC_PBA_ERR
Failed to load PBA
0x11 USH_RC_CLR_SCD_ERR
Failed to clear SCD
0x12 USH_RC_RESET_ERR
Reset returned error
0x13 USH_RC_NUM_ERR
USH failed to numerate
0x14 USH_RC_BCM_ERR
Failed to update BCM
0x15 USH_RC_MISSING_DLL
Missing TPM DLL
0x16 USH_RC_MISSING_DRV
Missing TPM Driver
0x17 USH_RC_RFID_PARAM_ERR
Failed to update RFID parameters
0x18 USH_RC_SYSID_DLL_ERR
Failed to load SYSID DLL
0x19 USH_RC_NOT_OPERATIONAL
Not in BCM
0x1a USH_RC_MALLOC_ERR
Malloc failed
0x1b USH_RC_ENLOG_ERR
Enable Logging error
0x1c USH_RC_LOG_ERR
Log collection error
0x1d USH_RC_CAL_ERR
Fingerprint Calibration error
0x1e USH_RC_SEND_ERR
Send Log error
0x1f USH_RC_NO_CMD
Command not executed, not available
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.