hubsup.c File Reference

#include <ntddk.h>
#include <usbdi.h>
#include <usbioctl.h>
#include <drivers/usb3/usbdhub.h>

Include dependency graph for hubsup.c:

Go to the source code of this file.

Classes
struct	_USBD_SERIAL_RECORD

Macros
#define	_USBD_
#define	USBD_POOL_TAG   'DBSU'
#define	USBD_NONPAGED_POOL_NX   ((POOL_TYPE)0x200)

Typedefs
typedef struct _USBD_SERIAL_RECORD	USBD_SERIAL_RECORD
typedef struct _USBD_SERIAL_RECORD *	PUSBD_SERIAL_RECORD

Functions
static	RTL_STATIC_LIST_HEAD (UsbdSerialList)
NTSTATUS NTAPI	DllInitialize (_In_ PUNICODE_STRING RegistryPath)
NTSTATUS NTAPI	DllUnload (VOID)
ULONG NTAPI	USBD_AllocateHubNumber (VOID)
VOID NTAPI	USBD_ReleaseHubNumber (_In_ ULONG HubNumber)
static BOOLEAN	UsbdSerialRecordMatches (_In_ PUSBD_SERIAL_RECORD Record, _In_ USHORT IdVendor, _In_ USHORT IdProduct, _In_ PUSB_ID_STRING SerialNumber)
static ULONG	UsbdClassifySerialCollision (_In_ PUSBD_SERIAL_RECORD Existing, _In_opt_ PVOID HubContext, _In_ ULONG PortNumber, _In_opt_ PVOID ConnectorNode)
static PUSBD_SERIAL_RECORD	UsbdFindSerialRecordByDevice (_In_ PVOID DeviceContext)
ULONG NTAPI	USBD_AddDeviceToGlobalList (_In_ PVOID DeviceContext, _In_opt_ PVOID HubContext, _In_ ULONG PortNumber, _In_opt_ PVOID ConnectorNode, _In_ USHORT IdVendor, _In_ USHORT IdProduct, _In_ PUSB_ID_STRING SerialNumber)
VOID NTAPI	USBD_MarkDeviceAsDisconnected (_In_ PVOID DeviceContext)
VOID NTAPI	USBD_RemoveDeviceFromGlobalList (_In_ PVOID DeviceContext)

Variables
static POOL_TYPE	UsbdNonPagedPoolType = NonPagedPool
static PRTL_BITMAP	UsbdHubNumbers
static KEVENT	UsbdHubNumberLock
static KSPIN_LOCK	UsbdSerialListLock

Macro Definition Documentation

_USBD_

#define _USBD_

Definition at line 8 of file hubsup.c.

USBD_NONPAGED_POOL_NX

#define USBD_NONPAGED_POOL_NX   ((POOL_TYPE)0x200)

Definition at line 17 of file hubsup.c.

USBD_POOL_TAG

#define USBD_POOL_TAG   'DBSU'

Definition at line 14 of file hubsup.c.

Typedef Documentation

PUSBD_SERIAL_RECORD

typedef struct _USBD_SERIAL_RECORD * PUSBD_SERIAL_RECORD

USBD_SERIAL_RECORD

typedef struct _USBD_SERIAL_RECORD USBD_SERIAL_RECORD

Function Documentation

DllInitialize()

NTSTATUS NTAPI DllInitialize

(

_In_ PUNICODE_STRING

RegistryPath

)

Definition at line 44 of file hubsup.c.

{
    RTL_OSVERSIONINFOW OsVersion;
    PRTL_BITMAP Bitmap;
    SIZE_T BitmapSize;
 
    UNREFERENCED_PARAMETER(RegistryPath);
 
    RtlZeroMemory(&OsVersion, sizeof(OsVersion));
    OsVersion.dwOSVersionInfoSize = sizeof(OsVersion);
    if (NT_SUCCESS(RtlGetVersion(&OsVersion)))
    {
        if (OsVersion.dwMajorVersion > 6 ||
            (OsVersion.dwMajorVersion == 6 && OsVersion.dwMinorVersion >= 2))
        {
            UsbdNonPagedPoolType = USBD_NONPAGED_POOL_NX;
        }
    }
 
    KeInitializeSpinLock(&UsbdSerialListLock);
    InitializeListHead(&UsbdSerialList);
    KeInitializeEvent(&UsbdHubNumberLock, SynchronizationEvent, TRUE);
 
    /* Without the bitmap every hub simply gets number 0 */
    BitmapSize = sizeof(*Bitmap) + USBD_HUB_NUMBER_COUNT / 8;
    Bitmap = ExAllocatePoolZero(PagedPool, BitmapSize, USBD_POOL_TAG);
    if (Bitmap)
    {
        RtlInitializeBitMap(Bitmap, (PULONG)(Bitmap + 1), USBD_HUB_NUMBER_COUNT);
        RtlSetBits(Bitmap, USBD_HUB_NUMBER_NONE, 1);
        UsbdHubNumbers = Bitmap;
    }
 
    return STATUS_SUCCESS;
}

DllUnload()

