hidpi.h File Reference

#include "hidusage.h"

Include dependency graph for hidpi.h:

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

Go to the source code of this file.

Classes
struct	_HIDP_UNKNOWN_TOKEN
struct	_HIDP_KEYBOARD_MODIFIER_STATE
struct	_USAGE_AND_PAGE
struct	_HIDD_ATTRIBUTES
struct	_HIDD_CONFIGURATION
struct	_HIDP_BUTTON_CAPS
struct	_HIDP_CAPS
struct	_HIDP_DATA
struct	_HIDP_EXTENDED_ATTRIBUTES
struct	_HIDP_LINK_COLLECTION_NODE
struct	_HIDP_VALUE_CAPS

Macros
#define	HIDAPI   DECLSPEC_IMPORT
#define	HIDP_LINK_COLLECTION_ROOT   ((USHORT) -1)
#define	HIDP_LINK_COLLECTION_UNSPECIFIED   ((USHORT) 0)
#define	FACILITY_HID_ERROR_CODE   0x11
#define	HIDP_ERROR_CODES(SEV, CODE)    ((NTSTATUS) (((SEV) << 28) | (FACILITY_HID_ERROR_CODE << 16) | (CODE)))
#define	HIDP_STATUS_SUCCESS   (HIDP_ERROR_CODES(0x0, 0))
#define	HIDP_STATUS_NULL   (HIDP_ERROR_CODES(0x8, 1))
#define	HIDP_STATUS_INVALID_PREPARSED_DATA   (HIDP_ERROR_CODES(0xC, 1))
#define	HIDP_STATUS_INVALID_REPORT_TYPE   (HIDP_ERROR_CODES(0xC, 2))
#define	HIDP_STATUS_INVALID_REPORT_LENGTH   (HIDP_ERROR_CODES(0xC, 3))
#define	HIDP_STATUS_USAGE_NOT_FOUND   (HIDP_ERROR_CODES(0xC, 4))
#define	HIDP_STATUS_VALUE_OUT_OF_RANGE   (HIDP_ERROR_CODES(0xC, 5))
#define	HIDP_STATUS_BAD_LOG_PHY_VALUES   (HIDP_ERROR_CODES(0xC, 6))
#define	HIDP_STATUS_BUFFER_TOO_SMALL   (HIDP_ERROR_CODES(0xC, 7))
#define	HIDP_STATUS_INTERNAL_ERROR   (HIDP_ERROR_CODES(0xC, 8))
#define	HIDP_STATUS_I8042_TRANS_UNKNOWN   (HIDP_ERROR_CODES(0xC, 9))
#define	HIDP_STATUS_INCOMPATIBLE_REPORT_ID   (HIDP_ERROR_CODES(0xC, 0xA))
#define	HIDP_STATUS_NOT_VALUE_ARRAY   (HIDP_ERROR_CODES(0xC, 0xB))
#define	HIDP_STATUS_IS_VALUE_ARRAY   (HIDP_ERROR_CODES(0xC, 0xC))
#define	HIDP_STATUS_DATA_INDEX_NOT_FOUND   (HIDP_ERROR_CODES(0xC, 0xD))
#define	HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE   (HIDP_ERROR_CODES(0xC, 0xE))
#define	HIDP_STATUS_BUTTON_NOT_PRESSED   (HIDP_ERROR_CODES(0xC, 0xF))
#define	HIDP_STATUS_REPORT_DOES_NOT_EXIST   (HIDP_ERROR_CODES(0xC, 0x10))
#define	HIDP_STATUS_NOT_IMPLEMENTED   (HIDP_ERROR_CODES(0xC, 0x20))
#define	HIDP_STATUS_I8242_TRANS_UNKNOWN   HIDP_STATUS_I8042_TRANS_UNKNOWN
#define	HidP_GetButtonCaps(_Type_, _Caps_, _Len_, _Data_)    HidP_GetSpecificButtonCaps(_Type_, 0, 0, 0, _Caps_, _Len_, _Data_)
#define	HidP_GetButtons(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe)    HidP_GetUsages(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe)
#define	HidP_GetButtonListLength(RTy, UPa, Ppd)    HidP_GetUsageListLength(Rty, UPa, Ppd)
#define	HidP_GetButtonsEx(RT, LC, BL, UL, PD, R, RL)    HidP_GetUsagesEx(RT, LC, BL, UL, PD, R, RL)
#define	HidP_GetValueCaps(_Type_, _Caps_, _Len_, _Data_)    HidP_GetSpecificValueCaps (_Type_, 0, 0, 0, _Caps_, _Len_, _Data_)
#define	HidP_IsSameUsageAndPage(u1, u2)   ((* (PULONG) &u1) == (* (PULONG) &u2))
#define	HidP_SetButtons(RT, UP, LC, UL1, UL2, PD, R, RL)    HidP_SetUsages(RT, UP, LC, UL1, UL2, PD, R, RL)
#define	HidP_UnsetButtons(RT, UP, LC, UL1, UL2, PD, R, RL)    HidP_UnsetUsages(RT, UP, LC, UL1, UL2, PD, R, RL)

