LUFA/Drivers/USB/Class/Device/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 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 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/Audio.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/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 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                                 const 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                          *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
 118                          *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
 119                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
 120                          *
 121                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 122                          *
 123                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 124                          */
 125                         bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 126
 127                         /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
 128                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 129                          *
 130                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 131                          */
 132                         void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 133
 134                         /** Audio class driver callback for the setting and retrieval of streaming endpoint properties. This callback must be implemented
 135                          *  in the user application to handle property manipulations on streaming audio endpoints.
 136                          *
 137                          *  When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
 138                          *  the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations
 139                          *  to indicate the size of the retreived data.
 140                          *
 141                          *  \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
 142                          *        of the \c DataLength parameter.
 143                          *
 144                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 145                          *  \param[in]     EndpointProperty    Property of the endpoint to get or set, a value from \ref Audio_ClassRequests_t.
 146                          *  \param[in]     EndpointIndex       Index of the streaming endpoint whose property is being referenced.
 147                          *  \param[in]     EndpointControl     Parameter of the endpoint to get or set, a value from \ref Audio_EndpointControls_t.
 148                          *  \param[in,out] DataLength          For SET operations, the length of the parameter data to set. For GET operations, the maximum
 149                          *                                     length of the retrieved data. When NULL, the function should return whether the given property
 150                          *                                     and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
 151                          *  \param[in,out] Data                Pointer to a location where the parameter data is stored for SET operations, or where
 152                          *                                     the retrieved data is to be stored for GET operations.
 153                          *
 154                          *  \return Boolean true if the property get/set was successful, false otherwise
 155                          */
 156                         bool CALLBACK_Audio_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 157                                                                    const uint8_t EndpointProperty,
 158                                                                    const uint8_t EndpointIndex,
 159                                                                    const uint8_t EndpointControl,
 160                                                                    uint16_t* const DataLength,
 161                                                                    uint8_t* Data);
 162
 163                 /* Inline Functions: */
 164                         /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 165                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 166                          *
 167                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 168                          */
 169                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 170                                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 171                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 172                         {
 173                                 (void)AudioInterfaceInfo;
 174                         }
 175
 176                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 177                          *  OUT endpoint ready for reading.
 178                          *
 179                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 180                          *       the call will fail.
 181                          *
 182                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 183                          *
 184                          *  \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
 185                          */
 186                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 187                                                                          ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 188                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 189                         {
 190                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 191                                   return false;
 192
 193                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);
 194                                 return Endpoint_IsOUTReceived();
 195                         }
 196
 197                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 198                          *  the streaming IN endpoint ready for writing.
 199                          *
 200                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 201                          *       the call will fail.
 202                          *
 203                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 204                          *
 205                          *  \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
 206                          */
 207                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 208                                                                              ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 209                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 210                         {
 211                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 212                                   return false;
 213
 214                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
 215                                 return Endpoint_IsINReady();
 216                         }
 217
 218                         /** Reads the next 8-bit audio sample from the current audio interface.
 219                          *
 220                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 221                          *       that the correct endpoint is selected and ready for data.
 222                          *
 223                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 224                          *
 225                          *  \return  Signed 8-bit audio sample from the audio interface.
 226                          */
 227                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 228                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 229                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 230                         {
 231                                 int8_t Sample;
 232
 233                                 (void)AudioInterfaceInfo;
 234
 235                                 Sample = Endpoint_Read_8();
 236
 237                                 if (!(Endpoint_BytesInEndpoint()))
 238                                   Endpoint_ClearOUT();
 239
 240                                 return Sample;
 241                         }
 242
 243                         /** Reads the next 16-bit audio sample from the current audio interface.
 244                          *
 245                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 246                          *       that the correct endpoint is selected and ready for data.
 247                          *
 248                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 249                          *
 250                          *  \return  Signed 16-bit audio sample from the audio interface.
 251                          */
 252                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 253                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 254                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 255                         {
 256                                 int16_t Sample;
 257
 258                                 (void)AudioInterfaceInfo;
 259
 260                                 Sample = (int16_t)Endpoint_Read_16_LE();
 261
 262                                 if (!(Endpoint_BytesInEndpoint()))
 263                                   Endpoint_ClearOUT();
 264
 265                                 return Sample;
 266                         }
 267
 268                         /** Reads the next 24-bit audio sample from the current audio interface.
 269                          *
 270                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 271                          *       that the correct endpoint is selected and ready for data.
 272                          *
 273                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 274                          *
 275                          *  \return Signed 24-bit audio sample from the audio interface.
 276                          */
 277                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 278                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 279                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 280                         {
 281                                 int32_t Sample;
 282
 283                                 (void)AudioInterfaceInfo;
 284
 285                                 Sample = (((uint32_t)Endpoint_Read_8() << 16) | Endpoint_Read_16_LE());
 286
 287                                 if (!(Endpoint_BytesInEndpoint()))
 288                                   Endpoint_ClearOUT();
 289
 290                                 return Sample;
 291                         }
 292
 293                         /** Writes the next 8-bit audio sample to the current audio interface.
 294                          *
 295                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 296                          *       ensure that the correct endpoint is selected and ready for data.
 297                          *
 298                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 299                          *  \param[in]     Sample              Signed 8-bit audio sample.
 300                          */
 301                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 302                                                                      const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 303                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 304                                                                      const int8_t Sample)
 305                         {
 306                                 Endpoint_Write_8(Sample);
 307
 308                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 309                                   Endpoint_ClearIN();
 310                         }
 311
 312                         /** Writes the next 16-bit audio sample to the current audio interface.
 313                          *
 314                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 315                          *       ensure that the correct endpoint is selected and ready for data.
 316                          *
 317                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 318                          *  \param[in]     Sample              Signed 16-bit audio sample.
 319                          */
 320                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 321                                                                       const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 322                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 323                                                                       const int16_t Sample)
 324                         {
 325                                 Endpoint_Write_16_LE(Sample);
 326
 327                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 328                                   Endpoint_ClearIN();
 329                         }
 330
 331                         /** Writes the next 24-bit audio sample to the current audio interface.
 332                          *
 333                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 334                          *       ensure that the correct endpoint is selected and ready for data.
 335                          *
 336                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 337                          *  \param[in]     Sample              Signed 24-bit audio sample.
 338                          */
 339                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 340                                                                       const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 341                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 342                                                                       const int32_t Sample)
 343                         {
 344                                 Endpoint_Write_16_LE(Sample);
 345                                 Endpoint_Write_8(Sample >> 16);
 346
 347                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 348                                   Endpoint_ClearIN();
 349                         }
 350
 351         /* Disable C linkage for C++ Compilers: */
 352                 #if defined(__cplusplus)
 353                         }
 354                 #endif
 355
 356 #endif
 357
 358 /** @} */
 359