Move documentation for the USB_HOST_TIMEOUT_MS into the HostStandardReq module where it is used.

This commit is contained in:
Dean Camera 2011-08-28 03:44:22 +00:00
parent 3b898ae178
commit dc9133ad21
4 changed files with 14 additions and 23 deletions

View file

@ -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.