usb_hid.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Functions
bool	usb_hid_init (void)
	Public USB HID/composite configuration API implementation.
bool	usb_hid_apply_config (const UsbInterfaceDef *defs, size_t count, bool *needs_replug)
	Applies the runtime interface configuration and optionally triggers re-enumeration.
bool	usb_hid_ready (void)
	Returns whether TinyUSB stack is ready.
bool	usb_hid_instance_ready (uint8_t instance)
	Returns whether a specific HID instance endpoint is ready.
bool	usb_hid_send_report (uint8_t instance, uint8_t report_id, const uint8_t *data, uint16_t len)
	Sends one HID report on the selected interface instance.

Function Documentation

usb_hid_apply_config()

bool usb_hid_apply_config	(	const UsbInterfaceDef *	defs,
		size_t	count,
		bool *	needs_replug )

Applies the runtime interface configuration and optionally triggers re-enumeration.

Parameters

defs	Interface definition array.
count	Number of interface definitions.
needs_replug	Optional out-flag indicating host re-enumeration request.

Returns

true on successful configuration apply.

Definition at line 367 of file usb_hid.cpp.

References build_config_descriptor(), MAX_INTERFACES, s_def_count, and s_defs.

Referenced by cdc::core::UsbManager::applyConfiguration().

usb_hid_init()

bool usb_hid_init

(

void

)

Public USB HID/composite configuration API implementation.

Initializes HID descriptor state and builds default descriptors.

Returns

true if initialization is complete.

Definition at line 352 of file usb_hid.cpp.

References build_config_descriptor(), init_serial_number(), and s_hid_initialized.

Referenced by usb_cdc_init().

usb_hid_instance_ready()

bool usb_hid_instance_ready

(

uint8_t

instance

)

Returns whether a specific HID instance endpoint is ready.

Parameters

instance

HID instance index.

Returns

true if that instance is ready for reports.

Definition at line 402 of file usb_hid.cpp.

Referenced by cdc::mod_fido2::fido2_usb_ready().

usb_hid_ready()

bool usb_hid_ready

(

void

)

Returns whether TinyUSB stack is ready.

Returns

true when USB device stack is ready.

Definition at line 393 of file usb_hid.cpp.

usb_hid_send_report()

bool usb_hid_send_report	(	uint8_t	instance,
		uint8_t	report_id,
		const uint8_t *	data,
		uint16_t	len )

Sends one HID report on the selected interface instance.

Parameters

instance	HID instance index.
report_id	Report ID.
data	Report payload.
len	Payload length in bytes.

Returns

true if TinyUSB accepted the report for transmission.

Definition at line 414 of file usb_hid.cpp.

Referenced by cdc::mod_fido2::fido2_usb_write().