LUFA/Drivers/USB/Class/Device/AudioClassDevice.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 Device mode driver for the library USB Audio 1.0 Class driver.
  33  *
  34  *  Device 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_USBClassAudioDevice Audio 1.0 Class Device 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/Device/AudioClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef _AUDIO_CLASS_DEVICE_H_
  54 #define _AUDIO_CLASS_DEVICE_H_
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/AudioClassCommon.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 Device Mode Configuration and State Structure.
  73                          *
  74                          *  Class state structure. An instance of this structure should be made for each Audio interface
  75                          *  within the user application, and passed to each of the Audio class driver functions as the
  76                          *  \c AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
  77                          */
  78                         typedef struct
  79                         {
  80                                 struct
  81                                 {
  82                                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
  83                                                                                                                 *   structure controls.
  84                                                                                                                 */
  85
  86                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
  87                                                                                                         *   (zero if unused).
  88                                                                                                         */
  89                                         uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
  90                                                                                                   *   (zero if unused).
  91                                                                                                   */
  92
  93                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
  94                                                                                                          *   (zero if unused).
  95                                                                                                          */
  96                                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
  97                                                                                                    *   (zero if unused).
  98                                                                                                    */
  99                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
 100                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
 101                                            */
 102                                 struct
 103                                 {
 104                                         bool InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
 105                                                                 *   of the Audio Streaming interface.
 106                                                                 */
 107                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 108                                           *   are reset to their defaults when the interface is enumerated.
 109                                           */
 110                         } USB_ClassInfo_Audio_Device_t;
 111
 112                 /* Function Prototypes: */
 113                         /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
 114                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
 115                          *  given Audio interface is selected.
 116                          *
 117                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 118                          *
 119                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 120                          */
 121                         bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 122
 123                         /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
 124                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 125                          *
 126                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 127                          */
 128                         void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 129
 130                         /** Audio class driver callback for the setting and retrieval of streaming endpoint properties. This callback must be implemented
 131                          *  in the user application to handle property manipulations on streaming audio endpoints.
 132                          *
 133                          *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
 134                          *  the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations
 135                          *  to indicate the size of the retreived data.
 136                          *
 137                          *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
 138                          *        of the \c DataLength parameter.
 139                          *
 140                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 141                          *  \param[in]     EndpointProperty    Property of the endpoint to get or set, a value from \ref Audio_ClassRequests_t.
 142                          *  \param[in]     EndpointAddress     Address of the streaming endpoint whose property is being referenced.
 143                          *  \param[in]     EndpointControl     Parameter of the endpoint to get or set, a value from \ref Audio_EndpointControls_t.
 144                          *  \param[in,out] DataLength          For SET operations, the length of the parameter data to set. For GET operations, the maximum
 145                          *                                     length of the retrieved data. When NULL, the function should return whether the given property
 146                          *                                     and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
 147                          *  \param[in,out] Data                Pointer to a location where the parameter data is stored for SET operations, or where
 148                          *                                     the retrieved data is to be stored for GET operations.
 149                          *
 150                          *  \return Boolean \c true if the property GET/SET was successful, \c false otherwise
 151                          */
 152                         bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 153                                                                           const uint8_t EndpointProperty,
 154                                                                           const uint8_t EndpointAddress,
 155                                                                           const uint8_t EndpointControl,
 156                                                                           uint16_t* const DataLength,
 157                                                                           uint8_t* Data) ATTR_NON_NULL_PTR_ARG(1);
 158
 159                         /** Audio class driver callback for the setting and retrieval of streaming interface properties. This callback must be implemented
 160                          *  in the user application to handle property manipulations on streaming audio interfaces.
 161                          *
 162                          *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
 163                          *  the given entity and should return as fast as possible. When non-NULL, this value may be altered for GET operations
 164                          *  to indicate the size of the retreived data.
 165                          *
 166                          *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
 167                          *        of the \c DataLength parameter.
 168                          *
 169                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 170                          *  \param[in]     Property            Property of the interface to get or set, a value from \ref Audio_ClassRequests_t.
 171                          *  \param[in]     EntityAddress       Address of the audio entity whose property is being referenced.
 172                          *  \param[in]     Parameter           Parameter of the entity to get or set, specific to each type of entity (see USB Audio specification).
 173                          *  \param[in,out] DataLength          For SET operations, the length of the parameter data to set. For GET operations, the maximum
 174                          *                                     length of the retrieved data. When NULL, the function should return whether the given property
 175                          *                                     and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
 176                          *  \param[in,out] Data                Pointer to a location where the parameter data is stored for SET operations, or where
 177                          *                                     the retrieved data is to be stored for GET operations.
 178                          *
 179                          *  \return Boolean \c true if the property GET/SET was successful, \c false otherwise
 180                          */
 181                         bool CALLBACK_Audio_Device_GetSetInterfaceProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 182                                                                            const uint8_t Property,
 183                                                                            const uint8_t EntityAddress,
 184                                                                            const uint16_t Parameter,
 185                                                                            uint16_t* const DataLength,
 186                                                                            uint8_t* Data) ATTR_NON_NULL_PTR_ARG(1);
 187
 188                         /** Audio class driver event for an Audio Stream start/stop change. This event fires each time the device receives a stream enable or
 189                          *  disable control request from the host, to start and stop the audio stream. The current state of the stream can be determined by the
 190                          *  State.InterfaceEnabled value inside the Audio interface structure passed as a parameter.
 191                          *
 192                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 193                          */
 194                         void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 195
 196                 /* Inline Functions: */
 197                         /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 198                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 199                          *
 200                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 201                          */
 202                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 203                                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 204                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 205                         {
 206                                 (void)AudioInterfaceInfo;
 207                         }
 208
 209                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 210                          *  OUT endpoint ready for reading.
 211                          *
 212                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 213                          *       the call will fail.
 214                          *
 215                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 216                          *
 217                          *  \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
 218                          */
 219                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 220                                                                          ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 221                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 222                         {
 223                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 224                                   return false;
 225
 226                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);
 227                                 return Endpoint_IsOUTReceived();
 228                         }
 229
 230                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 231                          *  the streaming IN endpoint ready for writing.
 232                          *
 233                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 234                          *       the call will fail.
 235                          *
 236                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 237                          *
 238                          *  \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
 239                          */
 240                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 241                                                                              ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 242                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 243                         {
 244                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 245                                   return false;
 246
 247                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
 248                                 return Endpoint_IsINReady();
 249                         }
 250
 251                         /** Reads the next 8-bit audio sample from the current audio interface.
 252                          *
 253                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 254                          *       that the correct endpoint is selected and ready for data.
 255                          *
 256                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 257                          *
 258                          *  \return  Signed 8-bit audio sample from the audio interface.
 259                          */
 260                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 261                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 262                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 263                         {
 264                                 int8_t Sample;
 265
 266                                 (void)AudioInterfaceInfo;
 267
 268                                 Sample = Endpoint_Read_8();
 269
 270                                 if (!(Endpoint_BytesInEndpoint()))
 271                                   Endpoint_ClearOUT();
 272
 273                                 return Sample;
 274                         }
 275
 276                         /** Reads the next 16-bit audio sample from the current audio interface.
 277                          *
 278                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 279                          *       that the correct endpoint is selected and ready for data.
 280                          *
 281                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 282                          *
 283                          *  \return  Signed 16-bit audio sample from the audio interface.
 284                          */
 285                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 286                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 287                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 288                         {
 289                                 int16_t Sample;
 290
 291                                 (void)AudioInterfaceInfo;
 292
 293                                 Sample = (int16_t)Endpoint_Read_16_LE();
 294
 295                                 if (!(Endpoint_BytesInEndpoint()))
 296                                   Endpoint_ClearOUT();
 297
 298                                 return Sample;
 299                         }
 300
 301                         /** Reads the next 24-bit audio sample from the current audio interface.
 302                          *
 303                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 304                          *       that the correct endpoint is selected and ready for data.
 305                          *
 306                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 307                          *
 308                          *  \return Signed 24-bit audio sample from the audio interface.
 309                          */
 310                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 311                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 312                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 313                         {
 314                                 int32_t Sample;
 315
 316                                 (void)AudioInterfaceInfo;
 317
 318                                 Sample = (((uint32_t)Endpoint_Read_8() << 16) | Endpoint_Read_16_LE());
 319
 320                                 if (!(Endpoint_BytesInEndpoint()))
 321                                   Endpoint_ClearOUT();
 322
 323                                 return Sample;
 324                         }
 325
 326                         /** Writes the next 8-bit audio sample to the current audio interface.
 327                          *
 328                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 329                          *       ensure that the correct endpoint is selected and ready for data.
 330                          *
 331                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 332                          *  \param[in]     Sample              Signed 8-bit audio sample.
 333                          */
 334                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 335                                                                      const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 336                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 337                                                                      const int8_t Sample)
 338                         {
 339                                 Endpoint_Write_8(Sample);
 340
 341                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 342                                   Endpoint_ClearIN();
 343                         }
 344
 345                         /** Writes the next 16-bit audio sample to the current audio interface.
 346                          *
 347                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 348                          *       ensure that the correct endpoint is selected and ready for data.
 349                          *
 350                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 351                          *  \param[in]     Sample              Signed 16-bit audio sample.
 352                          */
 353                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 354                                                                       const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 355                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 356                                                                       const int16_t Sample)
 357                         {
 358                                 Endpoint_Write_16_LE(Sample);
 359
 360                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 361                                   Endpoint_ClearIN();
 362                         }
 363
 364                         /** Writes the next 24-bit audio sample to the current audio interface.
 365                          *
 366                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 367                          *       ensure that the correct endpoint is selected and ready for data.
 368                          *
 369                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 370                          *  \param[in]     Sample              Signed 24-bit audio sample.
 371                          */
 372                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 373                                                                       const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 374                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 375                                                                       const int32_t Sample)
 376                         {
 377                                 Endpoint_Write_16_LE(Sample);
 378                                 Endpoint_Write_8(Sample >> 16);
 379
 380                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 381                                   Endpoint_ClearIN();
 382                         }
 383
 384         /* Private Interface - For use in library only: */
 385         #if !defined(__DOXYGEN__)
 386                 /* Function Prototypes: */
 387                         #if defined(__INCLUDE_FROM_AUDIO_DEVICE_C)
 388                                 void Audio_Device_Event_Stub(void) ATTR_CONST;
 389
 390                                 void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 391                                                                         ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(Audio_Device_Event_Stub);
 392                         #endif
 393
 394         #endif
 395
 396         /* Disable C linkage for C++ Compilers: */
 397                 #if defined(__cplusplus)
 398                         }
 399                 #endif
 400
 401 #endif
 402
 403 /** @} */
 404