parser.h File Reference

#include <wdm.h>
#include <hidpddi.h>
#include "hidparser.h"
#include "hidp.h"
#include <pshpack1.h>
#include <poppack.h>

Include dependency graph for parser.h:

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

Go to the source code of this file.

Classes
struct	ITEM_PREFIX
struct	SHORT_ITEM
struct	LONG_ITEM
struct	MAIN_ITEM_DATA
struct	__GLOBAL_ITEM_STATE_
struct	usage_value
struct	LOCAL_ITEM_STATE
struct	HID_REPORT_ITEM
struct	__HID_COLLECTION__
struct	_HID_REPORT
struct	HID_PARSER_CONTEXT

Macros
#define	_HIDPI_
#define	_HIDPI_NO_FUNCTION_MACROS_
#define	HID_REPORT_TYPE_ANY   0x07
#define	ITEM_TYPE_MAIN   0x0
#define	ITEM_TYPE_GLOBAL   0x1
#define	ITEM_TYPE_LOCAL   0x2
#define	ITEM_TYPE_LONG   0x3
#define	ITEM_TAG_MAIN_INPUT   0x8
#define	ITEM_TAG_MAIN_OUTPUT   0x9
#define	ITEM_TAG_MAIN_FEATURE   0xb
#define	ITEM_TAG_MAIN_COLLECTION   0xa
#define	ITEM_TAG_MAIN_END_COLLECTION   0xc
#define	ITEM_TAG_GLOBAL_USAGE_PAGE   0x0
#define	ITEM_TAG_GLOBAL_LOGICAL_MINIMUM   0x1
#define	ITEM_TAG_GLOBAL_LOGICAL_MAXIMUM   0x2
#define	ITEM_TAG_GLOBAL_PHYSICAL_MINIMUM   0x3
#define	ITEM_TAG_GLOBAL_PHYSICAL_MAXIMUM   0x4
#define	ITEM_TAG_GLOBAL_UNIT_EXPONENT   0x5
#define	ITEM_TAG_GLOBAL_UNIT   0x6
#define	ITEM_TAG_GLOBAL_REPORT_SIZE   0x7
#define	ITEM_TAG_GLOBAL_REPORT_ID   0x8
#define	ITEM_TAG_GLOBAL_REPORT_COUNT   0x9
#define	ITEM_TAG_GLOBAL_PUSH   0xa
#define	ITEM_TAG_GLOBAL_POP   0xb
#define	ITEM_TAG_LOCAL_USAGE   0x0
#define	ITEM_TAG_LOCAL_USAGE_MINIMUM   0x1
#define	ITEM_TAG_LOCAL_USAGE_MAXIMUM   0x2
#define	ITEM_TAG_LOCAL_DESIGNATOR_INDEX   0x3
#define	ITEM_TAG_LOCAL_DESIGNATOR_MINIMUM   0x4
#define	ITEM_TAG_LOCAL_DESIGNATOR_MAXIMUM   0x5
#define	ITEM_TAG_LOCAL_STRING_INDEX   0x7
#define	ITEM_TAG_LOCAL_STRING_MINIMUM   0x8
#define	ITEM_TAG_LOCAL_STRING_MAXIMUM   0x9
#define	ITEM_TAG_LOCAL_DELIMITER   0xa
#define	ITEM_TAG_LONG   0xf
#define	COLLECTION_PHYSICAL   0x00
#define	COLLECTION_APPLICATION   0x01
#define	COLLECTION_LOGICAL   0x02
#define	COLLECTION_REPORT   0x03
#define	COLLECTION_NAMED_ARRAY   0x04
#define	COLLECTION_USAGE_SWITCH   0x05
#define	COLLECTION_USAGE_MODIFIER   0x06
#define	COLLECTION_ALL   0xff
#define	UNIT_SYSTEM   0x0
#define	UNIT_LENGTH   0x1
#define	UNIT_MASS   0x2
#define	UNIT_TIME   0x3
#define	UNIT_TEMPERATURE   0x4
#define	UNIT_CURRENT   0x5
#define	UNIT_LUMINOUS_INTENSITY   0x6
#define	USAGE_PAGE_SHIFT   16
#define	USAGE_PAGE_MASK   0xffff
#define	USAGE_ID_SHIFT   0
#define	USAGE_ID_MASK   0xffff
#define	LBITFIELD9(b1, b2, b3, b4, b5, b6, b7, b8, b9)   USHORT b9,b8,b7,b6,b5,b4,b3,b2,b1
#define	HID_REPORT_TYPE_INPUT   0x01
#define	HID_REPORT_TYPE_OUTPUT   0x02
#define	HID_REPORT_TYPE_FEATURE   0x04

