fanout.cpp File Reference

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

Include dependency graph for fanout.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static ULONG NTAPI	HubClampTierDepth (_In_ ULONG Depth)
static BOOLEAN NTAPI	HubAddPort (_In_ HubFdo *Hub, _In_ const HubPortInfo *Info)
static VOID NTAPI	HubTrackPortRange (_In_ USHORT PortNumber, _Inout_ PUSHORT First, _Inout_ PUSHORT Last)
static BOOLEAN NTAPI	HubDescriptorSaysFixed (_In_ const UCHAR *Bitmap, _In_ ULONG PortNumber)
	_IRQL_requires_ (PASSIVE_LEVEL) BOOLEAN HubFdo
	Sends a synchronous IOCTL to the specified device object.

Variables
static const char	HubTagRegistration [] = "hub child registration"
static const char	HubTagPnpPower [] = "hub child pnp power"

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file fanout.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 108 of file fanout.cpp.

{
    HubPortInfo Info;
    ULONG Count20 = IsRootHub() ? m_RootHubInfo.Info.NumberOf20Ports : 0;
    ULONG Count30 = IsRootHub() ? m_RootHubInfo.Info.NumberOf30Ports : 0;
    ULONG BitmapBytes;
    ULONG Index;
    PLIST_ENTRY Entry;
    PVOID Buffer;
    WDF_OBJECT_ATTRIBUTES Attributes;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    if (!IsRootHub())
    {
        if (m_Parent.HubSpeed == UsbSuperSpeed)
            Count30 = m_HubDescriptor.Usb30.bNumberOfPorts;
        else
            Count20 = m_HubDescriptor.Usb20.bNumberOfPorts;
    }
 
    m_First20Port = 0xFFFF;
    m_Last20Port = 0;
 
    for (Index = 0; Index < Count20; Index++)
    {
        RtlZeroMemory(&Info, sizeof(Info));
        Info.Properties = (ULONG)PortProperty::Removable;
        Info.Protocol = 0x200;
 
        if (IsRootHub())
        {
            const ROOTHUB_20PORT_INFO* Root = m_Root20Ports[Index];
 
            Info.PortNumber = Root->PortNumber;
            if (Root->Removable == TriStateFalse)
                Info.Properties &= ~(ULONG)PortProperty::Removable;
            if (Root->IntegratedHubImplemented == TriStateTrue)
                Info.Properties |= (ULONG)PortProperty::IntegratedHub;
            if (Root->ControllerUsb20HardwareLpmFlags.Flags.L1CapabilitySupported)
                Info.Properties |= (ULONG)PortProperty::Usb20LpmCapable;
            if (Root->ControllerUsb20HardwareLpmFlags.Flags.BeslLpmCapabilitySupported)
                Info.Properties |= (ULONG)PortProperty::BeslCapable;
            Info.TotalHubDepth = HubClampTierDepth(Root->HubDepth);
        }
        else
        {
            Info.PortNumber = (USHORT)(Index + 1);
            if (HubDescriptorSaysFixed(&m_HubDescriptor.Usb20.bRemoveAndPowerMask[0], Info.PortNumber))
                Info.Properties &= ~(ULONG)PortProperty::Removable;
            Info.TotalHubDepth = m_ParentInfo.TotalHubDepth;
        }
 
        HubTrackPortRange(Info.PortNumber, &m_First20Port, &m_Last20Port);
        if (!HubAddPort(this, &Info))
            goto Failed;
    }
 
    m_First30Port = 0xFFFF;
    m_Last30Port = 0;
 
    for (Index = 0; Index < Count30; Index++)
    {
        RtlZeroMemory(&Info, sizeof(Info));
        Info.Properties = (ULONG)PortProperty::Removable;
        Info.Protocol = 0x300;
 
        if (IsRootHub())
        {
            const ROOTHUB_30PORT_INFO_EX* Root = m_Root30Ports[Index];
 
            Info.PortNumber = Root->Info.PortNumber;
            if (Root->Info.Removable == TriStateFalse)
                Info.Properties &= ~(ULONG)PortProperty::Removable;
            if (Root->Info.DebugCapable == TriStateTrue)
                Info.Properties |= (ULONG)PortProperty::DebugCapable;
            Info.Properties |= (ULONG)PortProperty::EnhancedSuperSpeed;
            if (Root->Info.MinorRevision != 0)
                Info.SspIsochBurstCount = m_SspIsochBurstCount;
            Info.SublinkSpeedAttr = Root->Speeds;
            Info.SublinkSpeedAttrCount = Root->SpeedsCount;
            Info.TotalHubDepth = HubClampTierDepth(Root->Info.HubDepth);
        }
        else
        {
            Info.PortNumber = (USHORT)(Index + 1);
            if (HubDescriptorSaysFixed((const UCHAR*)&m_HubDescriptor.Usb30.DeviceRemovable, Info.PortNumber))
                Info.Properties &= ~(ULONG)PortProperty::Removable;
            if (m_Parent.IsEnhancedSuperSpeed)
            {
                Info.Properties |= (ULONG)PortProperty::EnhancedSuperSpeed;
                Info.SspIsochBurstCount = m_SspIsochBurstCount;
            }
            Info.SublinkSpeedAttr = m_ParentInfo.SublinkSpeedAttr;
            Info.SublinkSpeedAttrCount = m_ParentInfo.SublinkSpeedAttrCount;
            Info.TotalHubDepth = m_ParentInfo.TotalHubDepth;
        }
 
        HubTrackPortRange(Info.PortNumber, &m_First30Port, &m_Last30Port);
        if (!HubAddPort(this, &Info))
            goto Failed;
    }
 
    m_PortCount = max(m_Last20Port, m_Last30Port);
    if (m_PortCount == 0)
        DPRINT1("Hub %p reports no ports\n", m_Device);
    NT_ASSERT(m_PortCount != 0);
 
    /* External hubs read the whole interrupt packet into the bitmap; only the allocation is ULONG aligned */
    BitmapBytes = max(2, m_PortCount / 8 + 1);
    BitmapBytes = max(BitmapBytes, m_InterruptMaxPacket);
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = m_Device;
 
    Status = WdfMemoryCreate(&Attributes,
                             NonPagedPool,
                             HUB_TAG_HUB,
                             ALIGN_UP_BY(BitmapBytes, sizeof(ULONG)),
                             &m_Interrupt.BitmapMemory,
                             &Buffer);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p change bitmap allocation failed 0x%lx\n", m_Device, Status);
        goto Failed;
    }
 
    m_Interrupt.BitmapBuffer = (PUCHAR)Buffer;
    m_Interrupt.BitmapMaxBytes = BitmapBytes;
 
    DPRINT("Hub %p has %lu ports, bitmap %lu bytes\n", m_Device, m_PortCount, BitmapBytes);
 
    SetFlag(HubFlag::Configured);
    return TRUE;
 
