rework release history

[cmsis-driver-validation] / Doxygen / DV_USBD.txt

/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
/**
\defgroup usbd_config Configuration
\ingroup  dv_usbd

The USB Device driver validation settings are available in the <b>DV_USBD_Config.h</b> configuration file.

\image html dv_usbd_config_h.png "DV_USBD_Config.h configuration file in Configuration Wizard view mode"

\section usbd_config_detail Configuration settings

<b>Driver_USBD#</b> selects the driver instance that will be tested.<br>
For example if we want to test <c>Driver_USBD2</c> then this setting would be set to <c>2</c>.

<b>Tests</b> section contains selections of tests to be executed.
For details on tests performed by each test function please refer to \ref usbd_tests "USB Device Tests".

*/

/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
/**
\defgroup usbd_comp_test USB Compliance Tests 
\ingroup dv_usbd

USB drivers need to be tested against the requirements of the USB standard. The following tools are provided by the
<a href="http://www.usb.org" target="_blank">USB Implementers Forum</a>: 
 - <a href="http://www.usb.org/developers/tools/usb20_tools/" target="_blank">USB Command Verifier (USB20CV Tools)</a> for
   USB 2.0 controllers
 - <a href="http://www.usb.org/developers/tools/" target="_blank">USB Command Verifier (USB3CV Tools)</a> for USB 3
   controllers

Before using the command verifier tools, make sure that you have an application running with the USB device class that you
are going to test. For example, if you want to test the behavior of the USB MSC device class, create a µVision project
containing this class. For more information, refer to the
<a href="http://www.keil.com/pack/doc/mw/USB/html/_u_s_b__device.html#Creation_Steps" target="_blank">MDK Middleware</a>
documentation.

Then, follow these steps to run the verification tools on a Windows PC:

- Install the appropriate USB Command Verifier tool and reboot your PC.
- Connect your device to the PC.
- Open the Windows Device Manager and select <b>View - Devices by connection</b> to view the USB host controllers available
  on the PC:

  \image html usbd_dev_manager.png "Select USB Device"

- Expand the entry and verify the controller properties to which your device is connected. Remember the location of the
  controller that will be tested:
  
  \image html usbd_dev_location.png "Device Location"

- Run the USB Command Verifier tool and select the controller according to the location found in the previous step:

  \image html usbd_select_device.png "Select Controller"

\note 
Do not test the controller that is connected to the keyboard or mouse. All devices connected to the tested controller will
stop working.

- When selecting the <b>Compliance Test</b> mode all test cases will run. In the <b>Debug</b> mode, you can choose individual
  test cases by selecting the related check boxes. Test reports are saved automatically in the \b Reports directory.

\image html usbd_command_verifier.png "Compliance Tests"
The following tests should be executed for:
 - USB Mass Storage Class: Chapter 9 Tests + MSC Tests
 - USB HID class: Chapter 9 Tests + HID Tests
 - Any other class (CDC, ADC, etc.): only Chapter 9 Tests

<b>Chapter 9 Tests</b> refers to the USB Device Framework chapter of the USB specification. Every USB peripheral is required
conform to this test which must be passed. Passed tests offer a good level of confidence that there are no major flows in the
USB device drivers.

The USB Command Verifier does not test how well a device behaves under stress. To get a better confidence, conduct stress
tests of all available examples:
  - USB MSC: Send a long file to the mass storage device and read it back and compare the output.
  - USB HID: Use the HID Client (available in the MDK installation directory below \\ARM\\Utilities\\HID_Client\\Release) to
    see how the device works under stress.
  - USB CDC (Virtual COM): Send a large file on the Virtual COM port and capture it on the UART and vice versa. Compare sent
    and received files for both directions.
  - USB ADC: Play a sound file form the board for some time and listen for any sound distortion. Record sounds coming from
    a microphone and verify the recorded file on the USB Host.

After the completion of the tests, click <b>Exit</b> to switch back the USB stack. Otherwise, the USB stack will stay in test
mode.
*/