Typedefs
typedef struct ITEM_PREFIX *	PITEM_PREFIX
typedef struct SHORT_ITEM *	PSHORT_ITEM
typedef struct LONG_ITEM *	PLONG_ITEM
typedef struct MAIN_ITEM_DATA *	PMAIN_ITEM_DATA
typedef struct __GLOBAL_ITEM_STATE_	GLOBAL_ITEM_STATE
typedef struct __GLOBAL_ITEM_STATE_ *	PGLOBAL_ITEM_STATE
typedef struct usage_value	USAGE_VALUE
typedef struct usage_value *	PUSAGE_VALUE
typedef struct LOCAL_ITEM_STATE *	PLOCAL_ITEM_STATE
typedef struct HID_REPORT_ITEM *	PHID_REPORT_ITEM
typedef struct __HID_COLLECTION__	HID_COLLECTION
typedef struct __HID_COLLECTION__ *	PHID_COLLECTION
typedef struct _HID_REPORT	HID_REPORT
typedef struct _HID_REPORT *	PHID_REPORT
typedef struct HID_PARSER_CONTEXT *	PHID_PARSER_CONTEXT

Functions
ULONG	HidParser_UsesReportId (IN PVOID CollectionContext, IN UCHAR ReportType)
NTSTATUS	HidParser_GetCollectionUsagePage (IN PVOID CollectionContext, OUT PUSHORT Usage, OUT PUSHORT UsagePage)
ULONG	HidParser_GetReportLength (IN PVOID CollectionContext, IN UCHAR ReportType)
ULONG	HidParser_GetReportItemCountFromReportType (IN PVOID CollectionContext, IN UCHAR ReportType)
ULONG	HidParser_GetReportItemTypeCountFromReportType (IN PVOID CollectionContext, IN UCHAR ReportType, IN ULONG bData)
ULONG	HidParser_GetMaxUsageListLengthWithReportAndPage (IN PVOID CollectionContext, IN UCHAR ReportType, IN USAGE UsagePage OPTIONAL)
NTSTATUS	HidParser_GetSpecificValueCapsWithReport (IN PVOID CollectionContext, IN UCHAR ReportType, IN USHORT UsagePage, IN USHORT Usage, OUT PHIDP_VALUE_CAPS ValueCaps, IN OUT PUSHORT ValueCapsLength)
NTSTATUS	HidParser_GetUsagesWithReport (IN PVOID CollectionContext, IN UCHAR ReportType, IN USAGE UsagePage, OUT USAGE *UsageList, IN OUT PULONG UsageLength, IN PCHAR ReportDescriptor, IN ULONG ReportDescriptorLength)
NTSTATUS	HidParser_GetScaledUsageValueWithReport (IN PVOID CollectionContext, IN UCHAR ReportType, IN USAGE UsagePage, IN USAGE Usage, OUT PLONG UsageValue, IN PCHAR ReportDescriptor, IN ULONG ReportDescriptorLength)
NTSTATUS	HidParser_GetUsageValueWithReport (IN PVOID CollectionContext, IN UCHAR ReportType, IN USAGE UsagePage, IN USAGE Usage, OUT PULONG UsageValue, IN PCHAR ReportDescriptor, IN ULONG ReportDescriptorLength)
NTSTATUS	HidParser_BuildContext (IN PVOID ParserContext, IN ULONG CollectionIndex, IN ULONG ContextSize, OUT PVOID *CollectionContext)
ULONG	HidParser_CalculateContextSize (IN PHID_COLLECTION Collection)
NTSTATUS	HidParser_ParseReportDescriptor (PUCHAR Report, ULONG ReportSize, OUT PVOID *ParserContext)
ULONG	HidParser_NumberOfTopCollections (IN PVOID ParserContext)
ULONG	HidParser_GetContextSize (IN PVOID ParserContext, IN ULONG CollectionNumber)
PHID_COLLECTION	HidParser_GetCollectionFromContext (IN PVOID Context)
ULONG	HidParser_GetTotalCollectionCount (IN PVOID CollectionContext)
NTSTATUS	HidParser_BuildCollectionContext (IN PHID_COLLECTION RootCollection, IN PVOID Context, IN ULONG ContextSize)
PHID_REPORT	HidParser_GetReportInCollection (IN PVOID Context, IN UCHAR ReportType)

Macro Definition Documentation

_HIDPI_

#define _HIDPI_

Definition at line 5 of file parser.h.

_HIDPI_NO_FUNCTION_MACROS_

#define _HIDPI_NO_FUNCTION_MACROS_

Definition at line 6 of file parser.h.

COLLECTION_ALL

#define COLLECTION_ALL   0xff

Definition at line 64 of file parser.h.

COLLECTION_APPLICATION

#define COLLECTION_APPLICATION   0x01

Definition at line 58 of file parser.h.

COLLECTION_LOGICAL

#define COLLECTION_LOGICAL   0x02

Definition at line 59 of file parser.h.

COLLECTION_NAMED_ARRAY

#define COLLECTION_NAMED_ARRAY   0x04

Definition at line 61 of file parser.h.

COLLECTION_PHYSICAL

#define COLLECTION_PHYSICAL   0x00

Definition at line 57 of file parser.h.

COLLECTION_REPORT

#define COLLECTION_REPORT   0x03

Definition at line 60 of file parser.h.

COLLECTION_USAGE_MODIFIER

#define COLLECTION_USAGE_MODIFIER   0x06

Definition at line 63 of file parser.h.

COLLECTION_USAGE_SWITCH

#define COLLECTION_USAGE_SWITCH   0x05

Definition at line 62 of file parser.h.

HID_REPORT_TYPE_ANY

#define HID_REPORT_TYPE_ANY   0x07

