Macros
#define	HID_ITEM(bTag, bType, bSize)
	Define HID short item.
#define	HID_INPUT(a)
	Define HID Input item with the data length of one byte.
#define	HID_OUTPUT(a)
	Define HID Output item with the data length of one byte.
#define	HID_FEATURE(a)
	Define HID Feature item with the data length of one byte.
#define	HID_COLLECTION(a)
	Define HID Collection item with the data length of one byte.
#define	HID_END_COLLECTION HID_ITEM(HID_ITEM_TAG_COLLECTION_END, HID_ITEM_TYPE_MAIN, 0)
	Define HID End Collection (non-data) item.
#define	HID_USAGE_PAGE(page)
	Define HID Usage Page item.
#define	HID_LOGICAL_MIN8(a)
	Define HID Logical Minimum item with the data length of one byte.
#define	HID_LOGICAL_MAX8(a)
	Define HID Logical Maximum item with the data length of one byte.
#define	HID_LOGICAL_MIN16(a, b)
	Define HID Logical Minimum item with the data length of two bytes.
#define	HID_LOGICAL_MAX16(a, b)
	Define HID Logical Maximum item with the data length of two bytes.
#define	HID_LOGICAL_MIN32(a, b, c, d)
	Define HID Logical Minimum item with the data length of four bytes.
#define	HID_LOGICAL_MAX32(a, b, c, d)
	Define HID Logical Maximum item with the data length of four bytes.
#define	HID_REPORT_SIZE(size)
	Define HID Report Size item with the data length of one byte.
#define	HID_REPORT_ID(id)
	Define HID Report ID item with the data length of one byte.
#define	HID_REPORT_COUNT(count)
	Define HID Report Count item with the data length of one byte.
#define	HID_USAGE(idx)
	Define HID Usage Index item with the data length of one byte.
#define	HID_USAGE16(idx)
	Define HID Usage Index item with the data length of two bytes.
#define	HID_USAGE_MIN8(a)
	Define HID Usage Minimum item with the data length of one byte.
#define	HID_USAGE_MAX8(a)
	Define HID Usage Maximum item with the data length of one byte.
#define	HID_USAGE_MIN16(a, b)
	Define HID Usage Minimum item with the data length of two bytes.
#define	HID_USAGE_MAX16(a, b)
	Define HID Usage Maximum item with the data length of two bytes.
#define	HID_UNIT_EXPONENT(exp)
	Define HID Unit Exponent item.

Detailed Description

Macro Definition Documentation

◆ HID_COLLECTION

#define HID_COLLECTION ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_COLLECTION, HID_ITEM_TYPE_MAIN, 1), a

HID_ITEM_TAG_COLLECTION

#define HID_ITEM_TAG_COLLECTION

HID Collection item tag.

Definition hid.h:84

HID_ITEM_TYPE_MAIN

#define HID_ITEM_TYPE_MAIN

HID Main item type.

Definition hid.h:73

HID_ITEM

#define HID_ITEM(bTag, bType, bSize)

Define HID short item.

Definition hid.h:212

Define HID Collection item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Collection item data

Returns: HID Collection item

◆ HID_END_COLLECTION

#define HID_END_COLLECTION HID_ITEM(HID_ITEM_TAG_COLLECTION_END, HID_ITEM_TYPE_MAIN, 0)

#include <zephyr/usb/class/hid.h>

Define HID End Collection (non-data) item.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Returns: HID End Collection item

◆ HID_FEATURE

#define HID_FEATURE ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_FEATURE, HID_ITEM_TYPE_MAIN, 1), a

HID_ITEM_TAG_FEATURE

#define HID_ITEM_TAG_FEATURE

HID Feature item tag.

Definition hid.h:86

Define HID Feature item with the data length of one byte.

Parameters

a	Feature item data

Returns: HID Feature item

◆ HID_INPUT

#define HID_INPUT ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_INPUT, HID_ITEM_TYPE_MAIN, 1), a

HID_ITEM_TAG_INPUT

#define HID_ITEM_TAG_INPUT

HID Input item tag.

Definition hid.h:80

Define HID Input item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Input item data

Returns: HID Input item

◆ HID_ITEM

#define HID_ITEM	(	bTag,
		bType,
		bSize )

#include <zephyr/usb/class/hid.h>

Value:

(((bTag & 0xF) << 4) | \

((bType & 0x3) << 2) | (bSize & 0x3))

Define HID short item.

Parameters

bTag	Item tag
bType	Item type
bSize	Item data size

Returns: HID Input item

