Add LUFA-side channel open/close routines, add signalling handlers for the creation...

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

diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h
index 9cce2e6..ef3ab38 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/OTG.h
+++ b/LUFA/Drivers/USB/LowLevel/OTG.h
@@ -28,6 +28,16 @@
   this software.\r
 */\r
  \r
   this software.\r
 */\r
  \r

+/** \file\r
+ *  \brief USB OTG mode definitions.\r
+ *\r
+ *  This file contains structures, function prototypes and macros related to USB OTG mode, where two USB devices\r
+ *  may be linked directly together and exchange host/device roles as needed.\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

 /** \ingroup Group_USB\r
  *  @defgroup Group_OTG USB On The Go (OTG) Management\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_OTG USB On The Go (OTG) Management\r
  *\r


@@ -47,6 +57,11 @@
                \r
                #include "../../../Common/Common.h"\r
 \r
                \r
                #include "../../../Common/Common.h"\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
                /* Macros: */\r
                        /** Mask for the VBUS pulsing method of SRP, supported by some OTG devices.\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Mask for the VBUS pulsing method of SRP, supported by some OTG devices.\r