Definition at line 17 of file parser.h.

HID_REPORT_TYPE_FEATURE

#define HID_REPORT_TYPE_FEATURE   0x04

Definition at line 263 of file parser.h.

HID_REPORT_TYPE_INPUT

#define HID_REPORT_TYPE_INPUT   0x01

Definition at line 261 of file parser.h.

HID_REPORT_TYPE_OUTPUT

#define HID_REPORT_TYPE_OUTPUT   0x02

Definition at line 262 of file parser.h.

ITEM_TAG_GLOBAL_LOGICAL_MAXIMUM

#define ITEM_TAG_GLOBAL_LOGICAL_MAXIMUM   0x2

Definition at line 33 of file parser.h.

ITEM_TAG_GLOBAL_LOGICAL_MINIMUM

#define ITEM_TAG_GLOBAL_LOGICAL_MINIMUM   0x1

Definition at line 32 of file parser.h.

ITEM_TAG_GLOBAL_PHYSICAL_MAXIMUM

#define ITEM_TAG_GLOBAL_PHYSICAL_MAXIMUM   0x4

Definition at line 35 of file parser.h.

ITEM_TAG_GLOBAL_PHYSICAL_MINIMUM

#define ITEM_TAG_GLOBAL_PHYSICAL_MINIMUM   0x3

Definition at line 34 of file parser.h.

ITEM_TAG_GLOBAL_POP

#define ITEM_TAG_GLOBAL_POP   0xb

Definition at line 42 of file parser.h.

ITEM_TAG_GLOBAL_PUSH

#define ITEM_TAG_GLOBAL_PUSH   0xa

Definition at line 41 of file parser.h.

ITEM_TAG_GLOBAL_REPORT_COUNT

#define ITEM_TAG_GLOBAL_REPORT_COUNT   0x9

Definition at line 40 of file parser.h.

ITEM_TAG_GLOBAL_REPORT_ID

#define ITEM_TAG_GLOBAL_REPORT_ID   0x8

Definition at line 39 of file parser.h.

ITEM_TAG_GLOBAL_REPORT_SIZE

#define ITEM_TAG_GLOBAL_REPORT_SIZE   0x7

Definition at line 38 of file parser.h.

ITEM_TAG_GLOBAL_UNIT

#define ITEM_TAG_GLOBAL_UNIT   0x6

Definition at line 37 of file parser.h.

ITEM_TAG_GLOBAL_UNIT_EXPONENT

#define ITEM_TAG_GLOBAL_UNIT_EXPONENT   0x5

Definition at line 36 of file parser.h.

ITEM_TAG_GLOBAL_USAGE_PAGE

#define ITEM_TAG_GLOBAL_USAGE_PAGE   0x0

Definition at line 31 of file parser.h.

ITEM_TAG_LOCAL_DELIMITER

#define ITEM_TAG_LOCAL_DELIMITER   0xa

Definition at line 53 of file parser.h.

ITEM_TAG_LOCAL_DESIGNATOR_INDEX

#define ITEM_TAG_LOCAL_DESIGNATOR_INDEX   0x3

Definition at line 47 of file parser.h.

ITEM_TAG_LOCAL_DESIGNATOR_MAXIMUM

#define ITEM_TAG_LOCAL_DESIGNATOR_MAXIMUM   0x5

Definition at line 49 of file parser.h.

ITEM_TAG_LOCAL_DESIGNATOR_MINIMUM

#define ITEM_TAG_LOCAL_DESIGNATOR_MINIMUM   0x4

Definition at line 48 of file parser.h.

ITEM_TAG_LOCAL_STRING_INDEX

#define ITEM_TAG_LOCAL_STRING_INDEX   0x7

Definition at line 50 of file parser.h.

ITEM_TAG_LOCAL_STRING_MAXIMUM

#define ITEM_TAG_LOCAL_STRING_MAXIMUM   0x9

Definition at line 52 of file parser.h.

ITEM_TAG_LOCAL_STRING_MINIMUM

#define ITEM_TAG_LOCAL_STRING_MINIMUM   0x8

Definition at line 51 of file parser.h.

ITEM_TAG_LOCAL_USAGE

#define ITEM_TAG_LOCAL_USAGE   0x0

Definition at line 44 of file parser.h.

ITEM_TAG_LOCAL_USAGE_MAXIMUM

#define ITEM_TAG_LOCAL_USAGE_MAXIMUM   0x2

Definition at line 46 of file parser.h.

ITEM_TAG_LOCAL_USAGE_MINIMUM

#define ITEM_TAG_LOCAL_USAGE_MINIMUM   0x1

Definition at line 45 of file parser.h.

ITEM_TAG_LONG

#define ITEM_TAG_LONG   0xf

Definition at line 55 of file parser.h.

ITEM_TAG_MAIN_COLLECTION

#define ITEM_TAG_MAIN_COLLECTION   0xa

Definition at line 28 of file parser.h.

ITEM_TAG_MAIN_END_COLLECTION

#define ITEM_TAG_MAIN_END_COLLECTION   0xc

Definition at line 29 of file parser.h.

ITEM_TAG_MAIN_FEATURE

#define ITEM_TAG_MAIN_FEATURE   0xb

Definition at line 27 of file parser.h.

