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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 /** \ingroup Group_USBClassAudio
  32  *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Device/Audio.c
  37  *
  38  *  \section Module Description
  39  *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef _AUDIO_CLASS_DEVICE_H_
  45 #define _AUDIO_CLASS_DEVICE_H_
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/Audio.h"
  50
  51                 #include <string.h>
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Preprocessor Checks: */
  59                 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
  60                         #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.
  61                 #endif
  62
  63         /* Public Interface - May be used in end-application: */
  64                 /* Type Defines: */
  65                         /** Class state structure. An instance of this structure should be made for each Audio interface
  66                          *  within the user application, and passed to each of the Audio class driver functions as the
  67                          *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
  68                          */
  69                         typedef struct
  70                         {
  71                                 const struct
  72                                 {
  73                                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
  74                                                                                                                 *   structure controls
  75                                                                                                                 */
  76
  77                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
  78                                                                                                         *   (zero if unused)
  79                                                                                                         */
  80                                         uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
  81                                                                                                   *   (zero if unused)
  82                                                                                                   */
  83
  84                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
  85                                                                                                          *   (zero if unused)
  86                                                                                                          */
  87                                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
  88                                                                                                    *   (zero if unused)
  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     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
  96                                                                                                 *   of the Audio Streaming interface.
  97                                                                                                 */
  98                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  99                                           *   are reset to their defaults when the interface is enumerated.
 100                                           */
 101                         } USB_ClassInfo_Audio_Device_t;
 102
 103                 /* Function Prototypes: */
 104                         /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
 105                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
 106                          *  given Audio interface is selected.
 107                          *
 108                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 109                          *
 110                          *  \return Boolean true if the endpoints were successfully configured, false otherwise
 111                          */
 112                         bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 113
 114                         /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
 115                          *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
 116                          *
 117                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 118                          */
 119                         void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 120
 121                         /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
 122                          *  OUT endpoint ready for reading.
 123                          *
 124                          *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
 125                          *        the call will fail.
 126                          *
 127                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 128                          *
 129                          *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
 130                          */
 131                         bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 132
 133                         /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
 134                          *  the streaming IN endpoint ready for writing.
 135                          *
 136                          *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
 137                          *        the call will fail.
 138                          *
 139                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 140                          *
 141                          *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
 142                          */
 143                         bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 144
 145                 /* Inline Functions: */
 146                         /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 147                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 148                          *
 149                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 150                          */
 151                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
 152                         static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 153                         {
 154                                 (void)AudioInterfaceInfo;
 155                         }
 156
 157                         /** Reads the next 8-bit audio sample from the current audio interface.
 158                          *
 159                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 160                          *        the correct endpoint is selected and ready for data.
 161                          *
 162                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 163                          *
 164                          *  \return  Signed 8-bit audio sample from the audio interface
 165                          */
 166                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 167                         static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 168                         {
 169                                 int8_t Sample;
 170
 171                                 (void)AudioInterfaceInfo;
 172
 173                                 Sample = Endpoint_Read_Byte();
 174
 175                                 if (!(Endpoint_BytesInEndpoint()))
 176                                   Endpoint_ClearOUT();
 177
 178                                 return Sample;
 179                         }
 180
 181                         /** Reads the next 16-bit audio sample from the current audio interface.
 182                          *
 183                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 184                          *        the correct endpoint is selected and ready for data.
 185                          *
 186                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 187                          *
 188                          *  \return  Signed 16-bit audio sample from the audio interface
 189                          */
 190                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 191                         static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 192                         {
 193                                 int16_t Sample;
 194
 195                                 (void)AudioInterfaceInfo;
 196
 197                                 Sample = (int16_t)Endpoint_Read_Word_LE();
 198
 199                                 if (!(Endpoint_BytesInEndpoint()))
 200                                   Endpoint_ClearOUT();
 201
 202                                 return Sample;
 203                         }
 204
 205                         /** Reads the next 24-bit audio sample from the current audio interface.
 206                          *
 207                          *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
 208                          *        the correct endpoint is selected and ready for data.
 209                          *
 210                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 211                          *  \return  Signed 24-bit audio sample from the audio interface
 212                          */
 213                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
 214                         static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 215                         {
 216                                 int32_t Sample;
 217
 218                                 (void)AudioInterfaceInfo;
 219
 220                                 Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
 221
 222                                 if (!(Endpoint_BytesInEndpoint()))
 223                                   Endpoint_ClearOUT();
 224
 225                                 return Sample;
 226                         }
 227
 228                         /** Writes the next 8-bit audio sample to the current audio interface.
 229                          *
 230                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 231                          *        the correct endpoint is selected and ready for data.
 232                          *
 233                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 234                          *  \param[in] Sample  Signed 8-bit audio sample
 235                          */
 236                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 237                                                                      const int8_t Sample) ATTR_ALWAYS_INLINE;
 238                         static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 239                                                                      const int8_t Sample)
 240                         {
 241                                 Endpoint_Write_Byte(Sample);
 242
 243                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 244                                   Endpoint_ClearIN();
 245                         }
 246
 247                         /** Writes the next 16-bit audio sample to the current audio interface.
 248                          *
 249                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 250                          *        the correct endpoint is selected and ready for data.
 251                          *
 252                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 253                          *  \param[in] Sample  Signed 16-bit audio sample
 254                          */
 255                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 256                                                                       const int16_t Sample) ATTR_ALWAYS_INLINE;
 257                         static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 258                                                                       const int16_t Sample)
 259                         {
 260                                 Endpoint_Write_Word_LE(Sample);
 261
 262                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 263                                   Endpoint_ClearIN();
 264                         }
 265
 266                         /** Writes the next 24-bit audio sample to the current audio interface.
 267                          *
 268                          *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
 269                          *        the correct endpoint is selected and ready for data.
 270                          *
 271                          *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
 272                          *  \param[in] Sample  Signed 24-bit audio sample
 273                          */
 274                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 275                                                                       const int32_t Sample) ATTR_ALWAYS_INLINE;
 276                         static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
 277                                                                       const int32_t Sample)
 278                         {
 279                                 Endpoint_Write_Byte(Sample >> 16);
 280                                 Endpoint_Write_Word_LE(Sample);
 281
 282                                 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
 283                                   Endpoint_ClearIN();
 284                         }
 285
 286         /* Disable C linkage for C++ Compilers: */
 287                 #if defined(__cplusplus)
 288                         }
 289                 #endif
 290
 291 #endif
 292
 293 /** @} */