Typedefs
typedef PUCHAR	PHIDP_REPORT_DESCRIPTOR
typedef struct _HIDP_PREPARSED_DATA *	PHIDP_PREPARSED_DATA
typedef struct _HIDP_UNKNOWN_TOKEN	HIDP_UNKNOWN_TOKEN
typedef struct _HIDP_UNKNOWN_TOKEN *	PHIDP_UNKNOWN_TOKEN
typedef enum _HIDP_KEYBOARD_DIRECTION	HIDP_KEYBOARD_DIRECTION
typedef struct _HIDP_KEYBOARD_MODIFIER_STATE	HIDP_KEYBOARD_MODIFIER_STATE
typedef struct _HIDP_KEYBOARD_MODIFIER_STATE *	PHIDP_KEYBOARD_MODIFIER_STATE
typedef BOOLEAN(NTAPI *	PHIDP_INSERT_SCANCODES) (_In_opt_ PVOID Context, _In_reads_bytes_(Length) PCHAR NewScanCodes, _In_ ULONG Length)
typedef struct _USAGE_AND_PAGE	USAGE_AND_PAGE
typedef struct _USAGE_AND_PAGE *	PUSAGE_AND_PAGE
typedef struct _HIDD_ATTRIBUTES	HIDD_ATTRIBUTES
typedef struct _HIDD_ATTRIBUTES *	PHIDD_ATTRIBUTES
typedef struct _HIDD_CONFIGURATION	HIDD_CONFIGURATION
typedef struct _HIDD_CONFIGURATION *	PHIDD_CONFIGURATION
typedef struct _HIDP_BUTTON_CAPS	HIDP_BUTTON_CAPS
typedef struct _HIDP_BUTTON_CAPS *	PHIDP_BUTTON_CAPS
typedef struct _HIDP_CAPS	HIDP_CAPS
typedef struct _HIDP_CAPS *	PHIDP_CAPS
typedef struct _HIDP_DATA	HIDP_DATA
typedef struct _HIDP_DATA *	PHIDP_DATA
typedef struct _HIDP_EXTENDED_ATTRIBUTES	HIDP_EXTENDED_ATTRIBUTES
typedef struct _HIDP_EXTENDED_ATTRIBUTES *	PHIDP_EXTENDED_ATTRIBUTES
typedef struct _HIDP_LINK_COLLECTION_NODE	HIDP_LINK_COLLECTION_NODE
typedef struct _HIDP_LINK_COLLECTION_NODE *	PHIDP_LINK_COLLECTION_NODE
typedef struct _HIDP_VALUE_CAPS	HIDP_VALUE_CAPS
typedef struct _HIDP_VALUE_CAPS *	PHIDP_VALUE_CAPS
typedef enum _HIDP_REPORT_TYPE	HIDP_REPORT_TYPE

Enumerations
enum	_HIDP_KEYBOARD_DIRECTION { HidP_Keyboard_Break , HidP_Keyboard_Make }
enum	_HIDP_REPORT_TYPE { HidP_Input , HidP_Output , HidP_Feature }