ITEM_TAG_MAIN_INPUT

#define ITEM_TAG_MAIN_INPUT   0x8

Definition at line 25 of file parser.h.

ITEM_TAG_MAIN_OUTPUT

#define ITEM_TAG_MAIN_OUTPUT   0x9

Definition at line 26 of file parser.h.

ITEM_TYPE_GLOBAL

#define ITEM_TYPE_GLOBAL   0x1

Definition at line 21 of file parser.h.

ITEM_TYPE_LOCAL

#define ITEM_TYPE_LOCAL   0x2

Definition at line 22 of file parser.h.

ITEM_TYPE_LONG

#define ITEM_TYPE_LONG   0x3

Definition at line 23 of file parser.h.

ITEM_TYPE_MAIN

#define ITEM_TYPE_MAIN   0x0

Definition at line 20 of file parser.h.

LBITFIELD9

#define LBITFIELD9	(		b1,
			b2,
			b3,
			b4,
			b5,
			b6,
			b7,
			b8,
			b9
	)		USHORT b9,b8,b7,b6,b5,b4,b3,b2,b1

Definition at line 114 of file parser.h.

UNIT_CURRENT

#define UNIT_CURRENT   0x5

Definition at line 71 of file parser.h.

UNIT_LENGTH

#define UNIT_LENGTH   0x1

Definition at line 67 of file parser.h.

UNIT_LUMINOUS_INTENSITY

#define UNIT_LUMINOUS_INTENSITY   0x6

Definition at line 72 of file parser.h.

UNIT_MASS

#define UNIT_MASS   0x2

Definition at line 68 of file parser.h.

UNIT_SYSTEM

#define UNIT_SYSTEM   0x0

Definition at line 66 of file parser.h.

UNIT_TEMPERATURE

#define UNIT_TEMPERATURE   0x4

Definition at line 70 of file parser.h.

UNIT_TIME

#define UNIT_TIME   0x3

Definition at line 69 of file parser.h.

USAGE_ID_MASK

#define USAGE_ID_MASK   0xffff

Definition at line 77 of file parser.h.

USAGE_ID_SHIFT

#define USAGE_ID_SHIFT   0

Definition at line 76 of file parser.h.

USAGE_PAGE_MASK

#define USAGE_PAGE_MASK   0xffff

Definition at line 75 of file parser.h.

USAGE_PAGE_SHIFT

#define USAGE_PAGE_SHIFT   16

Definition at line 74 of file parser.h.

Typedef Documentation

GLOBAL_ITEM_STATE

typedef struct __GLOBAL_ITEM_STATE_ GLOBAL_ITEM_STATE

HID_COLLECTION

typedef struct __HID_COLLECTION__ HID_COLLECTION

HID_REPORT

typedef struct _HID_REPORT HID_REPORT

PGLOBAL_ITEM_STATE

typedef struct __GLOBAL_ITEM_STATE_ * PGLOBAL_ITEM_STATE

PHID_COLLECTION

typedef struct __HID_COLLECTION__ * PHID_COLLECTION

PHID_PARSER_CONTEXT

typedef struct HID_PARSER_CONTEXT * PHID_PARSER_CONTEXT

PHID_REPORT

typedef struct _HID_REPORT * PHID_REPORT

PHID_REPORT_ITEM

typedef struct HID_REPORT_ITEM * PHID_REPORT_ITEM

PITEM_PREFIX

typedef struct ITEM_PREFIX * PITEM_PREFIX

PLOCAL_ITEM_STATE

typedef struct LOCAL_ITEM_STATE * PLOCAL_ITEM_STATE

PLONG_ITEM

typedef struct LONG_ITEM* PLONG_ITEM

PMAIN_ITEM_DATA

typedef struct MAIN_ITEM_DATA * PMAIN_ITEM_DATA

PSHORT_ITEM

typedef struct SHORT_ITEM * PSHORT_ITEM

PUSAGE_VALUE

typedef struct usage_value * PUSAGE_VALUE

USAGE_VALUE

typedef struct usage_value USAGE_VALUE

Function Documentation

HidParser_BuildCollectionContext()

NTSTATUS HidParser_BuildCollectionContext	(	IN PHID_COLLECTION	RootCollection,
		IN PVOID	Context,
		IN ULONG	ContextSize
	)

Definition at line 185 of file context.c.

{
    PHID_COLLECTION_CONTEXT CollectionContext;
    ULONG CollectionSize;
 
    //
    // init context
    //
    CollectionContext = (PHID_COLLECTION_CONTEXT)Context;
    CollectionContext->Size = ContextSize;
 
    //
    // store collections
    //
    CollectionSize = HidParser_StoreCollection(RootCollection, CollectionContext, 0);
 
    //
    // sanity check
    //
    ASSERT(CollectionSize + sizeof(HID_COLLECTION_CONTEXT) == ContextSize);
 
    DPRINT("CollectionContext %p\n", CollectionContext);
    DPRINT("CollectionContext RawData %p\n", CollectionContext->RawData);
    DPRINT("CollectionContext Size %lu\n", CollectionContext->Size);
 
    //
    // done
    //
    return HIDP_STATUS_SUCCESS;
}

