SAMV71 Xplained Ultra Software Package 1.3

Usbd_hid_tran

Collaboration diagram for Usbd_hid_tran:

Data Structures

struct  HIDDTransferReport
struct  HIDDTransferDriver
struct  _HIDDTransferDriverConfigurationDescriptors

Modules

 HID Transfer Device

Defines

#define MIN(a, b)   ((a < b) ? a : b)
#define HIDDTransferDriver_REPORTSIZE   32
#define HIDDTransferDriver_REPORTDESCRIPTORSIZE   32

Functions

void HIDDTransferDriver_Initialize (const USBDDriverDescriptors *pDescriptors)
void HIDDTransferDriver_ConfigurationChangedHandler (uint8_t cfgnum)
void HIDDTransferDriver_RequestHandler (const USBGenericRequest *request)
uint16_t HIDDTransferDriver_ReadReport (void *pData, uint32_t dwLength)
uint16_t HIDDTransferDriver_Read (void *pData, uint32_t dLength)
uint8_t HIDDTransferDriver_Write (const void *pData, uint32_t dLength, TransferCallback fCallback, void *pArg)
void HIDDTransferDriver_RemoteWakeUp (void)
struct
_HIDDTransferDriverConfigurationDescriptors 
__attribute__ ((__packed__)) HIDDTransferDriverConfigurationDescriptors

Variables

USBDDriverDescriptors hiddTransferDriverDescriptors

Define Documentation

#define HIDDTransferDriver_REPORTDESCRIPTORSIZE   32

Size of the report descriptor, in bytes

Definition at line 77 of file HIDDTransferDriver.h.

#define HIDDTransferDriver_REPORTSIZE   32

Size of the input and output report, in bytes

Definition at line 74 of file HIDDTransferDriver.h.

#define MIN (   a,
  b 
)    ((a < b) ? a : b)

Returns the minimum between two values.

Definition at line 75 of file USBDDriverDescriptors.c.


Function Documentation

void HIDDTransferDriver_ConfigurationChangedHandler ( uint8_t  cfgnum  ) 

Handles configureation changed event.

Parameters:
cfgnum New configuration number
void HIDDTransferDriver_Initialize ( const USBDDriverDescriptors pDescriptors  ) 

Initializes the HID Transfer device driver.

Parameters:
pDescriptors Pointer to USBDDriverDescriptors instance.
uint16_t HIDDTransferDriver_Read ( void *  pData,
uint32_t  dLength 
)

Try to read request buffer of interrupt OUT EP. Set pData to 0 to get current data length only.

Parameters:
pData Pointer to data buffer
dLength Data buffer length
Returns:
Number of bytes read
uint16_t HIDDTransferDriver_ReadReport ( void *  pData,
uint32_t  dwLength 
)

Try to read request buffer of SetReport. Set pData to 0 to get current data length only.

Parameters:
pData Pointer to data buffer
dwLength Data buffer length
Returns:
Number of bytes read
void HIDDTransferDriver_RemoteWakeUp ( void   ) 

Starts a remote wake-up sequence if the host has explicitely enabled it by sending the appropriate SET_FEATURE request.

void HIDDTransferDriver_RequestHandler ( const USBGenericRequest request  ) 

Handles HID-specific SETUP request sent by the host.

Parameters:
request Pointer to a USBGenericRequest instance
uint8_t HIDDTransferDriver_Write ( const void *  pData,
uint32_t  dLength,
TransferCallback  fCallback,
void *  pArg 
)

Write data through USB interrupt IN EP.

Parameters:
pData Pointer to the data sent.
dLength The data length.
fCallback Callback function invoked when transferring done.
pArg Pointer to additional arguments.

Variable Documentation

Initial value:
 {

    &deviceDescriptor,
    (USBConfigurationDescriptor *) &configurationDescriptors,
    0, 
    0, 
    0, 
    0, 
    0, 
    0, 
    stringDescriptors,
    4 
}

List of descriptors used by the HID Transfer driver.

Definition at line 257 of file USBDDriverDescriptors.c.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines