HID Class Reference

#include <hid.h>

Inheritance diagram for HID:

Collaboration diagram for HID:

Public Member Functions
	HID (USB *pusb)
const USB *	GetUsb ()
virtual bool	SetReportParser (uint8_t id, HIDReportParser *prs)
uint8_t	SetProtocol (uint8_t iface, uint8_t protocol)
uint8_t	GetProtocol (uint8_t iface, uint8_t *dataptr)
uint8_t	GetIdle (uint8_t iface, uint8_t reportID, uint8_t *dataptr)
uint8_t	SetIdle (uint8_t iface, uint8_t reportID, uint8_t duration)
uint8_t	GetReportDescr (uint8_t ep, USBReadParser *parser=NULL)
uint8_t	GetHidDescr (uint8_t ep, uint16_t nbytes, uint8_t *dataptr)
uint8_t	GetReport (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)
uint8_t	SetReport (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)
Public Member Functions inherited from USBDeviceConfig
virtual uint8_t	Init (uint8_t parent, uint8_t port, bool lowspeed)=0
virtual uint8_t	Release ()=0
virtual uint8_t	Poll ()=0
virtual uint8_t	GetAddress ()=0
Public Member Functions inherited from UsbConfigXtracter
virtual void	EndpointXtract (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)=0

Protected Member Functions
void	PrintEndpointDescriptor (const USB_ENDPOINT_DESCRIPTOR *ep_ptr)
void	PrintHidDescriptor (const USB_HID_DESCRIPTOR *pDesc)
virtual HIDReportParser *	GetReportParser (uint8_t id)

Protected Attributes
USB *	pUsb
uint8_t	bAddress

Static Protected Attributes
static const uint8_t	epInterruptInIndex = 1
static const uint8_t	epInterruptOutIndex = 2
static const uint8_t	maxHidInterfaces = 3
static const uint8_t	maxEpPerInterface = 2
static const uint8_t	totalEndpoints = (maxHidInterfaces * maxEpPerInterface + 1)

Detailed Description

Definition at line 161 of file hid.h.

Constructor & Destructor Documentation

HID::HID ( USB *  pusb )

inline

Definition at line 181 of file hid.h.

Member Function Documentation

void HID::PrintEndpointDescriptor ( const USB_ENDPOINT_DESCRIPTOR *  ep_ptr )

protected

Definition at line 44 of file hid.cpp.

void HID::PrintHidDescriptor ( const USB_HID_DESCRIPTOR *  pDesc )

protected

Definition at line 60 of file hid.cpp.

virtual HIDReportParser* HID::GetReportParser ( uint8_t  id )

protectedvirtual

Reimplemented in HIDUniversal.

const USB* HID::GetUsb ( )

inline

Definition at line 184 of file hid.h.

virtual bool HID::SetReportParser ( uint8_t  id, HIDReportParser *  prs  )

virtual

Reimplemented in HIDBoot< BOOT_PROTOCOL >, and HIDUniversal.

uint8_t HID::SetProtocol	(	uint8_t	iface,
		uint8_t	protocol
	)

Definition at line 36 of file hid.cpp.

uint8_t HID::GetProtocol	(	uint8_t	iface,
		uint8_t *	dataptr
	)

Definition at line 40 of file hid.cpp.

uint8_t HID::GetIdle	(	uint8_t	iface,
		uint8_t	reportID,
		uint8_t *	dataptr
	)

Definition at line 28 of file hid.cpp.

uint8_t HID::SetIdle	(	uint8_t	iface,
		uint8_t	reportID,
		uint8_t	duration
	)

Definition at line 32 of file hid.cpp.

uint8_t HID::GetReportDescr	(	uint8_t	ep,
		USBReadParser *	parser = NULL
	)

Definition at line 5 of file hid.cpp.

uint8_t HID::GetHidDescr	(	uint8_t	ep,
		uint16_t	nbytes,
		uint8_t *	dataptr
	)

uint8_t HID::GetReport	(	uint8_t	ep,
		uint8_t	iface,
		uint8_t	report_type,
		uint8_t	report_id,
		uint16_t	nbytes,
		uint8_t *	dataptr
	)

Definition at line 24 of file hid.cpp.

uint8_t HID::SetReport	(	uint8_t	ep,
		uint8_t	iface,
		uint8_t	report_type,
		uint8_t	report_id,
		uint16_t	nbytes,
		uint8_t *	dataptr
	)

Definition at line 20 of file hid.cpp.

Member Data Documentation

USB* HID::pUsb

protected

Definition at line 163 of file hid.h.

uint8_t HID::bAddress

protected

Definition at line 164 of file hid.h.

const uint8_t HID::epInterruptInIndex = 1

staticprotected

Definition at line 167 of file hid.h.

const uint8_t HID::epInterruptOutIndex = 2

staticprotected

Definition at line 168 of file hid.h.

const uint8_t HID::maxHidInterfaces = 3

staticprotected

Definition at line 170 of file hid.h.

const uint8_t HID::maxEpPerInterface = 2

staticprotected

Definition at line 171 of file hid.h.

const uint8_t HID::totalEndpoints = (maxHidInterfaces * maxEpPerInterface + 1)

staticprotected

Definition at line 172 of file hid.h.

---

The documentation for this class was generated from the following files:

• hid.h
• hid.cpp