#include "usbhub3.h"
#include <debug.h>

Include dependency graph for errreport.cpp:

Classes
struct	HubReportWork

Macros
#define	NDEBUG

Functions
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (HubReportWork, HubGetReportWork)

	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS NTAPI HubOpenThrottleKey(_In_ WDFDEVICE Device
	Sends a synchronous IOCTL to the specified device object.

	if (!NT_SUCCESS(Status))

	WdfRegistryClose (HardwareKey)

	if (HubReadThrottleMask(Device) &(1UL<<(Code &0x1F)))

	DPRINT1 ("USBHUB3 live dump 0x%lx, reason 0x%lx, not supported\n", Code, SubReason)

static ULONG NTAPI	HubReportCode (_In_ HubReport Type)

static VOID NTAPI	HubEvtReportWorkItem (_In_ WDFWORKITEM WorkItem)

NTSTATUS NTAPI	HubCreateReport (_In_ WDFDEVICE HubFdo, _In_ HubReport Type, _In_ ULONG SubReason)

Variables
_Out_ WDFKEY *	WerKey

WDFKEY	HardwareKey

NTSTATUS	Status

	Device

_In_ ULONG	Code

_In_ ULONG _In_ ULONG	SubReason

return	STATUS_NOT_SUPPORTED

Macro Definition Documentation

◆ NDEBUG

#define NDEBUG

Definition at line 10 of file errreport.cpp.

Function Documentation

◆ _IRQL_requires_()

_IRQL_requires_ ( PASSIVE_LEVEL )

Sends a synchronous IOCTL to the specified device object.

Parameters

[in]	IoControlCode	The IOCTL to send to the device.
[in]	DeviceObject	Pointer to the device object that will handle the IOCTL.
[in]	InputBuffer	Optional pointer to a buffer containing input data for the IOCTL. When specified, the buffer should be at least of InputBufferLength size.
[in]	InputBufferLength	Size in bytes, of the buffer pointed by InputBuffer.
[out]	OutputBuffer	Optional pointer to a buffer that will receive output data from the IOCTL. When specified, the buffer should be at least of OutputBufferLength size.
[in]	OutputBufferLength	Size in bytes, of the buffer pointed by OutputBuffer.
[in]	FileObject	Optional pointer to a file object that may be necessary for the IOCTL.

Returns: An NTSTATUS code indicating success or failure of this function.

Note: Must be called at PASSIVE_LEVEL with all APCs enabled.

Nothing is found unless the PCI bus driver publishes the properties.

The root hub name without its prefix; NULL when the PDO has no name.

Grows a private buffer to what the helper asks for.

Lets KMDF handle the IRP, then hands it back here still uncompleted.

Waits for the device machine to answer a PnP or power event; returns the PnP status.

Deletes the UCX endpoints of the disabled pipes, then the interface record.

One 4 byte value; the registry type is not checked.

Reread whenever user experience settings change; the open status is returned.

Definition at line 65 of file errreport.cpp.

{
    DECLARE_CONST_UNICODE_STRING(MaskName, L"ThrottleMask");
    WDFKEY Key;
    ULONG Mask = 0;
    NTSTATUS Status;
 
    if (!NT_SUCCESS(HubOpenThrottleKey(Device, &Key)))
        return 0;
 
    Status = WdfRegistryQueryULong(Key, &MaskName, &Mask);
    if (!NT_SUCCESS(Status))
    {
        if (Status != STATUS_OBJECT_NAME_NOT_FOUND)
            DPRINT1("Reading the WER throttle failed 0x%lx\n", Status);
        Mask = 0;
    }
 
    WdfRegistryClose(Key);
    return Mask;
}

◆ DPRINT1()

DPRINT1	(	"USBHUB3 live dump 0x%	lx,
		reason 0x%	lx,
		not supported\n"	,
		Code	,
		SubReason
	)

◆ HubCreateReport()

NTSTATUS NTAPI HubCreateReport	(	_In_ WDFDEVICE	HubFdo,
		_In_ HubReport	Type,
		_In_ ULONG	SubReason
	)

Device enumeration failures are throttled per hub, since no device is passed.

Definition at line 151 of file errreport.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    WDF_WORKITEM_CONFIG Config;
    WDFWORKITEM WorkItem;
    NTSTATUS Status;
 
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
        return HubSubmitLiveDump(HubFdo, HubReportCode(Type), SubReason);
 
    WDF_WORKITEM_CONFIG_INIT(&Config, HubEvtReportWorkItem);
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Attributes, HubReportWork);
    Attributes.ParentObject = HubFdo;
 
    Status = WdfWorkItemCreate(&Config, &Attributes, &WorkItem);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p report work item create failed 0x%lx\n", HubFdo, Status);
        return Status;
    }
 
    HubGetReportWork(WorkItem)->Type = Type;
    HubGetReportWork(WorkItem)->SubReason = SubReason;
    WdfWorkItemEnqueue(WorkItem);
 
    return STATUS_SUCCESS;
}