Failed:
    while (!IsListEmpty(&m_Mux.Ports))
    {
        Entry = RemoveHeadList(&m_Mux.Ports);
        m_Mux.PortCount--;
        WdfObjectDelete(CONTAINING_RECORD(Entry, HubPort, m_HubLink)->m_Object);
    }
 
    return FALSE;
}

HubAddPort()

static BOOLEAN NTAPI HubAddPort ( _In_ HubFdo *  Hub, _In_ const HubPortInfo *  Info  )

static

Adds one port to the end of the list; 2.0 ports are created before 3.0 ports.

Definition at line 63 of file fanout.cpp.

{
    HubPort* Port = HubPort::Create(Hub, Info);
 
    if (Port == NULL)
    {
        DPRINT1("Hub %p port %u create failed\n", Hub->m_Device, Info->PortNumber);
        return FALSE;
    }
 
    DPRINT("Hub %p created port %u (%p), protocol 0x%x\n",
           Hub->m_Device, Info->PortNumber, Port, Info->Protocol);
 
    InsertTailList(&Hub->m_Mux.Ports, &Port->m_HubLink);
    Hub->m_Mux.PortCount++;
    return TRUE;
}

Referenced by _IRQL_requires_().

HubClampTierDepth()

static ULONG NTAPI HubClampTierDepth ( _In_ ULONG  Depth )

static

Definition at line 26 of file fanout.cpp.

{
    return (Depth == 0 || Depth > 5) ? 5 : Depth;
}

Referenced by _IRQL_requires_().

HubDescriptorSaysFixed()

static BOOLEAN NTAPI HubDescriptorSaysFixed ( _In_ const UCHAR *  Bitmap, _In_ ULONG  PortNumber  )

static

Definition at line 101 of file fanout.cpp.

{
    return (Bitmap[PortNumber / 8] & (1 << (PortNumber % 8))) != 0;
}

Referenced by _IRQL_requires_().

HubTrackPortRange()

static VOID NTAPI HubTrackPortRange ( _In_ USHORT  PortNumber, _Inout_ PUSHORT  First, _Inout_ PUSHORT  Last  )

static

Definition at line 86 of file fanout.cpp.

{
    if (PortNumber < *First)
        *First = PortNumber;
    if (PortNumber > *Last)
        *Last = PortNumber;
}

Referenced by _IRQL_requires_().

Variable Documentation

HubTagPnpPower

const char HubTagPnpPower[] = "hub child pnp power"

static

Definition at line 20 of file fanout.cpp.

Referenced by HubFdo::QueuePowerDownToDevices(), and HubFdo::QueuePowerUpToDevices().

HubTagRegistration

const char HubTagRegistration[] = "hub child registration"

static

Definition at line 19 of file fanout.cpp.

Referenced by HubFdo::RegisterDevice(), and HubFdo::UnregisterDevice().