NTSTATUS NTAPI DllUnload

(

VOID

)

Definition at line 83 of file hubsup.c.

{
    if (UsbdHubNumbers)
    {
        ExFreePoolWithTag(UsbdHubNumbers, USBD_POOL_TAG);
        UsbdHubNumbers = NULL;
    }
 
    return STATUS_SUCCESS;
}

RTL_STATIC_LIST_HEAD()

static RTL_STATIC_LIST_HEAD ( UsbdSerialList  )

static

USBD_AddDeviceToGlobalList()

ULONG NTAPI USBD_AddDeviceToGlobalList	(	_In_ PVOID	DeviceContext,
		_In_opt_ PVOID	HubContext,
		_In_ ULONG	PortNumber,
		_In_opt_ PVOID	ConnectorNode,
		_In_ USHORT	IdVendor,
		_In_ USHORT	IdProduct,
		_In_ PUSB_ID_STRING	SerialNumber
	)

Definition at line 204 of file hubsup.c.

{
    PLIST_ENTRY Entry;
    PUSBD_SERIAL_RECORD Record;
    PUSBD_SERIAL_RECORD NewRecord;
    ULONG Result = USBD_GLOBAL_LIST_ADDED;
    KIRQL OldIrql;
 
    KeAcquireSpinLock(&UsbdSerialListLock, &OldIrql);
 
    /* Only the first record with the same identity decides */
    for (Entry = UsbdSerialList.Flink; Entry != &UsbdSerialList; Entry = Entry->Flink)
    {
        Record = CONTAINING_RECORD(Entry, USBD_SERIAL_RECORD, Link);
        if (UsbdSerialRecordMatches(Record, IdVendor, IdProduct, SerialNumber))
        {
            Result = UsbdClassifySerialCollision(Record, HubContext, PortNumber, ConnectorNode);
            break;
        }
    }
 
    if (Result != USBD_GLOBAL_LIST_ADDED)
        goto Exit;
 
    /* The serial is stored right after the record */
    NewRecord = ExAllocatePoolWithTag(UsbdNonPagedPoolType,
                                      sizeof(*NewRecord) + SerialNumber->LengthInBytes,
                                      USBD_POOL_TAG);
    if (!NewRecord)
    {
        Result = USBD_GLOBAL_LIST_NO_MEMORY;
        goto Exit;
    }
 
    RtlZeroMemory(NewRecord, sizeof(*NewRecord));
 
    if (SerialNumber->LengthInBytes != 0)
    {
        NewRecord->Serial = (PWCHAR)(NewRecord + 1);
        RtlCopyMemory(NewRecord->Serial, SerialNumber->Buffer, SerialNumber->LengthInBytes);
    }
 
    NewRecord->SerialLength = SerialNumber->LengthInBytes;
    NewRecord->DeviceContext = DeviceContext;
    NewRecord->HubContext = HubContext;
    NewRecord->PortNumber = PortNumber;
    NewRecord->ConnectorNode = ConnectorNode;
    NewRecord->IdVendor = IdVendor;
    NewRecord->IdProduct = IdProduct;
    InsertTailList(&UsbdSerialList, &NewRecord->Link);
 
Exit:
    KeReleaseSpinLock(&UsbdSerialListLock, OldIrql);
    return Result;
}

Referenced by DeviceMachine::AddChildToHub().

USBD_AllocateHubNumber()

ULONG NTAPI USBD_AllocateHubNumber

(

VOID

)

Definition at line 96 of file hubsup.c.

{
    ULONG Number;
 
    PAGED_CODE();
 
    if (!UsbdHubNumbers)
        return USBD_HUB_NUMBER_NONE;
 
    KeWaitForSingleObject(&UsbdHubNumberLock, Executive, KernelMode, FALSE, NULL);
    Number = RtlFindClearBitsAndSet(UsbdHubNumbers, 1, 0);
    KeSetEvent(&UsbdHubNumberLock, IO_NO_INCREMENT, FALSE);
 
    if (Number == MAXULONG)
        return USBD_HUB_NUMBER_NONE;
 
    return Number;
}

Referenced by _IRQL_requires_().

USBD_MarkDeviceAsDisconnected()

VOID NTAPI USBD_MarkDeviceAsDisconnected

(

_In_ PVOID

DeviceContext

)

Definition at line 269 of file hubsup.c.

{
    PUSBD_SERIAL_RECORD Record;
    KIRQL OldIrql;
 
    KeAcquireSpinLock(&UsbdSerialListLock, &OldIrql);
 
    Record = UsbdFindSerialRecordByDevice(DeviceContext);
    if (Record)
        Record->Disconnected = TRUE;
 
    KeReleaseSpinLock(&UsbdSerialListLock, OldIrql);
}

Referenced by DeviceMachine::MarkDisconnected().

USBD_ReleaseHubNumber()

VOID NTAPI USBD_ReleaseHubNumber

(

_In_ ULONG

HubNumber

)

Definition at line 117 of file hubsup.c.

