hubdrom.cpp File Reference

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

Include dependency graph for hubdrom.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	HUB_MAILBOX_READ_TYPE   0xC0
#define	HUB_MAILBOX_WRITE_TYPE   0x40
#define	HUB_MAILBOX_READ_REQUEST   0x40
#define	HUB_MAILBOX_WRITE_REQUEST   0x41
#define	HUB_MAILBOX_SPACE   0x0400
#define	HUB_VERIFIER_CONTROL_FAILURE   0x00000002
#define	DROM_VERSION_OFFSET   13
#define	DROM_LENGTH_OFFSET   14
#define	DROM_LENGTH_MASK   0x0FFF
#define	DROM_FIRST_ENTRY   22
#define	DROM_ENTRY_HEADER   2
#define	DROM_ENTRY_ADAPTER   0x80
#define	DROM_ENTRY_TYPE_MASK   0x3F
#define	DROM_ENTRY_TYPE_IDENTITY   9
#define	DROM_IDENTITY_VENDOR   4
#define	DROM_IDENTITY_PRODUCT   6
#define	DROM_IDENTITY_BCD   8
#define	DROM_IDENTITY_REVISION   14
#define	DROM_IDENTITY_LENGTH   15

Functions
static VOID NTAPI	HubMailboxComplete (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS Params, _In_ WDFCONTEXT Context)
static VOID NTAPI	HubMailboxTransfer (_In_ HubFdo *Hub, _In_ BOOLEAN Write, _In_ USHORT Register)
static USHORT NTAPI	HubDromReadUshort (_In_reads_bytes_(2) const UCHAR *Bytes)
	_IRQL_requires_ (PASSIVE_LEVEL) VOID NTAPI HubDromReportFirmwareUpdateDevice(_In_ HubFdo *Hub)
	The firmware update child is not supported, so the IDs it would report are only printed.

Variables
static EVT_WDF_REQUEST_COMPLETION_ROUTINE	HubMailboxComplete

Macro Definition Documentation

DROM_ENTRY_ADAPTER

#define DROM_ENTRY_ADAPTER   0x80

Definition at line 29 of file hubdrom.cpp.

DROM_ENTRY_HEADER

#define DROM_ENTRY_HEADER   2

Definition at line 28 of file hubdrom.cpp.

DROM_ENTRY_TYPE_IDENTITY

#define DROM_ENTRY_TYPE_IDENTITY   9

Definition at line 31 of file hubdrom.cpp.

DROM_ENTRY_TYPE_MASK

#define DROM_ENTRY_TYPE_MASK   0x3F

Definition at line 30 of file hubdrom.cpp.

DROM_FIRST_ENTRY

#define DROM_FIRST_ENTRY   22

Definition at line 27 of file hubdrom.cpp.

DROM_IDENTITY_BCD

#define DROM_IDENTITY_BCD   8

Definition at line 36 of file hubdrom.cpp.

DROM_IDENTITY_LENGTH

#define DROM_IDENTITY_LENGTH   15

Definition at line 38 of file hubdrom.cpp.

DROM_IDENTITY_PRODUCT

#define DROM_IDENTITY_PRODUCT   6

Definition at line 35 of file hubdrom.cpp.

DROM_IDENTITY_REVISION

#define DROM_IDENTITY_REVISION   14

Definition at line 37 of file hubdrom.cpp.

DROM_IDENTITY_VENDOR

#define DROM_IDENTITY_VENDOR   4

Definition at line 34 of file hubdrom.cpp.

DROM_LENGTH_MASK

#define DROM_LENGTH_MASK   0x0FFF

Definition at line 26 of file hubdrom.cpp.

DROM_LENGTH_OFFSET

#define DROM_LENGTH_OFFSET   14

Definition at line 25 of file hubdrom.cpp.

DROM_VERSION_OFFSET

#define DROM_VERSION_OFFSET   13

Definition at line 24 of file hubdrom.cpp.

HUB_MAILBOX_READ_REQUEST

#define HUB_MAILBOX_READ_REQUEST   0x40

Definition at line 16 of file hubdrom.cpp.

HUB_MAILBOX_READ_TYPE

#define HUB_MAILBOX_READ_TYPE   0xC0

Definition at line 14 of file hubdrom.cpp.

HUB_MAILBOX_SPACE

#define HUB_MAILBOX_SPACE   0x0400

