hid.c File Reference

#include "precomp.h"
#include <stdarg.h>
#include <winbase.h>
#include <debug.h>
#include "hidp.h"

Include dependency graph for hid.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
PVOID NTAPI	AllocFunction (IN ULONG ItemSize)
VOID NTAPI	FreeFunction (IN PVOID Item)
VOID NTAPI	ZeroFunction (IN PVOID Item, IN ULONG ItemSize)
VOID NTAPI	CopyFunction (IN PVOID Target, IN PVOID Source, IN ULONG Length)
VOID __cdecl	DebugFunction (IN LPCSTR FormatStr,...)
BOOL WINAPI	DllMain (HINSTANCE hinstDLL, DWORD dwReason, LPVOID lpvReserved)
HIDAPI BOOLEAN WINAPI	HidD_FlushQueue (IN HANDLE HidDeviceObject)
HIDAPI BOOLEAN WINAPI	HidD_FreePreparsedData (IN PHIDP_PREPARSED_DATA PreparsedData)
HIDAPI BOOLEAN WINAPI	HidD_GetAttributes (IN HANDLE HidDeviceObject, OUT PHIDD_ATTRIBUTES Attributes)
HIDAPI BOOLEAN WINAPI	HidD_GetFeature (IN HANDLE HidDeviceObject, OUT PVOID ReportBuffer, IN ULONG ReportBufferLength)
HIDAPI VOID WINAPI	HidD_GetHidGuid (OUT LPGUID HidGuid)
HIDAPI BOOLEAN WINAPI	HidD_GetInputReport (IN HANDLE HidDeviceObject, IN OUT PVOID ReportBuffer, IN ULONG ReportBufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetManufacturerString (IN HANDLE HidDeviceObject, OUT PVOID Buffer, IN ULONG BufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetNumInputBuffers (IN HANDLE HidDeviceObject, OUT PULONG NumberBuffers)
HIDAPI BOOLEAN WINAPI	HidD_GetPhysicalDescriptor (IN HANDLE HidDeviceObject, OUT PVOID Buffer, IN ULONG BufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetPreparsedData (IN HANDLE HidDeviceObject, OUT PHIDP_PREPARSED_DATA *PreparsedData)
HIDAPI BOOLEAN WINAPI	HidD_GetProductString (IN HANDLE HidDeviceObject, OUT PVOID Buffer, IN ULONG BufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetSerialNumberString (IN HANDLE HidDeviceObject, OUT PVOID Buffer, IN ULONG BufferLength)
HIDAPI ULONG WINAPI	HidD_Hello (OUT PCHAR Buffer, IN ULONG BufferLength)
HIDAPI BOOLEAN WINAPI	HidD_SetFeature (IN HANDLE HidDeviceObject, IN PVOID ReportBuffer, IN ULONG ReportBufferLength)
HIDAPI BOOLEAN WINAPI	HidD_SetNumInputBuffers (IN HANDLE HidDeviceObject, IN ULONG NumberBuffers)
HIDAPI BOOLEAN WINAPI	HidD_SetOutputReport (IN HANDLE HidDeviceObject, IN PVOID ReportBuffer, IN ULONG ReportBufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetIndexedString (IN HANDLE HidDeviceObject, IN ULONG StringIndex, OUT PVOID Buffer, IN ULONG BufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetMsGenreDescriptor (IN HANDLE HidDeviceObject, OUT PVOID Buffer, IN ULONG BufferLength)
HIDAPI BOOLEAN WINAPI	HidD_GetConfiguration (IN HANDLE HidDeviceObject, OUT PHIDD_CONFIGURATION Configuration, IN ULONG ConfigurationLength)
HIDAPI BOOLEAN WINAPI	HidD_SetConfiguration (IN HANDLE HidDeviceObject, IN PHIDD_CONFIGURATION Configuration, IN ULONG ConfigurationLength)

Variables
HINSTANCE	hDllInstance
const GUID	HidClassGuid = {0x4D1E55B2, 0xF16F, 0x11CF, {0x88,0xCB,0x00,0x11,0x11,0x00,0x00,0x30}}

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 34 of file hid.c.

Function Documentation

AllocFunction()

PVOID NTAPI AllocFunction

(

IN ULONG

ItemSize

)

Definition at line 45 of file hid.c.

{
    return LocalAlloc(LHND, ItemSize);
}

Referenced by BuildUSBAudioFilterTopology(), FilterAudioVolumeHandler(), HidParser_AddCollection(), HidParser_AddReportToCollection(), HidParser_AllocateCollection(), HidParser_AllocateReport(), HidParser_BuildContext(), HidParser_GetCollectionDescription(), HidParser_ParseReportDescriptor(), HidParser_ReserveReportItems(), InitCapturePin(), InitStreamPin(), RenderInitializeUrbAndIrp(), UsbAudioAllocCaptureUrbIso(), USBAudioCreateFilterContext(), USBAudioFilterCreate(), UsbAudioGetDataRanges(), USBAudioGetDescriptor(), UsbAudioGetSetProperty(), USBAudioPinBuildDescriptors(), USBAudioPinCreate(), USBAudioPnPStart(), USBAudioSelectAudioStreamingInterface(), USBAudioSelectConfiguration(), UsbAudioSetFormat(), and USBAudioStartDevice().

CopyFunction()

VOID NTAPI CopyFunction	(	IN PVOID	Target,
		IN PVOID	Source,
		IN ULONG	Length
	)

Definition at line 70 of file hid.c.

{
    memcpy(Target, Source, Length);
}

DebugFunction()

VOID __cdecl DebugFunction	(	IN LPCSTR	FormatStr,
			...
	)

Definition at line 80 of file hid.c.

{
#if 0
    va_arg list;
    va_start(list, FormatStr);
    vDbgPrintEx(FormatStr, list);
    va_end(list);
#endif
}

Referenced by HidParser_AllocateCollection(), HidParser_GetCollection(), HidParser_GetCollectionDescription(), and HidParser_ParseReportDescriptor().

DllMain()

BOOL WINAPI DllMain	(	HINSTANCE	hinstDLL,
		DWORD	dwReason,
		LPVOID	lpvReserved
	)

Definition at line 92 of file hid.c.

{
  switch(dwReason)
  {
    case DLL_PROCESS_ATTACH:
      hDllInstance = hinstDLL;
      break;
 
    case DLL_THREAD_ATTACH:
      break;
 
    case DLL_THREAD_DETACH:
      break;
 
    case DLL_PROCESS_DETACH:
      break;
  }
  return TRUE;
}

FreeFunction()

VOID NTAPI FreeFunction

(

IN PVOID

Item

)

Definition at line 53 of file hid.c.

{
    LocalFree((HLOCAL)Item);
}

Referenced by FilterAudioVolumeHandler(), HidParser_AddCollection(), HidParser_AddReportToCollection(), HidParser_FreeCollectionDescription(), HidParser_GetCollectionDescription(), HidParser_GetReport(), HidParser_ParseReportDescriptor(), USBAudioCreateFilterContext(), USBAudioGetDescriptor(), UsbAudioGetSetProperty(), USBAudioInitComponentId(), UsbAudioRenderComplete(), USBAudioSelectAudioStreamingInterface(), USBAudioSelectConfiguration(), UsbAudioSetFormat(), and USBAudioStartDevice().

HidD_FlushQueue()

HIDAPI BOOLEAN WINAPI HidD_FlushQueue

(

IN HANDLE

HidDeviceObject

)

Definition at line 122 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_FLUSH_QUEUE,
                         NULL, 0,
                         NULL, 0,
                         &RetLen, NULL) != 0;
}

HidD_FreePreparsedData()

HIDAPI BOOLEAN WINAPI HidD_FreePreparsedData

(

IN PHIDP_PREPARSED_DATA

PreparsedData

)

Definition at line 139 of file hid.c.

{
  return (LocalFree((HLOCAL)PreparsedData) == NULL);
}

Referenced by get_device(), test_device_info(), test_get_input_report(), and test_read_device().

HidD_GetAttributes()

HIDAPI BOOLEAN WINAPI HidD_GetAttributes	(	IN HANDLE	HidDeviceObject,
		OUT PHIDD_ATTRIBUTES	Attributes
	)

Definition at line 152 of file hid.c.

{
  HID_COLLECTION_INFORMATION hci;
  DWORD RetLen;
 
  if(!DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_COLLECTION_INFORMATION,
                                       NULL, 0,
                                       &hci, sizeof(HID_COLLECTION_INFORMATION),
                                       &RetLen, NULL))
  {
    return FALSE;
  }
 
  /* copy the fields */
  Attributes->Size = sizeof(HIDD_ATTRIBUTES);
  Attributes->VendorID = hci.VendorID;
  Attributes->ProductID = hci.ProductID;
  Attributes->VersionNumber = hci.VersionNumber;
 
  return TRUE;
}

Referenced by test_device_info().

HidD_GetConfiguration()

HIDAPI BOOLEAN WINAPI HidD_GetConfiguration	(	IN HANDLE	HidDeviceObject,
		OUT PHIDD_CONFIGURATION	Configuration,
		IN ULONG	ConfigurationLength
	)

Definition at line 502 of file hid.c.

{
 
  // magic cookie
  Configuration->cookie = (PVOID)HidD_GetConfiguration;
 
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_DRIVER_CONFIG,
                         0, 0,
                         &Configuration->size, ConfigurationLength - sizeof(ULONG),
                         (PULONG)&Configuration->cookie, NULL) != 0;
}

Referenced by HidD_GetConfiguration(), and HidD_SetConfiguration().

HidD_GetFeature()

HIDAPI BOOLEAN WINAPI HidD_GetFeature	(	IN HANDLE	HidDeviceObject,
		OUT PVOID	ReportBuffer,
		IN ULONG	ReportBufferLength
	)

Definition at line 183 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_FEATURE,
                         NULL, 0,
                         ReportBuffer, ReportBufferLength,
                         &RetLen, NULL) != 0;
}