{
    PAGED_CODE();
 
    /* 0 is reserved and anything past the map would land outside the buffer */
    if (!UsbdHubNumbers ||
        HubNumber == USBD_HUB_NUMBER_NONE ||
        HubNumber >= USBD_HUB_NUMBER_COUNT)
    {
        return;
    }
 
    KeWaitForSingleObject(&UsbdHubNumberLock, Executive, KernelMode, FALSE, NULL);
    RtlClearBits(UsbdHubNumbers, HubNumber, 1);
    KeSetEvent(&UsbdHubNumberLock, IO_NO_INCREMENT, FALSE);
}

USBD_RemoveDeviceFromGlobalList()

VOID NTAPI USBD_RemoveDeviceFromGlobalList

(

_In_ PVOID

DeviceContext

)

Definition at line 286 of file hubsup.c.

{
    PUSBD_SERIAL_RECORD Record;
    KIRQL OldIrql;
 
    KeAcquireSpinLock(&UsbdSerialListLock, &OldIrql);
 
    Record = UsbdFindSerialRecordByDevice(DeviceContext);
    if (Record)
        RemoveEntryList(&Record->Link);
 
    KeReleaseSpinLock(&UsbdSerialListLock, OldIrql);
 
    if (Record)
        ExFreePoolWithTag(Record, USBD_POOL_TAG);
}

Referenced by DeviceMachine::ForgetChild().

UsbdClassifySerialCollision()

static ULONG UsbdClassifySerialCollision ( _In_ PUSBD_SERIAL_RECORD  Existing, _In_opt_ PVOID  HubContext, _In_ ULONG  PortNumber, _In_opt_ PVOID  ConnectorNode  )

static

Definition at line 160 of file hubsup.c.

{
    BOOLEAN SameConnector;
    BOOLEAN SamePort;
 
    SameConnector = (ConnectorNode != NULL && Existing->ConnectorNode == ConnectorNode);
    SamePort = (HubContext != NULL &&
                Existing->HubContext == HubContext &&
                Existing->PortNumber == PortNumber);
 
    /* A connected record on the same connector is the other speed's copy that has not left yet */
    if (!Existing->Disconnected)
        return SameConnector ? USBD_GLOBAL_LIST_DUPLICATE_PENDING : USBD_GLOBAL_LIST_DUPLICATE;
 
    if (SameConnector || SamePort)
        return USBD_GLOBAL_LIST_ADDED;
 
    return USBD_GLOBAL_LIST_DUPLICATE_PENDING;
}

Referenced by USBD_AddDeviceToGlobalList().

UsbdFindSerialRecordByDevice()

static PUSBD_SERIAL_RECORD UsbdFindSerialRecordByDevice ( _In_ PVOID  DeviceContext )

static

Definition at line 186 of file hubsup.c.

{
    PLIST_ENTRY Entry;
    PUSBD_SERIAL_RECORD Record;
 
    for (Entry = UsbdSerialList.Flink; Entry != &UsbdSerialList; Entry = Entry->Flink)
    {
        Record = CONTAINING_RECORD(Entry, USBD_SERIAL_RECORD, Link);
        if (Record->DeviceContext == DeviceContext)
            return Record;
    }
 
    return NULL;
}

Referenced by USBD_MarkDeviceAsDisconnected(), and USBD_RemoveDeviceFromGlobalList().

UsbdSerialRecordMatches()

static BOOLEAN UsbdSerialRecordMatches ( _In_ PUSBD_SERIAL_RECORD  Record, _In_ USHORT  IdVendor, _In_ USHORT  IdProduct, _In_ PUSB_ID_STRING  SerialNumber  )

static

Definition at line 137 of file hubsup.c.

{
    if (Record->IdVendor != IdVendor || Record->IdProduct != IdProduct)
        return FALSE;
 
    if (Record->SerialLength != SerialNumber->LengthInBytes)
        return FALSE;
 
    if (Record->SerialLength == 0)
        return TRUE;
 
    return RtlEqualMemory(Record->Serial,
                          SerialNumber->Buffer,
                          Record->SerialLength);
}

Referenced by USBD_AddDeviceToGlobalList().

Variable Documentation

UsbdHubNumberLock

KEVENT UsbdHubNumberLock

static

Definition at line 37 of file hubsup.c.

Referenced by DllInitialize(), USBD_AllocateHubNumber(), and USBD_ReleaseHubNumber().

UsbdHubNumbers

PRTL_BITMAP UsbdHubNumbers

static

Definition at line 36 of file hubsup.c.

Referenced by DllInitialize(), DllUnload(), USBD_AllocateHubNumber(), and USBD_ReleaseHubNumber().

UsbdNonPagedPoolType

POOL_TYPE UsbdNonPagedPoolType = NonPagedPool

static

Definition at line 34 of file hubsup.c.

Referenced by DllInitialize(), and USBD_AddDeviceToGlobalList().

UsbdSerialListLock

KSPIN_LOCK UsbdSerialListLock

static

Definition at line 40 of file hubsup.c.

Referenced by DllInitialize(), USBD_AddDeviceToGlobalList(), USBD_MarkDeviceAsDisconnected(), and USBD_RemoveDeviceFromGlobalList().