SAM3S8/SD8 Software Package: libraries/usb/include/HIDDFunction.h File Reference

SAM3S8/SD8 Software Package 1.2
Data Structures | Defines | Typedefs | Functions

# HIDDFunction.h File Reference

`#include <stdint.h>`
`#include "HIDRequests.h"`
`#include "HIDDescriptors.h"`
`#include "USBD.h"`
`#include "USBDDriver.h"`

Go to the source code of this file.

## Data Structures

struct | HIDDReportHeader
struct | HIDDReport
struct | HIDDFunction

## Defines

#define | HIDD_EC_REPORTSENT 1
#define | HIDD_EC_REPORTCHANGED 2
#define | HIDD_EC_GETREPORT 3
#define | HIDD_EC_SETREPORT 4

## Typedefs

typedef void(* | HIDDReportEventCallback )(uint32_t ec, void *pArg)

## Functions

void | HIDDFunction_Initialize (HIDDFunction *pHidd, USBDDriver *pUsbd, uint8_t bInterfaceNb, const uint8_t *pReportDescriptor, HIDDReport *pInputList[], uint8_t bInputListSize, HIDDReport *pOutputList[], uint8_t bOutputListSize)
USBGenericDescriptor * | HIDDFunction_ParseInterface (HIDDFunction *pHidd, USBGenericDescriptor *pDescriptors, uint32_t dwLength)
uint32_t | HIDDFunction_RequestHandler (HIDDFunction *pHidd, const USBGenericRequest *request)
uint32_t | HIDDFunction_StartSendingInputs (HIDDFunction *pHidd)
uint32_t | HIDDFunction_StartPollingOutputs (HIDDFunction *pHidd)
uint32_t | HIDDFunction_Read (const HIDDFunction *pHidd, void *pData, uint32_t dwLength, TransferCallback fCallback, void *pArg)
uint32_t | HIDDFunction_Write (const HIDDFunction *pHidd, void *pData, uint32_t dwLength, TransferCallback fCallback, void *pArg)
void | HIDDFunction_InitializeReport (HIDDReport *pReport, uint16_t wSize, uint8_t bID, HIDDReportEventCallback fCallback, void *pArg)

## Detailed Description

Definitions used for general HID support.

The HID Function supports following:

- 1 interface with 1 pipe in and 1 pipe out;
- An input report list;
- An output report list;
- handles requests:
  - handles: GET_IDLE/SET_IDLE, GET_REPORT/SET_REPORT, SET_PROTOCOL/GET_PROTOCOL;
  - stall : SET_DESCRIPTOR.

Definition in file HIDDFunction.h.

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines