hid_device.h File Reference

Go to the source code of this file.

Functions
uint8_t	tud_hid_n_interface_protocol (uint8_t instance)
uint8_t	tud_hid_n_get_protocol (uint8_t instance)
bool	tud_hid_n_report (uint8_t instance, uint8_t report_id, void const *report, uint16_t len)
bool	tud_hid_n_keyboard_report (uint8_t instance, uint8_t report_id, uint8_t modifier, const uint8_t keycode[6])
bool	tud_hid_n_mouse_report (uint8_t instance, uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal)
bool	tud_hid_n_abs_mouse_report (uint8_t instance, uint8_t report_id, uint8_t buttons, int16_t x, int16_t y, int8_t vertical, int8_t horizontal)
bool	tud_hid_n_gamepad_report (uint8_t instance, uint8_t report_id, int8_t x, int8_t y, int8_t z, int8_t rz, int8_t rx, int8_t ry, uint8_t hat, uint32_t buttons)
static TU_ATTR_ALWAYS_INLINE bool	tud_hid_ready (void)
static TU_ATTR_ALWAYS_INLINE uint8_t	tud_hid_interface_protocol (void)
static TU_ATTR_ALWAYS_INLINE uint8_t	tud_hid_get_protocol (void)
static TU_ATTR_ALWAYS_INLINE bool	tud_hid_report (uint8_t report_id, void const *report, uint16_t len)
static TU_ATTR_ALWAYS_INLINE bool	tud_hid_keyboard_report (uint8_t report_id, uint8_t modifier, const uint8_t keycode[6])
static TU_ATTR_ALWAYS_INLINE bool	tud_hid_mouse_report (uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal)
static TU_ATTR_ALWAYS_INLINE bool	tud_hid_abs_mouse_report (uint8_t report_id, uint8_t buttons, int16_t x, int16_t y, int8_t vertical, int8_t horizontal)
static TU_ATTR_ALWAYS_INLINE bool	tud_hid_gamepad_report (uint8_t report_id, int8_t x, int8_t y, int8_t z, int8_t rz, int8_t rx, int8_t ry, uint8_t hat, uint32_t buttons)
uint8_t const *	tud_hid_descriptor_report_cb (uint8_t instance)
uint16_t	tud_hid_get_report_cb (uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t *buffer, uint16_t reqlen)
void	tud_hid_set_report_cb (uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t const *buffer, uint16_t bufsize)
void	tud_hid_set_protocol_cb (uint8_t instance, uint8_t protocol)
bool	tud_hid_set_idle_cb (uint8_t instance, uint8_t idle_rate)
void	tud_hid_report_complete_cb (uint8_t instance, uint8_t const *report, uint16_t len)
void	tud_hid_report_failed_cb (uint8_t instance, hid_report_type_t report_type, uint8_t const *report, uint16_t xferred_bytes)
void	hidd_init (void)
bool	hidd_deinit (void)
void	hidd_reset (uint8_t rhport)
uint16_t	hidd_open (uint8_t rhport, tusb_desc_interface_t const *itf_desc, uint16_t max_len)
bool	hidd_control_xfer_cb (uint8_t rhport, uint8_t stage, tusb_control_request_t const *request)
bool	hidd_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes)

Variables
	C

Function Documentation

hidd_control_xfer_cb()

bool hidd_control_xfer_cb	(	uint8_t	rhport,
		uint8_t	stage,
		tusb_control_request_t const *	request
	)

Definition at line 262 of file hid_device.c.

hidd_deinit()

bool hidd_deinit

(

void

)

Definition at line 199 of file hid_device.c.

hidd_init()

void hidd_init

(

void

)

Definition at line 195 of file hid_device.c.

hidd_open()

uint16_t hidd_open	(	uint8_t	rhport,
		tusb_desc_interface_t const *	itf_desc,
		uint16_t	max_len
	)

Definition at line 208 of file hid_device.c.

hidd_reset()

void hidd_reset

(

uint8_t

rhport

)

Definition at line 203 of file hid_device.c.

hidd_xfer_cb()

bool hidd_xfer_cb	(	uint8_t	rhport,
		uint8_t	ep_addr,
		xfer_result_t	event,
		uint32_t	xferred_bytes
	)

Definition at line 373 of file hid_device.c.

tud_hid_abs_mouse_report()

static TU_ATTR_ALWAYS_INLINE bool tud_hid_abs_mouse_report ( uint8_t  report_id, uint8_t  buttons, int16_t  x, int16_t  y, int8_t  vertical, int8_t  horizontal  )

inlinestatic

Definition at line 109 of file hid_device.h.

tud_hid_descriptor_report_cb()

uint8_t const * tud_hid_descriptor_report_cb

(

uint8_t

instance

)

Definition at line 290 of file global_callbacks.cpp.

tud_hid_gamepad_report()

static TU_ATTR_ALWAYS_INLINE bool tud_hid_gamepad_report ( uint8_t  report_id, int8_t  x, int8_t  y, int8_t  z, int8_t  rz, int8_t  rx, int8_t  ry, uint8_t  hat, uint32_t  buttons  )

inlinestatic

Definition at line 113 of file hid_device.h.

tud_hid_get_protocol()

static TU_ATTR_ALWAYS_INLINE uint8_t tud_hid_get_protocol ( void  )

inlinestatic

Definition at line 93 of file hid_device.h.

tud_hid_get_report_cb()

uint16_t tud_hid_get_report_cb	(	uint8_t	itf,
		uint8_t	report_id,
		hid_report_type_t	report_type,
		uint8_t *	buffer,
		uint16_t	reqlen
	)

HID Get Feature

Definition at line 331 of file global_callbacks.cpp.

tud_hid_interface_protocol()

static TU_ATTR_ALWAYS_INLINE uint8_t tud_hid_interface_protocol ( void  )

inlinestatic

Definition at line 89 of file hid_device.h.

tud_hid_keyboard_report()

static TU_ATTR_ALWAYS_INLINE bool tud_hid_keyboard_report ( uint8_t  report_id, uint8_t  modifier, const uint8_t  keycode[6]  )

inlinestatic

Definition at line 101 of file hid_device.h.

tud_hid_mouse_report()

static TU_ATTR_ALWAYS_INLINE bool tud_hid_mouse_report ( uint8_t  report_id, uint8_t  buttons, int8_t  x, int8_t  y, int8_t  vertical, int8_t  horizontal  )

inlinestatic

Definition at line 105 of file hid_device.h.

tud_hid_n_abs_mouse_report()

bool tud_hid_n_abs_mouse_report	(	uint8_t	instance,
		uint8_t	report_id,
		uint8_t	buttons,
		int16_t	x,
		int16_t	y,
		int8_t	vertical,
		int8_t	horizontal
	)

Definition at line 164 of file hid_device.c.

tud_hid_n_gamepad_report()

bool tud_hid_n_gamepad_report	(	uint8_t	instance,
		uint8_t	report_id,
		int8_t	x,
		int8_t	y,
		int8_t	z,
		int8_t	rz,
		int8_t	rx,
		int8_t	ry,
		uint8_t	hat,
		uint32_t	buttons
	)

Definition at line 176 of file hid_device.c.

tud_hid_n_get_protocol()

uint8_t tud_hid_n_get_protocol

(

uint8_t

instance

)

Definition at line 133 of file hid_device.c.

tud_hid_n_interface_protocol()

uint8_t tud_hid_n_interface_protocol

(

uint8_t

instance

)

Definition at line 129 of file hid_device.c.

tud_hid_n_keyboard_report()

bool tud_hid_n_keyboard_report	(	uint8_t	instance,
		uint8_t	report_id,
		uint8_t	modifier,
		const uint8_t	keycode[6]
	)

Definition at line 137 of file hid_device.c.

tud_hid_n_mouse_report()

bool tud_hid_n_mouse_report	(	uint8_t	instance,
		uint8_t	report_id,
		uint8_t	buttons,
		int8_t	x,
		int8_t	y,
		int8_t	vertical,
		int8_t	horizontal
	)

Definition at line 151 of file hid_device.c.

tud_hid_n_report()

bool tud_hid_n_report	(	uint8_t	instance,
		uint8_t	report_id,
		void const *	report,
		uint16_t	len
	)

Definition at line 110 of file hid_device.c.

tud_hid_ready()

static TU_ATTR_ALWAYS_INLINE bool tud_hid_ready ( void  )

inlinestatic

Definition at line 85 of file hid_device.h.

tud_hid_report()

static TU_ATTR_ALWAYS_INLINE bool tud_hid_report ( uint8_t  report_id, void const *  report, uint16_t  len  )

inlinestatic

Definition at line 97 of file hid_device.h.

tud_hid_report_complete_cb()

void tud_hid_report_complete_cb	(	uint8_t	instance,
		uint8_t const *	report,
		uint16_t	len
	)

Definition at line 87 of file hid_device.c.

tud_hid_report_failed_cb()

void tud_hid_report_failed_cb	(	uint8_t	instance,
		hid_report_type_t	report_type,
		uint8_t const *	report,
		uint16_t	xferred_bytes
	)

Definition at line 94 of file hid_device.c.

tud_hid_set_idle_cb()

bool tud_hid_set_idle_cb	(	uint8_t	instance,
		uint8_t	idle_rate
	)

Definition at line 81 of file hid_device.c.

tud_hid_set_protocol_cb()

void tud_hid_set_protocol_cb	(	uint8_t	instance,
		uint8_t	protocol
	)

Definition at line 76 of file hid_device.c.

tud_hid_set_report_cb()

void tud_hid_set_report_cb	(	uint8_t	itf,
		uint8_t	report_id,
		hid_report_type_t	report_type,
		uint8_t const *	buffer,
		uint16_t	bufsize
	)

USB Out Endpoint callback HID Out and Set Feature

Definition at line 312 of file global_callbacks.cpp.

Variable Documentation

C

C

extern

Initial value:

{
#endif
 
 
 
 
 
#if !defined(CFG_TUD_HID_EP_BUFSIZE) & defined(CFG_TUD_HID_BUFSIZE)
  
  
  #define CFG_TUD_HID_EP_BUFSIZE  CFG_TUD_HID_BUFSIZE
#endif
 
#ifndef CFG_TUD_HID_EP_BUFSIZE
  #define CFG_TUD_HID_EP_BUFSIZE     64
#endif
 
 
 
 
 
 
bool tud_hid_n_ready(uint8_t instance)