Definition at line 18 of file hubdrom.cpp.

HUB_MAILBOX_WRITE_REQUEST

#define HUB_MAILBOX_WRITE_REQUEST   0x41

Definition at line 17 of file hubdrom.cpp.

HUB_MAILBOX_WRITE_TYPE

#define HUB_MAILBOX_WRITE_TYPE   0x40

Definition at line 15 of file hubdrom.cpp.

HUB_VERIFIER_CONTROL_FAILURE

#define HUB_VERIFIER_CONTROL_FAILURE   0x00000002

Definition at line 21 of file hubdrom.cpp.

NDEBUG

#define NDEBUG

Definition at line 10 of file hubdrom.cpp.

Function Documentation

_IRQL_requires_()

_IRQL_requires_

(

PASSIVE_LEVEL

)

The firmware update child is not supported, so the IDs it would report are only printed.

Sends a synchronous IOCTL to the specified device object.

Definition at line 256 of file hubdrom.cpp.

{
    const HubRouterIdentity* Identity = &Hub->m_RouterIdentity;
 
    if (!Identity->Known || Hub->IsRootHub() || Hub->m_FwUpdateProtocol == 0)
        return;
 
    DPRINT1("Hub %p firmware update device USB\\VID_%04X&PID_%04X&BCD_%04X&REV_%04X&GFU is not supported\n",
            Hub, Identity->VendorId, Identity->ProductId, Identity->BcdDevice, Identity->Revision);
}

HubDromReadUshort()

static USHORT NTAPI HubDromReadUshort ( _In_reads_bytes_(2) const UCHAR *  Bytes )

static

Definition at line 106 of file hubdrom.cpp.

{
    return (USHORT)(Bytes[0] | (Bytes[1] << 8));
}

Referenced by HubMachine::DromDataLength(), and HubMachine::ParseDromIdentity().

HubMailboxComplete()

static VOID NTAPI HubMailboxComplete ( _In_ WDFREQUEST  Request, _In_ WDFIOTARGET  Target, _In_ PWDF_REQUEST_COMPLETION_PARAMS  Params, _In_ WDFCONTEXT  Context  )

static

Definition at line 45 of file hubdrom.cpp.

{
    HubFdo* Hub = (HubFdo*)Context;
    NTSTATUS Status = Params->IoStatus.Status;
 
    UNREFERENCED_PARAMETER(Request);
    UNREFERENCED_PARAMETER(Target);
 
    Hub->m_Control.Reuse();
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p mailbox register %u access failed 0x%lx, URB status 0x%lx\n",
                Hub, Hub->m_Control.Urb.SetupPacket[4], Status, Hub->m_Control.Urb.Hdr.Status);
 
        Hub->Post(HubEvent::TransferFailed);
        return;
    }
 
    Hub->Post(HubEvent::TransferDone);
}

HubMailboxTransfer()

static VOID NTAPI HubMailboxTransfer ( _In_ HubFdo *  Hub, _In_ BOOLEAN  Write, _In_ USHORT  Register  )

static

Definition at line 75 of file hubdrom.cpp.

{
    NTSTATUS Status;
 
    Hub->m_Control.SetSetup(Write ? HUB_MAILBOX_WRITE_TYPE : HUB_MAILBOX_READ_TYPE,
                            Write ? HUB_MAILBOX_WRITE_REQUEST : HUB_MAILBOX_READ_REQUEST,
                            HUB_MAILBOX_SPACE,
                            Register,
                            sizeof(Hub->m_DromMailbox));
 
    Status = Hub->m_Control.Send(Hub->m_RootHubTarget,
                                 Hub->UsbDevice(),
                                 HubMailboxComplete,
                                 Hub,
                                 &Hub->m_DromMailbox,
                                 sizeof(Hub->m_DromMailbox),
                                 FALSE,
                                 Hub->NeedsForwardProgress());
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p mailbox register %u %s not sent 0x%lx\n", Hub, Register, Write ? "write" : "read", Status);
        Hub->Post(HubEvent::TransferFailed);
    }
}

Referenced by HubMachine::ReadDromRegister(), and HubMachine::WriteDromRegister().

Variable Documentation

HubMailboxComplete

EVT_WDF_REQUEST_COMPLETION_ROUTINE HubMailboxComplete

static

Definition at line 40 of file hubdrom.cpp.

Referenced by HubMailboxTransfer().