hubport.cpp File Reference

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

Include dependency graph for hubport.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	PORT_DEBOUNCE_TIME   100
#define	PORT_OVERCURRENT_TIME   500
#define	PORT_RESET_TIME   3000
#define	HUB_PORT_RESUME_WAIT_MS   500
#define	PORT_RESUME_RECOVERY_TIME   10
#define	PORT_POWER_ON_TIME_ROOT   100
#define	PORT_POWER_ON_TIME   300
#define	PORT_RECONNECT_TIME_BOOT   2000
#define	PORT_RECONNECT_TIME   1000
#define	PORT_SUPERSPEED_DISABLE_TIME   5000
#define	PORT_RESET_POLL_TIME   500

Functions
	_IRQL_requires_ (PASSIVE_LEVEL) HubPort *HubPort
	Sends a synchronous IOCTL to the specified device object.

Variables
static const char	HubTagPort [] = "hub port"

Macro Definition Documentation

HUB_PORT_RESUME_WAIT_MS

#define HUB_PORT_RESUME_WAIT_MS   500

Definition at line 20 of file hubport.cpp.

NDEBUG

#define NDEBUG

Definition at line 10 of file hubport.cpp.

PORT_DEBOUNCE_TIME

#define PORT_DEBOUNCE_TIME   100

Definition at line 17 of file hubport.cpp.

PORT_OVERCURRENT_TIME

#define PORT_OVERCURRENT_TIME   500

Definition at line 18 of file hubport.cpp.

PORT_POWER_ON_TIME

#define PORT_POWER_ON_TIME   300

Definition at line 23 of file hubport.cpp.

PORT_POWER_ON_TIME_ROOT

#define PORT_POWER_ON_TIME_ROOT   100

Definition at line 22 of file hubport.cpp.

PORT_RECONNECT_TIME

#define PORT_RECONNECT_TIME   1000

Definition at line 25 of file hubport.cpp.

PORT_RECONNECT_TIME_BOOT

#define PORT_RECONNECT_TIME_BOOT   2000

Definition at line 24 of file hubport.cpp.

PORT_RESET_POLL_TIME

#define PORT_RESET_POLL_TIME   500

Definition at line 27 of file hubport.cpp.

PORT_RESET_TIME

#define PORT_RESET_TIME   3000

Definition at line 19 of file hubport.cpp.

PORT_RESUME_RECOVERY_TIME

#define PORT_RESUME_RECOVERY_TIME   10

Definition at line 21 of file hubport.cpp.

PORT_SUPERSPEED_DISABLE_TIME

#define PORT_SUPERSPEED_DISABLE_TIME   5000

Definition at line 26 of file hubport.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.

Sends a synchronous IOCTL to the specified device object.

STATUS_SUCCESS when the caller's token is an administrator's.

Definition at line 36 of file hubport.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    WDF_TIMER_CONFIG TimerConfig;
    HubPort* Port;
    WDFOBJECT Object;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Attributes, HubPort);
    Attributes.ParentObject = Hub->m_Device;
    Attributes.ExecutionLevel = WdfExecutionLevelPassive;
    Attributes.EvtCleanupCallback = EvtCleanup;
    Attributes.EvtDestroyCallback = EvtDestroy;
 
    Status = WdfObjectCreate(&Attributes, &Object);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p port %u object creation failed 0x%lx\n", Hub, Info->PortNumber, Status);
        return NULL;
    }
 
    WdfObjectReferenceWithTag(Hub->m_Device, (PVOID)HubTagPort);
 
    Port = new (HubGetPortContext(Object)) HubPort();
    Port->m_Object = Object;
    Port->m_Hub = Hub;
    Port->m_Info = *Info;
    Port->m_SelectedFeature = HUB_FEATURE_NONE;
    Port->m_D3ColdReconnectTimeout = PORT_RECONNECT_TIME;
    HubClearListEntry(&Port->m_HubLink);
 
    Status = Port->m_Control.Create(Object, WdfDeviceGetIoTarget(Hub->m_Device));
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Port %u control request creation failed 0x%lx\n", Port->Number(), Status);
        goto Failed;
    }
 
    Port->m_Machine.Initialize(Port, Port->IsUsb30());
    Port->m_Timer.Initialize(TimerFired, Port);
 
    if (Hub->HasFlag(HubFlag::DelayAfterResetComplete))
    {
        WDF_TIMER_CONFIG_INIT(&TimerConfig, ResetPollFired);
        WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
        Attributes.ParentObject = Object;
 
        Status = WdfTimerCreate(&TimerConfig, &Attributes, &Port->m_ResetPollTimer);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Port %u reset poll timer creation failed 0x%lx\n", Port->Number(), Status);
            goto Failed;
        }
    }
 
    Port->m_WorkItem = Hub->AllocateWorkItem();
    if (Port->m_WorkItem == NULL)
    {
        DPRINT1("Port %u work item allocation failed\n", Port->Number());
        goto Failed;
    }
 
    DPRINT("Hub %p created port %p number %u\n", Hub, Port, Port->Number());
    return Port;
 
Failed:
    WdfObjectDelete(Object);
    return NULL;
}

Variable Documentation

HubTagPort

const char HubTagPort[] = "hub port"

static

Definition at line 14 of file hubport.cpp.

Referenced by _IRQL_requires_().