Referenced by HidParser_BuildContext().

HidParser_BuildContext()

NTSTATUS HidParser_BuildContext	(	IN PVOID	ParserContext,
		IN ULONG	CollectionIndex,
		IN ULONG	ContextSize,
		OUT PVOID *	CollectionContext
	)

Definition at line 1303 of file parser.c.

{
    PHID_COLLECTION Collection;
    PVOID Context;
    NTSTATUS Status;
 
    //
    // lets get the collection
    //
    Collection = HidParser_GetCollection((PHID_PARSER_CONTEXT)ParserContext, CollectionIndex);
    ASSERT(Collection);
 
    //
    // lets allocate the context
    //
    Context = AllocFunction(ContextSize);
    if (Context == NULL)
    {
        //
        // no memory
        //
        return HIDP_STATUS_INTERNAL_ERROR;
    }
 
    //
    // lets build the context
    //
    Status = HidParser_BuildCollectionContext(Collection, Context, ContextSize);
    if (Status == HIDP_STATUS_SUCCESS)
    {
        //
        // store context
        //
        *CollectionContext = Context;
    }
 
    //
    // done
    //
    return Status;
}

Referenced by HidParser_GetCollectionDescription().

HidParser_CalculateContextSize()

ULONG HidParser_CalculateContextSize

(

IN PHID_COLLECTION

Collection

)

Definition at line 65 of file context.c.

{
    ULONG Size;
 
    //
    // minimum size is the size of the collection
    //
    Size = HidParser_CalculateCollectionSize(Collection);
 
    //
    // append collection context size
    //
    Size += sizeof(HID_COLLECTION_CONTEXT);
    return Size;
}

Referenced by HidParser_GetContextSize().

HidParser_GetCollectionFromContext()

PHID_COLLECTION HidParser_GetCollectionFromContext

(

IN PVOID

Context

)

Definition at line 290 of file context.c.

{
    PHID_COLLECTION_CONTEXT CollectionContext = (PHID_COLLECTION_CONTEXT)Context;
 
    //
    // return root collection
    //
    return (PHID_COLLECTION)CollectionContext->RawData;
}

Referenced by HidParser_GetCollectionUsagePage().

HidParser_GetCollectionUsagePage()

NTSTATUS HidParser_GetCollectionUsagePage	(	IN PVOID	CollectionContext,
		OUT PUSHORT	Usage,
		OUT PUSHORT	UsagePage
	)

Definition at line 65 of file api.c.

{
    PHID_COLLECTION Collection;
 
    //
    // find collection
    //
    Collection = HidParser_GetCollectionFromContext(CollectionContext);
    if (!Collection)
    {
        //
        // collection not found
        //
        return HIDP_STATUS_USAGE_NOT_FOUND;
    }
 
    //
    // store result
    //
    *UsagePage = (Collection->Usage >> 16);
    *Usage = (Collection->Usage & 0xFFFF);
    return HIDP_STATUS_SUCCESS;
}

Referenced by HidParser_GetCaps(), and HidParser_GetCollectionDescription().

HidParser_GetContextSize()

ULONG HidParser_GetContextSize	(	IN PVOID	ParserContext,
		IN ULONG	CollectionNumber
	)

Definition at line 1351 of file parser.c.

{
    PHID_COLLECTION Collection;
    ULONG Size;
 
    //
    // lets get the collection
    //
    Collection = HidParser_GetCollection((PHID_PARSER_CONTEXT)ParserContext, CollectionIndex);
 
    //
    // calculate size
    //
    Size = HidParser_CalculateContextSize(Collection);
    return Size;
}

Referenced by HidParser_GetCollectionDescription().

HidParser_GetMaxUsageListLengthWithReportAndPage()

ULONG HidParser_GetMaxUsageListLengthWithReportAndPage	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType,
		IN USAGE UsagePage	OPTIONAL
	)

Definition at line 210 of file api.c.

{
    ULONG Index;
    PHID_REPORT Report;
    ULONG ItemCount = 0;
    USHORT CurrentUsagePage;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return 0;
    }
 
    for(Index = 0; Index < Report->ItemCount; Index++)
    {
        //
        // check usage page
        //
        CurrentUsagePage = (Report->Items[Index].UsageMinimum >> 16);
        if (CurrentUsagePage == UsagePage && Report->Items[Index].HasData)
        {
            //
            // found item
            //
            ItemCount++;
        }
    }
 
    //
    // done
    //
    return ItemCount;
}

Referenced by HidParser_MaxUsageListLength().

HidParser_GetReportInCollection()

PHID_REPORT HidParser_GetReportInCollection	(	IN PVOID	Context,
		IN UCHAR	ReportType
	)

Definition at line 277 of file context.c.

{
    PHID_COLLECTION_CONTEXT CollectionContext = (PHID_COLLECTION_CONTEXT)Context;
 
    //
    // done
    //
    return HidParser_SearchReportInCollection(CollectionContext, (PHID_COLLECTION)&CollectionContext->RawData, ReportType);
}