Functions
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_TranslateUsageAndPagesToI8042ScanCodes (_In_reads_(UsageListLength) PUSAGE_AND_PAGE ChangedUsageList, _In_ ULONG UsageListLength, _In_ HIDP_KEYBOARD_DIRECTION KeyAction, _Inout_ PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, _In_ PHIDP_INSERT_SCANCODES InsertCodesProcedure, _In_opt_ PVOID InsertCodesContext)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_TranslateUsagesToI8042ScanCodes (_In_reads_(UsageListLength) PUSAGE ChangedUsageList, _In_ ULONG UsageListLength, _In_ HIDP_KEYBOARD_DIRECTION KeyAction, _Inout_ PHIDP_KEYBOARD_MODIFIER_STATE ModifierState, _In_ PHIDP_INSERT_SCANCODES InsertCodesProcedure, _In_opt_ PVOID InsertCodesContext)
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) HIDAPI NTSTATUS NTAPI HidP_GetCaps(_In_ PHIDP_PREPARSED_DATA PreparsedData
	Queries information details about a security descriptor.
_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) HIDAPI NTSTATUS NTAPI HidP_GetData(_In_ HIDP_REPORT_TYPE ReportType
_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA _Inout_ PULONG _In_ PHIDP_PREPARSED_DATA	_Out_writes_bytes_ (ReportLength) PCHAR Report
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_GetScaledUsageValue (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _In_ USAGE Usage, _Out_ PLONG UsageValue, _In_ PHIDP_PREPARSED_DATA PreparsedData, _In_reads_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_GetUsages (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _Out_writes_to_(*UsageLength, *UsageLength) USAGE *UsageList, _Inout_ ULONG *UsageLength, _In_ PHIDP_PREPARSED_DATA PreparsedData, _Out_writes_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ _In_ USHORT _Inout_updates_to_ UsageLength PUSAGE_AND_PAGE _Inout_ ULONG _In_ PHIDP_PREPARSED_DATA	_In_reads_bytes_ (ReportLength) PCHAR Report
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_GetUsageValue (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _In_ USAGE Usage, _Out_ PULONG UsageValue, _In_ PHIDP_PREPARSED_DATA PreparsedData, _In_reads_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_GetUsageValueArray (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _In_ USAGE Usage, _Inout_updates_bytes_(UsageValueByteLength) PCHAR UsageValue, _In_ USHORT UsageValueByteLength, _In_ PHIDP_PREPARSED_DATA PreparsedData, _In_reads_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_SetData (_In_ HIDP_REPORT_TYPE ReportType, _Inout_updates_to_(*DataLength, *DataLength) PHIDP_DATA DataList, _Inout_ PULONG DataLength, _In_ PHIDP_PREPARSED_DATA PreparsedData, _In_reads_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_SetScaledUsageValue (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _In_ USAGE Usage, _In_ LONG UsageValue, _In_ PHIDP_PREPARSED_DATA PreparsedData, _Inout_updates_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_SetUsages (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _Inout_updates_to_(*UsageLength, *UsageLength) PUSAGE UsageList, _Inout_ PULONG UsageLength, _In_ PHIDP_PREPARSED_DATA PreparsedData, _In_reads_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_SetUsageValue (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _In_ USAGE Usage, _In_ ULONG UsageValue, _In_ PHIDP_PREPARSED_DATA PreparsedData, _Inout_updates_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_SetUsageValueArray (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_ USHORT LinkCollection, _In_ USAGE Usage, _In_reads_bytes_(UsageValueByteLength) PCHAR UsageValue, _In_ USHORT UsageValueByteLength, _In_ PHIDP_PREPARSED_DATA PreparsedData, _Inout_updates_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_ HIDAPI NTSTATUS NTAPI	HidP_UnsetUsages (_In_ HIDP_REPORT_TYPE ReportType, _In_ USAGE UsagePage, _In_opt_ USHORT LinkCollection, _Inout_updates_to_(*UsageLength, *UsageLength) PUSAGE UsageList, _Inout_ PULONG UsageLength, _In_ PHIDP_PREPARSED_DATA PreparsedData, _In_reads_bytes_(ReportLength) PCHAR Report, _In_ ULONG ReportLength)
_Must_inspect_result_	_In_reads_ (UsageListLength) PUSAGE_AND_PAGE CurrentUsageList
_Must_inspect_result_	_Out_writes_ (UsageListLength) PUSAGE_AND_PAGE BreakUsageList

Variables
_Must_inspect_result_ _Out_ PHIDP_CAPS	Capabilities
_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA	DataList
_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA _Inout_ PULONG	DataLength
_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA _Inout_ PULONG _In_ PHIDP_PREPARSED_DATA	PreparsedData
_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA _Inout_ PULONG _In_ PHIDP_PREPARSED_DATA _In_ ULONG	ReportLength
_Must_inspect_result_ _In_ USHORT	DataIndex
_Must_inspect_result_ _In_ USHORT _In_ PHIDP_PREPARSED_DATA _Out_writes_to_ LengthAttributes PHIDP_EXTENDED_ATTRIBUTES	Attributes
_Must_inspect_result_ _In_ USHORT _In_ PHIDP_PREPARSED_DATA _Out_writes_to_ LengthAttributes PHIDP_EXTENDED_ATTRIBUTES _Inout_ OUT PULONG	LengthAttributes
_Must_inspect_result_ _Inout_ PULONG	LinkCollectionNodesLength
_Must_inspect_result_ _In_ USAGE	UsagePage
_Must_inspect_result_ _In_ USAGE _In_ USHORT	LinkCollection
_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE	Usage
_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_BUTTON_CAPS	ButtonCaps
_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_BUTTON_CAPS _Inout_ PUSHORT	ButtonCapsLength
_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_VALUE_CAPS	ValueCaps
_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_VALUE_CAPS _Inout_ PUSHORT	ValueCapsLength
_Must_inspect_result_ _In_ USHORT _Inout_updates_to_ UsageLength PUSAGE_AND_PAGE	ButtonList
_Must_inspect_result_ _In_ USHORT _Inout_updates_to_ UsageLength PUSAGE_AND_PAGE _Inout_ ULONG *	UsageLength
_Must_inspect_result_ _In_ UCHAR	ReportID
_Must_inspect_result_ _In_ ULONG	UsageListLength

Macro Definition Documentation

FACILITY_HID_ERROR_CODE

#define FACILITY_HID_ERROR_CODE   0x11

Definition at line 243 of file hidpi.h.

HIDAPI

#define HIDAPI   DECLSPEC_IMPORT

Definition at line 35 of file hidpi.h.

HIDP_ERROR_CODES

#define HIDP_ERROR_CODES	(		SEV,
			CODE
	)		((NTSTATUS) (((SEV) << 28) | (FACILITY_HID_ERROR_CODE << 16) | (CODE)))

Definition at line 245 of file hidpi.h.

HidP_GetButtonCaps

#define HidP_GetButtonCaps	(		_Type_,
			_Caps_,
			_Len_,
			_Data_
	)		HidP_GetSpecificButtonCaps(_Type_, 0, 0, 0, _Caps_, _Len_, _Data_)

Definition at line 279 of file hidpi.h.

HidP_GetButtonListLength

#define HidP_GetButtonListLength	(		RTy,
			UPa,
			Ppd
	)		HidP_GetUsageListLength(Rty, UPa, Ppd)

Definition at line 297 of file hidpi.h.

HidP_GetButtons

#define HidP_GetButtons	(		Rty,
			UPa,
			LCo,
			ULi,
			ULe,
			Ppd,
			Rep,
			RLe
	)		HidP_GetUsages(Rty, UPa, LCo, ULi, ULe, Ppd, Rep, RLe)

Definition at line 294 of file hidpi.h.

HidP_GetButtonsEx

#define HidP_GetButtonsEx	(		RT,
			LC,
			BL,
			UL,
			PD,
			R,
			RL
	)		HidP_GetUsagesEx(RT, LC, BL, UL, PD, R, RL)

Definition at line 312 of file hidpi.h.

HidP_GetValueCaps

#define HidP_GetValueCaps	(		_Type_,
			_Caps_,
			_Len_,
			_Data_
	)		HidP_GetSpecificValueCaps (_Type_, 0, 0, 0, _Caps_, _Len_, _Data_)

Definition at line 470 of file hidpi.h.

HidP_IsSameUsageAndPage

#define HidP_IsSameUsageAndPage	(		u1,
			u2
	)		((* (PULONG) &u1) == (* (PULONG) &u2))

Definition at line 495 of file hidpi.h.

HIDP_LINK_COLLECTION_ROOT

#define HIDP_LINK_COLLECTION_ROOT   ((USHORT) -1)

Definition at line 184 of file hidpi.h.

HIDP_LINK_COLLECTION_UNSPECIFIED

#define HIDP_LINK_COLLECTION_UNSPECIFIED   ((USHORT) 0)

Definition at line 185 of file hidpi.h.

HidP_SetButtons

#define HidP_SetButtons	(		RT,
			UP,
			LC,
			UL1,
			UL2,
			PD,
			R,
			RL
	)		HidP_SetUsages(RT, UP, LC, UL1, UL2, PD, R, RL)

Definition at line 530 of file hidpi.h.

HIDP_STATUS_BAD_LOG_PHY_VALUES

#define HIDP_STATUS_BAD_LOG_PHY_VALUES   (HIDP_ERROR_CODES(0xC, 6))

Definition at line 255 of file hidpi.h.

HIDP_STATUS_BUFFER_TOO_SMALL

#define HIDP_STATUS_BUFFER_TOO_SMALL   (HIDP_ERROR_CODES(0xC, 7))

Definition at line 256 of file hidpi.h.

HIDP_STATUS_BUTTON_NOT_PRESSED

#define HIDP_STATUS_BUTTON_NOT_PRESSED   (HIDP_ERROR_CODES(0xC, 0xF))

Definition at line 264 of file hidpi.h.

HIDP_STATUS_DATA_INDEX_NOT_FOUND

#define HIDP_STATUS_DATA_INDEX_NOT_FOUND   (HIDP_ERROR_CODES(0xC, 0xD))

Definition at line 262 of file hidpi.h.

HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE

#define HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE   (HIDP_ERROR_CODES(0xC, 0xE))

Definition at line 263 of file hidpi.h.

HIDP_STATUS_I8042_TRANS_UNKNOWN

#define HIDP_STATUS_I8042_TRANS_UNKNOWN   (HIDP_ERROR_CODES(0xC, 9))

Definition at line 258 of file hidpi.h.

HIDP_STATUS_I8242_TRANS_UNKNOWN

#define HIDP_STATUS_I8242_TRANS_UNKNOWN   HIDP_STATUS_I8042_TRANS_UNKNOWN

Definition at line 267 of file hidpi.h.

HIDP_STATUS_INCOMPATIBLE_REPORT_ID

#define HIDP_STATUS_INCOMPATIBLE_REPORT_ID   (HIDP_ERROR_CODES(0xC, 0xA))

Definition at line 259 of file hidpi.h.

HIDP_STATUS_INTERNAL_ERROR

#define HIDP_STATUS_INTERNAL_ERROR   (HIDP_ERROR_CODES(0xC, 8))

Definition at line 257 of file hidpi.h.

HIDP_STATUS_INVALID_PREPARSED_DATA

#define HIDP_STATUS_INVALID_PREPARSED_DATA   (HIDP_ERROR_CODES(0xC, 1))

Definition at line 250 of file hidpi.h.

HIDP_STATUS_INVALID_REPORT_LENGTH

#define HIDP_STATUS_INVALID_REPORT_LENGTH   (HIDP_ERROR_CODES(0xC, 3))

Definition at line 252 of file hidpi.h.

HIDP_STATUS_INVALID_REPORT_TYPE

#define HIDP_STATUS_INVALID_REPORT_TYPE   (HIDP_ERROR_CODES(0xC, 2))

Definition at line 251 of file hidpi.h.

HIDP_STATUS_IS_VALUE_ARRAY

#define HIDP_STATUS_IS_VALUE_ARRAY   (HIDP_ERROR_CODES(0xC, 0xC))

Definition at line 261 of file hidpi.h.

HIDP_STATUS_NOT_IMPLEMENTED

#define HIDP_STATUS_NOT_IMPLEMENTED   (HIDP_ERROR_CODES(0xC, 0x20))

Definition at line 266 of file hidpi.h.

HIDP_STATUS_NOT_VALUE_ARRAY

#define HIDP_STATUS_NOT_VALUE_ARRAY   (HIDP_ERROR_CODES(0xC, 0xB))

Definition at line 260 of file hidpi.h.

HIDP_STATUS_NULL

#define HIDP_STATUS_NULL   (HIDP_ERROR_CODES(0x8, 1))

Definition at line 249 of file hidpi.h.

HIDP_STATUS_REPORT_DOES_NOT_EXIST

#define HIDP_STATUS_REPORT_DOES_NOT_EXIST   (HIDP_ERROR_CODES(0xC, 0x10))

Definition at line 265 of file hidpi.h.

HIDP_STATUS_SUCCESS

#define HIDP_STATUS_SUCCESS   (HIDP_ERROR_CODES(0x0, 0))

Definition at line 248 of file hidpi.h.

HIDP_STATUS_USAGE_NOT_FOUND

#define HIDP_STATUS_USAGE_NOT_FOUND   (HIDP_ERROR_CODES(0xC, 4))

Definition at line 253 of file hidpi.h.

HIDP_STATUS_VALUE_OUT_OF_RANGE

#define HIDP_STATUS_VALUE_OUT_OF_RANGE   (HIDP_ERROR_CODES(0xC, 5))

Definition at line 254 of file hidpi.h.

HidP_UnsetButtons

#define HidP_UnsetButtons	(		RT,
			UP,
			LC,
			UL1,
			UL2,
			PD,
			R,
			RL
	)		HidP_UnsetUsages(RT, UP, LC, UL1, UL2, PD, R, RL)

Definition at line 618 of file hidpi.h.

Typedef Documentation

HIDD_ATTRIBUTES

typedef struct _HIDD_ATTRIBUTES HIDD_ATTRIBUTES

HIDD_CONFIGURATION

typedef struct _HIDD_CONFIGURATION HIDD_CONFIGURATION

HIDP_BUTTON_CAPS

typedef struct _HIDP_BUTTON_CAPS HIDP_BUTTON_CAPS

HIDP_CAPS

typedef struct _HIDP_CAPS HIDP_CAPS

HIDP_DATA

typedef struct _HIDP_DATA HIDP_DATA

HIDP_EXTENDED_ATTRIBUTES

typedef struct _HIDP_EXTENDED_ATTRIBUTES HIDP_EXTENDED_ATTRIBUTES

HIDP_KEYBOARD_DIRECTION

typedef enum _HIDP_KEYBOARD_DIRECTION HIDP_KEYBOARD_DIRECTION

HIDP_KEYBOARD_MODIFIER_STATE

typedef struct _HIDP_KEYBOARD_MODIFIER_STATE HIDP_KEYBOARD_MODIFIER_STATE

HIDP_LINK_COLLECTION_NODE

typedef struct _HIDP_LINK_COLLECTION_NODE HIDP_LINK_COLLECTION_NODE

HIDP_REPORT_TYPE

typedef enum _HIDP_REPORT_TYPE HIDP_REPORT_TYPE

HIDP_UNKNOWN_TOKEN

typedef struct _HIDP_UNKNOWN_TOKEN HIDP_UNKNOWN_TOKEN

HIDP_VALUE_CAPS

typedef struct _HIDP_VALUE_CAPS HIDP_VALUE_CAPS

PHIDD_ATTRIBUTES

typedef struct _HIDD_ATTRIBUTES * PHIDD_ATTRIBUTES

PHIDD_CONFIGURATION

typedef struct _HIDD_CONFIGURATION * PHIDD_CONFIGURATION

PHIDP_BUTTON_CAPS

typedef struct _HIDP_BUTTON_CAPS * PHIDP_BUTTON_CAPS

PHIDP_CAPS

typedef struct _HIDP_CAPS * PHIDP_CAPS

PHIDP_DATA

typedef struct _HIDP_DATA * PHIDP_DATA

PHIDP_EXTENDED_ATTRIBUTES

typedef struct _HIDP_EXTENDED_ATTRIBUTES * PHIDP_EXTENDED_ATTRIBUTES

PHIDP_INSERT_SCANCODES

typedef BOOLEAN(NTAPI * PHIDP_INSERT_SCANCODES) (_In_opt_ PVOID Context, _In_reads_bytes_(Length) PCHAR NewScanCodes, _In_ ULONG Length)

Definition at line 72 of file hidpi.h.

PHIDP_KEYBOARD_MODIFIER_STATE

typedef struct _HIDP_KEYBOARD_MODIFIER_STATE * PHIDP_KEYBOARD_MODIFIER_STATE

PHIDP_LINK_COLLECTION_NODE

typedef struct _HIDP_LINK_COLLECTION_NODE * PHIDP_LINK_COLLECTION_NODE

PHIDP_PREPARSED_DATA

typedef struct _HIDP_PREPARSED_DATA* PHIDP_PREPARSED_DATA

Definition at line 39 of file hidpi.h.

PHIDP_REPORT_DESCRIPTOR

typedef PUCHAR PHIDP_REPORT_DESCRIPTOR

Definition at line 38 of file hidpi.h.

PHIDP_UNKNOWN_TOKEN

typedef struct _HIDP_UNKNOWN_TOKEN * PHIDP_UNKNOWN_TOKEN

PHIDP_VALUE_CAPS

typedef struct _HIDP_VALUE_CAPS * PHIDP_VALUE_CAPS

PUSAGE_AND_PAGE

typedef struct _USAGE_AND_PAGE * PUSAGE_AND_PAGE

USAGE_AND_PAGE

typedef struct _USAGE_AND_PAGE USAGE_AND_PAGE

Enumeration Type Documentation

_HIDP_KEYBOARD_DIRECTION

enum _HIDP_KEYBOARD_DIRECTION

Enumerator
HidP_Keyboard_Break
HidP_Keyboard_Make

Definition at line 47 of file hidpi.h.

                                      {
  HidP_Keyboard_Break,
  HidP_Keyboard_Make
} HIDP_KEYBOARD_DIRECTION;

_HIDP_REPORT_TYPE

enum _HIDP_REPORT_TYPE

Enumerator
HidP_Input
HidP_Output
HidP_Feature

Definition at line 237 of file hidpi.h.

                               {
  HidP_Input,
  HidP_Output,
  HidP_Feature
} HIDP_REPORT_TYPE;

Function Documentation

_In_reads_()

_Must_inspect_result_ _In_reads_

(

UsageListLength

)

_In_reads_bytes_()

_Must_inspect_result_ _In_ USHORT _Inout_updates_to_ UsageLength PUSAGE_AND_PAGE _Inout_ ULONG _In_ PHIDP_PREPARSED_DATA _In_reads_bytes_

(

ReportLength

)

_IRQL_requires_max_() [1/2]

_Must_inspect_result_ _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 347 of file common.c.

{
    NTSTATUS                    status;
    BOOLEAN                     requestSent = FALSE;
 
    BOOLEAN                     shouldRetry = TRUE;
    PCDB                        cdb = (PCDB)DeviceExtension->PowerContext.Srb.Cdb;
    ULONG                       timeoutValue = DeviceExtension->TimeOutValue;
    ULONG                       retryCount = 1;
 
    // reset some fields.
    DeviceExtension->PowerContext.RetryIntervalIn100ns = 0;
    status = PowerContextReuseRequest(DeviceExtension);
    RequestClearSendTime(DeviceExtension->PowerContext.PowerRequest);
 
    if (!NT_SUCCESS(status))
    {
        return status;
    }
 
    // set proper timeout value and max retry count.
    switch(DeviceExtension->PowerContext.PowerChangeState.PowerDown)
    {
    case PowerDownDeviceInitial:
    case PowerDownDeviceQuiesced:
    case PowerDownDeviceStopped:
        break;
 
    case PowerDownDeviceLocked:
        // Case of issuing SYNC CACHE command. Do not use power irp timeout remaining time in this case
        // as we want to give best try on SYNC CACHE command.
        retryCount = MAXIMUM_RETRIES;
        timeoutValue = DeviceExtension->TimeOutValue;
        break;
 
    case PowerDownDeviceFlushed:
    {
        // Case of issuing STOP UNIT command
        // As "Imme" bit is set to '1', this command should be completed in short time.
        // This command is at low importance, failure of this command has very small impact.
        ULONG secondsRemaining = 0;
 
#if (WINVER >= 0x0601)
        // this API is introduced in Windows7
        PoQueryWatchdogTime(DeviceExtension->LowerPdo, &secondsRemaining);
#endif
 
        if (secondsRemaining == 0)
        {
            // not able to retrieve remaining time from PoQueryWatchdogTime API, use default values.
            retryCount = MAXIMUM_RETRIES;
            timeoutValue = SCSI_CDROM_TIMEOUT;
        }
        else
        {
            // plan to leave about 30 seconds to lower level drivers if possible.
            if (secondsRemaining >= 32)
            {
                retryCount = (secondsRemaining - 30)/SCSI_CDROM_TIMEOUT + 1;
                timeoutValue = SCSI_CDROM_TIMEOUT;
 
                if (retryCount > MAXIMUM_RETRIES)
                {
                    retryCount = MAXIMUM_RETRIES;
                }
 
                if (retryCount == 1)
                {
                    timeoutValue = secondsRemaining - 30;
                }
            }
            else
            {
                // issue the command with minimal timeout value and do not retry on it.
                retryCount = 1;
                timeoutValue = 2;
            }
        }
    }
        break;
    default:
        NT_ASSERT( FALSE );
        status = STATUS_NOT_IMPLEMENTED;
        return status;
    }
 
    DeviceExtension->PowerContext.RetryCount = retryCount;
 
    // issue command.
    while (shouldRetry)
    {
 
        // set SRB fields.
        DeviceExtension->PowerContext.Srb.SrbFlags = SRB_FLAGS_NO_DATA_TRANSFER |
                                                     SRB_FLAGS_DISABLE_SYNCH_TRANSFER |
                                                     SRB_FLAGS_NO_QUEUE_FREEZE |
                                                     SRB_FLAGS_BYPASS_LOCKED_QUEUE |
                                                     SRB_FLAGS_D3_PROCESSING;
 
        DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_EXECUTE_SCSI;
        DeviceExtension->PowerContext.Srb.TimeOutValue = timeoutValue;
 
        if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceInitial)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_LOCK_QUEUE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceLocked)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_QUIESCE_DEVICE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
        {
            // Case of issuing SYNC CACHE command.
            DeviceExtension->PowerContext.Srb.CdbLength = 10;
            cdb->SYNCHRONIZE_CACHE10.OperationCode = SCSIOP_SYNCHRONIZE_CACHE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceFlushed)
        {
            // Case of issuing STOP UNIT command.
            DeviceExtension->PowerContext.Srb.CdbLength = 6;
            cdb->START_STOP.OperationCode = SCSIOP_START_STOP_UNIT;
            cdb->START_STOP.Start = 0;
            cdb->START_STOP.Immediate = 1;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceStopped)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_UNLOCK_QUEUE;
        }
 
        // Set up completion routine and context if requested
        if (CompletionRoutine)
        {
            WdfRequestSetCompletionRoutine(DeviceExtension->PowerContext.PowerRequest,
                                           CompletionRoutine,
                                           Context);
        }
 
        status = RequestSend(DeviceExtension,
                             DeviceExtension->PowerContext.PowerRequest,
                             DeviceExtension->IoTarget,
                             CompletionRoutine ? 0 : WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
                             &requestSent);
 
        if (requestSent)
        {
            if ((CompletionRoutine == NULL) &&
                (SRB_STATUS(DeviceExtension->PowerContext.Srb.SrbStatus) != SRB_STATUS_SUCCESS))
            {
                TracePrint((TRACE_LEVEL_ERROR,
                            TRACE_FLAG_POWER,
                            "%p\tError occured when issuing %s command to device. Srb %p, Status %x\n",
                            DeviceExtension->PowerContext.PowerRequest,
                            (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced) ? "SYNC CACHE" : "STOP UNIT",
                            &DeviceExtension->PowerContext.Srb,
                            DeviceExtension->PowerContext.Srb.SrbStatus));
 
                NT_ASSERT(!(TEST_FLAG(DeviceExtension->PowerContext.Srb.SrbStatus, SRB_STATUS_QUEUE_FROZEN)));
 
                shouldRetry = RequestSenseInfoInterpret(DeviceExtension,
                                                        DeviceExtension->PowerContext.PowerRequest,
                                                        &(DeviceExtension->PowerContext.Srb),
                                                        retryCount - DeviceExtension->PowerContext.RetryCount,
                                                        &status,
                                                        &(DeviceExtension->PowerContext.RetryIntervalIn100ns));
 
                if (shouldRetry && (DeviceExtension->PowerContext.RetryCount-- == 0))
                {
                    shouldRetry = FALSE;
                }
            }
            else
            {
                // succeeded, do not need to retry.
                shouldRetry = FALSE;
            }
 
        }
        else
        {
            // request failed to be sent
            shouldRetry = FALSE;
        }
 
        if (shouldRetry)
        {
            LARGE_INTEGER t;
            t.QuadPart = -DeviceExtension->PowerContext.RetryIntervalIn100ns;
            KeDelayExecutionThread(KernelMode, FALSE, &t);
 
            status = PowerContextReuseRequest(DeviceExtension);
            if (!NT_SUCCESS(status))
            {
                shouldRetry = FALSE;
            }
        }
    }
 
    if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
    {
        // record SYNC CACHE command completion time stamp.
        KeQueryTickCount(&DeviceExtension->PowerContext.Step1CompleteTime);
    }
 
    return status;
}

