BitsToRepresentRange() returns the number of bits required to represent all values in a given range. It is used to check that the report field size is appropriate for the given logical minimum and maximum.

If the range is all positive then it is assumed that there is no sign bit, otherwise twos complement format is assumed, as per the HID class specification, v1.11, Section 6.2.2.7.

CheckAllReportSizes() checks if all report sizes are integral multiples of 8 bits.

CheckDesignatorMinAndMaxErrors

CheckMandatoryFieldError

CheckForCollectionErrors() validates the current collection object. It adds non-critical errors to the warnings list. It returns an error code if a critical error is encountered.

CheckForFieldErrors() validates the current global and local item state in preparation for creating a CField object. It adds non-critical errors to the warnings list. It returns an error code if a critical error is encountered.

CheckForMainErrors() performs error checking common to CheckForCollectionErrors() and CheckForFieldErrors(). It adds non-critical errors to the warnings list. It returns an error code if a critical error is encountered.

CheckLogicalMinAndMax Check if logical minimum and maximum must match the number of usage values

CheckMandatoryFieldError

CheckMandatoryFieldError

CheckParseErrors

CheckStringMinAndMaxErrors

CheckUsageMinAndMaxErrors

ClearLocalState() clears the appropriate fields in the CField object that represents the current local item state.

Used to access the current collection object, i.e. the object at the top of the collection stack (iCollectionStack).

CreateCollectionL() is called to instantiate a new CCollection object when a "begin collection" item is encountered in the report descriptor.

CreateFieldL() is called to instantiate a new CField object when an input, output or feature item is encountered in the report descriptor.

The current local and global states extracted from the report descriptor are copied to the CField, which is placed into the current CCollection.

DumpStateTableL() copies the current local and global item state into a CField object.

Return field count

Handle a HID descriptor global item. Stores the data in the appropriate member of the current global state object, iGlobal.

HandleGlobalLogicalMaximum

HandleGlobalLogicalMinimum

HandleGlobalPhysicalMinimum

HandleGlobalPhysicalMinimum

HandleGlobalPop

HandleGlobalPush

HandleGlobalReportSize

HandleGlobalReportId

HandleGlobalReportSize

HandleGlobalUnit

HandleGlobalUnitExponent

HandleGlobalUsagePage

HandleItem

HandleLocalDelimiter

HandleLocalDesignatorIndex

HandleLocalDesignatorMaximum

HandleLocalDesignatorMinimum

HandleLocalStringIndex

HandleLocalStringMaximum

HandleLocalStringMinimum

HandleLocalUsage

HandleLocalUsageMinimum

HandleLocalUsageMinimum

HandleMainCollection

MainEndCollection

HandleMainFeature

HandleMainInputTagL

HandleMainOutputTag

IsReservedUsagePage() checks if the given HID usage page is listed as reserved according to the HID clas specification, v1.11.

IssueWarning() adds a TParserWarning to the warning list.

Handle a HID descriptor local item. Stores the data in the appropriate member of the local state object, *iLocal.

Handle a HID descriptor main item. This includes the creation of new field objects in the current collection and management of the global item state stack.

NumberOfLeadingZeros() is used by BitsToRepresentRange(). It returns the number of leading zeros in the binary representation of a number, effectively performing a log_2 operation.

ParseL() parses a string of bytes representing a HID report descriptor. It returns a tree of collection and field objects (a CReportRoot). Ownership of the CReportRoot is transferred to the caller.

Warning messages produced during the parse process are added to a list which the driver can retrieve using the Warnings() function. Note that the list will be overwritten by the next ParseL() operation.

Errors and warnings are represented using the format described in "HID Parser Error Codes", Revision 1.2, USB Implementers' Forum, February 2000.

Pushes a pointer to the current collection object on to the collection stack.

Note that the collection stack is used to create the tree of collections. It should not be confused with the global state stack, iGlobalStack.

Pushes a pointer to the current collection object on to the collection stack.

Note that the collection stack is used to create the tree of collections. It should not be confused with the global state stack, iGlobalStack.

ResetParser

HID global tags

THidItem defineds a set of flags used for keeping track of which items have been encountered in the report descriptor for the current report field. The flags are used with the iItemsDefined and iGlobalItemsDefined data members.

HID local tags

HID main tags

A bitmask containing the THidItem flags which represent local (as opposed to main or global) items.

A bitmask containing the THidItem flags which represent mandatory items.

A bitmask containing the THidItem flags which represent report items.

A bitmask containing the THidItem flags which represent local unused items.

Count of alternate USAGE declarations so far

Count of alternate USAGE_MAX declarations

Count of alternate USAGE_MIN declarations

Stack used to create the collection tree

Record of any critical error encountered

Field count

Current global state

Global items seen since the last main tag

Global state stack, to allow HID descriptor PUSH and POP commands

Number of the item we're currently processing

All items forming the current item state

The local state, cleared after each "Main" item Own.

ETrue if a redundant local item is seen

The root node of the collection tree Own.

ETrue if currently within a delimiter pair