entry.cpp File Reference

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

Include dependency graph for entry.cpp:

Go to the source code of this file.

Classes
struct	HubPolicyValue

Macros
#define	NDEBUG

Functions
	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS NTAPI HubQueryRegistryULong(_In_ WDFKEY Key
	Sends a synchronous IOCTL to the specified device object.
return	WdfRegistryQueryValue (Key, &ValueName, sizeof(*Value), Value, NULL, NULL)
return	WdfRegistryOpenKey (NULL, &KeyName, Access, WDF_NO_OBJECT_ATTRIBUTES, Key)
static VOID NTAPI	HubApplyDisableSelectiveSuspendUI (_In_ ULONG Value)
static VOID NTAPI	HubApplyMsOsDescriptorMode (_In_ ULONG Value)
static VOID NTAPI	HubApplyEnableDiagnosticMode (_In_ ULONG Value)
static VOID NTAPI	HubApplyDisableOnSoftRemove (_In_ ULONG Value)
static VOID NTAPI	HubApplyDisableUxdSupport (_In_ ULONG Value)
static VOID NTAPI	HubApplyEnableExtendedValidation (_In_ ULONG Value)
static VOID NTAPI	HubApplyWakeOnConnectUI (_In_ ULONG Value)
static VOID NTAPI	HubApplyPreventSuperSpeedDebounce (_In_ ULONG Value)
VOID NTAPI	HubNotifyBootDeviceRemoval (_In_opt_ PVOID Handle)
static VOID NTAPI	HubEvtDriverCleanup (_In_ WDFOBJECT Object)
	CODE_SEG ("INIT") NTSTATUS NTAPI DriverEntry(_In_ PDRIVER_OBJECT DriverObject
	if (!NT_SUCCESS(Status))
	HubReadGlobalPolicy ()
	HubReadUsb20LpmPolicy ()
	HubReadLtmPolicy ()
	HubReadKseGlobalFlags ()
	DPRINT ("Hub driver loaded, global flags 0x%lx\n",(ULONG) HubDriver.GlobalFlags)

Variables
HubDriverState	HubDriver
const ULONG	Microsoft_USBD_Compat_Version = 0x110
DRIVER_INITIALIZE	DriverEntry
static EVT_WDF_OBJECT_CONTEXT_CLEANUP	HubEvtDriverCleanup
_In_ PCWSTR	Name
_In_ PCWSTR _Out_ PULONG	Value
RtlInitUnicodeString &	ValueName
_In_ ACCESS_MASK	Access
_In_ ACCESS_MASK _Out_ WDFKEY *	Key
RtlInitUnicodeString &	KeyName
static const HubPolicyValue	HubGlobalPolicy []
_In_ PUNICODE_STRING	RegistryPath
WDF_OBJECT_ATTRIBUTES	Attributes
NTSTATUS	Status = WdfDriverCreate(DriverObject, RegistryPath, &Attributes, &Config, &HubDriver.Driver)
HubDriver	DriverObject = DriverObject
WDF_DRIVER_CONFIG_INIT &	Config
Config	DriverPoolTag = HUB_TAG_DRIVER
Attributes	EvtCleanupCallback = HubEvtDriverCleanup
Attributes	ParentObject = HubDriver.Driver
HubDriver	KseQueryDeviceFlags
HubDriver	RegisterPowerSetting
HubDriver	UnregisterPowerSetting
HubDriver	GetInterfaceProperty
return	STATUS_SUCCESS

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file entry.cpp.

Function Documentation

_IRQL_requires_()

_IRQL_requires_

(

PASSIVE_LEVEL

)

Sends a synchronous IOCTL to the specified device object.

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

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

Definition at line 164 of file entry.cpp.

{
    WDFKEY Key;
    ULONG Index;
    ULONG Value;
    NTSTATUS Status;
 
    HubDriver.SetFlag(HubGlobal::DisableOnSoftRemove);
 
    if (!NT_SUCCESS(HubOpenRegistryKey(L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\USBHUB\\hubg",
                                       KEY_QUERY_VALUE, &Key)))
    {
        return;
    }
 
    for (Index = 0; Index < RTL_NUMBER_OF(HubGlobalPolicy); Index++)
    {
        Status = HubQueryRegistryULong(Key, HubGlobalPolicy[Index].Name, &Value);
        if (Status == STATUS_OBJECT_NAME_NOT_FOUND)
            continue;
 
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Reading %S failed 0x%lx\n", HubGlobalPolicy[Index].Name, Status);
            break;
        }
 
        HubGlobalPolicy[Index].Apply(Value);
    }
 
    WdfRegistryClose(Key);
}

CODE_SEG()

CODE_SEG

(

"INIT"

)

Definition at line 246 of file Interface.c.

{
    UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\FileSystem\\Filters\\"DRIVER_NAME);
    PDEVICE_OBJECT RawDeviceObject;
    PDEVICE_OBJECT DeviceObject;
    PFILE_OBJECT RawFileObject;
    UNICODE_STRING ObjectName;
    UNICODE_STRING SymLink;
 
    NTSTATUS Status;
 
    RtlZeroMemory(&DriverData, sizeof(DRIVER_DATA));
    DriverData.DriverObject = DriverObject;
 
    /* Save the registry key for this driver */
    DriverData.ServiceKey.Length = RegistryPath->Length;
    DriverData.ServiceKey.MaximumLength = RegistryPath->MaximumLength;
    DriverData.ServiceKey.Buffer = (PWCHAR)ExAllocatePoolWithTag(NonPagedPool,
                                                                 RegistryPath->MaximumLength,
                                                                 FM_TAG_REGISTRY_DATA);
    if (!DriverData.ServiceKey.Buffer) return STATUS_INSUFFICIENT_RESOURCES;
    RtlCopyUnicodeString(&DriverData.ServiceKey, RegistryPath);
 
    /* Do some initialization */
    ExInitializeFastMutex(&DriverData.FilterAttachLock);
 
    /* Create the main filter manager device object */
    Status = IoCreateDevice(DriverObject,
                            0,
                            &DeviceName,
                            FILE_DEVICE_DISK_FILE_SYSTEM,
                            FILE_DEVICE_SECURE_OPEN,
                            FALSE,
                            &DeviceObject);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("fltmgr IoCreateDevice failed.  Status = %X\n", Status);
        goto Cleanup;
    }
 
    /* Store a global reference so we can access from callbacks */
    DriverData.DeviceObject = DeviceObject;
 
    /* Generate the symbolic link name */
    RtlInitUnicodeString(&SymLink, L"\\??\\"DRIVER_NAME);
    Status = IoCreateSymbolicLink(&SymLink, &DeviceName);
    if (!NT_SUCCESS(Status)) goto Cleanup;
 
    /* Create the callbacks for the dispatch table, FastIo and FS callbacks */
    Status = SetupDispatchAndCallbacksTables(DriverObject);
    if (!NT_SUCCESS(Status)) goto Cleanup;
 
    /* Initialize the comms objects */
    Status = FltpSetupCommunicationObjects(DriverObject);
    if (!NT_SUCCESS(Status)) goto Cleanup;
 
    /* Register for notifications when a new file system is loaded. This also enumerates any existing file systems */
    Status = IoRegisterFsRegistrationChange(DriverObject, FltpFsNotification);
    FLT_ASSERT(Status != STATUS_DEVICE_ALREADY_ATTACHED); // Windows checks for this, I'm not sure how it can happen. Needs investigation??
    if (!NT_SUCCESS(Status))  goto Cleanup;
 
    InitializeListHead(&FilterList);
    ExInitializeResourceLite(&FilterListLock);
 
    /* IoRegisterFsRegistrationChange isn't notified about the raw  file systems, so we attach to them manually */
    RtlInitUnicodeString(&ObjectName, L"\\Device\\RawDisk");
    Status = IoGetDeviceObjectPointer(&ObjectName,
                                      FILE_READ_ATTRIBUTES,
                                      &RawFileObject,
                                      &RawDeviceObject);
    if (NT_SUCCESS(Status))
    {
        FltpFsNotification(RawDeviceObject, TRUE);
        ObDereferenceObject(RawFileObject);
    }
 
    RtlInitUnicodeString(&ObjectName, L"\\Device\\RawCdRom");
    Status = IoGetDeviceObjectPointer(&ObjectName,
                                      FILE_READ_ATTRIBUTES,
                                      &RawFileObject,
                                      &RawDeviceObject);
    if (NT_SUCCESS(Status))
    {
        FltpFsNotification(RawDeviceObject, TRUE);
        ObDereferenceObject(RawFileObject);
    }
 
    /* We're done, clear the initializing flag */
    ClearFlag(DeviceObject->Flags, DO_DEVICE_INITIALIZING);
    Status = STATUS_SUCCESS;
 
Cleanup:
 
    if (!NT_SUCCESS(Status))
    {
        if (DriverData.FastIoDispatch)
        {
            DriverObject->FastIoDispatch = NULL;
            ExFreePoolWithTag(DriverData.FastIoDispatch, FM_TAG_DISPATCH_TABLE);
        }
 
        IoDeleteSymbolicLink(&SymLink);
 
        if (DeviceObject)
            IoDeleteDevice(DeviceObject);
 
        if (DriverData.ServiceKey.Buffer)
            ExFreePoolWithTag(DriverData.ServiceKey.Buffer, FM_TAG_REGISTRY_DATA);
    }
 
    return Status;
}

