Move documentation for the USB_HOST_TIMEOUT_MS into the HostStandardReq module where...

[pub/USBasp.git] / LUFA / Drivers / USB / Core / HostStandardReq.h

diff --git a/LUFA/Drivers/USB/Core/HostStandardReq.h b/LUFA/Drivers/USB/Core/HostStandardReq.h
index ba8d7be..4bc3dda 100644 (file)
--- a/LUFA/Drivers/USB/Core/HostStandardReq.h
+++ b/LUFA/Drivers/USB/Core/HostStandardReq.h
@@ -58,6 +58,18 @@
                #endif
 
        /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
+                               /** Constant for the maximum software timeout period of sent USB control transactions to an attached
+                                *  device. If a device fails to respond to a sent control request within this period, the
+                                *  library will return a timeout error code.
+                                *
+                                *  This value may be overridden in the user project makefile as the value of the
+                                *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
+                                */
+                               #define USB_HOST_TIMEOUT_MS                1000
+                       #endif
+                       
                /* Enums: */
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
                         *  if the transfer of the request is unsuccessful.