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 d8ab056..ef3ab38 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/OTG.h
+++ b/LUFA/Drivers/USB/LowLevel/OTG.h
@@ -1,13 +1,13 @@
 /*\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
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r


@@ -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