Determining Why the UMDF Driver Fails to Load or the UMDF Device Fails to Start

This topic describes troubleshooting steps you can use when a UMDF driver fails to load or an associated device fails to start.

You can use the following technique with both UMDF version 1 and 2 drivers.

  1. Check setup by ensuring that the following files are correct:

    • Driver's INF file.

      Use the ChkINF tool to validate the driver's INF file.

    • %windir%\inf\ (setupapi.log on Windows XP), %windir%\setupact.log, and %windir%\temp\wudf_update.log files.

  2. If you did not find any setup issues, enable the HostProcessDbgBreakOnStart registry entry by using the WDF Verifier control application (WdfVerifier.exe). By enabling HostProcessDbgBreakOnStart, you will make the driver host process for the device (WUDFHost.exe) break into the debugger shortly after WUDFHost.exe starts but before your driver DLL loads.

    You should enable HostProcessDbgBreakOnStart with a user-mode debugger and not a kernel-mode debugger. A kernel-mode debugger, by default, does not receive user-mode module load and unload notifications. Therefore, you will not be able to set deferred breakpoints.

  3. If you do not see a host start, perform the following steps to correctly configure the device:

    1. Ensure that all the drivers that you install through your INF exist and are copied to the operating system.
    2. If the reflector (also known as WUDFRd.sys) is not the service on the device, ensure that the driver, which would then be the service, has a service entry (for example, 'sc qc foo') and is set to start automatically.
  4. Ensure that your driver's symbols are in the symbol path (that is, .sympath).

  5. Verify the following items one at a time. In the following steps, assume that your driver is foo.dll:

    1. Verify that your driver's DllMain routine is called (for example, bu Foo!DllMain).
    2. If your driver DLL does load, for subsequent steps, you can also use the HostProcessDbgBreakOnDriverLoad registry entry. Having HostProcessDbgBreakOnDriverLoad set causes WUDFHost.exe to break into the debugger after your driver DLL is loaded. HostProcessDbgBreakOnDriverLoad can also be used with the kernel-mode debugger because at this point in the driver loading and device starting process you can set breakpoints in your driver code.
    3. This step applies to UMDF version 1 drivers only. Verify that your driver's DllGetClassObject routine is called. Verify that the class identifier (ID) for your driver is correct. Verify that DllGetClassObject runs successfully and returns a driver object (for example, bu Foo!DllGetClassObject).

    4. For UMDF version 1, verify that your driver's IDriverEntry::OnDeviceAdd method is called. Verify that the method creates a device and returns successfully (for example, bu Foo!CMyDriver::OnDeviceAdd).

      For UMDF version 2, verify that your driver's EvtDriverDeviceAdd function is called. Verify that the function creates a device and returns successfully (for example, bu Foo!MyDriverDeviceAdd).

    5. For UMDF version 1, verify that your driver's IPnpCallbackHardware::OnPrepareHardware or IPnpCallback::OnD0Entry method is called. Verify that the method returns successfully (for example, bu Foo!CMyDevice::OnPrepareHardware or Foo!CMyDevice::OnD0Entry).

      For UMDF version 2, verify that your driver's EvtDevicePrepareHardware or EvtDeviceD0Entry function is called. Verify that the function returns successfully (for example, bu Foo!MyDevicePrepareHardware or Foo!MyDeviceD0Entry).

    6. If each of the previous operations run successfully but the operation that follows does not run, you should check the following items:

      1. Verify that every driver above and below your driver in the user-mode stack also successfully performs these operations.
      2. Verify that the kernel stack below your driver successfully completes the IRP_MJ_PNP and IRP_MN_START_DEVICE IRPs.