◆ HID_LOGICAL_MAX16

#define HID_LOGICAL_MAX16	(		a,
			b )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_LOGICAL_MAX, HID_ITEM_TYPE_GLOBAL, 2), a, b

HID_ITEM_TYPE_GLOBAL

#define HID_ITEM_TYPE_GLOBAL

HID Global item type.

Definition hid.h:75

HID_ITEM_TAG_LOGICAL_MAX

#define HID_ITEM_TAG_LOGICAL_MAX

HID Logical Maximum item tag.

Definition hid.h:95

Define HID Logical Maximum item with the data length of two bytes.

Parameters

a	Minimum value lower byte
b	Minimum value higher byte

Returns: HID Logical Maximum item

◆ HID_LOGICAL_MAX32

#define HID_LOGICAL_MAX32	(	a,
		b,
		c,
		d )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_LOGICAL_MAX, HID_ITEM_TYPE_GLOBAL, 3), a, b, c, d

d

irp nz macro MOVR cc d

Definition asm-macro-32-bit-gnu.h:11

Define HID Logical Maximum item with the data length of four bytes.

Parameters

a	Minimum value lower byte
b	Minimum value low middle byte
c	Minimum value high middle byte
d	Minimum value higher byte

Returns: HID Logical Maximum item

◆ HID_LOGICAL_MAX8

#define HID_LOGICAL_MAX8 ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_LOGICAL_MAX, HID_ITEM_TYPE_GLOBAL, 1), a

Define HID Logical Maximum item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Maximum value in logical units

Returns: HID Logical Maximum item

◆ HID_LOGICAL_MIN16

#define HID_LOGICAL_MIN16	(		a,
			b )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_LOGICAL_MIN, HID_ITEM_TYPE_GLOBAL, 2), a, b

HID_ITEM_TAG_LOGICAL_MIN

#define HID_ITEM_TAG_LOGICAL_MIN

HID Logical Minimum item tag.

Definition hid.h:93

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

Parameters

a	Minimum value lower byte
b	Minimum value higher byte

Returns: HID Logical Minimum item

◆ HID_LOGICAL_MIN32

#define HID_LOGICAL_MIN32	(	a,
		b,
		c,
		d )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_LOGICAL_MIN, HID_ITEM_TYPE_GLOBAL, 3), a, b, c, d

Define HID Logical Minimum item with the data length of four bytes.

Parameters

a	Minimum value lower byte
b	Minimum value low middle byte
c	Minimum value high middle byte
d	Minimum value higher byte

Returns: HID Logical Minimum item

◆ HID_LOGICAL_MIN8

#define HID_LOGICAL_MIN8 ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_LOGICAL_MIN, HID_ITEM_TYPE_GLOBAL, 1), a

Define HID Logical Minimum item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Minimum value in logical units

Returns: HID Logical Minimum item

◆ HID_OUTPUT

#define HID_OUTPUT ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_OUTPUT, HID_ITEM_TYPE_MAIN, 1), a

HID_ITEM_TAG_OUTPUT

#define HID_ITEM_TAG_OUTPUT

HID Output item tag.

Definition hid.h:82

Define HID Output item with the data length of one byte.

For usage examples, see HID_KEYBOARD_REPORT_DESC()

Parameters

a	Output item data

Returns: HID Output item

◆ HID_REPORT_COUNT

#define HID_REPORT_COUNT ( count )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_REPORT_COUNT, HID_ITEM_TYPE_GLOBAL, 1), count

HID_ITEM_TAG_REPORT_COUNT

#define HID_ITEM_TAG_REPORT_COUNT

HID Report count item tag.

Definition hid.h:109

Define HID Report Count item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

count Number of data fields included in the report

Returns: HID Report Count item

◆ HID_REPORT_ID

#define HID_REPORT_ID ( id )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_REPORT_ID, HID_ITEM_TYPE_GLOBAL, 1), id

HID_ITEM_TAG_REPORT_ID

#define HID_ITEM_TAG_REPORT_ID

HID Report ID item tag.

Definition hid.h:107

Define HID Report ID item with the data length of one byte.

Parameters

id Report ID

Returns: HID Report ID item

◆ HID_REPORT_SIZE

#define HID_REPORT_SIZE ( size )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_REPORT_SIZE, HID_ITEM_TYPE_GLOBAL, 1), size

HID_ITEM_TAG_REPORT_SIZE

#define HID_ITEM_TAG_REPORT_SIZE

HID Report Size item tag.

Definition hid.h:105

Define HID Report Size item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

size	Report field size in bits

