Fixed incorrect comparison in the descriptor callback routine of the TeensyHID bootlo...
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / HostChapter9.h
index 7550bcd..e38c67e 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
 \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief USB host standard request management.\r
+ *\r
+ *  This file contains the function prototypes neccesary for the issuing of outgoing standard control requests\r
+ *  when the library is in USB host mode.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
 #ifndef __HOSTCHAPTER9_H__\r
 #define __HOSTCHAPTER9_H__\r
 \r
 #ifndef __HOSTCHAPTER9_H__\r
 #define __HOSTCHAPTER9_H__\r
 \r
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+               #endif\r
+               \r
        /* Public Interface - May be used in end-application: */\r
                /* Enums: */\r
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error\r
        /* Public Interface - May be used in end-application: */\r
                /* Enums: */\r
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error\r
                         */\r
                        enum USB_Host_SendControlErrorCodes_t\r
                        {\r
                         */\r
                        enum USB_Host_SendControlErrorCodes_t\r
                        {\r
-                               HOST_SENDCONTROL_Successful       = 0, /**< No error occurred in the request transfer. */\r
-                               HOST_SENDCONTROL_DeviceDisconnect = 1, /**< The attached device was disconnected during the\r
+                               HOST_SENDCONTROL_Successful         = 0, /**< No error occurred in the request transfer. */\r
+                               HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the\r
                                                                        *   request transfer.\r
                                                                        */\r
                                                                        *   request transfer.\r
                                                                        */\r
-                               HOST_SENDCONTROL_PipeError        = 2, /**< An error occurred in the pipe while sending the request. */\r
-                               HOST_SENDCONTROL_SetupStalled     = 3, /**< The attached device stalled the request, usually\r
+                               HOST_SENDCONTROL_PipeError          = 2, /**< An error occurred in the pipe while sending the request. */\r
+                               HOST_SENDCONTROL_SetupStalled       = 3, /**< The attached device stalled the request, usually\r
                                                                        *   indicating that the request is unsupported on the device.\r
                                                                        */\r
                                                                        *   indicating that the request is unsupported on the device.\r
                                                                        */\r
-                               HOST_SENDCONTROL_SoftwareTimeOut  = 4, /**< The request or data transfer timed out. */\r
+                               HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */\r
                        };\r
                        \r
                /* Function Prototypes: */\r
                        };\r
                        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\r
-                       #if defined(INCLUDE_FROM_HOSTCHAPTER9_C)\r
+                       #if defined(__INCLUDE_FROM_HOSTCHAPTER9_C)\r
                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);\r
                        #endif\r
        #endif\r
                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);\r
                        #endif\r
        #endif\r