LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Host mode driver for the library USB Android Open Accessory Class driver.
  33  *
  34  *  Host mode driver for the library USB Android Open Accessory Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassAOA
  41  *  \defgroup Group_USBClassAndroidAccessoryHost Android Open Accessory Class Host Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Host Mode USB Class driver framework interface, for the Android Open Accessory USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __AOA_CLASS_HOST_H__
  54 #define __AOA_CLASS_HOST_H__
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/AndroidAccessoryClassCommon.h"
  59
  60                 #include <stdio.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_AOA_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  70                 #endif
  71
  72         /* Public Interface - May be used in end-application: */
  73                 /* Macros: */
  74                         /** Error code for some Android Open Accessory Host functions, indicating a logical (and not hardware) error. */
  75                         #define AOA_ERROR_LOGICAL_CMD_FAILED              0x80
  76
  77                 /* Type Defines: */
  78                         /** \brief Android Open Accessory Class Host Mode Configuration and State Structure.
  79                          *
  80                          *  Class state structure. An instance of this structure should be made within the user application,
  81                          *  and passed to each of the Android Open Accessory class driver functions as the \c AOAInterfaceInfo
  82                          *  parameter. This stores each Android Open Accessory interface's configuration and state information.
  83                          */
  84                         typedef struct
  85                         {
  86                                 const struct
  87                                 {
  88                                         uint8_t  DataINPipeNumber; /**< Pipe number of the AOA interface's IN data pipe. */
  89                                         bool     DataINPipeDoubleBank; /**< Indicates if the AOA interface's IN data pipe should use double banking. */
  90
  91                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the AOA interface's OUT data pipe. */
  92                                         bool     DataOUTPipeDoubleBank; /**< Indicates if the AOA interface's OUT data pipe should use double banking. */
  93
  94                                         struct
  95                                         {
  96                                                 char* Manufacturer; /**< Device manufacturer string. */
  97                                                 char* Model; /**< Device model name string. */
  98                                                 char* Description; /**< Device description string. */
  99                                                 char* Version; /**< Device version string. */
 100                                                 char* URI; /**< Device URI information string. */
 101                                                 char* Serial; /**< Device serial number string. */
 102                                         } ATTR_PACKED PropertyStrings; /**< Android Accessory property strings, sent to identify the accessory when the
 103                                                                         *   Android device is switched into Open Accessory mode. */
 104                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
 105                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
 106                                            */
 107                                 struct
 108                                 {
 109                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
 110                                                         *   after \ref AOA_Host_ConfigurePipes() is called and the Host state machine is in the
 111                                                         *   Configured state.
 112                                                         */
 113                                         uint8_t  InterfaceNumber; /**< Interface index of the AOA interface within the attached device. */
 114
 115                                         uint16_t DataINPipeSize; /**< Size in bytes of the AOA interface's IN data pipe. */
 116                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the AOA interface's OUT data pipe. */
 117                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 118                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 119                                                   *   the interface is enumerated.
 120                                                   */
 121                         } USB_ClassInfo_AOA_Host_t;
 122
 123                 /* Enums: */
 124                         /** Enum for the possible error codes returned by the \ref AOA_Host_ConfigurePipes() function. */
 125                         enum AOA_Host_EnumerationFailure_ErrorCodes_t
 126                         {
 127                                 AOA_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 128                                 AOA_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 129                                 AOA_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Android Open Accessory interface was not found in the device's Configuration Descriptor. */
 130                                 AOA_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 131                         };
 132
 133                 /* Function Prototypes: */
 134                         /** General management task for a given Android Open Accessory host class interface, required for the correct operation of the interface.
 135                          *  This should be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 136                          *
 137                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing an Android Open Accessory Class host configuration and state.
 138                          */
 139                         void AOA_Host_USBTask(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 140
 141                         /** Validates a device descriptor, to check if the device is a valid Android device, and if it is currently in Android Open Accessory mode.
 142                          *
 143                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing an AOA Class host configuration and state.
 144                          *  \param[in]     DeviceDescriptor  Pointer a buffer containing the attached device's Device Descriptor.
 145                          *  \param[out]    NeedModeSwitch    Pointer to a boolean where the mode switch requirement of the attached device is to be stored.
 146                          *
 147                          *  \return Boolean \c true if the attached device is a valid Android device, \c false otherwise.
 148                          */
 149                         bool AOA_Host_ValidateAccessoryDevice(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 150                                                   const USB_Descriptor_Device_t* const DeviceDescriptor,
 151                                                               bool* const NeedModeSwitch) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);
 152
 153                         /** Host interface configuration routine, to configure a given Android Open Accessory host interface instance using the Configuration
 154                          *  Descriptor read from an attached USB device. This function automatically updates the given Android Open Accessory Host instance's
 155                          *  state values and configures the pipes required to communicate with the interface if it is found within the device. This should be
 156                          *  called once after the stack has enumerated the attached device, while the host state machine is in the Addressed state.
 157                          *
 158                          *  \param[in,out] AOAInterfaceInfo      Pointer to a structure containing an AOA Class host configuration and state.
 159                          *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
 160                          *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
 161                          *
 162                          *  \return A value from the \ref AOA_Host_EnumerationFailure_ErrorCodes_t enum.
 163                          */
 164                         uint8_t AOA_Host_ConfigurePipes(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 165                                                         uint16_t ConfigDescriptorSize,
 166                                                         void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 167
 168                         /** Starts Accessory Mode in the attached Android device. This function will validate the device's Android Open Accessory protocol
 169                          *  version, send the configured property strings, and request a switch to Android Open Accessory mode.
 170                          *
 171                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing an AOA Class host configuration and state.
 172                          *
 173                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum, or \ref AOA_ERROR_LOGICAL_CMD_FAILED if a logical error occured..
 174                          */
 175                         uint8_t AOA_Host_StartAccessoryMode(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 176
 177                         /** Sends a given data buffer to the attached USB device, if connected. If a device is not connected when the function is
 178                          *  called, the data will be discarded. Bytes will be queued for transmission to the device until either the pipe bank
 179                          *  becomes full, or the \ref AOA_Host_Flush() function is called to flush the pending data to the device. This allows for
 180                          *  multiple bytes to be packed into a single pipe packet, increasing data throughput.
 181                          *
 182                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 183                          *       call will fail.
 184                          *
 185                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class host configuration and state.
 186                          *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
 187                          *  \param[in]     Length            Length of the data to send to the device.
 188                          *
 189                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 190                          */
 191                         uint8_t AOA_Host_SendData(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 192                                                   const uint8_t* const Buffer,
 193                                                   const uint16_t Length);
 194
 195                         /** Sends a given null-terminated string to the attached USB device, if connected. If a device is not connected when the
 196                          *  function is called, the string is discarded. Bytes will be queued for transmission to the device until either the pipe
 197                          *  bank becomes full, or the \ref AOA_Host_Flush() function is called to flush the pending data to the device. This allows
 198                          *  for multiple bytes to be packed into a single pipe packet, increasing data throughput.
 199                          *
 200                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 201                          *       call will fail.
 202                          *
 203                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class host configuration and state.
 204                          *  \param[in]     String            Pointer to the null terminated string to send to the device.
 205                          *
 206                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 207                          */
 208                         uint8_t AOA_Host_SendString(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 209                                                     const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 210
 211                         /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
 212                          *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 213                          *  \ref AOA_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 214                          *  packed into a single pipe packet, increasing data throughput.
 215                          *
 216                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 217                          *       call will fail.
 218                          *
 219                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class host configuration and state.
 220                          *  \param[in]     Data              Byte of data to send to the device.
 221                          *
 222                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 223                          */
 224                         uint8_t AOA_Host_SendByte(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 225                                                   const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 226
 227                         /** Determines the number of bytes received by the AOA interface from the device, waiting to be read. This indicates the number
 228                          *  of bytes in the IN pipe bank only, and thus the number of calls to \ref AOA_Host_ReceiveByte() which are guaranteed to succeed
 229                          *  immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
 230                          *  released back to the USB controller until all bytes are read.
 231                          *
 232                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 233                          *       call will fail.
 234                          *
 235                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class host configuration and state.
 236                          *
 237                          *  \return Total number of buffered bytes received from the device.
 238                          */
 239                         uint16_t AOA_Host_BytesReceived(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 240
 241                         /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function
 242                          *  returns a negative value. The \ref AOA_Host_BytesReceived() function may be queried in advance to determine how many bytes
 243                          *  are currently buffered in the AOA interface's data receive pipe.
 244                          *
 245                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 246                          *       call will fail.
 247                          *
 248                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class host configuration and state.
 249                          *
 250                          *  \return Next received byte from the device, or a negative value if no data received.
 251                          */
 252                         int16_t AOA_Host_ReceiveByte(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 253
 254                         /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 255                          *
 256                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 257                          *       call will fail.
 258                          *
 259                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class host configuration and state.
 260                          *
 261                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 262                          */
 263                         uint8_t AOA_Host_Flush(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 264
 265                         /** Creates a standard character stream for the given AOA Device instance so that it can be used with all the regular
 266                          *  functions in the standard \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
 267                          *  stream is bidirectional and can be used for both input and output functions.
 268                          *
 269                          *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
 270                          *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
 271                          *  be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
 272                          *  line buffering.
 273                          *
 274                          *  \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
 275                          *        to the given AOA interface.
 276                          *        \n\n
 277                          *
 278                          *  \note This function is not available on all microcontroller architectures.
 279                          *
 280                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class configuration and state.
 281                          *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
 282                          */
 283                         void AOA_Host_CreateStream(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 284                                                    FILE* const Stream);
 285
 286                         /** Identical to \ref AOA_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
 287                          *  the transfer. While blocking, the USB and AOA service tasks are called repeatedly to maintain USB communications.
 288                          *
 289                          *  \note This function is not available on all microcontroller architectures.
 290                          *
 291                          *  \param[in,out] AOAInterfaceInfo  Pointer to a structure containing a AOA Class configuration and state.
 292                          *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
 293                          */
 294                         void AOA_Host_CreateBlockingStream(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 295                                                            FILE* const Stream);
 296
 297         /* Private Interface - For use in library only: */
 298         #if !defined(__DOXYGEN__)
 299                 /* Function Prototypes: */
 300                         #if defined(__INCLUDE_FROM_ANDROIDACCESSORY_HOST_C)
 301                                 #if defined(FDEV_SETUP_STREAM)
 302                                 static int AOA_Host_putchar(char c,
 303                                                             FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
 304                                 static int AOA_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 305                                 static int AOA_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 306                                 #endif
 307
 308                                 static uint8_t AOA_Host_GetAccessoryProtocol(uint16_t* const Protocol) ATTR_NON_NULL_PTR_ARG(1);
 309                                 static uint8_t AOA_Host_SendPropertyString(USB_ClassInfo_AOA_Host_t* const AOAInterfaceInfo,
 310                                                                        const uint8_t StringIndex) ATTR_NON_NULL_PTR_ARG(1);
 311
 312                                 static uint8_t DCOMP_AOA_Host_NextAndroidAccessoryInterface(void* const CurrentDescriptor)
 313                                                                                             ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 314                                 static uint8_t DCOMP_AOA_Host_NextInterfaceBulkEndpoint(void* const CurrentDescriptor)
 315                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 316                         #endif
 317         #endif
 318
 319         /* Disable C linkage for C++ Compilers: */
 320                 #if defined(__cplusplus)
 321                         }
 322                 #endif
 323
 324 #endif
 325
 326 /** @} */
 327
 328