_IRQL_requires_max_() [2/2]

_Must_inspect_result_ _IRQL_requires_max_

(

PASSIVE_LEVEL

)

Queries information details about a security descriptor.

Computes the quota size of a security descriptor.

Assigns a security descriptor for a new object.

An extended function that assigns a security descriptor for a new object.

Frees a security descriptor.

An extended function that sets new information data to a security descriptor.

Modifies some information data about a security descriptor.

Parameters

[in]	SecurityInformation	Security information details to be queried from a security descriptor.
[out]	SecurityDescriptor	The returned security descriptor with security information data.
[in,out]	Length	The returned length of a security descriptor.
[in,out]	ObjectsSecurityDescriptor	The returned object security descriptor.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the specific information about the security descriptor has been queried. STATUS_BUFFER_TOO_SMALL is returned if the buffer size is too small to contain the queried info about the security descriptor.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

See SeSetSecurityDescriptorInfoEx.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	AutoInheritFlags	Flags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

Returns STATUS_SUCCESS if the operations have been completed without problems and that new info has been set to the security descriptor. STATUS_NO_SECURITY_ON_OBJECT is returned if the object does not have a security descriptor. STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the new security descriptor with new info set has failed.

Parameters

[in]

SecurityDescriptor

A security descriptor to be freed from memory.

