1.9 What Does the WinDriver Toolkit Include?

• A printed version of this manual
• Two months of free technical support (Phone/Fax/Email)
• WinDriver modules
• The WinDriver CD
  • Utilities
  • Chipset support APIs
  • Sample files

1.9.1 WinDriver Modules

• WinDriver (WinDriver/include) - the general purpose hardware access toolkit. The main files here are:
  
  • windrvr.h: Declarations and definitions of WinDriver's basic API.

  • wdu_lib.h: Declarations and definitions of the WinDriver USB (WDU) library, which provides convenient wrapper USB APIs.

  • windrvr_int_thread.h: Declarations of convenient wrapper functions to simplify interrupt handling.

  • windrvr_events.h: Declarations of APIs for handling and Plug-and-Play and power management events.

  • utils.h: Declarations of general utility functions.

  • status_strings.h: Declarations of API for converting WinDriver status codes to descriptive error strings.

• DriverWizard (WinDriver/wizard/wdwizard) - a graphical tool that diagnoses your hardware and enables you to easily generate code for your driver (refer to Chapter 5 for details).

• Graphical Debugger (WinDriver/util/wddebug_gui) - a graphical debugging tool that collects information about your driver as it runs.
  WinDriver also includes a console version of this program (WinDriver/util/wddebug), which can be used on platforms that have no GUI support, such as Windows CE.
  For details regarding the Debug Monitor, refer to section 7.2.

• WinDriver distribution package (WinDriver/redist - Windows, Windows CE and Linux ; WinDriver$\backslash$redist_win98_compat - Windows 98/Me/2000/XP/Server 2003/Vista) - the files you include in the driver distribution to customers.

• This manual - the full WinDriver manual (this document), in different formats, can be found under the WinDriver/docs directory.

1.9.2 Utilities

• usb_diag.exe (WinDriver/util/usb_diag.exe) - enables the user to view the resources of connected USB devices and communicate with the devices - transfer data to/from the device, set the active alternate setting, reset pipes, etc.
  On Windows 98/Me/2000/XP/Server 2003/Vista the program identifies all devices that have been registered to work with WinDriver using an INF file. On the other supported operating systems the program identifies all USB devices connected to the target platform.
• pci_dump.exe (WinDriver/util/pci_dump.exe) - used to obtain a dump of the PCI configuration registers of the installed PCI cards.

The Windows CE version also includes:

• $\backslash$REDIST$\backslash$... $\backslash$X86EMU$\backslash$WINDRVR_CE_EMU.DLL: DLL that communicates with the WinDriver kernel - for the x86 HPC emulation mode of Windows CE.

• $\backslash$REDIST$\backslash$... $\backslash$X86EMU$\backslash$WINDRVR_CE_EMU.LIB: an import library that is used to link with WinDriver applications that are compiled for the x86 HPC emulation mode of Windows CE.

1.9.3 WinDriver's Specific Chipset Support

WinDriver provides custom wrapper APIs and sample code for major USB chipsets (see Chapter 8), including for the following chipsets:

• Cypress EZ-USB - WinDriver/cypress

• Microchip PIC18F4550 - WinDriver/microchip/pic18f4550

• Philips PDIUSBD12 - WinDriver/pdiusbd12

• Texas Instruments TUSB3410, TUSB3210, TUSB2136 and TUSB5052 - WinDriver/ti

• Agere USS2828 - WinDriver/agere.

• Silicon Laboratories C8051F320 USB - WinDriver/silabs

1.9.4 Samples

In addition to the samples provided for specific chipsets [1.9.3], WinDriver includes a variety of samples that demonstrate how to use WinDriver's API to communicate with your device and perform various driver tasks.

• C samples: found under the WinDriver/samples directory.
  These samples also include the source code for the utilities listed above [1.9.2].

• .NET C# and Visual Basic .NET samples (Windows): found under the WinDriver$\backslash$csharp.net and WinDriver$\backslash$vb.net directories (respectively).

• Delphi (Pascal) samples (Windows) WinDriver$\backslash$delphi$\backslash$samples directory.

• Visual Basic samples (Windows): found under the WinDriver$\backslash$vb$\backslash$samples directory.