projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fixed possible invalid program execution when in host mode if corrupt descriptor...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / HID.h
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index 5329e29..133e4f5 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -33,18 +33,18 @@
  *
  *  Device mode driver for the library USB HID Class driver.
  *
  *
  *  Device mode driver for the library USB HID Class driver.
  *
- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/HID.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.
  */
 
 /** \ingroup Group_USBClassHID
  */
 
 /** \ingroup Group_USBClassHID
- *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
+ *  \defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
  *
  *  @{
  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
  *
  *  @{
@@ -57,8 +57,6 @@
                #include "../../USB.h"
                #include "../Common/HID.h"
 
                #include "../../USB.h"
                #include "../Common/HID.h"
 
-               #include <string.h>
-
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
@@ -66,7 +64,7 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_HID_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_HID_DRIVER)
-                       #error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
                #endif
 
        /* Public Interface - May be used in end-application: */
                #endif
 
        /* Public Interface - May be used in end-application: */
@@ -75,7 +73,7 @@
                         *
                         *  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
                         *
                         *  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.
+                        *  \c HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
                         *
                         *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
                         *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
                         *
                         *  \note Due to technical limitations, the HID device class driver does not utilize a separate OUT
                         *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to
@@ -95,18 +93,18 @@
                                                                      *  stored by the driver, for comparison purposes to detect report changes that
                                                                      *  must be sent immediately to the host. This should point to a buffer big enough
                                                                      *  to hold the largest HID input report sent from the HID interface. If this is set
                                                                      *  stored by the driver, for comparison purposes to detect report changes that
                                                                      *  must be sent immediately to the host. This should point to a buffer big enough
                                                                      *  to hold the largest HID input report sent from the HID interface. If this is set
-                                                                                                 *  to NULL, it is up to the user to force transfers when needed in the
+                                                                                                 *  to \c NULL, it is up to the user to force transfers when needed in the
                                                                                                  *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
                                                                                                  *
                                                                                                  *  \note Due to the single buffer, the internal driver can only correctly compare
                                                                                                  *        subsequent reports with identical report IDs. In multiple report devices,
                                                                                                  *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
                                                                                                  *
                                                                                                  *  \note Due to the single buffer, the internal driver can only correctly compare
                                                                                                  *        subsequent reports with identical report IDs. In multiple report devices,
-                                                                                                 *        this buffer should be set to NULL and the decision to send reports made
+                                                                                                 *        this buffer should be set to \c NULL and the decision to send reports made
                                                                                                  *        by the user application instead.
                                                                      */
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a
                                                                          *  second buffer of the same size within the driver so that subsequent reports
                                                                          *  can be compared. If the user app is to determine when reports are to be sent
                                                                                                  *        by the user application instead.
                                                                      */
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a
                                                                          *  second buffer of the same size within the driver so that subsequent reports
                                                                          *  can be compared. If the user app is to determine when reports are to be sent
-                                                                         *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value must still be
+                                                                         *  exclusively (i.e. \ref PrevReportINBuffer is \c NULL) this value must still be
                                                                                                          *  set to the size of the largest report the device can issue to the host.
                                                                          */
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
                                                                                                          *  set to the size of the largest report the device can issue to the host.
                                                                          */
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
@@ -134,12 +132,12 @@
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
                         *
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
                         *
-                        *  \return Boolean true if the endpoints were successfully configured, false otherwise.
+                        *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
                         */
                        bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Processes incoming control requests from the host, that are directed to the given HID class interface. This should be
                         */
                        bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Processes incoming control requests from the host, that are directed to the given HID class interface. This should be
-                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
+                        *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
                         */
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
                         */
@@ -164,8 +162,8 @@
                         *  \param[out]    ReportData        Pointer to a buffer where the generated HID report should be stored.
                         *  \param[out]    ReportSize        Number of bytes in the generated input report, or zero if no report is to be sent.
                         *
                         *  \param[out]    ReportData        Pointer to a buffer where the generated HID report should be stored.
                         *  \param[out]    ReportSize        Number of bytes in the generated input report, or zero if no report is to be sent.
                         *
-                        *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within
-                        *          the idle period (useful for devices which report relative movement), false otherwise.
+                        *  \return Boolean \c true to force the sending of the report even if it is identical to the previous report and still within
+                        *          the idle period (useful for devices which report relative movement), \c false otherwise.
                         */
                        bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
                                                                 uint8_t* const ReportID,
                         */
                        bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
                                                                 uint8_t* const ReportID,
USB isp AVR programmer