HidD_GetHidGuid()

HIDAPI VOID WINAPI HidD_GetHidGuid

(

OUT LPGUID

HidGuid

)

Definition at line 202 of file hid.c.

{
  *HidGuid = HidClassGuid;
}

Referenced by get_device(), and run_for_each_device().

HidD_GetIndexedString()

HIDAPI BOOLEAN WINAPI HidD_GetIndexedString	(	IN HANDLE	HidDeviceObject,
		IN ULONG	StringIndex,
		OUT PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 465 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_INDEXED_STRING,
                         &StringIndex, sizeof(ULONG),
                         Buffer, BufferLength,
                         &RetLen, NULL) != 0;
}

HidD_GetInputReport()

HIDAPI BOOLEAN WINAPI HidD_GetInputReport	(	IN HANDLE	HidDeviceObject,
		IN OUT PVOID	ReportBuffer,
		IN ULONG	ReportBufferLength
	)

Definition at line 215 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_INPUT_REPORT,
                         NULL, 0,
                         ReportBuffer, ReportBufferLength,
                         &RetLen, NULL) != 0;
}

Referenced by test_get_input_report().

HidD_GetManufacturerString()

HIDAPI BOOLEAN WINAPI HidD_GetManufacturerString	(	IN HANDLE	HidDeviceObject,
		OUT PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 234 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_MANUFACTURER_STRING,
                         NULL, 0,
                         Buffer, BufferLength,
                         &RetLen, NULL) != 0;
}