Referenced by HubEvtReportWorkItem(), and DeviceMachine::ReportEnumFailure().

◆ HubEvtReportWorkItem()

static VOID NTAPI HubEvtReportWorkItem ( _In_ WDFWORKITEM WorkItem )

static

Definition at line 139 of file errreport.cpp.

{
    HubReportWork* Work = HubGetReportWork(WorkItem);
 
    HubCreateReport((WDFDEVICE)WdfWorkItemGetParentObject(WorkItem), Work->Type, Work->SubReason);
    WdfObjectDelete(WorkItem);
}

Referenced by HubCreateReport().

◆ HubReportCode()

static ULONG NTAPI HubReportCode ( _In_ HubReport Type )

static

Definition at line 117 of file errreport.cpp.

{
    switch (Type)
    {
        case HubReport::HubResetSucceeded:
            return HUB_LIVEDUMP_HUB_RESET_OK;
 
        case HubReport::HubResetFailed:
            return HUB_LIVEDUMP_HUB_RESET_FAILED;
 
        case HubReport::DeviceEnumerationFailed:
            return HUB_LIVEDUMP_ENUMERATION_FAILED;
 
        default:
            return 0;
    }
}

Referenced by HubCreateReport().

◆ if() [1/2]

if ( ! NT_SUCCESSStatus )

Definition at line 45 of file errreport.cpp.

    {
        DPRINT1("Hub %p hardware key open failed 0x%lx\n", Device, Status);
        return Status;
    }

◆ if() [2/2]

if ( HubReadThrottleMask(Device) &(1UL<<(Code &0x1F)) )

Definition at line 103 of file errreport.cpp.

    {
        DPRINT("Hub %p live dump 0x%lx throttled\n", Device, Code);
        return STATUS_UNSUCCESSFUL;
    }

◆ WDF_DECLARE_CONTEXT_TYPE_WITH_NAME()

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	HubReportWork	,
		HubGetReportWork
	)

◆ WdfRegistryClose()

WdfRegistryClose ( HardwareKey )

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), BootEnvironmentIsWinPE(), CheckHDAGraphicsRegistryKeys(), HubMachine::LogResetRecovery(), XhciController::ReadRegistryErrata(), XhciController::ReadVerifierFlags(), and XhciController::UpdateRegistryCounters().

Variable Documentation

◆ Code

_In_ ULONG Code

Definition at line 98 of file errreport.cpp.

◆ Device

Device

Definition at line 59 of file errreport.cpp.

◆ HardwareKey

WDFKEY HardwareKey

Definition at line 35 of file errreport.cpp.

◆ Status

return Status

Initial value:

= WdfDeviceOpenRegistryKey(Device,
                                      PLUGPLAY_REGKEY_DEVICE,
                                      KEY_CREATE_SUB_KEY,
                                      WDF_NO_OBJECT_ATTRIBUTES,
                                      &HardwareKey)