DPRINT()

DPRINT	(	"Hub driver	loaded,
		global flags 0x%lx\n"	,
		(ULONG) HubDriver.	GlobalFlags
	)

HubApplyDisableOnSoftRemove()

static VOID NTAPI HubApplyDisableOnSoftRemove ( _In_ ULONG  Value )

static

Definition at line 97 of file entry.cpp.

{
    if (Value == 0)
        HubDriver.ClearFlag(HubGlobal::DisableOnSoftRemove);
}

HubApplyDisableSelectiveSuspendUI()

static VOID NTAPI HubApplyDisableSelectiveSuspendUI ( _In_ ULONG  Value )

static

Definition at line 64 of file entry.cpp.

{
    if (Value != 0)
        HubDriver.SetFlag(HubGlobal::DisableSelectiveSuspendUI);
}

HubApplyDisableUxdSupport()

static VOID NTAPI HubApplyDisableUxdSupport ( _In_ ULONG  Value )

static

Definition at line 107 of file entry.cpp.

{
    if (Value != 0)
        HubDriver.SetFlag(HubGlobal::DisableUxdSupport);
}

HubApplyEnableDiagnosticMode()

static VOID NTAPI HubApplyEnableDiagnosticMode ( _In_ ULONG  Value )

static

Definition at line 86 of file entry.cpp.

