Fixed misspelled HID_KEYBOARD_MODIFIER_* macros in the HID class driver (thanks to...
[pub/USBasp.git] / LUFA / Drivers / USB / Core / HostStandardReq.h
index caa42e3..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.
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
-                       uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);
+                       uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the string descriptor
                         *  of the specified index. This can be used to easily retrieve string descriptors from the device by
                         */
                        uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
                                                                   void* const Buffer,
-                                                                  const uint8_t BufferLength);
+                                                                  const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(2);
 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
-                       uint8_t USB_Host_GetDeviceStatus(uint8_t* const FeatureStatus);
+                       uint8_t USB_Host_GetDeviceStatus(uint8_t* const FeatureStatus) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device.
                         *
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
-                       uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointAddress);
+                       uint8_t USB_Host_ClearEndpointStall(const uint8_t EndpointAddress);
 
                        /** Selects a given alternative setting for the specified interface, via a SET INTERFACE standard request to
                         *  the attached device.