USB HID descriptor format helpers. More...

Detailed Description

USB HID descriptor format helpers.

Macros
#define	USB_HID_ITEM_TYPE_MAIN 0x0
	HID Main item type.

#define	USB_HID_ITEM_TYPE_GLOBAL 0x1
	HID Global item type.

#define	USB_HID_ITEM_TYPE_LOCAL 0x2
	HID Local item type.

#define	USB_HID_ITEM_TAG_INPUT 0x8
	HID Input item tag.

#define	USB_HID_ITEM_TAG_OUTPUT 0x9
	HID Output item tag.

#define	USB_HID_ITEM_TAG_COLLECTION 0xA
	HID Collection item tag.

#define	USB_HID_ITEM_TAG_FEATURE 0xB
	HID Feature item tag.

#define	USB_HID_ITEM_TAG_COLLECTION_END 0xC
	HID End Collection item tag.

#define	USB_HID_ITEM_TAG_USAGE_PAGE 0x0
	HID Usage Page item tag.

#define	USB_HID_ITEM_TAG_LOGICAL_MIN 0x1
	HID Logical Minimum item tag.

#define	USB_HID_ITEM_TAG_LOGICAL_MAX 0x2
	HID Logical Maximum item tag.

#define	USB_HID_ITEM_TAG_PHYSICAL_MIN 0x3
	HID Physical Minimum item tag.

#define	USB_HID_ITEM_TAG_PHYSICAL_MAX 0x4
	HID Physical Maximum item tag.

#define	USB_HID_ITEM_TAG_UNIT_EXPONENT 0x5
	HID Unit Exponent item tag.

#define	USB_HID_ITEM_TAG_UNIT 0x6
	HID Unit item tag.

#define	USB_HID_ITEM_TAG_REPORT_SIZE 0x7
	HID Report Size item tag.

#define	USB_HID_ITEM_TAG_REPORT_ID 0x8
	HID Report ID item tag.

#define	USB_HID_ITEM_TAG_REPORT_COUNT 0x9
	HID Report count item tag.

#define	USB_HID_ITEM_TAG_USAGE 0x0
	HID Usage item tag.

#define	USB_HID_ITEM_TAG_USAGE_MIN 0x1
	HID Usage Minimum item tag.

#define	USB_HID_ITEM_TAG_USAGE_MAX 0x2
	HID Usage Maximum item tag.

#define	USB_HID_COLLECTION_PHYSICAL 0x00
	Physical collection type.

#define	USB_HID_COLLECTION_APPLICATION 0x01
	Application collection type.

#define	USB_HID_COLLECTION_LOGICAL 0x02
	Logical (interrelated data) collection type.

#define	USB_HID_COLLECTION_REPORT 0x03
	Report collection type.

#define	USB_HID_COLLECTION_NAMED_ARRAY 0x04
	Named array collection type.

#define	USB_HID_COLLECTION_USAGE_SWITCH 0x05
	Usage switch collection type.

#define	USB_HID_COLLECTION_USAGE_MOD 0x06
	Modifier switch collection type.

#define	USB_HID_ITEM(tag, type, size) (((tag & 0xF) << 4) \| ((type & 0x3) << 2) \| (size & 0x3))
	Defines a HID descriptor short item. More...

#define	USB_HID_INPUT(input)
	Defines a HID descriptor input item. More...

#define	USB_HID_OUTPUT(output)
	Defines a HID descriptor output item. More...

#define	USB_HID_FEATURE(feature)
	Defines a HID Feature item. More...

#define	USB_HID_COLLECTION(collection)
	Defines a HID Collection item. More...

#define	USB_HID_END_COLLECTION USB_HID_ITEM(USB_HID_ITEM_TAG_COLLECTION_END, USB_HID_ITEM_TYPE_MAIN, 0)
	Defines a HID End Collection item.

#define	USB_HID_USAGE_PAGE(page)
	Defines a HID Usage Page item. More...

#define	USB_HID_USAGE_PAGE16(page)
	Defines a HID Usage Page item. More...

#define	USB_HID_LOGICAL_MIN8(minimum)
	Defines a HID Logical Minimum item. More...

#define	USB_HID_LOGICAL_MIN16(minimum)
	Defines a HID Logical Minimum item. More...

