f1076ac4d6
Added parameter directions to function parameter documentation. Added new experimental FAST_STREAM_FUNCTIONS compile time option to speed up stream transfers at the expense of a higher FLASH consumption (needs testing to verify improved throughput).
146 lines
7.3 KiB
C
146 lines
7.3 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2009.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.fourwalledcubicle.com
|
|
*/
|
|
|
|
/*
|
|
Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
|
|
Permission to use, copy, modify, and distribute this software
|
|
and its documentation for any purpose and without fee is hereby
|
|
granted, provided that the above copyright notice appear in all
|
|
copies and that both that the copyright notice and this
|
|
permission notice and warranty disclaimer appear in supporting
|
|
documentation, and that the name of the author not be used in
|
|
advertising or publicity pertaining to distribution of the
|
|
software without specific, written prior permission.
|
|
|
|
The author disclaim all warranties with regard to this
|
|
software, including all implied warranties of merchantability
|
|
and fitness. In no event shall the author be liable for any
|
|
special, indirect or consequential damages or any damages
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
in an action of contract, negligence or other tortious action,
|
|
arising out of or in connection with the use or performance of
|
|
this software.
|
|
*/
|
|
|
|
/** \ingroup Group_USBClassHID
|
|
* @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
|
|
*
|
|
* \section Module Description
|
|
* Device Mode USB Class driver framework interface, for the HID USB Class driver.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _HID_CLASS_DEVICE_H_
|
|
#define _HID_CLASS_DEVICE_H_
|
|
|
|
/* Includes: */
|
|
#include "../../USB.h"
|
|
#include "../Common/HID.h"
|
|
|
|
#include <string.h>
|
|
|
|
/* Enable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Public Interface - May be used in end-application: */
|
|
/* Type Defines: */
|
|
/** Class state structure. An instance of this structure should be made for each HID interface
|
|
* within the user application, and passed to each of the HID class driver functions as the
|
|
* HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
|
|
*/
|
|
typedef struct
|
|
{
|
|
const struct
|
|
{
|
|
uint8_t InterfaceNumber; /**< Interface number of the HID interface within the device */
|
|
|
|
uint8_t ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */
|
|
uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */
|
|
|
|
uint8_t ReportINBufferSize; /**< Size of the largest possible report to send to the host, for
|
|
* buffer allocation purposes
|
|
*/
|
|
} Config; /**< Config data for the USB class interface within the device. All elements in this section
|
|
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.
|
|
*/
|
|
struct
|
|
{
|
|
bool UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */
|
|
uint16_t IdleCount; /**< Report idle period, in ms, set by the host */
|
|
uint16_t IdleMSRemaining; /**< Total number of ms remaining before the idle period elapsed - this should be
|
|
* decremented by the user application if non-zero each millisecond */
|
|
} State; /**< State data for the USB class interface within the device. All elements in this section
|
|
* <b>may</b> be set to initial values, but may also be ignored to default to sane values when
|
|
* the interface is enumerated.
|
|
*/
|
|
} USB_ClassInfo_HID_Device_t;
|
|
|
|
/* Function Prototypes: */
|
|
/** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library
|
|
* \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
|
|
* containing the given HID interface is selected.
|
|
*
|
|
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.
|
|
*
|
|
* \return Boolean true if the endpoints were sucessfully configured, false otherwise
|
|
*/
|
|
bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
|
|
|
|
/** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be
|
|
* linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
|
|
*
|
|
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.
|
|
*/
|
|
void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
|
|
|
|
/** General management task for a given HID class interface, required for the correct operation of the interface. This should
|
|
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
|
|
*
|
|
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.
|
|
*/
|
|
void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
|
|
|
|
/** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either
|
|
* HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the
|
|
* user is responsible for the creation of the next HID input report to be sent to the host.
|
|
*
|
|
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.
|
|
* \param[in,out] ReportID If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should
|
|
* be set to the report ID of the generated HID input report. If multiple reports are not sent via the
|
|
* given HID interface, this parameter should be ignored.
|
|
* \param[out] ReportData Pointer to a buffer where the generated HID report should be stored.
|
|
*
|
|
* \return Number of bytes in the generated input report, or zero if no report is to be sent
|
|
*/
|
|
uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);
|
|
|
|
/** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to
|
|
* either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback
|
|
* the user is responsible for the processing of the received HID output report from the host.
|
|
*
|
|
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.
|
|
* \param[in] ReportID Report ID of the received output report. If multiple reports are not received via the given HID
|
|
* interface, this parameter should be ignored.
|
|
* \param[in] ReportData Pointer to a buffer where the received HID report is stored.
|
|
* \param[in] ReportSize Size in bytes of the received report from the host.
|
|
*/
|
|
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
|
|
const void* ReportData, const uint16_t ReportSize);
|
|
|
|
/* Disable C linkage for C++ Compilers: */
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/** @} */
|