Add documentation to the USB Class Drivers module on how to use the Host mode class...

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / DevChapter9.h

diff --git a/LUFA/Drivers/USB/LowLevel/DevChapter9.h b/LUFA/Drivers/USB/LowLevel/DevChapter9.h
index e6baca2..3d49062 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/DevChapter9.h
+++ b/LUFA/Drivers/USB/LowLevel/DevChapter9.h
@@ -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


@@ -82,23 +82,32 @@
                         */\r
                        extern uint8_t USB_ConfigurationNumber;\r
                        \r
                         */\r
                        extern uint8_t USB_ConfigurationNumber;\r
                        \r

-                       /** Indicates if the host is currently allowing the device to issue remote wakeup events. If this\r
-                        *  flag is cleared, the device should not issue remote wakeup events to the host.\r
-                        *\r
-                        *  \note This variable should be treated as read-only in the user application, and never manually\r
-                        *        changed in value.\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern bool USB_RemoteWakeupEnabled;\r
+                       #if !defined(NO_DEVICE_REMOTE_WAKEUP)\r
+                               /** Indicates if the host is currently allowing the device to issue remote wakeup events. If this\r
+                                *  flag is cleared, the device should not issue remote wakeup events to the host.\r
+                                *\r
+                                *  \note This variable should be treated as read-only in the user application, and never manually\r
+                                *        changed in value.\r
+                                *\r
+                                *  \note To reduce FLASH usage of the compiled applications where Remote Wakeup is not supported,\r
+                                *        this global and the underlying management code can be disabled by defining the \r
+                                *        NO_DEVICE_REMOTE_WAKEUP token in the project makefile and passing it to the compiler via\r
+                                *        the -D switch.\r
+                                *\r
+                                *  \ingroup Group_Device\r
+                                */\r
+                               extern bool USB_RemoteWakeupEnabled;\r
+                       #endif\r

                        \r
                        \r

-                       /** Indicates if the device is currently being powered by its own power supply, rather than being\r
-                        *  powered by the host's USB supply. This flag should remain cleared if the device does not\r
-                        *  support self powered mode, as indicated in the device descriptors.\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern bool USB_CurrentlySelfPowered;\r
+                       #if !defined(NO_DEVICE_SELF_POWER)\r
+                               /** Indicates if the device is currently being powered by its own power supply, rather than being\r
+                                *  powered by the host's USB supply. This flag should remain cleared if the device does not\r
+                                *  support self powered mode, as indicated in the device descriptors.\r
+                                *\r
+                                *  \ingroup Group_Device\r
+                                */\r
+                               extern bool USB_CurrentlySelfPowered;\r
+                       #endif\r

        \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
        \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r