X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/64e5c4084f862267d96b0947f462de7058f3dc4c..bb3879331211a19c3adc3927cac870cc7e36b775:/LUFA/Drivers/USB/Class/Host/HID.h

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index 89cb3d860..f6bd81c75 100644
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -105,10 +105,10 @@
 					bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot
 					                            *   Protocol when enabled via \ref HID_Host_SetBootProtocol()
 					                            */
-					bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a seperate OUT data pipe for
+					bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a separate OUT data pipe for
 					                         *   OUT reports, or if OUT reports are sent via the control pipe instead.
 					                         */
-					bool UsingBootProtocol; /**< Indicates that the interface is currently initialised in Boot Protocol mode */
+					bool UsingBootProtocol; /**< Indicates that the interface is currently initialized in Boot Protocol mode */
 					uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */
 					
 					uint8_t LargestReportSize; /**< Largest report the device will send, in bytes */
@@ -154,20 +154,24 @@
 			 *  \return A value from the \ref HIDHost_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, 3);
+			                                void* DeviceConfigDescriptor) 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.
+			 *  
+			 *  \note 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
 			 *
 			 *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 			 */
-			uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);
+			uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)
+			                               ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 
 			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
-			/** Received a HID IN report from the attached device, by the report ID.
+			/** Receives a HID IN report from the attached device, by the report ID.
 			 *
 			 *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
 			 *
@@ -178,7 +182,7 @@
 			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 			 */
 			uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,
-			                                   void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);
+			                                   void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 			#endif
 			
 			/** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's
@@ -199,11 +203,11 @@
 			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
 			                                const uint8_t ReportID,
 			#endif
-			                                void* Buffer, const uint16_t ReportSize)
+			                                void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
 			#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
-			                                ATTR_NON_NULL_PTR_ARG(1, 3);
+			                                ATTR_NON_NULL_PTR_ARG(3);
 			#else
-			                                ATTR_NON_NULL_PTR_ARG(1, 2);
+			                                ATTR_NON_NULL_PTR_ARG(2);
 			#endif
 
 			/** Determines if a HID IN report has been received from the attached device on the data IN pipe.