Referenced by HidParser_GetMaxUsageListLengthWithReportAndPage(), HidParser_GetReportItemCountFromReportType(), HidParser_GetReportItemTypeCountFromReportType(), HidParser_GetReportLength(), HidParser_GetScaledUsageValueWithReport(), HidParser_GetSpecificValueCapsWithReport(), HidParser_GetUsagesWithReport(), HidParser_GetUsageValueWithReport(), and HidParser_UsesReportId().

HidParser_GetReportItemCountFromReportType()

ULONG HidParser_GetReportItemCountFromReportType	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType
	)

Definition at line 132 of file api.c.

{
    PHID_REPORT Report;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return 0;
    }
 
    //
    // return report item count
    //
    return Report->ItemCount;
}

Referenced by HidParser_GetCaps().

HidParser_GetReportItemTypeCountFromReportType()

ULONG HidParser_GetReportItemTypeCountFromReportType	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType,
		IN ULONG	bData
	)

Definition at line 158 of file api.c.

{
    ULONG Index;
    PHID_REPORT Report;
    ULONG ItemCount = 0;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return 0;
    }
 
    //
    // enumerate all items
    //
    for(Index = 0; Index < Report->ItemCount; Index++)
    {
        //
        // check item type
        //
        if (Report->Items[Index].HasData && bData)
        {
            //
            // found data item
            //
            ItemCount++;
        }
        else if (Report->Items[Index].HasData == FALSE && bData == FALSE)
        {
            //
            // found value item
            //
            ItemCount++;
        }
    }
 
    //
    // no report items
    //
    return ItemCount;
}

Referenced by HidParser_GetCaps().

HidParser_GetReportLength()

ULONG HidParser_GetReportLength	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType
	)

Definition at line 93 of file api.c.

{
    PHID_REPORT Report;
    ULONG ReportLength;
 
    //
    // get first report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no report found
        //
        return 0;
    }
 
    //
    // get report length
    //
    ReportLength = Report->ReportSize;
 
    //
    // done
    //
    if (ReportLength)
    {
        //
        // byte aligned length
        //
        ASSERT(ReportLength % 8 == 0);
        return ReportLength / 8;
    }
    return ReportLength;
}

Referenced by HidParser_GetCaps(), and HidParser_GetCollectionDescription().

HidParser_GetScaledUsageValueWithReport()

NTSTATUS HidParser_GetScaledUsageValueWithReport	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType,
		IN USAGE	UsagePage,
		IN USAGE	Usage,
		OUT PLONG	UsageValue,
		IN PCHAR	ReportDescriptor,
		IN ULONG	ReportDescriptorLength
	)

Definition at line 646 of file api.c.

{
    ULONG Index;
    PHID_REPORT Report;
    USHORT CurrentUsagePage;
    PHID_REPORT_ITEM ReportItem;
    ULONG Data;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return HIDP_STATUS_REPORT_DOES_NOT_EXIST;
    }
 
    if (Report->ReportSize / 8 != (ReportDescriptorLength - 1))
    {
        //
        // invalid report descriptor length
        //
        return HIDP_STATUS_INVALID_REPORT_LENGTH;
    }
 
    for (Index = 0; Index < Report->ItemCount; Index++)
    {
        //
        // get report item
        //
        ReportItem = &Report->Items[Index];
 
        //
        // check usage page
        //
        CurrentUsagePage = (ReportItem->UsageMinimum >> 16);
 
        //
        // does usage page match
        //
        if (UsagePage != CurrentUsagePage)
            continue;
 
        //
        // does the usage match
        //
        if (Usage != (ReportItem->UsageMinimum & 0xFFFF))
            continue;
 
        //
        // check if the specified usage is activated
        //
        ASSERT(ReportItem->ByteOffset < ReportDescriptorLength);
 
        //
        // one extra shift for skipping the prepended report id
        //
        Data = 0;
        CopyFunction(&Data, &ReportDescriptor[ReportItem->ByteOffset + 1], min(sizeof(ULONG), ReportDescriptorLength - (ReportItem->ByteOffset + 1)));
 
        //
        // shift data
        //
        Data >>= ReportItem->Shift;
 
        //
        // clear unwanted bits
        //
        Data &= ReportItem->Mask;
 
        if (ReportItem->Minimum > ReportItem->Maximum)
        {
            //
            // logical boundaries are signed values
            //
 
            // FIXME: scale with physical min/max
            if ((Data & ~(ReportItem->Mask >> 1)) != 0)
            {
                Data |= ~ReportItem->Mask;
            }
        }
        else
        {
            // logical boundaries are absolute values
            return HIDP_STATUS_BAD_LOG_PHY_VALUES;
        }
 
        //
        // store result
        //
        *UsageValue = Data;
        return HIDP_STATUS_SUCCESS;
    }
 
    //
    // usage not found
    //
    return HIDP_STATUS_USAGE_NOT_FOUND;
}

Referenced by HidParser_GetScaledUsageValue().

HidParser_GetSpecificValueCapsWithReport()

NTSTATUS HidParser_GetSpecificValueCapsWithReport	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType,
		IN USHORT	UsagePage,
		IN USHORT	Usage,
		OUT PHIDP_VALUE_CAPS	ValueCaps,
		IN OUT PUSHORT	ValueCapsLength
	)

Definition at line 254 of file api.c.