HidD_GetMsGenreDescriptor()

HIDAPI BOOLEAN WINAPI HidD_GetMsGenreDescriptor	(	IN HANDLE	HidDeviceObject,
		OUT PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 484 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_MS_GENRE_DESCRIPTOR,
                         0, 0,
                         Buffer, BufferLength,
                         &RetLen, NULL) != 0;
}

HidD_GetNumInputBuffers()

HIDAPI BOOLEAN WINAPI HidD_GetNumInputBuffers	(	IN HANDLE	HidDeviceObject,
		OUT PULONG	NumberBuffers
	)

Definition at line 253 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_GET_NUM_DEVICE_INPUT_BUFFERS,
                         NULL, 0,
                         NumberBuffers, sizeof(ULONG),
                         &RetLen, NULL) != 0;
}

HidD_GetPhysicalDescriptor()

HIDAPI BOOLEAN WINAPI HidD_GetPhysicalDescriptor	(	IN HANDLE	HidDeviceObject,
		OUT PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 271 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_GET_PHYSICAL_DESCRIPTOR,
                         NULL, 0,
                         Buffer, BufferLength,
                         &RetLen, NULL) != 0;
}

HidD_GetPreparsedData()

HIDAPI BOOLEAN WINAPI HidD_GetPreparsedData	(	IN HANDLE	HidDeviceObject,
		OUT PHIDP_PREPARSED_DATA *	PreparsedData
	)

Definition at line 290 of file hid.c.

{
  HID_COLLECTION_INFORMATION hci;
  DWORD RetLen;
  BOOLEAN Ret;
 
  if(PreparsedData == NULL)
  {
    return FALSE;
  }
 
  if(!DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_COLLECTION_INFORMATION,
                                       NULL, 0,
                                       &hci, sizeof(HID_COLLECTION_INFORMATION),
                                       &RetLen, NULL))
  {
    return FALSE;
  }
 
  *PreparsedData = LocalAlloc(LHND, hci.DescriptorSize);
  if(*PreparsedData == NULL)
  {
    SetLastError(ERROR_NOT_ENOUGH_MEMORY);
    return FALSE;
  }
 
  Ret = DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_COLLECTION_DESCRIPTOR,
                        NULL, 0,
                        *PreparsedData, hci.DescriptorSize,
                        &RetLen, NULL) != 0;
 
  if(!Ret)
  {
    /* FIXME - Free the buffer in case we failed to get the descriptor? */
    LocalFree((HLOCAL)*PreparsedData);
  }
