Tag for the LUFA-120730-BETA release.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / AndroidAccessoryClassCommon.h
index c1c0e8d..dc1289d 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2012.\r
-\r
-  dean [at] fourwalledcubicle [dot] com\r
-           www.lufa-lib.org\r
-*/\r
-\r
-/*\r
-  Copyright 2012  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 Common definitions and declarations for the library USB Android Open Accessory Class driver.\r
- *\r
- *  Common definitions and declarations for the library USB Android Open Accessory Class driver.\r
- *\r
- *  \note This file should not be included directly. It is automatically included as needed by the USB module driver\r
- *        dispatch header located in LUFA/Drivers/USB.h.\r
- */\r
-\r
-/** \ingroup Group_USBClassAOA\r
- *  \defgroup Group_USBClassAOACommon  Common Class Definitions\r
- *\r
- *  \section Sec_ModDescription Module Description\r
- *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
- *  Android Open Accessory Class.\r
- *\r
- *  @{\r
- */\r
-\r
-#ifndef _AOA_CLASS_COMMON_H_\r
-#define _AOA_CLASS_COMMON_H_\r
-\r
-       /* Includes: */\r
-               #include "../../Core/StdDescriptors.h"\r
-\r
-       /* Enable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       extern "C" {\r
-               #endif\r
-\r
-       /* Preprocessor Checks: */\r
-               #if !defined(__INCLUDE_FROM_AOA_DRIVER)\r
-                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.\r
-               #endif\r
-\r
-       /* Macros: */\r
-               /** Product ID value in a Device Descriptor to indicate an Android device in Open Accessory mode. */\r
-               #define ANDROID_ACCESSORY_PRODUCT_ID        0x2D00\r
-\r
-               /** Product ID value in a Device Descriptor to indicate an Android device in Open Accessory and Android Debug mode. */\r
-               #define ANDROID_ACCESSORY_ADB_PRODUCT_ID    0x2D01\r
-\r
-       /* Enums: */\r
-               /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the\r
-                *  Android Open Accessory class.\r
-                */\r
-               enum AOA_Descriptor_ClassSubclassProtocol_t\r
-               {\r
-                       AOA_CSCP_AOADataClass    = 0xFF, /**< Descriptor Class value indicating that the device or interface\r
-                                                         *   belongs to the AOA data class.\r
-                                                         */\r
-                       AOA_CSCP_AOADataSubclass = 0xFF, /**< Descriptor Subclass value indicating that the device or interface\r
-                                                         *   belongs to AOA data subclass.\r
-                                                         */\r
-                       AOA_CSCP_AOADataProtocol = 0x00, /**< Descriptor Protocol value indicating that the device or interface\r
-                                                         *   belongs to the AOA data class protocol.\r
-                                                         */\r
-               };\r
-\r
-               /** Enum for the Android Open Accessory class specific control requests that can be issued by the USB bus host. */\r
-               enum AOA_ClassRequests_t\r
-               {\r
-                       AOA_REQ_GetAccessoryProtocol    = 0x33, /**< Android Open Accessory control request to retrieve the device's supported Accessory Protocol version. */\r
-                       AOA_REQ_SendString              = 0x34, /**< Android Open Accessory control request to set an accessory property string in the device. */\r
-                       AOA_REQ_StartAccessoryMode      = 0x35, /**< Android Open Accessory control request to switch the device into Accessory mode. */\r
-               };\r
-\r
-               /** Enum for the possible Android Open Accessory property string indexes. */\r
-               enum AOA_Strings_t\r
-               {\r
-                       AOA_STRING_Manufacturer         = 0, /**< Index of the Manufacturer property string. */\r
-                       AOA_STRING_Model                = 1, /**< Index of the Model Name property string. */\r
-                       AOA_STRING_Description          = 2, /**< Index of the Description property string. */\r
-                       AOA_STRING_Version              = 3, /**< Index of the Version Number property string. */\r
-                       AOA_STRING_URI                  = 4, /**< Index of the URI Information property string. */\r
-                       AOA_STRING_Serial               = 5, /**< Index of the Serial Number property string. */\r
-                       \r
-                       #if !defined(__DOXYGEN__)\r
-                       AOA_STRING_TOTAL_STRINGS\r
-                       #endif\r
-               };\r
-               \r
-               /** Enum for the possible Android Open Accessory protocol versions. */\r
-               enum AOA_Protocols_t\r
-               {\r
-                       AOA_PROTOCOL_AccessoryV1        = 0x0001, /**< Android Open Accessory version 1. */\r
-               };\r
-\r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
-\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Common definitions and declarations for the library USB Android Open Accessory Class driver.
+ *
+ *  Common definitions and declarations for the library USB Android Open Accessory Class driver.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.
+ */
+
+/** \ingroup Group_USBClassAOA
+ *  \defgroup Group_USBClassAOACommon  Common Class Definitions
+ *
+ *  \section Sec_ModDescription Module Description
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
+ *  Android Open Accessory Class.
+ *
+ *  @{
+ */
+
+#ifndef _AOA_CLASS_COMMON_H_
+#define _AOA_CLASS_COMMON_H_
+
+       /* Includes: */
+               #include "../../Core/StdDescriptors.h"
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_AOA_DRIVER)
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
+               #endif
+
+       /* Macros: */
+               /** Product ID value in a Device Descriptor to indicate an Android device in Open Accessory mode. */
+               #define ANDROID_ACCESSORY_PRODUCT_ID        0x2D00
+
+               /** Product ID value in a Device Descriptor to indicate an Android device in Open Accessory and Android Debug mode. */
+               #define ANDROID_ACCESSORY_ADB_PRODUCT_ID    0x2D01
+
+       /* Enums: */
+               /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the
+                *  Android Open Accessory class.
+                */
+               enum AOA_Descriptor_ClassSubclassProtocol_t
+               {
+                       AOA_CSCP_AOADataClass    = 0xFF, /**< Descriptor Class value indicating that the device or interface
+                                                         *   belongs to the AOA data class.
+                                                         */
+                       AOA_CSCP_AOADataSubclass = 0xFF, /**< Descriptor Subclass value indicating that the device or interface
+                                                         *   belongs to AOA data subclass.
+                                                         */
+                       AOA_CSCP_AOADataProtocol = 0x00, /**< Descriptor Protocol value indicating that the device or interface
+                                                         *   belongs to the AOA data class protocol.
+                                                         */
+               };
+
+               /** Enum for the Android Open Accessory class specific control requests that can be issued by the USB bus host. */
+               enum AOA_ClassRequests_t
+               {
+                       AOA_REQ_GetAccessoryProtocol    = 0x33, /**< Android Open Accessory control request to retrieve the device's supported Accessory Protocol version. */
+                       AOA_REQ_SendString              = 0x34, /**< Android Open Accessory control request to set an accessory property string in the device. */
+                       AOA_REQ_StartAccessoryMode      = 0x35, /**< Android Open Accessory control request to switch the device into Accessory mode. */
+               };
+
+               /** Enum for the possible Android Open Accessory property string indexes. */
+               enum AOA_Strings_t
+               {
+                       AOA_STRING_Manufacturer         = 0, /**< Index of the Manufacturer property string. */
+                       AOA_STRING_Model                = 1, /**< Index of the Model Name property string. */
+                       AOA_STRING_Description          = 2, /**< Index of the Description property string. */
+                       AOA_STRING_Version              = 3, /**< Index of the Version Number property string. */
+                       AOA_STRING_URI                  = 4, /**< Index of the URI Information property string. */
+                       AOA_STRING_Serial               = 5, /**< Index of the Serial Number property string. */
+                       
+                       #if !defined(__DOXYGEN__)
+                       AOA_STRING_TOTAL_STRINGS
+                       #endif
+               };
+               
+               /** Enum for the possible Android Open Accessory protocol versions. */
+               enum AOA_Protocols_t
+               {
+                       AOA_PROTOCOL_AccessoryV1        = 0x0001, /**< Android Open Accessory version 1. */
+               };
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+
+#endif
+
+/** @} */
+