#define	USB_HID_LOGICAL_MIN32(minimum)
	Defines a HID Logical Minimum item. More...

#define	USB_HID_LOGICAL_MAX8(maximum)
	Defines a HID Logical Maximum item. More...

#define	USB_HID_LOGICAL_MAX16(maximum)
	Defines a HID Logical Maximum item. More...

#define	USB_HID_LOGICAL_MAX32(maximum)
	Defines a HID Logical Maximum item. More...

#define	USB_HID_REPORT_SIZE(size)
	Defines a HID Report Size item. More...

#define	USB_HID_REPORT_ID(id)
	Defines a HID Report ID item. More...

#define	USB_HID_REPORT_COUNT(count)
	Define HID Report Count item. More...

#define	USB_HID_USAGE(index)
	Defines a HID Usage Index item. More...

#define	USB_HID_USAGE_MIN8(start)
	Defines a HID Usage Minimum item. More...

#define	USB_HID_USAGE_MIN16(start)
	Define HID Usage Minimum item with the data length of two bytes. More...

#define	USB_HID_USAGE_MAX8(end)
	Defines HID Usage Maximum item. More...

#define	USB_HID_USAGE_MAX16(end)
	Defines HID Usage Maximum item. More...

Macro Definition Documentation

◆ USB_HID_COLLECTION

#define USB_HID_COLLECTION ( collection )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_COLLECTION, USB_HID_ITEM_TYPE_MAIN, 1), \

collection

USB_HID_ITEM

#define USB_HID_ITEM(tag, type, size)

Defines a HID descriptor short item.

Definition: hid.h:271

USB_HID_ITEM_TAG_COLLECTION

#define USB_HID_ITEM_TAG_COLLECTION

HID Collection item tag.

Definition: hid.h:153

USB_HID_ITEM_TYPE_MAIN

#define USB_HID_ITEM_TYPE_MAIN

HID Main item type.

Definition: hid.h:128

Defines a HID Collection item.

Note: data length is one byte.

Parameters

collection Collection item data

Definition at line 314 of file hid.h.

◆ USB_HID_FEATURE

#define USB_HID_FEATURE ( feature )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_FEATURE, USB_HID_ITEM_TYPE_MAIN, 1), \

feature

USB_HID_ITEM_TAG_FEATURE

#define USB_HID_ITEM_TAG_FEATURE

HID Feature item tag.

Definition: hid.h:158

Defines a HID Feature item.

Note: data length is one byte.

Parameters

feature Feature item data

Definition at line 303 of file hid.h.

◆ USB_HID_INPUT

#define USB_HID_INPUT ( input )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_INPUT, USB_HID_ITEM_TYPE_MAIN, 1), \

input

USB_HID_ITEM_TAG_INPUT

#define USB_HID_ITEM_TAG_INPUT

HID Input item tag.

Definition: hid.h:143

Defines a HID descriptor input item.

Note: data length is one byte

Parameters

input Input item flags

Definition at line 281 of file hid.h.

◆ USB_HID_ITEM

#define USB_HID_ITEM	(	tag,
		type,
		size
	)	(((tag & 0xF) << 4) \| ((type & 0x3) << 2) \| (size & 0x3))

Defines a HID descriptor short item.

Parameters

tag	Item tag
type	Item type
size	Item data size

Definition at line 271 of file hid.h.

◆ USB_HID_LOGICAL_MAX16

#define USB_HID_LOGICAL_MAX16 ( maximum )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MAX, USB_HID_ITEM_TYPE_GLOBAL, 2), \

(maximum & 0xff), (maximum >> 8)

USB_HID_ITEM_TAG_LOGICAL_MAX

#define USB_HID_ITEM_TAG_LOGICAL_MAX

HID Logical Maximum item tag.

Definition: hid.h:177

USB_HID_ITEM_TYPE_GLOBAL

#define USB_HID_ITEM_TYPE_GLOBAL

HID Global item type.

Definition: hid.h:133

Defines a HID Logical Maximum item.

Note: data length is two bytes.

Parameters

maximum Maximum value in logical units

Definition at line 400 of file hid.h.

◆ USB_HID_LOGICAL_MAX32

#define USB_HID_LOGICAL_MAX32 ( maximum )

