Removed invalid dfu and flip related targets from the bootloaders - bootloaders can...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / USBTask.h

diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h
index 9c0abf0..0b54742 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBTask.h
+++ b/LUFA/Drivers/USB/HighLevel/USBTask.h
@@ -1,21 +1,21 @@
 /*\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
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\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
@@ -27,7 +27,17 @@
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\r
- \r
+\r
+/** \file\r
+ *  \brief Main USB service task management.\r
+ *\r
+ *  This file contains the function definitions required for the main USB service task, which must be called\r
+ *  from the user application to ensure that the USB connection to or from a connected USB device is maintained.\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 __USBTASK_H__\r
 #define __USBTASK_H__\r
 \r
@@ -54,6 +64,11 @@
                #if defined(__cplusplus)\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
                /* Global Variables: */\r
@@ -76,7 +91,7 @@
                         extern USB_Request_Header_t USB_ControlRequest;\r
                        \r
                        #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
-                               #if !defined(HOST_STATE_AS_GPIOR1) || defined(__DOXYGEN__)\r
+                               #if !defined(HOST_STATE_AS_GPIOR) || defined(__DOXYGEN__)\r
                                        /** Indicates the current host state machine state. When in host mode, this indicates the state\r
                                         *  via one of the values of the \ref USB_Host_States_t enum values.\r
                                         *\r
@@ -100,7 +115,7 @@
                                #else\r
                                        #define _GET_HOST_GPIOR_NAME2(y) GPIOR ## y\r
                                        #define _GET_HOST_GPIOR_NAME(x)  _GET_HOST_GPIOR_NAME2(x)\r
-                                       #define USB_HostState _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)\r
+                                       #define USB_HostState            _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)\r
                                #endif\r
                        #endif\r
 \r
@@ -132,7 +147,7 @@
                                #else\r
                                        #define _GET_DEVICE_GPIOR_NAME2(y) GPIOR ## y\r
                                        #define _GET_DEVICE_GPIOR_NAME(x)  _GET_DEVICE_GPIOR_NAME2(x)\r
-                                       #define USB_DeviceState _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)\r
+                                       #define USB_DeviceState            _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)\r
                                #endif\r
                        #endif\r
 \r
@@ -164,7 +179,7 @@
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
-                       #if defined(INCLUDE_FROM_USBTASK_C)\r
+                       #if defined(__INCLUDE_FROM_USBTASK_C)\r
                                #if defined(USB_CAN_BE_HOST)\r
                                        static void USB_HostTask(void);\r
                                #endif\r
@@ -175,7 +190,9 @@
                        #endif\r
                        \r
                /* Macros: */\r
-                       #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) {USB_HostState = HOST_STATE_WaitForDevice; WaitMSRemaining = duration; PostWaitState = nextstate; }\r
+                       #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) MACROS{ USB_HostState = HOST_STATE_WaitForDevice; \\r
+                                                                                    WaitMSRemaining = (duration);             \\r
+                                                                                    PostWaitState = (nextstate);        }MACROE\r
        #endif\r
        \r
        /* Disable C linkage for C++ Compilers: */\r