hidusb.h File Reference

#include <ntddk.h>
#include <hidport.h>
#include <debug.h>
#include <hubbusif.h>
#include <usbbusif.h>
#include <usbioctl.h>
#include <usb.h>
#include <usbdlib.h>

Include dependency graph for hidusb.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	HID_USB_DEVICE_EXTENSION
struct	HID_USB_RESET_CONTEXT

Macros
#define	_HIDPI_
#define	_HIDPI_NO_FUNCTION_MACROS_
#define	NDEBUG
#define	USB_SET_IDLE_REQUEST   0xA
#define	USB_GET_PROTOCOL_REQUEST   0x3
#define	HIDUSB_TAG   'UdiH'
#define	HIDUSB_URB_TAG   'rUiH'

Typedefs
typedef struct HID_USB_DEVICE_EXTENSION *	PHID_USB_DEVICE_EXTENSION
typedef struct HID_USB_RESET_CONTEXT *	PHID_USB_RESET_CONTEXT

Functions
NTSTATUS	Hid_GetDescriptor (IN PDEVICE_OBJECT DeviceObject, IN USHORT UrbFunction, IN USHORT UrbLength, IN OUT PVOID *UrbBuffer, IN OUT PULONG UrbBufferLength, IN UCHAR DescriptorType, IN UCHAR Index, IN USHORT LanguageIndex)
NTSTATUS	Hid_DispatchUrb (IN PDEVICE_OBJECT DeviceObject, IN PURB Urb)

Macro Definition Documentation

_HIDPI_

#define _HIDPI_

Definition at line 3 of file hidusb.h.

_HIDPI_NO_FUNCTION_MACROS_

#define _HIDPI_NO_FUNCTION_MACROS_

Definition at line 4 of file hidusb.h.

HIDUSB_TAG

#define HIDUSB_TAG   'UdiH'

Definition at line 90 of file hidusb.h.

HIDUSB_URB_TAG

#define HIDUSB_URB_TAG   'rUiH'

Definition at line 91 of file hidusb.h.

NDEBUG

#define NDEBUG

Definition at line 5 of file hidusb.h.

USB_GET_PROTOCOL_REQUEST

#define USB_GET_PROTOCOL_REQUEST   0x3

Definition at line 88 of file hidusb.h.

USB_SET_IDLE_REQUEST

#define USB_SET_IDLE_REQUEST   0xA

Definition at line 87 of file hidusb.h.

Typedef Documentation

PHID_USB_DEVICE_EXTENSION

typedef struct HID_USB_DEVICE_EXTENSION * PHID_USB_DEVICE_EXTENSION

PHID_USB_RESET_CONTEXT

typedef struct HID_USB_RESET_CONTEXT * PHID_USB_RESET_CONTEXT

Function Documentation

Hid_DispatchUrb()

NTSTATUS Hid_DispatchUrb	(	IN PDEVICE_OBJECT	DeviceObject,
		IN PURB	Urb
	)

Definition at line 960 of file hidusb.c.

{
    PIRP Irp;
    KEVENT Event;
    PHID_DEVICE_EXTENSION DeviceExtension;
    IO_STATUS_BLOCK IoStatus;
    PIO_STACK_LOCATION IoStack;
    NTSTATUS Status;

    //
    // init event
    //
    KeInitializeEvent(&Event, NotificationEvent, FALSE);

    //
    // get device extension
    //
    DeviceExtension = DeviceObject->DeviceExtension;

    //
    // build irp
    //
    Irp = IoBuildDeviceIoControlRequest(IOCTL_INTERNAL_USB_SUBMIT_URB,
                                        DeviceExtension->NextDeviceObject,
                                        NULL,
                                        0,
                                        NULL,
                                        0,
                                        TRUE,
                                        &Event,
                                        &IoStatus);
    if (!Irp)
    {
        //
        // no memory
        //
        return STATUS_INSUFFICIENT_RESOURCES;
    }

    //
    // get next stack location
    //
    IoStack = IoGetNextIrpStackLocation(Irp);

    //
    // store urb
    //
    IoStack->Parameters.Others.Argument1 = Urb;

    //
    // set completion routine
    //
    IoSetCompletionRoutine(Irp, Hid_PnpCompletion, &Event, TRUE, TRUE, TRUE);

    //
    // call driver
    //
    Status = IoCallDriver(DeviceExtension->NextDeviceObject, Irp);

    //
    // wait for the request to finish
    //
    if (Status == STATUS_PENDING)
    {
        KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, NULL);
    }

    //
    // complete request
    //
    IoCompleteRequest(Irp, IO_NO_INCREMENT);

    if (Status == STATUS_PENDING)
    {
        //
        // get final status
        //
        Status = IoStatus.Status;
    }

    DPRINT("[HIDUSB] DispatchUrb %x\n", Status);


    //
    // done
    //
    return Status;
}