Value:

    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MAX, USB_HID_ITEM_TYPE_GLOBAL, 3), \
    maximum & 0xff, \
    (maximum >> 8) & 0xff, \
    (maximum >> 16) & 0xff, \
    (maximum >> 24) & 0xff

Defines a HID Logical Maximum item.

Note: data length is four bytes.

Parameters

maximum Maximum value in logical units

Definition at line 411 of file hid.h.

◆ USB_HID_LOGICAL_MAX8

#define USB_HID_LOGICAL_MAX8 ( maximum )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MAX, USB_HID_ITEM_TYPE_GLOBAL, 1), \

maximum

Defines a HID Logical Maximum item.

Note: data length is one byte.

Parameters

maximum Maximum value in logical units

Definition at line 389 of file hid.h.

◆ USB_HID_LOGICAL_MIN16

#define USB_HID_LOGICAL_MIN16 ( minimum )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MIN, USB_HID_ITEM_TYPE_GLOBAL, 2), \

minimum & 0xff, (minimum >> 8)

USB_HID_ITEM_TAG_LOGICAL_MIN

#define USB_HID_ITEM_TAG_LOGICAL_MIN

HID Logical Minimum item tag.

Definition: hid.h:172

Defines a HID Logical Minimum item.

Note: data length is two bytes.

Parameters

minimum Minimum value in logical units

Definition at line 364 of file hid.h.

◆ USB_HID_LOGICAL_MIN32

#define USB_HID_LOGICAL_MIN32 ( minimum )

Value:

    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MIN, USB_HID_ITEM_TYPE_GLOBAL, 3), \
    minimum & 0xff, \
    (minimum >> 8) & 0xff, \
    (minimum >> 16) & 0xff, \
    (minimum >> 24) & 0xff

Defines a HID Logical Minimum item.

Note: data length is four bytes.

Parameters

minimum Minimum value in logical units

Definition at line 375 of file hid.h.

◆ USB_HID_LOGICAL_MIN8

#define USB_HID_LOGICAL_MIN8 ( minimum )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MIN, USB_HID_ITEM_TYPE_GLOBAL, 1), \

minimum

Defines a HID Logical Minimum item.

Note: data length is one byte.

Parameters

minimum Minimum value in logical units

Definition at line 353 of file hid.h.

◆ USB_HID_OUTPUT

#define USB_HID_OUTPUT ( output )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_OUTPUT, USB_HID_ITEM_TYPE_MAIN, 1), \

output

USB_HID_ITEM_TAG_OUTPUT

#define USB_HID_ITEM_TAG_OUTPUT

HID Output item tag.

Definition: hid.h:148

Defines a HID descriptor output item.

Note: data length is one byte

Parameters

output Output item flags

Definition at line 292 of file hid.h.

◆ USB_HID_REPORT_COUNT

#define USB_HID_REPORT_COUNT ( count )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_REPORT_COUNT, USB_HID_ITEM_TYPE_GLOBAL, 1), \

count

USB_HID_ITEM_TAG_REPORT_COUNT

#define USB_HID_ITEM_TAG_REPORT_COUNT

HID Report count item tag.

Definition: hid.h:212

Define HID Report Count item.

Note: data length is one byte.

Parameters

count Number of data fields included in the report

Definition at line 447 of file hid.h.

◆ USB_HID_REPORT_ID

#define USB_HID_REPORT_ID ( id )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_REPORT_ID, USB_HID_ITEM_TYPE_GLOBAL, 1), \

id

USB_HID_ITEM_TAG_REPORT_ID

#define USB_HID_ITEM_TAG_REPORT_ID

HID Report ID item tag.

Definition: hid.h:207

Defines a HID Report ID item.

Note: data length is one byte.

Parameters

id Report ID

Definition at line 436 of file hid.h.

◆ USB_HID_REPORT_SIZE

#define USB_HID_REPORT_SIZE ( size )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_REPORT_SIZE, USB_HID_ITEM_TYPE_GLOBAL, 1), \

size

USB_HID_ITEM_TAG_REPORT_SIZE

#define USB_HID_ITEM_TAG_REPORT_SIZE

HID Report Size item tag.

Definition: hid.h:202

Defines a HID Report Size item.

Note: data length is one byte.

Parameters

size	Report field size in bits

Definition at line 425 of file hid.h.

◆ USB_HID_USAGE