Returns: HID Report Size item

◆ HID_UNIT_EXPONENT

#define HID_UNIT_EXPONENT ( exp )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_UNIT_EXPONENT, HID_ITEM_TYPE_GLOBAL, 1), exp

HID_ITEM_TAG_UNIT_EXPONENT

#define HID_ITEM_TAG_UNIT_EXPONENT

HID Unit Exponent item tag.

Definition hid.h:101

Define HID Unit Exponent item.

Parameters

exp	Unit exponent, refer to the HID Unit Exponent table in the specification for usage

Returns: HID Unit Exponent item

◆ HID_USAGE

#define HID_USAGE ( idx )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE, HID_ITEM_TYPE_LOCAL, 1), idx

HID_ITEM_TYPE_LOCAL

#define HID_ITEM_TYPE_LOCAL

HID Local item type.

Definition hid.h:77

HID_ITEM_TAG_USAGE

#define HID_ITEM_TAG_USAGE

HID Usage item tag.

Definition hid.h:112

Define HID Usage Index item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

idx	HID Usage ID per the HID Usage Table

Returns: HID Usage Index item

◆ HID_USAGE16

#define HID_USAGE16 ( idx )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE, HID_ITEM_TYPE_LOCAL, 2), (uint8_t)idx, (idx >> 8)

uint8_t

__UINT8_TYPE__ uint8_t

Definition stdint.h:88

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

Parameters

idx	HID Usage ID per the HID Usage Table

Returns: HID Usage Index item

◆ HID_USAGE_MAX16

#define HID_USAGE_MAX16	(		a,
			b )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE_MAX, HID_ITEM_TYPE_LOCAL, 2), a, b

HID_ITEM_TAG_USAGE_MAX

#define HID_ITEM_TAG_USAGE_MAX

HID Usage Maximum item tag.

Definition hid.h:116

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

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Ending Usage lower byte
b	Ending Usage higher byte

Returns: HID Usage Maximum item

◆ HID_USAGE_MAX8

#define HID_USAGE_MAX8 ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE_MAX, HID_ITEM_TYPE_LOCAL, 1), a

Define HID Usage Maximum item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Ending Usage

Returns: HID Usage Maximum item

◆ HID_USAGE_MIN16

#define HID_USAGE_MIN16	(		a,
			b )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE_MIN, HID_ITEM_TYPE_LOCAL, 2), a, b

HID_ITEM_TAG_USAGE_MIN

#define HID_ITEM_TAG_USAGE_MIN

HID Usage Minimum item tag.

Definition hid.h:114

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

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Starting Usage lower byte
b	Starting Usage higher byte

Returns: HID Usage Minimum item

◆ HID_USAGE_MIN8

#define HID_USAGE_MIN8 ( a )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE_MIN, HID_ITEM_TYPE_LOCAL, 1), a

Define HID Usage Minimum item with the data length of one byte.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

a	Starting Usage

Returns: HID Usage Minimum item

◆ HID_USAGE_PAGE

#define HID_USAGE_PAGE ( page )

#include <zephyr/usb/class/hid.h>

Value:

HID_ITEM(HID_ITEM_TAG_USAGE_PAGE, HID_ITEM_TYPE_GLOBAL, 1), page

HID_ITEM_TAG_USAGE_PAGE

#define HID_ITEM_TAG_USAGE_PAGE

HID Usage Page item tag.

Definition hid.h:91

Define HID Usage Page item.

For usage examples, see HID_MOUSE_REPORT_DESC(), HID_KEYBOARD_REPORT_DESC()

Parameters

page	Usage Page

Returns: HID Usage Page item

Macros

Detailed Description

Macro Definition Documentation

◆ HID_COLLECTION

◆ HID_END_COLLECTION

◆ HID_FEATURE

◆ HID_INPUT

◆ HID_ITEM

◆ HID_LOGICAL_MAX16

◆ HID_LOGICAL_MAX32

◆ HID_LOGICAL_MAX8

◆ HID_LOGICAL_MIN16

◆ HID_LOGICAL_MIN32

◆ HID_LOGICAL_MIN8

◆ HID_OUTPUT

◆ HID_REPORT_COUNT

◆ HID_REPORT_ID

◆ HID_REPORT_SIZE

◆ HID_UNIT_EXPONENT

◆ HID_USAGE

◆ HID_USAGE16

◆ HID_USAGE_MAX16

◆ HID_USAGE_MAX8

◆ HID_USAGE_MIN16

◆ HID_USAGE_MIN8

◆ HID_USAGE_PAGE