USBHID Class Reference

#include <usbhid.h>

Inheritance diagram for USBHID:

Collaboration diagram for USBHID:

Public Member Functions
	USBHID (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 (uint16_t wIndex, 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)
virtual uint8_t	ConfigureDevice (uint8_t parent, uint8_t port, bool lowspeed)
virtual uint8_t	Release ()
virtual uint8_t	Poll ()
virtual uint8_t	GetAddress ()
virtual void	ResetHubPort (uint8_t port)
virtual bool	VIDPIDOK (uint16_t vid, uint16_t pid)
virtual bool	DEVCLASSOK (uint8_t klass)
virtual bool	DEVSUBCLASSOK (uint8_t subklass)
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)

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 = 5
static const uint8_t	maxEpPerInterface = 2
static const uint8_t	totalEndpoints = (maxHidInterfaces * maxEpPerInterface + 1)

Detailed Description

Definition at line 143 of file usbhid.h.

Constructor & Destructor Documentation

USBHID()

USBHID::USBHID ( USB *  pusb )

inline

Definition at line 165 of file usbhid.h.

Member Function Documentation

PrintEndpointDescriptor()

void USBHID::PrintEndpointDescriptor ( const USB_ENDPOINT_DESCRIPTOR *  ep_ptr )

protected

Definition at line 74 of file usbhid.cpp.

PrintHidDescriptor()

void USBHID::PrintHidDescriptor ( const USB_HID_DESCRIPTOR *  pDesc )

protected

Definition at line 90 of file usbhid.cpp.

GetReportParser()

virtual HIDReportParser* USBHID::GetReportParser ( uint8_t  id )

inlineprotectedvirtual

Reimplemented in HIDComposite.

Definition at line 159 of file usbhid.h.

GetUsb()

const USB* USBHID::GetUsb ( )

inline

Definition at line 168 of file usbhid.h.

SetReportParser()

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

inlinevirtual

Reimplemented in HIDComposite, and HIDBoot< BOOT_PROTOCOL >.

Definition at line 172 of file usbhid.h.

SetProtocol()

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

Definition at line 66 of file usbhid.cpp.

GetProtocol()

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

Definition at line 70 of file usbhid.cpp.

GetIdle()

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

Definition at line 58 of file usbhid.cpp.

SetIdle()

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

Definition at line 62 of file usbhid.cpp.

GetReportDescr()

uint8_t USBHID::GetReportDescr	(	uint16_t	wIndex,
		USBReadParser *	parser = NULL
	)

Definition at line 34 of file usbhid.cpp.

GetHidDescr()

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

GetReport()

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

Definition at line 54 of file usbhid.cpp.

SetReport()

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

Definition at line 50 of file usbhid.cpp.

Member Data Documentation

pUsb

USB* USBHID::pUsb

protected

Definition at line 145 of file usbhid.h.

bAddress

uint8_t USBHID::bAddress

protected

Definition at line 146 of file usbhid.h.

epInterruptInIndex

const uint8_t USBHID::epInterruptInIndex = 1

staticprotected

Definition at line 149 of file usbhid.h.

epInterruptOutIndex

const uint8_t USBHID::epInterruptOutIndex = 2

staticprotected

Definition at line 150 of file usbhid.h.

maxHidInterfaces

const uint8_t USBHID::maxHidInterfaces = 5

staticprotected

Definition at line 152 of file usbhid.h.

maxEpPerInterface

const uint8_t USBHID::maxEpPerInterface = 2

staticprotected

Definition at line 153 of file usbhid.h.

totalEndpoints

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

staticprotected

Definition at line 154 of file usbhid.h.

---

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

• usbhid.h
• usbhid.cpp