hidparser.c File Reference

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

Include dependency graph for hidparser.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
NTSTATUS NTAPI	HidParser_GetCollectionDescription (IN PHIDP_REPORT_DESCRIPTOR ReportDesc, IN ULONG DescLength, IN POOL_TYPE PoolType, OUT PHIDP_DEVICE_DESC DeviceDescription)
VOID NTAPI	HidParser_FreeCollectionDescription (IN PHIDP_DEVICE_DESC DeviceDescription)
HIDAPI NTSTATUS NTAPI	HidParser_GetCaps (IN PVOID CollectionContext, OUT PHIDP_CAPS Capabilities)
HIDAPI ULONG NTAPI	HidParser_MaxUsageListLength (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage OPTIONAL)
HIDAPI NTSTATUS NTAPI	HidParser_GetButtonCaps (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN PHIDP_BUTTON_CAPS ButtonCaps, IN PUSHORT ButtonCapsLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetSpecificValueCaps (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection, IN USAGE Usage, OUT PHIDP_VALUE_CAPS ValueCaps, IN OUT PUSHORT ValueCapsLength)
HIDAPI NTSTATUS NTAPI	HidParser_UsageListDifference (IN PUSAGE PreviousUsageList, IN PUSAGE CurrentUsageList, OUT PUSAGE BreakUsageList, OUT PUSAGE MakeUsageList, IN ULONG UsageListLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetUsages (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection OPTIONAL, OUT USAGE *UsageList, IN OUT PULONG UsageLength, IN PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetScaledUsageValue (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection OPTIONAL, IN USAGE Usage, OUT PLONG UsageValue, IN PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_TranslateUsageAndPagesToI8042ScanCodes (IN PUSAGE_AND_PAGE ChangedUsageList, IN ULONG UsageListLength, IN HIDP_KEYBOARD_DIRECTION KeyAction, IN OUT PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, IN PHIDP_INSERT_SCANCODES InsertCodesProcedure, IN PVOID InsertCodesContext)
HIDAPI NTSTATUS NTAPI	HidParser_GetUsagesEx (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USHORT LinkCollection, OUT PUSAGE_AND_PAGE ButtonList, IN OUT ULONG *UsageLength, IN PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_UsageAndPageListDifference (IN PUSAGE_AND_PAGE PreviousUsageList, IN PUSAGE_AND_PAGE CurrentUsageList, OUT PUSAGE_AND_PAGE BreakUsageList, OUT PUSAGE_AND_PAGE MakeUsageList, IN ULONG UsageListLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetSpecificButtonCaps (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection, IN USAGE Usage, OUT PHIDP_BUTTON_CAPS ButtonCaps, IN OUT PULONG ButtonCapsLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetData (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, OUT PHIDP_DATA DataList, IN OUT PULONG DataLength, IN PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetExtendedAttributes (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USHORT DataIndex, OUT PHIDP_EXTENDED_ATTRIBUTES Attributes, IN OUT PULONG LengthAttributes)
HIDAPI NTSTATUS NTAPI	HidParser_GetLinkCollectionNodes (IN PVOID CollectionContext, OUT PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes, IN OUT PULONG LinkCollectionNodesLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetUsageValue (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection, IN USAGE Usage, OUT PULONG UsageValue, IN PCHAR Report, IN ULONG ReportLength)
NTSTATUS NTAPI	HidParser_SysPowerEvent (IN PVOID CollectionContext, IN PCHAR HidPacket, IN USHORT HidPacketLength, OUT PULONG OutputBuffer)
NTSTATUS NTAPI	HidParser_SysPowerCaps (IN PVOID CollectionContext, OUT PULONG OutputBuffer)
HIDAPI NTSTATUS NTAPI	HidParser_GetUsageValueArray (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection OPTIONAL, IN USAGE Usage, OUT PCHAR UsageValue, IN USHORT UsageValueByteLength, IN PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_UnsetUsages (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection, IN PUSAGE UsageList, IN OUT PULONG UsageLength, IN OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_TranslateUsagesToI8042ScanCodes (IN PUSAGE ChangedUsageList, IN ULONG UsageListLength, IN HIDP_KEYBOARD_DIRECTION KeyAction, IN OUT PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, IN PHIDP_INSERT_SCANCODES InsertCodesProcedure, IN PVOID InsertCodesContext)
HIDAPI NTSTATUS NTAPI	HidParser_SetUsages (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection, IN PUSAGE UsageList, IN OUT PULONG UsageLength, IN OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_SetUsageValueArray (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection OPTIONAL, IN USAGE Usage, IN PCHAR UsageValue, IN USHORT UsageValueByteLength, OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_SetUsageValue (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection, IN USAGE Usage, IN ULONG UsageValue, IN OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_SetScaledUsageValue (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN USAGE UsagePage, IN USHORT LinkCollection OPTIONAL, IN USAGE Usage, IN LONG UsageValue, IN OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_SetData (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN PHIDP_DATA DataList, IN OUT PULONG DataLength, IN OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI ULONG NTAPI	HidParser_MaxDataListLength (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType)
HIDAPI NTSTATUS NTAPI	HidParser_InitializeReportForID (IN PVOID CollectionContext, IN HIDP_REPORT_TYPE ReportType, IN UCHAR ReportID, IN OUT PCHAR Report, IN ULONG ReportLength)
HIDAPI NTSTATUS NTAPI	HidParser_GetValueCaps (IN PVOID CollectionContext, HIDP_REPORT_TYPE ReportType, PHIDP_VALUE_CAPS ValueCaps, PULONG ValueCapsLength)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file hidparser.c.

Function Documentation

HidParser_FreeCollectionDescription()

VOID NTAPI HidParser_FreeCollectionDescription

(

IN PHIDP_DEVICE_DESC

DeviceDescription

)

Definition at line 163 of file hidparser.c.

{
    ULONG Index;
 
    //
    // first free all context
    //
    for(Index = 0; Index < DeviceDescription->CollectionDescLength; Index++)
    {
        //
        // free collection context
        //
        FreeFunction(DeviceDescription->CollectionDesc[Index].PreparsedData);
    }
 
    //
    // now free collection description
    //
    FreeFunction(DeviceDescription->CollectionDesc);
 
    //
    // free report description
    //
    FreeFunction(DeviceDescription->ReportIDs);
}

Referenced by HidP_FreeCollectionDescription().

HidParser_GetButtonCaps()

HIDAPI NTSTATUS NTAPI HidParser_GetButtonCaps	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN PHIDP_BUTTON_CAPS	ButtonCaps,
		IN PUSHORT	ButtonCapsLength
	)

Definition at line 309 of file hidparser.c.

{
    return HidParser_GetSpecificButtonCaps(CollectionContext, ReportType, HID_USAGE_PAGE_UNDEFINED, HIDP_LINK_COLLECTION_UNSPECIFIED, HID_USAGE_PAGE_UNDEFINED, ButtonCaps, (PULONG)ButtonCapsLength);
}

HidParser_GetCaps()

HIDAPI NTSTATUS NTAPI HidParser_GetCaps	(	IN PVOID	CollectionContext,
		OUT PHIDP_CAPS	Capabilities
	)

Definition at line 193 of file hidparser.c.

{
    //
    // zero capabilities
    //
    ZeroFunction(Capabilities, sizeof(HIDP_CAPS));
 
    //
    // init capabilities
    //
    HidParser_GetCollectionUsagePage(CollectionContext, &Capabilities->Usage, &Capabilities->UsagePage);
    Capabilities->InputReportByteLength = HidParser_GetReportLength(CollectionContext, HID_REPORT_TYPE_INPUT);
    Capabilities->OutputReportByteLength = HidParser_GetReportLength(CollectionContext, HID_REPORT_TYPE_OUTPUT);
    Capabilities->FeatureReportByteLength = HidParser_GetReportLength(CollectionContext, HID_REPORT_TYPE_FEATURE);
 
    //
    // always pre-prend report id
    //
    Capabilities->InputReportByteLength = (Capabilities->InputReportByteLength > 0 ? Capabilities->InputReportByteLength + 1 : 0);
    Capabilities->OutputReportByteLength = (Capabilities->OutputReportByteLength > 0 ? Capabilities->OutputReportByteLength + 1 : 0);
    Capabilities->FeatureReportByteLength = (Capabilities->FeatureReportByteLength > 0 ? Capabilities->FeatureReportByteLength + 1 : 0);
 
    //
    // get number of link collection nodes
    //
    Capabilities->NumberLinkCollectionNodes = HidParser_GetTotalCollectionCount(CollectionContext);
 
    //
    // get data indices
    //
    Capabilities->NumberInputDataIndices = HidParser_GetReportItemTypeCountFromReportType(CollectionContext, HID_REPORT_TYPE_INPUT, TRUE);
    Capabilities->NumberOutputDataIndices = HidParser_GetReportItemTypeCountFromReportType(CollectionContext, HID_REPORT_TYPE_OUTPUT, TRUE);
    Capabilities->NumberFeatureDataIndices = HidParser_GetReportItemTypeCountFromReportType(CollectionContext, HID_REPORT_TYPE_FEATURE, TRUE);
 
    //
    // get value caps
    //
    Capabilities->NumberInputValueCaps = HidParser_GetReportItemTypeCountFromReportType(CollectionContext, HID_REPORT_TYPE_INPUT, FALSE);
    Capabilities->NumberOutputValueCaps = HidParser_GetReportItemTypeCountFromReportType(CollectionContext, HID_REPORT_TYPE_OUTPUT, FALSE);
    Capabilities->NumberFeatureValueCaps = HidParser_GetReportItemTypeCountFromReportType(CollectionContext, HID_REPORT_TYPE_FEATURE, FALSE);
 
 
    //
    // get button caps
    //
    Capabilities->NumberInputButtonCaps = HidParser_GetReportItemCountFromReportType(CollectionContext, HID_REPORT_TYPE_INPUT);
    Capabilities->NumberOutputButtonCaps = HidParser_GetReportItemCountFromReportType(CollectionContext, HID_REPORT_TYPE_OUTPUT);
    Capabilities->NumberFeatureButtonCaps = HidParser_GetReportItemCountFromReportType(CollectionContext, HID_REPORT_TYPE_FEATURE);
 
    //
    // done
    //
    return HIDP_STATUS_SUCCESS;
}

Referenced by HidP_GetCaps().

HidParser_GetCollectionDescription()

NTSTATUS NTAPI HidParser_GetCollectionDescription	(	IN PHIDP_REPORT_DESCRIPTOR	ReportDesc,
		IN ULONG	DescLength,
		IN POOL_TYPE	PoolType,
		OUT PHIDP_DEVICE_DESC	DeviceDescription
	)

Definition at line 18 of file hidparser.c.

{
    NTSTATUS ParserStatus;
    ULONG CollectionCount;
    ULONG Index;
    PVOID ParserContext;
 
    //
    // first parse the report descriptor
    //
    ParserStatus = HidParser_ParseReportDescriptor(ReportDesc, DescLength, &ParserContext);
    if (ParserStatus != HIDP_STATUS_SUCCESS)
    {
        //
        // failed to parse report descriptor
        //
        DebugFunction("[HIDPARSER] Failed to parse report descriptor with %x\n", ParserStatus);
        return ParserStatus;
    }
 
    //
    // get collection count
    //
    CollectionCount = HidParser_NumberOfTopCollections(ParserContext);
    if (CollectionCount == 0)
    {
        //
        // no top level collections found
        //
        ASSERT(FALSE);
        return STATUS_NO_DATA_DETECTED;
    }
 
    //
    // zero description
    //
    ZeroFunction(DeviceDescription, sizeof(HIDP_DEVICE_DESC));
 
    //
    // allocate collection
    //
    DeviceDescription->CollectionDesc = (PHIDP_COLLECTION_DESC)AllocFunction(sizeof(HIDP_COLLECTION_DESC) * CollectionCount);
    if (!DeviceDescription->CollectionDesc)
    {
        //
        // no memory
        //
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    //
    // allocate report description
    //
    DeviceDescription->ReportIDs = (PHIDP_REPORT_IDS)AllocFunction(sizeof(HIDP_REPORT_IDS) * CollectionCount);
    if (!DeviceDescription->ReportIDs)
    {
        //
        // no memory
        //
        FreeFunction(DeviceDescription->CollectionDesc);
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    for(Index = 0; Index < CollectionCount; Index++)
    {
        //
        // set preparsed data length
        //
        DeviceDescription->CollectionDesc[Index].PreparsedDataLength = HidParser_GetContextSize(ParserContext, Index);
        ParserStatus = HidParser_BuildContext(ParserContext, Index, DeviceDescription->CollectionDesc[Index].PreparsedDataLength, (PVOID*)&DeviceDescription->CollectionDesc[Index].PreparsedData);
        if (ParserStatus != HIDP_STATUS_SUCCESS)
        {
            //
            // no memory
            //
            FreeFunction(DeviceDescription->CollectionDesc);
            FreeFunction(DeviceDescription->ReportIDs);
            return ParserStatus;
        }
 
        //
        // init report description
        //
        DeviceDescription->ReportIDs[Index].CollectionNumber = Index + 1;
        DeviceDescription->ReportIDs[Index].ReportID = Index; //FIXME
        DeviceDescription->ReportIDs[Index].InputLength = HidParser_GetReportLength((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_INPUT);
        DeviceDescription->ReportIDs[Index].OutputLength = HidParser_GetReportLength((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_OUTPUT);
        DeviceDescription->ReportIDs[Index].FeatureLength = HidParser_GetReportLength((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_FEATURE);
 
 
        DeviceDescription->ReportIDs[Index].InputLength += (HidParser_UsesReportId((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_INPUT) ? 1 : 0);
        DeviceDescription->ReportIDs[Index].OutputLength += (HidParser_UsesReportId((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_OUTPUT) ? 1 : 0);
        DeviceDescription->ReportIDs[Index].FeatureLength += (HidParser_UsesReportId((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_FEATURE) ? 1 : 0);
 
 
        //
        // init collection description
        //
        DeviceDescription->CollectionDesc[Index].CollectionNumber = Index + 1;
 
        //
        // get collection usage page
        //
        ParserStatus = HidParser_GetCollectionUsagePage((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, &DeviceDescription->CollectionDesc[Index].Usage, &DeviceDescription->CollectionDesc[Index].UsagePage);
        if (ParserStatus != HIDP_STATUS_SUCCESS)
        {
            // collection not found
            FreeFunction(DeviceDescription->CollectionDesc);
            FreeFunction(DeviceDescription->ReportIDs);
            return ParserStatus;
        }
 
        //
        // windows seems to prepend the report id, regardless if it is required
        //
        DeviceDescription->CollectionDesc[Index].CollectionNumber = Index + 1;
        DeviceDescription->CollectionDesc[Index].InputLength = DeviceDescription->ReportIDs[Index].InputLength;
        DeviceDescription->CollectionDesc[Index].OutputLength = DeviceDescription->ReportIDs[Index].OutputLength;
        DeviceDescription->CollectionDesc[Index].FeatureLength = DeviceDescription->ReportIDs[Index].FeatureLength;
 
        DeviceDescription->CollectionDesc[Index].InputLength += (HidParser_UsesReportId((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_INPUT) == FALSE ? 1 : 0);
        DeviceDescription->CollectionDesc[Index].OutputLength += (HidParser_UsesReportId((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_OUTPUT) == FALSE ? 1 : 0);
        DeviceDescription->CollectionDesc[Index].FeatureLength += (HidParser_UsesReportId((PVOID)DeviceDescription->CollectionDesc[Index].PreparsedData, HID_REPORT_TYPE_FEATURE) == FALSE ? 1 : 0);
 
 
    }
 
    //
    // store collection & report count
    //
    DeviceDescription->CollectionDescLength = CollectionCount;
    DeviceDescription->ReportIDsLength = CollectionCount;
 
    //
    // done
    //
    return STATUS_SUCCESS;
}

Referenced by HidP_GetCollectionDescription().

HidParser_GetData()

HIDAPI NTSTATUS NTAPI HidParser_GetData	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		OUT PHIDP_DATA	DataList,
		IN OUT PULONG	DataLength,
		IN PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 836 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_GetExtendedAttributes()

HIDAPI NTSTATUS NTAPI HidParser_GetExtendedAttributes	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USHORT	DataIndex,
		OUT PHIDP_EXTENDED_ATTRIBUTES	Attributes,
		IN OUT PULONG	LengthAttributes
	)

Definition at line 852 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_GetLinkCollectionNodes()

HIDAPI NTSTATUS NTAPI HidParser_GetLinkCollectionNodes	(	IN PVOID	CollectionContext,
		OUT PHIDP_LINK_COLLECTION_NODE	LinkCollectionNodes,
		IN OUT PULONG	LinkCollectionNodesLength
	)

Definition at line 867 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_GetScaledUsageValue()

HIDAPI NTSTATUS NTAPI HidParser_GetScaledUsageValue	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT LinkCollection	OPTIONAL,
		IN USAGE	Usage,
		OUT PLONG	UsageValue,
		IN PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 559 of file hidparser.c.

{
    NTSTATUS ParserStatus;
 
    //
    // FIXME: implement searching in specific collection
    //
    ASSERT(LinkCollection == HIDP_LINK_COLLECTION_UNSPECIFIED);
 
    if (ReportType == HidP_Input)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetScaledUsageValueWithReport(CollectionContext, HID_REPORT_TYPE_INPUT, UsagePage, Usage, UsageValue, Report, ReportLength);
    }
    else if (ReportType == HidP_Output)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetScaledUsageValueWithReport(CollectionContext, HID_REPORT_TYPE_OUTPUT, UsagePage, Usage, UsageValue, Report, ReportLength);
    }
    else if (ReportType == HidP_Feature)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetScaledUsageValueWithReport(CollectionContext, HID_REPORT_TYPE_FEATURE,  UsagePage, Usage, UsageValue, Report, ReportLength);
    }
    else
    {
        //
        // invalid report type
        //
        return HIDP_STATUS_INVALID_REPORT_TYPE;
    }
 
    //
    // return status
    //
    return ParserStatus;
}

Referenced by HidP_GetScaledUsageValue().

HidParser_GetSpecificButtonCaps()

HIDAPI NTSTATUS NTAPI HidParser_GetSpecificButtonCaps	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT	LinkCollection,
		IN USAGE	Usage,
		OUT PHIDP_BUTTON_CAPS	ButtonCaps,
		IN OUT PULONG	ButtonCapsLength
	)

Definition at line 818 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by HidParser_GetButtonCaps().

HidParser_GetSpecificValueCaps()

HIDAPI NTSTATUS NTAPI HidParser_GetSpecificValueCaps	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT	LinkCollection,
		IN USAGE	Usage,
		OUT PHIDP_VALUE_CAPS	ValueCaps,
		IN OUT PUSHORT	ValueCapsLength
	)

Definition at line 321 of file hidparser.c.

{
    NTSTATUS ParserStatus;
 
    //
    // FIXME: implement searching in specific collection
    //
    ASSERT(LinkCollection == HIDP_LINK_COLLECTION_UNSPECIFIED);
 
    if (ReportType == HidP_Input)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetSpecificValueCapsWithReport(CollectionContext, HID_REPORT_TYPE_INPUT, UsagePage, Usage, ValueCaps, ValueCapsLength);
    }
    else if (ReportType == HidP_Output)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetSpecificValueCapsWithReport(CollectionContext, HID_REPORT_TYPE_OUTPUT, UsagePage, Usage, ValueCaps, ValueCapsLength);
    }
    else if (ReportType == HidP_Feature)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetSpecificValueCapsWithReport(CollectionContext, HID_REPORT_TYPE_FEATURE, UsagePage, Usage, ValueCaps, ValueCapsLength);
    }
    else
    {
        //
        // invalid report type
        //
        return HIDP_STATUS_INVALID_REPORT_TYPE;
    }
 
    //
    // return status
    //
    return ParserStatus;
}

Referenced by HidP_GetSpecificValueCaps().

HidParser_GetUsages()

HIDAPI NTSTATUS NTAPI HidParser_GetUsages	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT LinkCollection	OPTIONAL,
		OUT USAGE *	UsageList,
		IN OUT PULONG	UsageLength,
		IN PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 504 of file hidparser.c.

{
    NTSTATUS ParserStatus;
 
    //
    // FIXME: implement searching in specific collection
    //
    ASSERT(LinkCollection == HIDP_LINK_COLLECTION_UNSPECIFIED);
 
    if (ReportType == HidP_Input)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetUsagesWithReport(CollectionContext, HID_REPORT_TYPE_INPUT, UsagePage, UsageList, UsageLength, Report, ReportLength);
    }
    else if (ReportType == HidP_Output)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetUsagesWithReport(CollectionContext, HID_REPORT_TYPE_OUTPUT, UsagePage, UsageList, UsageLength, Report, ReportLength);
    }
    else if (ReportType == HidP_Feature)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetUsagesWithReport(CollectionContext, HID_REPORT_TYPE_FEATURE, UsagePage, UsageList, UsageLength, Report, ReportLength);
    }
    else
    {
        //
        // invalid report type
        //
        return HIDP_STATUS_INVALID_REPORT_TYPE;
    }
 
    //
    // return status
    //
    return ParserStatus;
}

Referenced by HidP_GetUsages(), and HidParser_GetUsagesEx().

HidParser_GetUsagesEx()

HIDAPI NTSTATUS NTAPI HidParser_GetUsagesEx	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USHORT	LinkCollection,
		OUT PUSAGE_AND_PAGE	ButtonList,
		IN OUT ULONG *	UsageLength,
		IN PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 674 of file hidparser.c.

{
    return HidParser_GetUsages(CollectionContext, ReportType, HID_USAGE_PAGE_UNDEFINED, LinkCollection, (PUSAGE)ButtonList, UsageLength, Report, ReportLength);
}

HidParser_GetUsageValue()

HIDAPI NTSTATUS NTAPI HidParser_GetUsageValue	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT	LinkCollection,
		IN USAGE	Usage,
		OUT PULONG	UsageValue,
		IN PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 880 of file hidparser.c.

{
    NTSTATUS ParserStatus;
 
    //
    // FIXME: implement searching in specific collection
    //
    ASSERT(LinkCollection == HIDP_LINK_COLLECTION_UNSPECIFIED);
 
    if (ReportType == HidP_Input)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetUsageValueWithReport(CollectionContext, HID_REPORT_TYPE_INPUT, UsagePage, Usage, UsageValue, Report, ReportLength);
    }
    else if (ReportType == HidP_Output)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetUsageValueWithReport(CollectionContext, HID_REPORT_TYPE_OUTPUT, UsagePage, Usage, UsageValue, Report, ReportLength);
    }
    else if (ReportType == HidP_Feature)
    {
        //
        // input report
        //
        ParserStatus = HidParser_GetUsageValueWithReport(CollectionContext, HID_REPORT_TYPE_FEATURE,  UsagePage, Usage, UsageValue, Report, ReportLength);
    }
    else
    {
        //
        // invalid report type
        //
        return HIDP_STATUS_INVALID_REPORT_TYPE;
    }
 
    //
    // return status
    //
    return ParserStatus;
}

Referenced by HidP_GetUsageValue().

HidParser_GetUsageValueArray()

HIDAPI NTSTATUS NTAPI HidParser_GetUsageValueArray	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT LinkCollection	OPTIONAL,
		IN USAGE	Usage,
		OUT PCHAR	UsageValue,
		IN USHORT	UsageValueByteLength,
		IN PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 959 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_GetValueCaps()

HIDAPI NTSTATUS NTAPI HidParser_GetValueCaps	(	IN PVOID	CollectionContext,
		HIDP_REPORT_TYPE	ReportType,
		PHIDP_VALUE_CAPS	ValueCaps,
		PULONG	ValueCapsLength
	)

Definition at line 1130 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_InitializeReportForID()

HIDAPI NTSTATUS NTAPI HidParser_InitializeReportForID	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN UCHAR	ReportID,
		IN OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 1113 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_MaxDataListLength()

HIDAPI ULONG NTAPI HidParser_MaxDataListLength	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType
	)

Definition at line 1101 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return 0;
}

HidParser_MaxUsageListLength()

HIDAPI ULONG NTAPI HidParser_MaxUsageListLength	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE UsagePage	OPTIONAL
	)

Definition at line 253 of file hidparser.c.

{
    //
    // FIXME test what should be returned when usage page is not defined
    //
    if (UsagePage == HID_USAGE_PAGE_UNDEFINED)
    {
        //
        // implement me
        //
        UNIMPLEMENTED;
 
        //
        // invalid report
        //
        return 0;
    }
 
    if (ReportType == HidP_Input)
    {
        //
        // input report
        //
        return HidParser_GetMaxUsageListLengthWithReportAndPage(CollectionContext, HID_REPORT_TYPE_INPUT, UsagePage);
    }
    else if (ReportType == HidP_Output)
    {
        //
        // input report
        //
        return HidParser_GetMaxUsageListLengthWithReportAndPage(CollectionContext, HID_REPORT_TYPE_OUTPUT, UsagePage);
    }
    else if (ReportType == HidP_Feature)
    {
        //
        // input report
        //
        return HidParser_GetMaxUsageListLengthWithReportAndPage(CollectionContext, HID_REPORT_TYPE_FEATURE, UsagePage);
    }
    else
    {
        //
        // invalid report type
        //
        return 0;
    }
}

Referenced by HidP_MaxUsageListLength().

HidParser_SetData()

HIDAPI NTSTATUS NTAPI HidParser_SetData	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN PHIDP_DATA	DataList,
		IN OUT PULONG	DataLength,
		IN OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 1085 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_SetScaledUsageValue()

HIDAPI NTSTATUS NTAPI HidParser_SetScaledUsageValue	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT LinkCollection	OPTIONAL,
		IN USAGE	Usage,
		IN LONG	UsageValue,
		IN OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 1067 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_SetUsages()

HIDAPI NTSTATUS NTAPI HidParser_SetUsages	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT	LinkCollection,
		IN PUSAGE	UsageList,
		IN OUT PULONG	UsageLength,
		IN OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 1012 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_SetUsageValue()

HIDAPI NTSTATUS NTAPI HidParser_SetUsageValue	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT	LinkCollection,
		IN USAGE	Usage,
		IN ULONG	UsageValue,
		IN OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 1049 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_SetUsageValueArray()

HIDAPI NTSTATUS NTAPI HidParser_SetUsageValueArray	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT LinkCollection	OPTIONAL,
		IN USAGE	Usage,
		IN PCHAR	UsageValue,
		IN USHORT	UsageValueByteLength,
		OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 1030 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_SysPowerCaps()

NTSTATUS NTAPI HidParser_SysPowerCaps	(	IN PVOID	CollectionContext,
		OUT PULONG	OutputBuffer
	)

Definition at line 947 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_SysPowerEvent()

NTSTATUS NTAPI HidParser_SysPowerEvent	(	IN PVOID	CollectionContext,
		IN PCHAR	HidPacket,
		IN USHORT	HidPacketLength,
		OUT PULONG	OutputBuffer
	)

Definition at line 934 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_TranslateUsageAndPagesToI8042ScanCodes()

HIDAPI NTSTATUS NTAPI HidParser_TranslateUsageAndPagesToI8042ScanCodes	(	IN PUSAGE_AND_PAGE	ChangedUsageList,
		IN ULONG	UsageListLength,
		IN HIDP_KEYBOARD_DIRECTION	KeyAction,
		IN OUT PHIDP_KEYBOARD_MODIFIER_STATE	ModifierState,
		IN PHIDP_INSERT_SCANCODES	InsertCodesProcedure,
		IN PVOID	InsertCodesContext
	)

Definition at line 614 of file hidparser.c.

{
    ULONG Index;
    NTSTATUS Status = HIDP_STATUS_SUCCESS;
 
    for(Index = 0; Index < UsageListLength; Index++)
    {
        //
        // check current usage
        //
        if (ChangedUsageList[Index].UsagePage == HID_USAGE_PAGE_KEYBOARD)
        {
            //
            // process keyboard usage
            //
            Status = HidParser_TranslateKbdUsage(ChangedUsageList[Index].Usage, KeyAction, ModifierState, InsertCodesProcedure, InsertCodesContext);
        }
        else if (ChangedUsageList[Index].UsagePage == HID_USAGE_PAGE_CONSUMER)
        {
            //
            // process consumer usage
            //
            Status = HidParser_TranslateCustUsage(ChangedUsageList[Index].Usage, KeyAction, ModifierState, InsertCodesProcedure, InsertCodesContext);
        }
        else
        {
            //
            // invalid page / end of usage list page
            //
            return HIDP_STATUS_I8042_TRANS_UNKNOWN;
        }
 
        //
        // check status
        //
        if (Status != HIDP_STATUS_SUCCESS)
        {
            //
            // failed
            //
            return Status;
        }
    }
 
    //
    // return status
    //
    return Status;
}

Referenced by HidP_TranslateUsageAndPagesToI8042ScanCodes().

HidParser_TranslateUsagesToI8042ScanCodes()

HIDAPI NTSTATUS NTAPI HidParser_TranslateUsagesToI8042ScanCodes	(	IN PUSAGE	ChangedUsageList,
		IN ULONG	UsageListLength,
		IN HIDP_KEYBOARD_DIRECTION	KeyAction,
		IN OUT PHIDP_KEYBOARD_MODIFIER_STATE	ModifierState,
		IN PHIDP_INSERT_SCANCODES	InsertCodesProcedure,
		IN PVOID	InsertCodesContext
	)

Definition at line 996 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_UnsetUsages()

HIDAPI NTSTATUS NTAPI HidParser_UnsetUsages	(	IN PVOID	CollectionContext,
		IN HIDP_REPORT_TYPE	ReportType,
		IN USAGE	UsagePage,
		IN USHORT	LinkCollection,
		IN PUSAGE	UsageList,
		IN OUT PULONG	UsageLength,
		IN OUT PCHAR	Report,
		IN ULONG	ReportLength
	)

Definition at line 978 of file hidparser.c.

{
    UNIMPLEMENTED;
    ASSERT(FALSE);
    return STATUS_NOT_IMPLEMENTED;
}

HidParser_UsageAndPageListDifference()

HIDAPI NTSTATUS NTAPI HidParser_UsageAndPageListDifference	(	IN PUSAGE_AND_PAGE	PreviousUsageList,
		IN PUSAGE_AND_PAGE	CurrentUsageList,
		OUT PUSAGE_AND_PAGE	BreakUsageList,
		OUT PUSAGE_AND_PAGE	MakeUsageList,
		IN ULONG	UsageListLength
	)

Definition at line 689 of file hidparser.c.

{
    ULONG Index, SubIndex, BreakUsageListIndex = 0, MakeUsageListIndex = 0, bFound;
    PUSAGE_AND_PAGE CurrentUsage, Usage;
 
    if (UsageListLength)
    {
        /* process removed usages */
        Index = 0;
        do
        {
            /* get usage from current index */
            CurrentUsage = &PreviousUsageList[Index];
 
            /* end of list reached? */
            if (CurrentUsage->Usage == 0 && CurrentUsage->UsagePage == 0)
                break;
 
            /* search in current list */
            SubIndex = 0;
            bFound = FALSE;
            do
            {
                /* get usage */
                Usage = &CurrentUsageList[SubIndex];
 
                /* end of list reached? */
                if (Usage->Usage == 0 && Usage->UsagePage == 0)
                    break;
 
                /* does it match */
                if (Usage->Usage == CurrentUsage->Usage && Usage->UsagePage == CurrentUsage->UsagePage)
                {
                    /* found match */
                    bFound = TRUE;
                }
 
                /* move to next index */
                SubIndex++;
 
            }while(SubIndex < UsageListLength);
 
            if (!bFound)
            {
                /* store it in break usage list */
                BreakUsageList[BreakUsageListIndex].Usage = CurrentUsage->Usage;
                BreakUsageList[BreakUsageListIndex].UsagePage = CurrentUsage->UsagePage;
                BreakUsageListIndex++;
            }
 
            /* move to next index */
            Index++;
 
        }while(Index < UsageListLength);
 
        /* process new usages */
        Index = 0;
        do
        {
            /* get usage from current index */
            CurrentUsage = &CurrentUsageList[Index];
 
            /* end of list reached? */
            if (CurrentUsage->Usage == 0 && CurrentUsage->UsagePage == 0)
                break;
 
            /* search in current list */
            SubIndex = 0;
            bFound = FALSE;
            do
            {
                /* get usage */
                Usage = &PreviousUsageList[SubIndex];
 
                /* end of list reached? */
                if (Usage->Usage == 0 && Usage->UsagePage == 0)
                    break;
 
                /* does it match */
                if (Usage->Usage == CurrentUsage->Usage && Usage->UsagePage == CurrentUsage->UsagePage)
                {
                    /* found match */
                    bFound = TRUE;
                }
 
                /* move to next index */
                SubIndex++;
 
            }while(SubIndex < UsageListLength);
 
            if (!bFound)
            {
                /* store it in break usage list */
                MakeUsageList[MakeUsageListIndex].Usage = CurrentUsage->Usage;
                MakeUsageList[MakeUsageListIndex].UsagePage = CurrentUsage->UsagePage;
                MakeUsageListIndex++;
            }
 
            /* move to next index */
            Index++;
        }while(Index < UsageListLength);
    }
 
    /* are there remaining free list entries */
    if (BreakUsageListIndex < UsageListLength)
    {
        /* zero them */
        RtlZeroMemory(&BreakUsageList[BreakUsageListIndex], (UsageListLength - BreakUsageListIndex) * sizeof(USAGE_AND_PAGE));
    }
 
    /* are there remaining free list entries */
    if (MakeUsageListIndex < UsageListLength)
    {
        /* zero them */
        RtlZeroMemory(&MakeUsageList[MakeUsageListIndex], (UsageListLength - MakeUsageListIndex) * sizeof(USAGE_AND_PAGE));
    }
 
    /* done */
    return HIDP_STATUS_SUCCESS;
}

Referenced by HidP_UsageAndPageListDifference().

HidParser_UsageListDifference()

HIDAPI NTSTATUS NTAPI HidParser_UsageListDifference	(	IN PUSAGE	PreviousUsageList,
		IN PUSAGE	CurrentUsageList,
		OUT PUSAGE	BreakUsageList,
		OUT PUSAGE	MakeUsageList,
		IN ULONG	UsageListLength
	)

Definition at line 375 of file hidparser.c.

{
    ULONG Index, SubIndex, bFound, BreakUsageIndex = 0, MakeUsageIndex = 0;
    USAGE CurrentUsage, Usage;
 
    if (UsageListLength)
    {
        Index = 0;
        do
        {
            /* get current usage */
            CurrentUsage = PreviousUsageList[Index];
 
            /* is the end of list reached? */
            if (!CurrentUsage)
                break;
 
            /* start searching in current usage list */
            SubIndex = 0;
            bFound = FALSE;
            do
            {
                /* get usage of current list */
                Usage = CurrentUsageList[SubIndex];
 
                /* end of list reached? */
                if (!Usage)
                    break;
 
                /* check if it matches the current one */
                if (CurrentUsage == Usage)
                {
                    /* it does */
                    bFound = TRUE;
                    break;
                }
 
                /* move to next usage */
                SubIndex++;
            }while(SubIndex < UsageListLength);
 
            /* was the usage found ?*/
            if (!bFound)
            {
                /* store it in the break usage list */
                BreakUsageList[BreakUsageIndex] = CurrentUsage;
                BreakUsageIndex++;
            }
 
            /* move to next usage */
            Index++;
 
        }while(Index < UsageListLength);
 
        /* now process the new items */
        Index = 0;
        do
        {
            /* get current usage */
            CurrentUsage = CurrentUsageList[Index];
 
            /* is the end of list reached? */
            if (!CurrentUsage)
                break;
 
            /* start searching in current usage list */
            SubIndex = 0;
            bFound = FALSE;
            do
            {
                /* get usage of previous list */
                Usage = PreviousUsageList[SubIndex];
 
                /* end of list reached? */
                if (!Usage)
                    break;
 
                /* check if it matches the current one */
                if (CurrentUsage == Usage)
                {
                    /* it does */
                    bFound = TRUE;
                    break;
                }
 
                /* move to next usage */
                SubIndex++;
            }while(SubIndex < UsageListLength);
 
            /* was the usage found ?*/
            if (!bFound)
            {
                /* store it in the make usage list */
                MakeUsageList[MakeUsageIndex] = CurrentUsage;
                MakeUsageIndex++;
            }
 
            /* move to next usage */
            Index++;
 
        }while(Index < UsageListLength);
    }
 
    /* does the break list contain empty entries */
    if (BreakUsageIndex < UsageListLength)
    {
        /* zeroize entries */
        RtlZeroMemory(&BreakUsageList[BreakUsageIndex], sizeof(USAGE) * (UsageListLength - BreakUsageIndex));
    }
 
    /* does the make usage list contain empty entries */
    if (MakeUsageIndex < UsageListLength)
    {
        /* zeroize entries */
        RtlZeroMemory(&MakeUsageList[MakeUsageIndex], sizeof(USAGE) * (UsageListLength - MakeUsageIndex));
    }
 
    /* done */
    return HIDP_STATUS_SUCCESS;
}

Referenced by HidP_UsageListDifference().