Move documentation for the USB_HOST_TIMEOUT_MS into the HostStandardReq module where...
authorDean Camera <dean@fourwalledcubicle.com>
Sun, 28 Aug 2011 03:44:22 +0000 (03:44 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Sun, 28 Aug 2011 03:44:22 +0000 (03:44 +0000)
LUFA/Drivers/USB/Class/Host/MassStorage.h
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
LUFA/Drivers/USB/Core/HostStandardReq.h
LUFA/Drivers/USB/Core/UC3/Host_UC3.h

index 4976297..ff336f8 100644 (file)
                                                       void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 
                        /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
-                        *  and readying it for the next Mass Storage command.
+                        *  and readying it for the next Mass Storage command. This should be called after a failed SCSI request to 
+                        *  ensure the attached Mass Storage device is ready to receive the next command.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
                         *
index 1b34801..b97c45c 100644 (file)
                         */
                        #define USB_HOST_DEVICEADDRESS                 1
 
-                       #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
-
                        #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)
                                /** Constant for the delay in milliseconds after a device is connected before the library
                                 *  will start the enumeration process. Some devices require a delay of up to 5 seconds
index ba8d7be..4bc3dda 100644 (file)
                #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.
index 6191559..61e82f1 100644 (file)
                         */
                        #define USB_HOST_DEVICEADDRESS                 1
 
-                       #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
-
                        #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)
                                /** Constant for the delay in milliseconds after a device is connected before the library
                                 *  will start the enumeration process. Some devices require a delay of up to 5 seconds