{
    ULONG Index;
    PHID_REPORT Report;
    USHORT ItemCount = 0;
    USHORT CurrentUsagePage;
    USHORT CurrentUsage;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return HIDP_STATUS_REPORT_DOES_NOT_EXIST;
    }
 
    for(Index = 0; Index < Report->ItemCount; Index++)
    {
        //
        // check usage page
        //
        CurrentUsagePage = (Report->Items[Index].UsageMinimum >> 16);
        CurrentUsage = (Report->Items[Index].UsageMinimum & 0xFFFF);
 
        if ((Usage == CurrentUsage && UsagePage == CurrentUsagePage) || (Usage == 0 && UsagePage == CurrentUsagePage) || (Usage == CurrentUsage && UsagePage == 0) || (Usage == 0 && UsagePage == 0))
        {
            //
            // check if there is enough place for the caps
            //
            if (ItemCount < *ValueCapsLength)
            {
                //
                // zero caps
                //
                ZeroFunction(&ValueCaps[ItemCount], sizeof(HIDP_VALUE_CAPS));
 
                //
                // init caps
                //
                ValueCaps[ItemCount].UsagePage = CurrentUsagePage;
                ValueCaps[ItemCount].ReportID = Report->ReportID;
                ValueCaps[ItemCount].LogicalMin = Report->Items[Index].Minimum;
                ValueCaps[ItemCount].LogicalMax = Report->Items[Index].Maximum;
                ValueCaps[ItemCount].IsAbsolute = !Report->Items[Index].Relative;
                ValueCaps[ItemCount].BitSize = Report->Items[Index].BitCount;
 
                //
                // FIXME: FILLMEIN
                //
            }
 
 
            //
            // found item
            //
            ItemCount++;
        }
    }
 
    //
    // store result
    //
    *ValueCapsLength = ItemCount;
 
    if (ItemCount)
    {
        //
        // success
        //
        return HIDP_STATUS_SUCCESS;
    }
 
    //
    // item not found
    //
    return HIDP_STATUS_USAGE_NOT_FOUND;
}

Referenced by HidParser_GetSpecificValueCaps().

HidParser_GetTotalCollectionCount()

ULONG HidParser_GetTotalCollectionCount

(

IN PVOID

CollectionContext

)

Definition at line 330 of file context.c.

{
    PHID_COLLECTION_CONTEXT CollectionContext;
 
    //
    // get parser context
    //
    CollectionContext = (PHID_COLLECTION_CONTEXT)Context;
 
    //
    // count collections
    //
    return HidParser_GetCollectionCount(CollectionContext, (PHID_COLLECTION)CollectionContext->RawData);
}

Referenced by HidParser_GetCaps().

HidParser_GetUsagesWithReport()

NTSTATUS HidParser_GetUsagesWithReport	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType,
		IN USAGE	UsagePage,
		OUT USAGE *	UsageList,
		IN OUT PULONG	UsageLength,
		IN PCHAR	ReportDescriptor,
		IN ULONG	ReportDescriptorLength
	)

Definition at line 343 of file api.c.

{
    ULONG Index;
    PHID_REPORT Report;
    ULONG ItemCount = 0;
    USHORT CurrentUsagePage;
    PHID_REPORT_ITEM ReportItem;
    UCHAR Activated;
    ULONG Data;
    PUSAGE_AND_PAGE UsageAndPage = NULL;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return HIDP_STATUS_REPORT_DOES_NOT_EXIST;
    }
 
    if (Report->ReportSize / 8 != (ReportDescriptorLength - 1))
    {
        //
        // invalid report descriptor length
        //
        return HIDP_STATUS_INVALID_REPORT_LENGTH;
    }
 
    //
    // cast to usage and page
    //
    if (UsagePage == HID_USAGE_PAGE_UNDEFINED)
    {
        //
        // the caller requested any set usages
        //
        UsageAndPage = (PUSAGE_AND_PAGE)UsageList;
    }
 
    for(Index = 0; Index < Report->ItemCount; Index++)
    {
        //
        // get report item
        //
        ReportItem = &Report->Items[Index];
 
        //
        // does it have data
        //
        if (!ReportItem->HasData)
            continue;
 
        //
        // check usage page
        //
        CurrentUsagePage = (ReportItem->UsageMinimum >> 16);
 
        if (UsagePage != HID_USAGE_PAGE_UNDEFINED)
        {
            //
            // does usage match
            //
            if (UsagePage != CurrentUsagePage)
                continue;
        }
 
        //
        // check if the specified usage is activated
        //
        ASSERT(ReportItem->ByteOffset < ReportDescriptorLength);
        ASSERT(ReportItem->BitCount <= 8);
 
        //
        // one extra shift for skipping the prepended report id
        //
        Data = ReportDescriptor[ReportItem->ByteOffset + 1];
 
        //
        // shift data
        //
        Data >>= ReportItem->Shift;
 
        //
        // clear unwanted bits
        //
        Data &= ReportItem->Mask;
 
        //
        // is it activated
        //
        Activated = (Data != 0);
 
        if (!Activated)
            continue;
 
        //
        // is there enough space for the usage
        //
        if (ItemCount >= *UsageLength)
        {
            ItemCount++;
            continue;
        }
 
        if (UsagePage != HID_USAGE_PAGE_UNDEFINED)
        {
            //
            // store item
            //
            UsageList[ItemCount] = (ReportItem->UsageMinimum & 0xFFFF);
        }
        else
        {
            //
            // store usage and page
            //
            if (ReportItem->BitCount == 1)
            {
                //
                // use usage minimum
                //
                UsageAndPage[ItemCount].Usage =(ReportItem->UsageMinimum & 0xFFFF);
            }
            else
            {
                //
                // use value from control
                //
                UsageAndPage[ItemCount].Usage = (USHORT)Data;
            }
            UsageAndPage[ItemCount].UsagePage = CurrentUsagePage;
        }
        ItemCount++;
    }
 
    if (ItemCount > *UsageLength)
    {
        //
        // list too small
        //
        return HIDP_STATUS_BUFFER_TOO_SMALL;
    }
 
    if (UsagePage == HID_USAGE_PAGE_UNDEFINED)
    {
        //
        // success, clear rest of array
        //
        ZeroFunction(&UsageAndPage[ItemCount], (*UsageLength - ItemCount) * sizeof(USAGE_AND_PAGE));
    }
    else
    {
        //
        // success, clear rest of array
        //
        ZeroFunction(&UsageList[ItemCount], (*UsageLength - ItemCount) * sizeof(USAGE));
    }
 
 
    //
    // store result size
    //
    *UsageLength = ItemCount;
 
    //
    // done
    //
    return HIDP_STATUS_SUCCESS;
}