Returns

Returns STATUS_SUCCESS.

Parameters

[in]	_ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	_ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	ObjectType	The type of the new object.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	AutoInheritFlags	Automatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the security descriptor has been assigned to the new object. STATUS_NO_TOKEN is returned if the caller hasn't supplied a valid argument to a security subject context. STATUS_INVALID_OWNER is returned if the caller hasn't supplied a parent descriptor that belongs to the main user (owner). STATUS_INVALID_PRIMARY_GROUP is returned by the same reason as with the previous NTSTATUS code. The two NTSTATUS codes are returned if the calling thread stated that the owner and/or group is defaulted to the parent descriptor (SEF_DEFAULT_OWNER_FROM_PARENT and/or SEF_DEFAULT_GROUP_FROM_PARENT respectively). STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the descriptor buffer has failed. A failure NTSTATUS is returned otherwise.

Parameters

[in]	ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

See SeAssignSecurityEx.

Parameters

[in]	SecurityDescriptor	A security descriptor.
[out]	QuotaInfoSize	The returned quota size of the given security descriptor to the caller. The function may return 0 to this parameter if the descriptor doesn't have a group or a discretionary access control list (DACL) even.

Returns

Returns STATUS_SUCCESS if the quota size of a security descriptor has been computed successfully. STATUS_UNKNOWN_REVISION is returned if the security descriptor has an invalid revision.

