USB Host Shield 2.0
Public Member Functions | List of all members
HIDBoot< BOOT_PROTOCOL > Class Template Reference

#include <hidboot.h>

Inheritance diagram for HIDBoot< BOOT_PROTOCOL >:
Inheritance graph
[legend]
Collaboration diagram for HIDBoot< BOOT_PROTOCOL >:
Collaboration graph
[legend]

Public Member Functions

 HIDBoot (USB *p, bool bRptProtoEnable=false)
 
virtual bool SetReportParser (uint8_t id, HIDReportParser *prs)
 
uint8_t Init (uint8_t parent, uint8_t port, bool lowspeed)
 
uint8_t Release ()
 
uint8_t Poll ()
 
virtual uint8_t GetAddress ()
 
virtual bool isReady ()
 
virtual void EndpointXtract (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)
 
virtual bool DEVCLASSOK (uint8_t klass)
 
virtual bool DEVSUBCLASSOK (uint8_t subklass)
 
- Public Member Functions inherited from USBHID
 USBHID (USB *pusb)
 
const USBGetUsb ()
 
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 ConfigureDevice (uint8_t parent, uint8_t port, bool lowspeed)
 
virtual void ResetHubPort (uint8_t port)
 
virtual bool VIDPIDOK (uint16_t vid, uint16_t pid)
 

Additional Inherited Members

- Protected Member Functions inherited from USBHID
void PrintEndpointDescriptor (const USB_ENDPOINT_DESCRIPTOR *ep_ptr)
 
void PrintHidDescriptor (const USB_HID_DESCRIPTOR *pDesc)
 
- Protected Attributes inherited from USBHID
USBpUsb
 
uint8_t bAddress
 
- Static Protected Attributes inherited from USBHID
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

template<const uint8_t BOOT_PROTOCOL>
class HIDBoot< BOOT_PROTOCOL >

Definition at line 201 of file hidboot.h.

Constructor & Destructor Documentation

◆ HIDBoot()

template<const uint8_t BOOT_PROTOCOL>
HIDBoot< BOOT_PROTOCOL >::HIDBoot ( USB p,
bool  bRptProtoEnable = false 
)

Definition at line 256 of file hidboot.h.

Member Function Documentation

◆ SetReportParser()

template<const uint8_t BOOT_PROTOCOL>
virtual bool HIDBoot< BOOT_PROTOCOL >::SetReportParser ( uint8_t  id,
HIDReportParser prs 
)
inlinevirtual

Reimplemented from USBHID.

Definition at line 224 of file hidboot.h.

◆ Init()

template<const uint8_t BOOT_PROTOCOL>
uint8_t HIDBoot< BOOT_PROTOCOL >::Init ( uint8_t  parent,
uint8_t  port,
bool  lowspeed 
)
virtual

Reimplemented from USBDeviceConfig.

Definition at line 285 of file hidboot.h.

◆ Release()

template<const uint8_t BOOT_PROTOCOL>
uint8_t HIDBoot< BOOT_PROTOCOL >::Release
virtual

Reimplemented from USBDeviceConfig.

Definition at line 564 of file hidboot.h.

◆ Poll()

template<const uint8_t BOOT_PROTOCOL>
uint8_t HIDBoot< BOOT_PROTOCOL >::Poll
virtual

Reimplemented from USBDeviceConfig.

Definition at line 578 of file hidboot.h.

◆ GetAddress()

template<const uint8_t BOOT_PROTOCOL>
virtual uint8_t HIDBoot< BOOT_PROTOCOL >::GetAddress ( )
inlinevirtual

Reimplemented from USBDeviceConfig.

Definition at line 234 of file hidboot.h.

◆ isReady()

template<const uint8_t BOOT_PROTOCOL>
virtual bool HIDBoot< BOOT_PROTOCOL >::isReady ( )
inlinevirtual

Definition at line 238 of file hidboot.h.

◆ EndpointXtract()

template<const uint8_t BOOT_PROTOCOL>
void HIDBoot< BOOT_PROTOCOL >::EndpointXtract ( uint8_t  conf,
uint8_t  iface,
uint8_t  alt,
uint8_t  proto,
const USB_ENDPOINT_DESCRIPTOR ep 
)
virtual

Reimplemented from UsbConfigXtracter.

Definition at line 539 of file hidboot.h.

◆ DEVCLASSOK()

template<const uint8_t BOOT_PROTOCOL>
virtual bool HIDBoot< BOOT_PROTOCOL >::DEVCLASSOK ( uint8_t  klass)
inlinevirtual

Reimplemented from USBDeviceConfig.

Definition at line 246 of file hidboot.h.

◆ DEVSUBCLASSOK()

template<const uint8_t BOOT_PROTOCOL>
virtual bool HIDBoot< BOOT_PROTOCOL >::DEVSUBCLASSOK ( uint8_t  subklass)
inlinevirtual

Reimplemented from USBDeviceConfig.

Definition at line 250 of file hidboot.h.


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