Referenced by HidParser_GetUsages().

HidParser_GetUsageValueWithReport()

NTSTATUS HidParser_GetUsageValueWithReport	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType,
		IN USAGE	UsagePage,
		IN USAGE	Usage,
		OUT PULONG	UsageValue,
		IN PCHAR	ReportDescriptor,
		IN ULONG	ReportDescriptorLength
	)

Definition at line 550 of file api.c.

{
    ULONG Index;
    PHID_REPORT Report;
    USHORT CurrentUsagePage;
    PHID_REPORT_ITEM ReportItem;
    ULONG Data;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return HIDP_STATUS_REPORT_DOES_NOT_EXIST;
    }
 
    if (Report->ReportSize / 8 != (ReportDescriptorLength - 1))
    {
        //
        // invalid report descriptor length
        //
        return HIDP_STATUS_INVALID_REPORT_LENGTH;
    }
 
    for (Index = 0; Index < Report->ItemCount; Index++)
    {
        //
        // get report item
        //
        ReportItem = &Report->Items[Index];
 
        //
        // check usage page
        //
        CurrentUsagePage = (ReportItem->UsageMinimum >> 16);
 
        //
        // does usage page match
        //
        if (UsagePage != CurrentUsagePage)
            continue;
 
        //
        // does the usage match
        //
        if (Usage != (ReportItem->UsageMinimum & 0xFFFF))
            continue;
 
        //
        // check if the specified usage is activated
        //
        ASSERT(ReportItem->ByteOffset < ReportDescriptorLength);
 
        //
        // one extra shift for skipping the prepended report id
        //
        Data = 0;
        CopyFunction(&Data, &ReportDescriptor[ReportItem->ByteOffset + 1], min(sizeof(ULONG), ReportDescriptorLength - (ReportItem->ByteOffset + 1)));
 
        //
        // shift data
        //
        Data >>= ReportItem->Shift;
 
        //
        // clear unwanted bits
        //
        Data &= ReportItem->Mask;
 
        //
        // store result
        //
        *UsageValue = Data;
        return HIDP_STATUS_SUCCESS;
    }
 
    //
    // usage not found
    //
    return HIDP_STATUS_USAGE_NOT_FOUND;
}

Referenced by HidParser_GetUsageValue().

HidParser_NumberOfTopCollections()

ULONG HidParser_NumberOfTopCollections

(

IN PVOID

ParserContext

)

Definition at line 1279 of file parser.c.

{
    PHID_PARSER_CONTEXT ParserContext;
 
    //
    // get parser context
    //
    ParserContext = (PHID_PARSER_CONTEXT)ParserCtx;
 
    //
    // sanity checks
    //
    ASSERT(ParserContext);
    ASSERT(ParserContext->RootCollection);
    ASSERT(ParserContext->RootCollection->NodeCount);
 
    //
    // number of top collections
    //
    return ParserContext->RootCollection->NodeCount;
}

Referenced by HidParser_GetCollectionDescription().

HidParser_ParseReportDescriptor()

NTSTATUS HidParser_ParseReportDescriptor	(	PUCHAR	Report,
		ULONG	ReportSize,
		OUT PVOID *	ParserContext
	)

HidParser_UsesReportId()

ULONG HidParser_UsesReportId	(	IN PVOID	CollectionContext,
		IN UCHAR	ReportType
	)

Definition at line 524 of file api.c.

{
    PHID_REPORT Report;
 
    //
    // get report
    //
    Report = HidParser_GetReportInCollection(CollectionContext, ReportType);
    if (!Report)
    {
        //
        // no such report
        //
        return 0;
    }
 
    //
    // returns true when report id != 0
    //
    return (Report->ReportID != 0);
 
}

Referenced by HidParser_GetCollectionDescription().