tHIDKeyboardUsageTable Struct Reference

#include <usbhid.h>

Data Fields
uint8_t	ui8BytesPerChar
uint32_t	pui32CapsLock [USBH_HID_CAPS_ARRAY_SZ]
void *	pvCharMapping

Detailed Description

This structure defines the mapping of USB usage identifiers to printable characters. The structure has three members that hold this information. The ui8BytesPerChar, indicates the number of bytes per character in the table. The pui32CapsLock array holds a packed bit array of usage identifiers that can be modified by the Caps Lock key. The pCharMapping array is treated as a double indexed array with two "columns". In the case of a single byte character it is treated as pairs of 8 bit values for unshifted and shifted values. In the case of a double byte characters it is treated as pairs of 16 bit values.

Field Documentation

ui8BytesPerChar

uint8_t tHIDKeyboardUsageTable::ui8BytesPerChar

Number of bytes per character in the pCharMapping table of this structure.

Referenced by USBHKeyboardUsageToChar().

pui32CapsLock

uint32_t tHIDKeyboardUsageTable::pui32CapsLock[USBH_HID_CAPS_ARRAY_SZ]

This is a packed bitmasked structure with a one bit flags that indicates if the corresponding Usage ID is affected by the Caps Lock key.

Referenced by USBHKeyboardUsageToChar().

pvCharMapping

void* tHIDKeyboardUsageTable::pvCharMapping

This is the indexed table of Usage ID to character value. It must be at least ui8BytesPerChar * 2 * USBH_HID_MAX_USAGE bytes in size as it is treated as a double indexed array.

Referenced by USBHKeyboardUsageToChar().

---

The documentation for this struct was generated from the following file:

• usbhid.h