aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Core/HostStandardReq.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-08-28 03:44:22 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-08-28 03:44:22 +0000
commitdc9133ad21e1661abdcc549a274b0cb464b0ac9e (patch)
treee6359e46cf6fd563bd63ebfde917ccd7464bd9ea /LUFA/Drivers/USB/Core/HostStandardReq.h
parent3b898ae17823033c25c672d0b0001c4f1610fcd0 (diff)
downloadlufa-dc9133ad21e1661abdcc549a274b0cb464b0ac9e.tar.gz
lufa-dc9133ad21e1661abdcc549a274b0cb464b0ac9e.tar.bz2
lufa-dc9133ad21e1661abdcc549a274b0cb464b0ac9e.zip
Move documentation for the USB_HOST_TIMEOUT_MS into the HostStandardReq module where it is used.
Diffstat (limited to 'LUFA/Drivers/USB/Core/HostStandardReq.h')
-rw-r--r--LUFA/Drivers/USB/Core/HostStandardReq.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/LUFA/Drivers/USB/Core/HostStandardReq.h b/LUFA/Drivers/USB/Core/HostStandardReq.h
index ba8d7be4e..4bc3ddad2 100644
--- 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.