{
    if (Value != 0)
        HubDriver.SetFlag(HubGlobal::EnableDiagnosticMode);
}

HubApplyEnableExtendedValidation()

static VOID NTAPI HubApplyEnableExtendedValidation ( _In_ ULONG  Value )

static

Definition at line 118 of file entry.cpp.

{
    if (Value == 0)
        return;
 
    HubDriver.SetFlag(HubGlobal::EnableExtendedValidation);
    if (Value & 0x8)
        HubDriver.SetFlag(HubGlobal::CheckReservedFields);
    if (Value & 0x4)
        HubDriver.SetFlag(HubGlobal::StrictDescriptorChecks);
}

HubApplyMsOsDescriptorMode()

static VOID NTAPI HubApplyMsOsDescriptorMode ( _In_ ULONG  Value )

static

Definition at line 74 of file entry.cpp.

{
    if (Value <= (ULONG)HubMsOsMode::NeverQuery)
        HubDriver.MsOsMode = (HubMsOsMode)Value;
    else
        DPRINT1("Ignoring MsOsDescriptorMode %lu\n", Value);
}

HubApplyPreventSuperSpeedDebounce()

static VOID NTAPI HubApplyPreventSuperSpeedDebounce ( _In_ ULONG  Value )

static

Definition at line 144 of file entry.cpp.

{
    if (Value != 0)
        HubDriver.SetFlag(HubGlobal::PreventSuperSpeedDebounce);
}

HubApplyWakeOnConnectUI()

static VOID NTAPI HubApplyWakeOnConnectUI ( _In_ ULONG  Value )

static

Definition at line 134 of file entry.cpp.

{
    if (Value != 0)
        HubDriver.SetFlag(HubGlobal::WakeOnConnectUI);
}

HubEvtDriverCleanup()

static VOID NTAPI HubEvtDriverCleanup ( _In_ WDFOBJECT  Object )

static

Definition at line 358 of file entry.cpp.