Referenced by Hid_DisableConfiguration(), Hid_GetDescriptor(), Hid_GetProtocol(), Hid_SelectConfiguration(), Hid_SetIdle(), HidUsb_AbortPipe(), and HidUsb_ResetInterruptPipe().

Hid_GetDescriptor()

NTSTATUS Hid_GetDescriptor	(	IN PDEVICE_OBJECT	DeviceObject,
		IN USHORT	UrbFunction,
		IN USHORT	UrbLength,
		IN OUT PVOID *	UrbBuffer,
		IN OUT PULONG	UrbBufferLength,
		IN UCHAR	DescriptorType,
		IN UCHAR	Index,
		IN USHORT	LanguageIndex
	)

Definition at line 1052 of file hidusb.c.

{
    PURB Urb;
    NTSTATUS Status;
    UCHAR Allocated = FALSE;

    //
    // allocate urb
    //
    Urb = ExAllocatePoolWithTag(NonPagedPool, UrbLength, HIDUSB_URB_TAG);
    if (!Urb)
    {
        //
        // no memory
        //
        return STATUS_INSUFFICIENT_RESOURCES;
    }

    //
    // is there an urb buffer
    //
    if (!*UrbBuffer)
    {
        //
        // allocate buffer
        //
        *UrbBuffer = ExAllocatePoolWithTag(NonPagedPool, *UrbBufferLength, HIDUSB_TAG);
        if (!*UrbBuffer)
        {
            //
            // no memory
            //
            ExFreePoolWithTag(Urb, HIDUSB_URB_TAG);
            return STATUS_INSUFFICIENT_RESOURCES;
        }

        //
        // zero buffer
        //
        RtlZeroMemory(*UrbBuffer, *UrbBufferLength);
        Allocated = TRUE;
    }

    //
    // zero urb
    //
    RtlZeroMemory(Urb, UrbLength);

    //
    // build descriptor request
    //
    UsbBuildGetDescriptorRequest(Urb, UrbLength, DescriptorType, Index, LanguageIndex, *UrbBuffer, NULL, *UrbBufferLength, NULL);

    //
    // set urb function
    //
    Urb->UrbHeader.Function = UrbFunction;

    //
    // dispatch urb
    //
    Status = Hid_DispatchUrb(DeviceObject, Urb);

    //
    // did the request fail
    //
    if (!NT_SUCCESS(Status))
    {
        if (Allocated)
        {
            //
            // free allocated buffer
            //
            ExFreePoolWithTag(*UrbBuffer, HIDUSB_TAG);
            *UrbBuffer = NULL;
        }

        //
        // free urb
        //
        ExFreePoolWithTag(Urb, HIDUSB_URB_TAG);
        *UrbBufferLength = 0;
        return Status;
    }

    //
    // did urb request fail
    //
    if (!NT_SUCCESS(Urb->UrbHeader.Status))
    {
        if (Allocated)
        {
            //
            // free allocated buffer
            //
            ExFreePoolWithTag(*UrbBuffer, HIDUSB_TAG);
            *UrbBuffer = NULL;
        }

        //
        // free urb
        //
        ExFreePoolWithTag(Urb, HIDUSB_URB_TAG);
        *UrbBufferLength = 0;
        return STATUS_UNSUCCESSFUL;
    }

    //
    // store result length
    //
    *UrbBufferLength = Urb->UrbControlDescriptorRequest.TransferBufferLength;

    //
    // free urb
    //
    ExFreePoolWithTag(Urb, HIDUSB_URB_TAG);

    //
    // completed successfully
    //
    return STATUS_SUCCESS;
}

Referenced by Hid_PnpStart(), and HidUsb_GetReportDescriptor().