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                 /* Inline Functions: */
 135                         /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 136                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 137                          *
 138                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 139                          */
 140                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 141                                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 142                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 143                         {
 144                                 (void)AudioInterfaceInfo;
 145                         }
 146
 147                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 148                          *  OUT endpoint ready for reading.
 149                          *
 150                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 151                          *       the call will fail.
 152                          *
 153                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 154                          *
 155                          *  \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
 156                          */
 157                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 158                                                                          ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 159                         static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 160                         {
 161                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 162                                   return false;
 163
 164                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);
 165                                 return Endpoint_IsOUTReceived();
 166                         }
 167
 168                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 169                          *  the streaming IN endpoint ready for writing.
 170                          *
 171                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 172                          *       the call will fail.
 173                          *
 174                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 175                          *
 176                          *  \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
 177                          */
 178                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 179                                                                              ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 180                         static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 181                         {
 182                                 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
 183                                   return false;
 184
 185                                 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
 186                                 return Endpoint_IsINReady();
 187                         }
 188
 189                         /** Reads the next 8-bit audio sample from the current audio interface.
 190                          *
 191                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 192                          *       ensure the correct endpoint is selected and ready for data.
 193                          *
 194                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 195                          *
 196                          *  \return  Signed 8-bit audio sample from the audio interface.
 197                          */
 198                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 199                                                                       ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 200                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 201                         {
 202                                 int8_t Sample;
 203
 204                                 (void)AudioInterfaceInfo;
 205
 206                                 Sample = Endpoint_Read_Byte();
 207
 208                                 if (!(Endpoint_BytesInEndpoint()))
 209                                   Endpoint_ClearOUT();
 210
 211                                 return Sample;
 212                         }
 213
 214                         /** Reads the next 16-bit audio sample from the current audio interface.
 215                          *
 216                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 217                          *       that the correct endpoint is selected and ready for data.
 218                          *
 219                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 220                          *
 221                          *  \return  Signed 16-bit audio sample from the audio interface.
 222                          */
 223                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 224                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 225                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 226                         {
 227                                 int16_t Sample;
 228
 229                                 (void)AudioInterfaceInfo;
 230
 231                                 Sample = (int16_t)Endpoint_Read_Word_LE();
 232
 233                                 if (!(Endpoint_BytesInEndpoint()))
 234                                   Endpoint_ClearOUT();
 235
 236                                 return Sample;
 237                         }
 238
 239                         /** Reads the next 24-bit audio sample from the current audio interface.
 240                          *
 241                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
 242                          *       that the correct endpoint is selected and ready for data.
 243                          *
 244                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 245                          *
 246                          *  \return Signed 24-bit audio sample from the audio interface.
 247                          */
 248                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 249                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 250                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 251                         {
 252                                 int32_t Sample;
 253
 254                                 (void)AudioInterfaceInfo;
 255
 256                                 Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
 257
 258                                 if (!(Endpoint_BytesInEndpoint()))
 259                                   Endpoint_ClearOUT();
 260
 261                                 return Sample;
 262                         }
 263
 264                         /** Writes the next 8-bit audio sample to the current audio interface.
 265                          *
 266                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 267                          *       ensure that the correct endpoint is selected and ready for data.
 268                          *
 269                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 270                          *  \param[in]     Sample              Signed 8-bit audio sample.
 271                          */
 272                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 273                                                                      const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 274                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 275                                                                      const int8_t Sample)
 276                         {
 277                                 Endpoint_Write_Byte(Sample);
 278
 279                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 280                                   Endpoint_ClearIN();
 281                         }
 282
 283                         /** Writes the next 16-bit audio sample to the current audio interface.
 284                          *
 285                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 286                          *       ensure that the correct endpoint is selected and ready for data.
 287                          *
 288                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 289                          *  \param[in]     Sample              Signed 16-bit audio sample.
 290                          */
 291                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 292                                                                       const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 293                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 294                                                                       const int16_t Sample)
 295                         {
 296                                 Endpoint_Write_Word_LE(Sample);
 297
 298                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 299                                   Endpoint_ClearIN();
 300                         }
 301
 302                         /** Writes the next 24-bit audio sample to the current audio interface.
 303                          *
 304                          *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
 305                          *       ensure that the correct endpoint is selected and ready for data.
 306                          *
 307                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 308                          *  \param[in]     Sample              Signed 24-bit audio sample.
 309                          */
 310                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 311                                                                       const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 312                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 313                                                                       const int32_t Sample)
 314                         {
 315                                 Endpoint_Write_Word_LE(Sample);
 316                                 Endpoint_Write_Byte(Sample >> 16);
 317
 318                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 319                                   Endpoint_ClearIN();
 320                         }
 321
 322         /* Disable C linkage for C++ Compilers: */
 323                 #if defined(__cplusplus)
 324                         }
 325                 #endif
 326
 327 #endif
 328
 329 /** @} */
 330