Definition at line 923 of file Messaging.c.

{
    PFLT_SERVER_PORT_OBJECT PortObject;
    NTSTATUS Status;
 
    /* The caller must allow at least one connection */
    if (MaxConnections == 0)
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /* The request must be for a kernel handle */
    if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /*
     * Get rundown protection on the target to stop the owner
     * from unloading whilst this port object is open. It gets
     * removed in the FltpServerPortClose callback
     */
    Status = FltObjectReference(Filter);
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }
 
    /* Create the server port object for this filter */
    Status = ObCreateObject(KernelMode,
                            ServerPortObjectType,
                            ObjectAttributes,
                            KernelMode,
                            NULL,
                            sizeof(FLT_SERVER_PORT_OBJECT),
                            0,
                            0,
                            (PVOID *)&PortObject);
    if (NT_SUCCESS(Status))
    {
        /* Zero out the struct */
        RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));
 
        /* Increment the ref count on the target filter */
        FltpObjectPointerReference((PFLT_OBJECT)Filter);
 
        /* Setup the filter port object */
        PortObject->Filter = Filter;
        PortObject->ConnectNotify = ConnectNotifyCallback;
        PortObject->DisconnectNotify = DisconnectNotifyCallback;
        PortObject->MessageNotify = MessageNotifyCallback;
        PortObject->Cookie = ServerPortCookie;
        PortObject->MaxConnections = MaxConnections;
 
        /* Insert the object */
        Status = ObInsertObject(PortObject,
                                NULL,
                                STANDARD_RIGHTS_ALL | FILE_READ_DATA,
                                0,
                                NULL,
                                (PHANDLE)ServerPort);
        if (NT_SUCCESS(Status))
        {
            /* Lock the connection list */
            ExAcquireFastMutex(&Filter->ConnectionList.mLock);
 
            /* Add the new port object to the connection list and increment the count */
            InsertTailList(&Filter->ConnectionList.mList, &PortObject->FilterLink);
            Filter->ConnectionList.mCount++;
 
            /* Unlock the connection list*/
            ExReleaseFastMutex(&Filter->ConnectionList.mLock);
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        /* Allow the filter to be cleaned up */
        FltObjectDereference(Filter);
    }
 
    return Status;
}