{
    UNREFERENCED_PARAMETER(Object);
 
    PAGED_CODE();
 
    NT_ASSERT(IsListEmpty(&HubDriver.HubList));
    NT_ASSERT(IsListEmpty(&HubDriver.ConnectorMap));
 
    HubDriver.DriverObject = NULL;
}

HubNotifyBootDeviceRemoval()

VOID NTAPI HubNotifyBootDeviceRemoval

(

_In_opt_ PVOID

Handle

)

Kernel boot device removal notice; nothing when the kernel lacks it or Handle is NULL.

Definition at line 335 of file entry.cpp.

{
    if (Handle != NULL && HubDriver.NotifyBootDeviceRemoval != NULL)
        HubDriver.NotifyBootDeviceRemoval(Handle);
}

Referenced by PortMachine::NotifyBootDeviceRemoval(), and DeviceMachine::NotifyWrongDevice().

HubReadGlobalPolicy()

HubReadGlobalPolicy

(

)

HubReadKseGlobalFlags()

HubReadKseGlobalFlags

(

)

HubReadLtmPolicy()

HubReadLtmPolicy

(

)

HubReadUsb20LpmPolicy()

HubReadUsb20LpmPolicy

(

)

if()

if

(

!

NT_SUCCESSStatus

)

Definition at line 394 of file entry.cpp.

    {
        DPRINT1("WdfDriverCreate failed 0x%lx\n", Status);
        return Status;
    }

WdfRegistryOpenKey()

return WdfRegistryOpenKey	(	NULL	,
		&	KeyName,
		Access	,
		WDF_NO_OBJECT_ATTRIBUTES	,
		Key
	)

Referenced by _IRQL_requires_max_(), BootEnvironmentIsWinPE(), CheckHDAGraphicsRegistryKeys(), and XhciController::ReadVerifierFlags().

WdfRegistryQueryValue()

return WdfRegistryQueryValue	(	Key	,
		&	ValueName,
		sizeof *	Value,
		Value	,
		NULL	,
		NULL
	)

Referenced by XhciController::ReadVerifierFlags().

Variable Documentation

Access

_In_ ACCESS_MASK Access

Definition at line 45 of file entry.cpp.

Referenced by AcpiExDecodeFieldAccess(), cmdUse(), ConSrvGetObject(), ConSrvInsertObject(), CreateLogoffSecurityAttributes(), CShellCommandDOKA::Execute(), GetProcessToken(), InitIdtVector(), make_impersonation_token(), NtSetInformationProcess(), ObtCreateObjects(), OpenBootStore(), OpenBootStore_UStr(), OpenBootStoreByHandle(), OpenDevice(), OpenIniBootLoaderStore(), OpenMountManager(), pCDevSettings_OpenDeviceKey(), PiPropCreateBranch(), PrintFileDacl(), SdbpOpenKey(), SeCreateAccessState(), SeCreateAccessStateEx(), SepAnalyzeAcesFromDacl(), SetInterruptGate(), test_AccessCheck(), and TestSeAssignSecurity().

Attributes

WDF_OBJECT_ATTRIBUTES_INIT& Attributes

Definition at line 380 of file entry.cpp.

Config

WDF_DRIVER_CONFIG_INIT& Config

Definition at line 387 of file entry.cpp.

DriverEntry

DRIVER_INITIALIZE DriverEntry

Definition at line 18 of file entry.cpp.

DriverObject

HubDriver DriverObject = DriverObject

Definition at line 383 of file entry.cpp.

DriverPoolTag

Config DriverPoolTag = HUB_TAG_DRIVER

Definition at line 388 of file entry.cpp.

EvtCleanupCallback

Attributes EvtCleanupCallback = HubEvtDriverCleanup

Definition at line 391 of file entry.cpp.

GetInterfaceProperty

HubDriver GetInterfaceProperty

Initial value:

=
        (PFN_HUB_GET_INTERFACE_PROPERTY)HubResolveKernelRoutine(L"IoGetDeviceInterfacePropertyData")

Definition at line 427 of file entry.cpp.

HubDriver

InitializeListHead & HubDriver

Definition at line 13 of file entry.cpp.

