Add new Android Open Accessory class driver to the library core and add a new Android...

[pub/lufa.git] / LUFA / Drivers / USB / Class / AndroidAccessoryClass.h

diff --git a/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h b/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h
new file mode 100644 (file)
index 0000000..00eedd8
--- /dev/null
+++ b/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h
@@ -0,0 +1,75 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2011.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2011  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
+  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, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *  \brief Master include file for the library USB Android Open Accessory Class driver.\r
+ *\r
+ *  Master include file for the library USB Android Open Accessory Class driver, for both host and device modes, where available.\r
+ *\r
+ *  This file should be included in all user projects making use of this optional class driver, instead of\r
+ *  including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories.\r
+ */\r
+\r
+/** \ingroup Group_USBClassDrivers\r
+ *  \defgroup Group_USBClassAOA Android Open Accessory Class Driver\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>\r
+ *\r
+ *  \section Sec_ModDescription Module Description\r
+ *  Android Open Accessory Class Driver module. This module contains an internal implementation of the USB Android Open Accessory\r
+ *  Class, for Host USB mode. User applications can use this class driver instead of implementing the Android Open Accessory Class\r
+ *  manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interface with\r
+ *  Host using the USB Android Open Accessory Class.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef _AOA_CLASS_H_\r
+#define _AOA_CLASS_H_\r
+\r
+       /* Macros: */\r
+               #define __INCLUDE_FROM_USB_DRIVER\r
+               #define __INCLUDE_FROM_AOA_DRIVER\r
+\r
+       /* Includes: */\r
+               #include "../Core/USBMode.h"\r
+\r
+               #if defined(USB_CAN_BE_HOST)\r
+                       #include "Host/AndroidAccessoryClassHost.h"\r
+               #endif\r
+\r
+#endif\r
+\r
+/** @} */\r
+\r