Update code and StaticAnlysisTest so that missingInclude warnings do not have to...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HIDClassHost.h

diff --git a/LUFA/Drivers/USB/Class/Host/HIDClassHost.h b/LUFA/Drivers/USB/Class/Host/HIDClassHost.h
index 5d8c8e9..7bdaad1 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HIDClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDClassHost.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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


@@ -42,7 +42,7 @@
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:

- *    - LUFA/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *    - LUFA/Drivers/USB/Class/Host/HIDClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>

  *
  *  \section Sec_ModDescription Module Description
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.
  *
  *  \section Sec_ModDescription Module Description
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.


@@ -81,7 +81,7 @@
                         */
                        typedef struct
                        {
                         */
                        typedef struct
                        {

-                               const struct
+                               struct

                                {
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe. */
                                        bool     DataINPipeDoubleBank; /**< Indicates if the HID interface's IN data pipe should use double banking. */
                                {
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe. */
                                        bool     DataINPipeDoubleBank; /**< Indicates if the HID interface's IN data pipe should use double banking. */


@@ -148,18 +148,18 @@
                         *  device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *
                         *  device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *

-                        *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
-                        *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
+                        *  \attention Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
+                        *             to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.

                         *
                         *

-                        *  \param[in,out] HIDInterfaceInfo        Pointer to a structure containing a HID Class host configuration and state.
-                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
-                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
+                        *  \param[in,out] HIDInterfaceInfo      Pointer to a structure containing a HID Class host configuration and state.
+                        *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
+                        *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.

                         *
                         *  \return A value from the \ref HID_Host_EnumerationFailure_ErrorCodes_t enum.
                         */
                        uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
                                                        uint16_t ConfigDescriptorSize,
                         *
                         *  \return A value from the \ref HID_Host_EnumerationFailure_ErrorCodes_t enum.
                         */
                        uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
                                                        uint16_t ConfigDescriptorSize,

-                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
+                                                       void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);

 
 
                        /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.
 
 
                        /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.


@@ -167,8 +167,8 @@
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
                         *       call will fail.
                         *
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
                         *       call will fail.
                         *

-                        *  \note The destination buffer should be large enough to accommodate the largest report that the attached device
-                        *        can generate.
+                        *  \attention The destination buffer should be large enough to accommodate the largest report that the attached device
+                        *             can generate.

                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
                         *  \param[in]     Buffer            Buffer to store the received report into.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
                         *  \param[in]     Buffer            Buffer to store the received report into.


@@ -267,9 +267,8 @@
                        /** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves
                         *  and parses the device's HID report descriptor, so that the size of each report can be determined in advance.
                         *
                        /** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves
                         *  and parses the device's HID report descriptor, so that the size of each report can be determined in advance.
                         *

-                        *  \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
-                        *        Report Parser this function references <b>must</b> be implemented in the user code.
-                        *        \n\n
+                        *  \attention Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
+                        *             Report Parser this function references <b>must</b> be implemented in the user code.

                         *
                         *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
                         *
                         *
                         *  \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
                         *