Referenced by _IRQL_requires_(), DeviceMachine::DisableWhenUnused(), HubApplyDisableOnSoftRemove(), HubApplyDisableSelectiveSuspendUI(), HubApplyDisableUxdSupport(), HubApplyEnableDiagnosticMode(), HubApplyEnableExtendedValidation(), HubApplyMsOsDescriptorMode(), HubApplyPreventSuperSpeedDebounce(), HubApplyWakeOnConnectUI(), HubChildAddressDone(), HubChildComputeLpm20(), HubConnectorFindById(), HubConnectorFindByPort(), HubDescInitDeviceContext(), HubEvtDriverCleanup(), HubNotifyBootDeviceRemoval(), HubUsb4InterfaceChange(), HubWmiEvtSurpriseRemovalCleanup(), DeviceMachine::LtmWanted(), DeviceMachine::MsOsQueryWanted(), PortMachine::NeedsDebounce(), and DeviceMachine::NeedsSecondReset().

HubEvtDriverCleanup

EVT_WDF_OBJECT_CONTEXT_CLEANUP HubEvtDriverCleanup

static

Definition at line 19 of file entry.cpp.

HubGlobalPolicy

const HubPolicyValue HubGlobalPolicy[]

static

Initial value:

=
{
    { L"DisableSelectiveSuspendUI", HubApplyDisableSelectiveSuspendUI },
    { L"MsOsDescriptorMode", HubApplyMsOsDescriptorMode },
    { L"EnableDiagnosticMode", HubApplyEnableDiagnosticMode },
    { L"DisableOnSoftRemove", HubApplyDisableOnSoftRemove },
    { L"DisableUxdSupport", HubApplyDisableUxdSupport },
    { L"EnableExtendedValidation", HubApplyEnableExtendedValidation },
    { L"WakeOnConnectUI", HubApplyWakeOnConnectUI },
    { L"PreventDebounceTimeForSuperSpeedDevices", HubApplyPreventSuperSpeedDebounce }
}

Definition at line 151 of file entry.cpp.

Referenced by _IRQL_requires_().

Key

_In_ ACCESS_MASK _Out_ WDFKEY* Key

Initial value:

{
    UNICODE_STRING KeyName

Definition at line 46 of file entry.cpp.

Referenced by _IRQL_requires_().

KeyName

RtlInitUnicodeString& KeyName

Definition at line 50 of file entry.cpp.

KseQueryDeviceFlags

HubDriver KseQueryDeviceFlags

Initial value:

=
        (PFN_HUB_KSE_QUERY_DEVICE_FLAGS)HubResolveKernelRoutine(L"KseQueryDeviceFlags")

Definition at line 421 of file entry.cpp.

Microsoft_USBD_Compat_Version

const ULONG Microsoft_USBD_Compat_Version = 0x110

Definition at line 16 of file entry.cpp.

Name

_In_ PCWSTR Name

Definition at line 28 of file entry.cpp.

Referenced by _IRQL_requires_().

ParentObject

Attributes ParentObject = HubDriver.Driver

Definition at line 401 of file entry.cpp.

RegisterPowerSetting

HubDriver RegisterPowerSetting

Initial value:

=
        (PFN_HUB_REGISTER_POWER_SETTING)HubResolveKernelRoutine(L"PoRegisterPowerSettingCallback")

Definition at line 423 of file entry.cpp.

RegistryPath

_In_ PUNICODE_STRING RegistryPath

Initial value:

{
    WDF_DRIVER_CONFIG Config

Definition at line 377 of file entry.cpp.

Status

Status = WdfDriverCreate(DriverObject, RegistryPath, &Attributes, &Config, &HubDriver.Driver)

Definition at line 381 of file entry.cpp.

Referenced by _IRQL_requires_(), and if().

STATUS_SUCCESS

return STATUS_SUCCESS

Definition at line 434 of file entry.cpp.

UnregisterPowerSetting

HubDriver UnregisterPowerSetting

Initial value:

=
        (PFN_HUB_UNREGISTER_POWER_SETTING)HubResolveKernelRoutine(L"PoUnregisterPowerSettingCallback")

Definition at line 425 of file entry.cpp.

Value

* Value

Initial value:

{
    UNICODE_STRING ValueName

Definition at line 29 of file entry.cpp.

Referenced by _IRQL_requires_().

ValueName

RtlInitUnicodeString& ValueName

Definition at line 34 of file entry.cpp.