Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Device / Audio.h @ 978b99e5

History | View | Annotate | Download (18.2 KB)

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 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/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
                         *  \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 true if the property get/set was successful, 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);
158

    
159
                        /** Audio class driver event for an Audio Stream start/stop change. This event fires each time the device receives a stream enable or
160
                         *  disable control request from the host, to start and stop the audio stream. The current state of the stream can be determined by the
161
                         *  State.InterfaceEnabled value inside the Audio interface structure passed as a parameter.
162
                         *
163
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
164
                         */
165
                        void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
166

    
167
                /* Inline Functions: */
168
                        /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
169
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
170
                         *
171
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
172
                         */
173
                        static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
174
                                                                ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
175
                        static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
176
                        {
177
                                (void)AudioInterfaceInfo;
178
                        }
179

    
180
                        /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
181
                         *  OUT endpoint ready for reading.
182
                         *
183
                         *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
184
                         *       the call will fail.
185
                         *
186
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
187
                         *
188
                         *  \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
189
                         */
190
                        static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
191
                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
192
                        static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
193
                        {
194
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
195
                                  return false;
196

    
197
                                Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpointNumber);
198
                                return Endpoint_IsOUTReceived();
199
                        }
200

    
201
                        /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
202
                         *  the streaming IN endpoint ready for writing.
203
                         *
204
                         *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
205
                         *       the call will fail.
206
                         *
207
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
208
                         *
209
                         *  \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
210
                         */
211
                        static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
212
                                                                             ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
213
                        static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
214
                        {
215
                                if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
216
                                  return false;
217

    
218
                                Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpointNumber);
219
                                return Endpoint_IsINReady();
220
                        }
221

    
222
                        /** Reads the next 8-bit audio sample from the current audio interface.
223
                         *
224
                         *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
225
                         *       that the correct endpoint is selected and ready for data.
226
                         *
227
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
228
                         *
229
                         *  \return  Signed 8-bit audio sample from the audio interface.
230
                         */
231
                        static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
232
                                                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
233
                        static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
234
                        {
235
                                int8_t Sample;
236

    
237
                                (void)AudioInterfaceInfo;
238

    
239
                                Sample = Endpoint_Read_8();
240

    
241
                                if (!(Endpoint_BytesInEndpoint()))
242
                                  Endpoint_ClearOUT();
243

    
244
                                return Sample;
245
                        }
246

    
247
                        /** Reads the next 16-bit audio sample from the current audio interface.
248
                         *
249
                         *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
250
                         *       that 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
                         *
254
                         *  \return  Signed 16-bit audio sample from the audio interface.
255
                         */
256
                        static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
257
                                                                        ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
258
                        static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
259
                        {
260
                                int16_t Sample;
261

    
262
                                (void)AudioInterfaceInfo;
263

    
264
                                Sample = (int16_t)Endpoint_Read_16_LE();
265

    
266
                                if (!(Endpoint_BytesInEndpoint()))
267
                                  Endpoint_ClearOUT();
268

    
269
                                return Sample;
270
                        }
271

    
272
                        /** Reads the next 24-bit audio sample from the current audio interface.
273
                         *
274
                         *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
275
                         *       that the correct endpoint is selected and ready for data.
276
                         *
277
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
278
                         *
279
                         *  \return Signed 24-bit audio sample from the audio interface.
280
                         */
281
                        static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
282
                                                                        ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
283
                        static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
284
                        {
285
                                int32_t Sample;
286

    
287
                                (void)AudioInterfaceInfo;
288

    
289
                                Sample = (((uint32_t)Endpoint_Read_8() << 16) | Endpoint_Read_16_LE());
290

    
291
                                if (!(Endpoint_BytesInEndpoint()))
292
                                  Endpoint_ClearOUT();
293

    
294
                                return Sample;
295
                        }
296

    
297
                        /** Writes the next 8-bit audio sample to the current audio interface.
298
                         *
299
                         *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
300
                         *       ensure that the correct endpoint is selected and ready for data.
301
                         *
302
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
303
                         *  \param[in]     Sample              Signed 8-bit audio sample.
304
                         */
305
                        static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
306
                                                                     const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
307
                        static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
308
                                                                     const int8_t Sample)
309
                        {
310
                                Endpoint_Write_8(Sample);
311

    
312
                                if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
313
                                  Endpoint_ClearIN();
314
                        }
315

    
316
                        /** Writes the next 16-bit audio sample to the current audio interface.
317
                         *
318
                         *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
319
                         *       ensure that the correct endpoint is selected and ready for data.
320
                         *
321
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
322
                         *  \param[in]     Sample              Signed 16-bit audio sample.
323
                         */
324
                        static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
325
                                                                      const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
326
                        static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
327
                                                                      const int16_t Sample)
328
                        {
329
                                Endpoint_Write_16_LE(Sample);
330

    
331
                                if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
332
                                  Endpoint_ClearIN();
333
                        }
334

    
335
                        /** Writes the next 24-bit audio sample to the current audio interface.
336
                         *
337
                         *  \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
338
                         *       ensure that the correct endpoint is selected and ready for data.
339
                         *
340
                         *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
341
                         *  \param[in]     Sample              Signed 24-bit audio sample.
342
                         */
343
                        static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
344
                                                                      const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
345
                        static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
346
                                                                      const int32_t Sample)
347
                        {
348
                                Endpoint_Write_16_LE(Sample);
349
                                Endpoint_Write_8(Sample >> 16);
350

    
351
                                if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
352
                                  Endpoint_ClearIN();
353
                        }
354

    
355
        /* Private Interface - For use in library only: */
356
        #if !defined(__DOXYGEN__)
357
                /* Function Prototypes: */
358
                        #if defined(__INCLUDE_FROM_AUDIO_DEVICE_C)
359
                                void Audio_Device_Event_Stub(void) ATTR_CONST;
360
                                
361
                                void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
362
                                                                        ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(Audio_Device_Event_Stub);
363
                        #endif
364

    
365
        #endif        
366

    
367
        /* Disable C linkage for C++ Compilers: */
368
                #if defined(__cplusplus)
369
                        }
370
                #endif
371

    
372
#endif
373

    
374
/** @} */
375