LUFA/Drivers/USB/Class/Host/Audio.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 Audio 1.0 Class driver.
  33  *
  34  *  Host mode driver for the library USB Audio 1.0 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_USBClassAudio
  41  *  \defgroup Group_USBClassAudioHost Audio 1.0 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/Audio.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 Audio 1.0 USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __AUDIO_CLASS_HOST_H__
  54 #define __AUDIO_CLASS_HOST_H__
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/Audio.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Type Defines: */
  72                         /** \brief Audio Class Host Mode Configuration and State Structure.
  73                          *
  74                          *  Class state structure. An instance of this structure should be made within the user application,
  75                          *  and passed to each of the Audio class driver functions as the \c AudioInterfaceInfo parameter. This
  76                          *  stores each Audio interface's configuration and state information.
  77                          */
  78                         typedef struct
  79                         {
  80                                 const struct
  81                                 {
  82                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Audio interface's IN data pipe. If this interface should not
  83                                                                     *   bind to an IN endpoint, this may be set to 0 to disable audio input streaming for
  84                                                                     *   this driver instance.
  85                                                                     */
  86                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Audio interface's OUT data pipe. If this interface should not
  87                                                                     *   bind to an OUT endpoint, this may be set to 0 to disable audio output streaming for
  88                                                                     *   this driver instance.
  89                                                                     */
  90                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  91                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  92                                            */
  93                                 struct
  94                                 {
  95                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  96                                                         *   after \ref Audio_Host_ConfigurePipes() is called and the Host state machine is in the
  97                                                         *   Configured state.
  98                                                         */
  99                                         uint8_t ControlInterfaceNumber; /**< Interface index of the Audio Control interface within the attached device. */
 100                                         uint8_t StreamingInterfaceNumber; /**< Interface index of the Audio Streaming interface within the attached device. */
 101
 102                                         uint8_t EnabledStreamingAltIndex; /**< Alternative setting index of the Audio Streaming interface when the stream is enabled. */
 103
 104                                         uint16_t DataINPipeSize; /**< Size in bytes of the Audio interface's IN data pipe. */
 105                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Audio interface's OUT data pipe. */
 106                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 107                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 108                                                   *   the interface is enumerated.
 109                                                   */
 110                         } USB_ClassInfo_Audio_Host_t;
 111
 112                 /* Enums: */
 113                         /** Enum for the possible error codes returned by the \ref Audio_Host_ConfigurePipes() function. */
 114                         enum AUDIO_Host_EnumerationFailure_ErrorCodes_t
 115                         {
 116                                 AUDIO_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 117                                 AUDIO_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 118                                 AUDIO_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible AUDIO interface was not found in the device's Configuration Descriptor. */
 119                                 AUDIO_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 120                         };
 121
 122                 /* Function Prototypes: */
 123                         /** Host interface configuration routine, to configure a given Audio host interface instance using the Configuration
 124                          *  Descriptor read from an attached USB device. This function automatically updates the given Audio Host instance's
 125                          *  state values and configures the pipes required to communicate with the interface if it is found within the
 126                          *  device. This should be called once after the stack has enumerated the attached device, while the host state
 127                          *  machine is in the Addressed state.
 128                          *
 129                          *  \param[in,out] AudioInterfaceInfo      Pointer to a structure containing an Audio Class host configuration and state.
 130                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
 131                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
 132                          *
 133                          *  \return A value from the \ref AUDIO_Host_EnumerationFailure_ErrorCodes_t enum.
 134                          */
 135                         uint8_t Audio_Host_ConfigurePipes(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 136                                                           uint16_t ConfigDescriptorSize,
 137                                                           void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 138
 139                         /** Starts or stops the audio streaming for the given configured Audio Host interface, allowing for audio samples to be
 140                          *  send and/or received.
 141                          *
 142                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.
 143                          *  \param[in]     EnableStreaming     Boolean true to enable streaming of the specified interface, false to disable
 144                          *
 145                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 146                          */
 147                         uint8_t Audio_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 148                                                               const bool EnableStreaming) ATTR_NON_NULL_PTR_ARG(1);
 149                         uint8_t Audio_Host_StartStopStreaming(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 150                                                               const bool EnableStreaming);
 151
 152                         /** Gets or sets the specified property of a streaming audio class endpoint that is bound to a pipe in the given
 153                          *  class instance.
 154                          *
 155                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.
 156                          *  \param[in]     DataPipeIndex       Index of the data pipe whose bound endpoint is to be altered.
 157                          *  \param[in]     EndpointProperty    Property of the endpoint to get or set, a value from \ref Audio_ClassRequests_t.
 158                          *  \param[in]     EndpointControl     Parameter of the endpoint to get or set, a value from \ref Audio_EndpointControls_t.
 159                          *  \param[in,out] DataLength          For SET operations, the length of the parameter data to set. For GET operations, the maximum
 160                          *                                     length of the retrieved data.
 161                          *  \param[in,out] Data                Pointer to a location where the parameter data is stored for SET operations, or where
 162                          *                                     the retrieved data is to be stored for GET operations.
 163                          *
 164                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 165                          */
 166                         uint8_t Audio_Host_GetSetEndpointProperty(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 167                                                                   const uint8_t DataPipeIndex,
 168                                                                   const uint8_t EndpointProperty,
 169                                                                   const uint8_t EndpointControl,
 170                                                                   const uint16_t DataLength,
 171                                                                   void* const Data) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 172                         uint8_t Audio_Host_GetSetEndpointProperty(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 173                                                                   const uint8_t DataPipeIndex,
 174                                                                   const uint8_t EndpointProperty,
 175                                                                   const uint8_t EndpointControl,
 176                                                                   const uint16_t DataLength,
 177                                                                   void* const Data);
 178
 179                 /* Inline Functions: */
 180                         /** General management task for a given Audio host class interface, required for the correct operation of
 181                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 182                          *  \ref USB_USBTask().
 183                          *
 184                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class host configuration and state.
 185                          */
 186                         static inline void Audio_Host_USBTask(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 187                                                               ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 188                         static inline void Audio_Host_USBTask(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 189                         {
 190                                 (void)AudioInterfaceInfo;
 191                         }
 192
 193                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 194                          *  IN pipe ready for reading.
 195                          *
 196                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
 197                          *       the call will fail.
 198                          *
 199                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 200                          *
 201                          *  \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
 202                          */
 203                         static inline bool Audio_Host_IsSampleReceived(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 204                                                                        ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 205                         static inline bool Audio_Host_IsSampleReceived(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 206                         {
 207                                 if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))
 208                                   return false;
 209
 210                                 bool SampleReceived = false;
 211
 212                                 Pipe_SelectPipe(AudioInterfaceInfo->Config.DataINPipeNumber);
 213                                 Pipe_Unfreeze();
 214                                 SampleReceived = Pipe_IsINReceived();
 215                                 Pipe_Freeze();
 216
 217                                 return SampleReceived;
 218                         }
 219
 220                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 221                          *  the streaming OUT pipe ready for writing.
 222                          *
 223                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
 224                          *       the call will fail.
 225                          *
 226                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 227                          *
 228                          *  \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
 229                          */
 230                         static inline bool Audio_Host_IsReadyForNextSample(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 231                                                                            ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 232                         static inline bool Audio_Host_IsReadyForNextSample(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 233                         {
 234                                 if ((USB_HostState != HOST_STATE_Configured) || !(AudioInterfaceInfo->State.IsActive))
 235                                   return false;
 236
 237                                 Pipe_SelectPipe(AudioInterfaceInfo->Config.DataOUTPipeNumber);
 238                                 return Pipe_IsOUTReady();
 239                         }
 240
 241                         /** Reads the next 8-bit audio sample from the current audio interface.
 242                          *
 243                          *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure
 244                          *       that the correct pipe is selected and ready for data.
 245                          *
 246                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 247                          *
 248                          *  \return  Signed 8-bit audio sample from the audio interface.
 249                          */
 250                         static inline int8_t Audio_Host_ReadSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 251                                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 252                         static inline int8_t Audio_Host_ReadSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 253                         {
 254                                 int8_t Sample;
 255
 256                                 (void)AudioInterfaceInfo;
 257
 258                                 Sample = Pipe_Read_8();
 259
 260                                 if (!(Pipe_BytesInPipe()))
 261                                 {
 262                                         Pipe_Unfreeze();
 263                                         Pipe_ClearIN();
 264                                         Pipe_Freeze();
 265                                 }
 266
 267                                 return Sample;
 268                         }
 269
 270                         /** Reads the next 16-bit audio sample from the current audio interface.
 271                          *
 272                          *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure
 273                          *       that the correct pipe is selected and ready for data.
 274                          *
 275                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 276                          *
 277                          *  \return  Signed 16-bit audio sample from the audio interface.
 278                          */
 279                         static inline int16_t Audio_Host_ReadSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 280                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 281                         static inline int16_t Audio_Host_ReadSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 282                         {
 283                                 int16_t Sample;
 284
 285                                 (void)AudioInterfaceInfo;
 286
 287                                 Sample = (int16_t)Pipe_Read_16_LE();
 288
 289                                 if (!(Pipe_BytesInPipe()))
 290                                 {
 291                                         Pipe_Unfreeze();
 292                                         Pipe_ClearIN();
 293                                         Pipe_Freeze();
 294                                 }
 295
 296                                 return Sample;
 297                         }
 298
 299                         /** Reads the next 24-bit audio sample from the current audio interface.
 300                          *
 301                          *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsSampleReceived() function to ensure
 302                          *       that the correct pipe is selected and ready for data.
 303                          *
 304                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 305                          *
 306                          *  \return Signed 24-bit audio sample from the audio interface.
 307                          */
 308                         static inline int32_t Audio_Host_ReadSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 309                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 310                         static inline int32_t Audio_Host_ReadSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo)
 311                         {
 312                                 int32_t Sample;
 313
 314                                 (void)AudioInterfaceInfo;
 315
 316                                 Sample = (((uint32_t)Pipe_Read_8() << 16) | Pipe_Read_16_LE());
 317
 318                                 if (!(Pipe_BytesInPipe()))
 319                                 {
 320                                         Pipe_Unfreeze();
 321                                         Pipe_ClearIN();
 322                                         Pipe_Freeze();
 323                                 }
 324
 325                                 return Sample;
 326                         }
 327
 328                         /** Writes the next 8-bit audio sample to the current audio interface.
 329                          *
 330                          *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to
 331                          *       ensure that the correct pipe is selected and ready for data.
 332                          *
 333                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 334                          *  \param[in]     Sample              Signed 8-bit audio sample.
 335                          */
 336                         static inline void Audio_Host_WriteSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 337                                                                    const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 338                         static inline void Audio_Host_WriteSample8(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 339                                                                    const int8_t Sample)
 340                         {
 341                                 Pipe_Write_8(Sample);
 342
 343                                 if (!(Pipe_IsReadWriteAllowed()))
 344                                 {
 345                                         Pipe_Unfreeze();
 346                                         Pipe_ClearOUT();
 347                                         Pipe_WaitUntilReady();
 348                                         Pipe_Freeze();
 349                                 }
 350                         }
 351
 352                         /** Writes the next 16-bit audio sample to the current audio interface.
 353                          *
 354                          *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to
 355                          *       ensure that the correct pipe is selected and ready for data.
 356                          *
 357                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 358                          *  \param[in]     Sample              Signed 16-bit audio sample.
 359                          */
 360                         static inline void Audio_Host_WriteSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 361                                                                     const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 362                         static inline void Audio_Host_WriteSample16(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 363                                                                     const int16_t Sample)
 364                         {
 365                                 Pipe_Write_16_LE(Sample);
 366
 367                                 if (!(Pipe_IsReadWriteAllowed()))
 368                                 {
 369                                         Pipe_Unfreeze();
 370                                         Pipe_ClearOUT();
 371                                         Pipe_WaitUntilReady();
 372                                         Pipe_Freeze();
 373                                 }
 374                         }
 375
 376                         /** Writes the next 24-bit audio sample to the current audio interface.
 377                          *
 378                          *  \pre This should be preceded immediately by a call to the \ref Audio_Host_IsReadyForNextSample() function to
 379                          *       ensure that the correct pipe is selected and ready for data.
 380                          *
 381                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 382                          *  \param[in]     Sample              Signed 24-bit audio sample.
 383                          */
 384                         static inline void Audio_Host_WriteSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 385                                                                     const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 386                         static inline void Audio_Host_WriteSample24(USB_ClassInfo_Audio_Host_t* const AudioInterfaceInfo,
 387                                                                     const int32_t Sample)
 388                         {
 389                                 Pipe_Write_16_LE(Sample);
 390                                 Pipe_Write_8(Sample >> 16);
 391
 392                                 if (!(Pipe_IsReadWriteAllowed()))
 393                                 {
 394                                         Pipe_Unfreeze();
 395                                         Pipe_ClearOUT();
 396                                         Pipe_WaitUntilReady();
 397                                         Pipe_Freeze();
 398                                 }
 399                         }
 400
 401         /* Private Interface - For use in library only: */
 402         #if !defined(__DOXYGEN__)
 403                 /* Function Prototypes: */
 404                         #if defined(__INCLUDE_FROM_AUDIO_HOST_C)
 405                                 static uint8_t DCOMP_Audio_Host_NextAudioControlInterface(void* CurrentDescriptor)
 406                                                                                           ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 407                                 static uint8_t DCOMP_Audio_Host_NextAudioStreamInterface(void* CurrentDescriptor)
 408                                                                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 409                                 static uint8_t DCOMP_Audio_Host_NextAudioInterfaceDataEndpoint(void* CurrentDescriptor)
 410                                                                                                ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 411                         #endif
 412         #endif
 413
 414         /* Disable C linkage for C++ Compilers: */
 415                 #if defined(__cplusplus)
 416                         }
 417                 #endif
 418
 419 #endif
 420
 421 /** @} */
 422