HIDDTransferDriver.h File Reference

#include <USBDescriptors.h>
#include <HIDDescriptors.h>
#include <USBRequests.h>
#include "USBD.h"
#include <USBDDriver.h>

Go to the source code of this file.

Data Structures
struct	_HIDDTransferDriverConfigurationDescriptors
Defines
#define	HIDDTransferDriver_REPORTSIZE   32
#define	HIDDTransferDriver_REPORTDESCRIPTORSIZE   32
Functions
struct _HIDDTransferDriverConfigurationDescriptors	__attribute__ ((__packed__)) HIDDTransferDriverConfigurationDescriptors
void	HIDDTransferDriver_Initialize (const USBDDriverDescriptors *pDescriptors)
void	HIDDTransferDriver_ConfigurationChangedHandler (uint8_t cfgnum)
void	HIDDTransferDriver_RequestHandler (const USBGenericRequest *request)
uint16_t	HIDDTransferDriver_Read (void *pData, uint32_t dLength)
uint16_t	HIDDTransferDriver_ReadReport (void *pData, uint32_t dwLength)
uint8_t	HIDDTransferDriver_Write (const void *pData, uint32_t dLength, TransferCallback fCallback, void *pArg)
void	HIDDTransferDriver_RemoteWakeUp (void)
Variables
USBConfigurationDescriptor	configuration
USBInterfaceDescriptor	interface
HIDDescriptor1	hid
USBEndpointDescriptor	interruptIn
USBEndpointDescriptor	interruptOut

---

Detailed Description

Purpose

Definition of methods for using a HID transfer device driver.

Usage

1. Re-implement the USBDCallbacks_RequestReceived callback to forward requests to HIDDTransferDriver_RequestHandler. This is done automatically unless the NOAUTOCALLBACK symbol is defined during compilation.
2. Initialize the driver using HIDDTransferDriver_Initialize. The USB driver is automatically initialized by this method.
3. Call the HIDDTransferDriver_Write method when sending data to host.
4. Call the HIDDTransferRead, HIDDTransferReadReport when checking and getting received data from host.

Definition in file HIDDTransferDriver.h.

---

Variable Documentation

USBConfigurationDescriptor configuration

Configuration descriptor.

Definition at line 112 of file HIDDTransferDriver.h.

HIDDescriptor1 hid

HID descriptor.

Definition at line 116 of file HIDDTransferDriver.h.

USBInterfaceDescriptor interface

Interface descriptor.

Definition at line 114 of file HIDDTransferDriver.h.

USBEndpointDescriptor interruptIn

Interrupt IN endpoint descriptor.

Definition at line 118 of file HIDDTransferDriver.h.

USBEndpointDescriptor interruptOut

Interrupt OUT endpoint descriptor.

Definition at line 120 of file HIDDTransferDriver.h.