_Out_writes_()

_Must_inspect_result_ _Out_writes_

(

UsageListLength

)

_Out_writes_bytes_()

_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA _Inout_ PULONG _In_ PHIDP_PREPARSED_DATA _Out_writes_bytes_

(

ReportLength

)

HidP_GetScaledUsageValue()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_GetScaledUsageValue	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_In_ USAGE	Usage,
		_Out_ PLONG	UsageValue,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_In_reads_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

Referenced by MouHid_GetButtonMove(), and MouHid_ReadCompletion().

HidP_GetUsages()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_GetUsages	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_Out_writes_to_ *, *UsageLength USAGE *	UsageList,
		_Inout_ ULONG *	UsageLength,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_Out_writes_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

Referenced by MouHid_GetButtonFlags(), and process_data().

HidP_GetUsageValue()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_GetUsageValue	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_In_ USAGE	Usage,
		_Out_ PULONG	UsageValue,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_In_reads_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

Referenced by MouHid_GetButtonMove(), and process_data().

HidP_GetUsageValueArray()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_GetUsageValueArray	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_In_ USAGE	Usage,
		_Inout_updates_bytes_(UsageValueByteLength) PCHAR	UsageValue,
		_In_ USHORT	UsageValueByteLength,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_In_reads_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

HidP_SetData()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_SetData	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_Inout_updates_to_ *, *DataLength PHIDP_DATA	DataList,
		_Inout_ PULONG	DataLength,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_In_reads_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

HidP_SetScaledUsageValue()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_SetScaledUsageValue	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_In_ USAGE	Usage,
		_In_ LONG	UsageValue,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_Inout_updates_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

HidP_SetUsages()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_SetUsages	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_Inout_updates_to_ *, *UsageLength PUSAGE	UsageList,
		_Inout_ PULONG	UsageLength,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_In_reads_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

HidP_SetUsageValue()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_SetUsageValue	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_In_ USAGE	Usage,
		_In_ ULONG	UsageValue,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_Inout_updates_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

HidP_SetUsageValueArray()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_SetUsageValueArray	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_ USHORT	LinkCollection,
		_In_ USAGE	Usage,
		_In_reads_bytes_(UsageValueByteLength) PCHAR	UsageValue,
		_In_ USHORT	UsageValueByteLength,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_Inout_updates_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

HidP_TranslateUsageAndPagesToI8042ScanCodes()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_TranslateUsageAndPagesToI8042ScanCodes	(	_In_reads_(UsageListLength) PUSAGE_AND_PAGE	ChangedUsageList,
		_In_ ULONG	UsageListLength,
		_In_ HIDP_KEYBOARD_DIRECTION	KeyAction,
		_Inout_ PHIDP_KEYBOARD_MODIFIER_STATE	ModifierState,
		_In_ PHIDP_INSERT_SCANCODES	InsertCodesProcedure,
		_In_opt_ PVOID	InsertCodesContext
	)

Referenced by KbdHid_ReadCompletion().

HidP_TranslateUsagesToI8042ScanCodes()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_TranslateUsagesToI8042ScanCodes	(	_In_reads_(UsageListLength) PUSAGE	ChangedUsageList,
		_In_ ULONG	UsageListLength,
		_In_ HIDP_KEYBOARD_DIRECTION	KeyAction,
		_Inout_ PHIDP_KEYBOARD_MODIFIER_STATE	ModifierState,
		_In_ PHIDP_INSERT_SCANCODES	InsertCodesProcedure,
		_In_opt_ PVOID	InsertCodesContext
	)

HidP_UnsetUsages()

_Must_inspect_result_ HIDAPI NTSTATUS NTAPI HidP_UnsetUsages	(	_In_ HIDP_REPORT_TYPE	ReportType,
		_In_ USAGE	UsagePage,
		_In_opt_ USHORT	LinkCollection,
		_Inout_updates_to_ *, *UsageLength PUSAGE	UsageList,
		_Inout_ PULONG	UsageLength,
		_In_ PHIDP_PREPARSED_DATA	PreparsedData,
		_In_reads_bytes_(ReportLength) PCHAR	Report,
		_In_ ULONG	ReportLength
	)

Variable Documentation

Attributes

_Must_inspect_result_ _In_ USHORT _In_ PHIDP_PREPARSED_DATA _Out_writes_to_ LengthAttributes PHIDP_EXTENDED_ATTRIBUTES Attributes

Definition at line 348 of file hidpi.h.

ButtonCaps

_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_BUTTON_CAPS ButtonCaps

Definition at line 385 of file hidpi.h.

Referenced by HidP_GetButtonCaps(), and HidParser_GetButtonCaps().

ButtonCapsLength

_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_BUTTON_CAPS _Inout_ PUSHORT ButtonCapsLength

Definition at line 386 of file hidpi.h.

Referenced by HidP_GetButtonCaps(), and HidParser_GetButtonCaps().

ButtonList

_Must_inspect_result_ _In_ USHORT _Inout_updates_to_ UsageLength PUSAGE_AND_PAGE ButtonList

Definition at line 425 of file hidpi.h.

Referenced by HidP_GetUsagesEx(), and HidParser_GetUsagesEx().

Capabilities

_Must_inspect_result_ _Out_ PHIDP_CAPS Capabilities

Definition at line 324 of file hidpi.h.

DataIndex

_Must_inspect_result_ _In_ USHORT DataIndex

Definition at line 346 of file hidpi.h.

Referenced by WriteMidiUartMulti().

DataLength

_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA _Inout_ PULONG DataLength

Definition at line 334 of file hidpi.h.

DataList

_Must_inspect_result_ _Out_writes_to_ DataLength PHIDP_DATA DataList

Definition at line 333 of file hidpi.h.

Referenced by CKsDataTypeHandler::KsIsMediaTypeInRanges().

LengthAttributes