#if 0
  else
  {
    /* should we truncate the memory in case RetLen < hci.DescriptorSize? */
  }
#endif
 
  return Ret;
}

Referenced by get_device(), test_device_info(), test_get_input_report(), and test_read_device().

HidD_GetProductString()

HIDAPI BOOLEAN WINAPI HidD_GetProductString	(	IN HANDLE	HidDeviceObject,
		OUT PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 345 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_PRODUCT_STRING,
                         NULL, 0,
                         Buffer, BufferLength,
                         &RetLen, NULL) != 0;
}

Referenced by test_device_info(), test_get_input_report(), and test_read_device().

HidD_GetSerialNumberString()

HIDAPI BOOLEAN WINAPI HidD_GetSerialNumberString	(	IN HANDLE	HidDeviceObject,
		OUT PVOID	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 364 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_GET_SERIALNUMBER_STRING,
                         NULL, 0,
                         Buffer, BufferLength,
                         &RetLen, NULL) != 0;
}

HidD_Hello()

HIDAPI ULONG WINAPI HidD_Hello	(	OUT PCHAR	Buffer,
		IN ULONG	BufferLength
	)

Definition at line 389 of file hid.c.

{
  const CHAR HelloString[] = "Hello\n";
 
  if(BufferLength > 0)
  {
    memcpy(Buffer, HelloString, min(sizeof(HelloString), BufferLength));
  }
 
  return sizeof(HelloString);
}

HidD_SetConfiguration()

HIDAPI BOOLEAN WINAPI HidD_SetConfiguration	(	IN HANDLE	HidDeviceObject,
		IN PHIDD_CONFIGURATION	Configuration,
		IN ULONG	ConfigurationLength
	)

Definition at line 523 of file hid.c.

{
    BOOLEAN Ret = FALSE;
 
    if (Configuration->cookie == (PVOID)HidD_GetConfiguration)
    {
        Ret = DeviceIoControl(HidDeviceObject, IOCTL_HID_SET_DRIVER_CONFIG,
                              0, 0,
                              (PVOID)&Configuration->size, ConfigurationLength - sizeof(ULONG),
                              (PULONG)&Configuration->cookie, NULL) != 0;
    }
    else
    {
        SetLastError(ERROR_INVALID_PARAMETER);
    }
 
    return Ret;
}

HidD_SetFeature()

HIDAPI BOOLEAN WINAPI HidD_SetFeature	(	IN HANDLE	HidDeviceObject,
		IN PVOID	ReportBuffer,
		IN ULONG	ReportBufferLength
	)

Definition at line 410 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_SET_FEATURE,
                         ReportBuffer, ReportBufferLength,
                         NULL, 0,
                         &RetLen, NULL) != 0;
}

HidD_SetNumInputBuffers()

HIDAPI BOOLEAN WINAPI HidD_SetNumInputBuffers	(	IN HANDLE	HidDeviceObject,
		IN ULONG	NumberBuffers
	)

Definition at line 429 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_SET_NUM_DEVICE_INPUT_BUFFERS,
                         &NumberBuffers, sizeof(ULONG),
                         NULL, 0,
                         &RetLen, NULL) != 0;
}

HidD_SetOutputReport()

HIDAPI BOOLEAN WINAPI HidD_SetOutputReport	(	IN HANDLE	HidDeviceObject,
		IN PVOID	ReportBuffer,
		IN ULONG	ReportBufferLength
	)

Definition at line 447 of file hid.c.

{
  DWORD RetLen;
  return DeviceIoControl(HidDeviceObject, IOCTL_HID_SET_OUTPUT_REPORT,
                         ReportBuffer, ReportBufferLength,
                         NULL, 0,
                         &RetLen, NULL) != 0;
}

ZeroFunction()

VOID NTAPI ZeroFunction	(	IN PVOID	Item,
		IN ULONG	ItemSize
	)

Definition at line 61 of file hid.c.

{
    memset(Item, 0, ItemSize);
}

Referenced by HidParser_GetCaps(), HidParser_GetCollectionDescription(), HidParser_GetSpecificValueCapsWithReport(), HidParser_GetUsagesWithReport(), and HidParser_ParseReportDescriptor().

Variable Documentation

hDllInstance

HINSTANCE hDllInstance

Definition at line 38 of file hid.c.

Referenced by DllMain().

HidClassGuid

const GUID HidClassGuid = {0x4D1E55B2, 0xF16F, 0x11CF, {0x88,0xCB,0x00,0x11,0x11,0x00,0x00,0x30}}

Definition at line 41 of file hid.c.

Referenced by HidD_GetHidGuid().