#define USB_HID_USAGE ( index )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE, USB_HID_ITEM_TYPE_LOCAL, 1), \

index

USB_HID_ITEM_TAG_USAGE

#define USB_HID_ITEM_TAG_USAGE

HID Usage item tag.

Definition: hid.h:217

USB_HID_ITEM_TYPE_LOCAL

#define USB_HID_ITEM_TYPE_LOCAL

HID Local item type.

Definition: hid.h:138

Defines a HID Usage Index item.

Note: data length is one byte.

Parameters

index Number of data fields included in the report

Definition at line 458 of file hid.h.

◆ USB_HID_USAGE_MAX16

#define USB_HID_USAGE_MAX16 ( end )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MAX, USB_HID_ITEM_TYPE_LOCAL, 2), \

end & 0xff, (end >> 8) & 0xff

USB_HID_ITEM_TAG_USAGE_MAX

#define USB_HID_ITEM_TAG_USAGE_MAX

HID Usage Maximum item tag.

Definition: hid.h:227

Defines HID Usage Maximum item.

Note: data length is one byte.

Parameters

end	Ending Usage

Definition at line 502 of file hid.h.

◆ USB_HID_USAGE_MAX8

#define USB_HID_USAGE_MAX8 ( end )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MAX, USB_HID_ITEM_TYPE_LOCAL, 1), \

end

Defines HID Usage Maximum item.

Note: data length is one byte.

Parameters

end	Ending Usage

Definition at line 491 of file hid.h.

◆ USB_HID_USAGE_MIN16

#define USB_HID_USAGE_MIN16 ( start )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MIN, USB_HID_ITEM_TYPE_LOCAL, 2), \

start & 0xff, (start >> 8) & 0xff

USB_HID_ITEM_TAG_USAGE_MIN

#define USB_HID_ITEM_TAG_USAGE_MIN

HID Usage Minimum item tag.

Definition: hid.h:222

Define HID Usage Minimum item with the data length of two bytes.

Note: data length is two bytes.

Parameters

start Starting Usage

Definition at line 480 of file hid.h.

◆ USB_HID_USAGE_MIN8

#define USB_HID_USAGE_MIN8 ( start )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MIN, USB_HID_ITEM_TYPE_LOCAL, 1), \

start

Defines a HID Usage Minimum item.

Note: data length is one byte.

Parameters

start Starting Usage

Definition at line 469 of file hid.h.

◆ USB_HID_USAGE_PAGE

#define USB_HID_USAGE_PAGE ( page )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_PAGE, USB_HID_ITEM_TYPE_GLOBAL, 1), \

page

USB_HID_ITEM_TAG_USAGE_PAGE

#define USB_HID_ITEM_TAG_USAGE_PAGE

HID Usage Page item tag.

Definition: hid.h:168

Defines a HID Usage Page item.

Note: data length is one byte.

Parameters

page	Usage Page

Definition at line 331 of file hid.h.

◆ USB_HID_USAGE_PAGE16

#define USB_HID_USAGE_PAGE16 ( page )

Value:

USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_PAGE, USB_HID_ITEM_TYPE_GLOBAL, 2), \

page & 0xff, (page >> 8)

Defines a HID Usage Page item.

Note: data length is two bytes.

Parameters

page	Usage page

Definition at line 342 of file hid.h.

Detailed Description

Macros

Macro Definition Documentation

◆ USB_HID_COLLECTION

◆ USB_HID_FEATURE

◆ USB_HID_INPUT

◆ USB_HID_ITEM

◆ USB_HID_LOGICAL_MAX16

◆ USB_HID_LOGICAL_MAX32

◆ USB_HID_LOGICAL_MAX8

◆ USB_HID_LOGICAL_MIN16

◆ USB_HID_LOGICAL_MIN32

◆ USB_HID_LOGICAL_MIN8

◆ USB_HID_OUTPUT

◆ USB_HID_REPORT_COUNT

◆ USB_HID_REPORT_ID

◆ USB_HID_REPORT_SIZE

◆ USB_HID_USAGE

◆ USB_HID_USAGE_MAX16

◆ USB_HID_USAGE_MAX8

◆ USB_HID_USAGE_MIN16

◆ USB_HID_USAGE_MIN8

◆ USB_HID_USAGE_PAGE

◆ USB_HID_USAGE_PAGE16