_Must_inspect_result_ _In_ USHORT _In_ PHIDP_PREPARSED_DATA _Out_writes_to_ LengthAttributes PHIDP_EXTENDED_ATTRIBUTES _Inout_ OUT PULONG LengthAttributes

Definition at line 349 of file hidpi.h.

LinkCollection

_Must_inspect_result_ _In_ USHORT LinkCollection

Definition at line 383 of file hidpi.h.

Referenced by HidP_GetScaledUsageValue(), HidP_GetSpecificValueCaps(), HidP_GetUsages(), HidP_GetUsagesEx(), HidP_GetUsageValue(), HidParser_GetScaledUsageValue(), HidParser_GetSpecificValueCaps(), HidParser_GetUsages(), HidParser_GetUsagesEx(), and HidParser_GetUsageValue().

LinkCollectionNodesLength

_Must_inspect_result_ _Inout_ PULONG LinkCollectionNodesLength

Definition at line 358 of file hidpi.h.

PreparsedData

_In_ USAGE _In_ PHIDP_PREPARSED_DATA PreparsedData

Definition at line 335 of file hidpi.h.

Referenced by HidD_FreePreparsedData(), HidD_GetPreparsedData(), HidP_GetButtonCaps(), HidP_GetCaps(), HidP_GetScaledUsageValue(), HidP_GetSpecificValueCaps(), HidP_GetUsages(), HidP_GetUsagesEx(), HidP_GetUsageValue(), HidP_GetValueCaps(), HidP_MaxUsageListLength(), KbdHid_StartDevice(), and MouHid_StartDevice().

ReportID

_Must_inspect_result_ _In_ UCHAR ReportID

Definition at line 482 of file hidpi.h.

Referenced by HidClassPDO_GetReportDescriptionByReportID(), HidParser_AllocateReport(), HidParser_FindReport(), HidParser_FindReportInCollection(), and HidParser_GetReport().

ReportLength

_Must_inspect_result_ _In_ UCHAR _In_ PHIDP_PREPARSED_DATA _In_ ULONG ReportLength

Definition at line 337 of file hidpi.h.

Referenced by HidP_GetScaledUsageValue(), HidP_GetUsages(), HidP_GetUsagesEx(), HidP_GetUsageValue(), HidParser_GetReportLength(), HidParser_GetScaledUsageValue(), HidParser_GetUsages(), HidParser_GetUsagesEx(), HidParser_GetUsageValue(), and HidParser_ParseReportDescriptor().

Usage

_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE Usage

(

void

)

Definition at line 384 of file hidpi.h.

Referenced by Addhost(), FxPkgPnp::AdjustUsageCount(), CheckDeviceFormat(), clear_normals(), compare_normals(), CreateD3D9MipMap(), CreateDIBSection(), D3DXComputeTangentFrameEx(), D3DXCreateMeshFVFTest(), D3DXCreateMeshTest(), D3DXFVFFromDeclarator(), D3DXLoadMeshFromXInMemory(), DECLARE_INTERFACE_(), Deletehost(), DIB_ConvertBitmapInfo(), FxPkgPnp::GetUsageCount(), GreGetDIBitsInternal(), HeapSummary(), HidP_GetScaledUsageValue(), HidP_GetSpecificValueCaps(), HidP_GetUsageValue(), HidParser_GetScaledUsageValue(), HidParser_GetSpecificValueCaps(), HidParser_GetUsageValue(), HidParser_TranslateUsageAndPagesToI8042ScanCodes(), HidParser_UsageAndPageListDifference(), HidParser_UsageListDifference(), IDirect3D9Impl_CheckDeviceFormat(), IDirect3DDevice9Base_CreateTexture(), InitDirect3DBaseTexture9(), FxPkgPnp::IsUsageSupported(), main(), MouHid_GetButtonFlags(), NtGdiCreateDIBSection(), NtGdiSetSystemPaletteUse(), ParseCmdline(), ReserveMemory(), FxPkgPnp::SetUsageSupport(), test_shader_semantics(), and wmain().

UsageLength

_Must_inspect_result_ _In_ USHORT _Inout_updates_to_ UsageLength PUSAGE_AND_PAGE _Inout_ ULONG* UsageLength

Definition at line 426 of file hidpi.h.

Referenced by HidP_GetUsages(), HidP_GetUsagesEx(), HidParser_GetUsages(), HidParser_GetUsagesEx(), and HidParser_GetUsagesWithReport().

UsageListLength

_Must_inspect_result_ _In_ ULONG UsageListLength

Definition at line 647 of file hidpi.h.

Referenced by HidP_TranslateUsageAndPagesToI8042ScanCodes(), HidP_UsageAndPageListDifference(), HidP_UsageListDifference(), HidParser_TranslateUsageAndPagesToI8042ScanCodes(), HidParser_UsageAndPageListDifference(), HidParser_UsageListDifference(), and MouHid_GetButtonFlags().

UsagePage

_In_ USAGE UsagePage

Definition at line 382 of file hidpi.h.

Referenced by HidP_GetScaledUsageValue(), HidP_GetSpecificValueCaps(), HidP_GetUsages(), HidP_GetUsageValue(), HidP_MaxUsageListLength(), HidParser_GetCollectionUsagePage(), HidParser_GetMaxUsageListLengthWithReportAndPage(), HidParser_GetScaledUsageValue(), HidParser_GetScaledUsageValueWithReport(), HidParser_GetSpecificValueCaps(), HidParser_GetSpecificValueCapsWithReport(), HidParser_GetUsages(), HidParser_GetUsagesWithReport(), HidParser_GetUsageValue(), HidParser_GetUsageValueWithReport(), HidParser_MaxUsageListLength(), HidParser_TranslateUsageAndPagesToI8042ScanCodes(), and process_data().

ValueCaps

_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_VALUE_CAPS ValueCaps

Definition at line 399 of file hidpi.h.

Referenced by HidP_GetSpecificValueCaps(), HidP_GetValueCaps(), HidParser_GetSpecificValueCaps(), HidParser_GetSpecificValueCapsWithReport(), and MouHid_StartDevice().

ValueCapsLength

_Must_inspect_result_ _In_ USAGE _In_ USHORT _In_ USAGE _Out_ PHIDP_VALUE_CAPS _Inout_ PUSHORT ValueCapsLength

Definition at line 400 of file hidpi.h.

Referenced by HidP_GetSpecificValueCaps(), HidP_GetValueCaps(), HidParser_GetSpecificValueCaps(), HidParser_GetSpecificValueCapsWithReport(), and MouHid_StartDevice().