3 Copyright (C) Dean Camera, 2012.
\r
5 dean [at] fourwalledcubicle [dot] com
\r
10 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
\r
12 Permission to use, copy, modify, distribute, and sell this
\r
13 software and its documentation for any purpose is hereby granted
\r
14 without fee, provided that the above copyright notice appear in
\r
15 all copies and that both that the copyright notice and this
\r
16 permission notice and warranty disclaimer appear in supporting
\r
17 documentation, and that the name of the author not be used in
\r
18 advertising or publicity pertaining to distribution of the
\r
19 software without specific, written prior permission.
\r
21 The author disclaim all warranties with regard to this
\r
22 software, including all implied warranties of merchantability
\r
23 and fitness. In no event shall the author be liable for any
\r
24 special, indirect or consequential damages or any damages
\r
25 whatsoever resulting from loss of use, data or profits, whether
\r
26 in an action of contract, negligence or other tortious action,
\r
27 arising out of or in connection with the use or performance of
\r
32 * \brief Device mode driver for the library USB Audio 1.0 Class driver.
\r
34 * Device mode driver for the library USB Audio 1.0 Class driver.
\r
36 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
\r
37 * dispatch header located in LUFA/Drivers/USB.h.
\r
40 /** \ingroup Group_USBClassAudio
\r
41 * \defgroup Group_USBClassAudioDevice Audio 1.0 Class Device Mode Driver
\r
43 * \section Sec_Dependencies Module Source Dependencies
\r
44 * The following files must be built with any user project that uses this module:
\r
45 * - LUFA/Drivers/USB/Class/Device/AudioClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
\r
47 * \section Sec_ModDescription Module Description
\r
48 * Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
\r
53 #ifndef _AUDIO_CLASS_DEVICE_H_
\r
54 #define _AUDIO_CLASS_DEVICE_H_
\r
57 #include "../../USB.h"
\r
58 #include "../Common/AudioClassCommon.h"
\r
60 /* Enable C linkage for C++ Compilers: */
\r
61 #if defined(__cplusplus)
\r
65 /* Preprocessor Checks: */
\r
66 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
\r
67 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
\r
70 /* Public Interface - May be used in end-application: */
\r
72 /** \brief Audio Class Device Mode Configuration and State Structure.
\r
74 * Class state structure. An instance of this structure should be made for each Audio interface
\r
75 * within the user application, and passed to each of the Audio class driver functions as the
\r
76 * \c AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
\r
82 uint8_t ControlInterfaceNumber; /**< Index of the Audio Control interface within the device this
\r
83 * structure controls.
\r
85 uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
\r
86 * structure controls.
\r
89 USB_Endpoint_Table_t DataINEndpoint; /**< Data IN endpoint configuration table. */
\r
90 USB_Endpoint_Table_t DataOUTEndpoint; /**< Data OUT endpoint configuration table. */
\r
91 } Config; /**< Config data for the USB class interface within the device. All elements in this section
\r
92 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
\r
96 bool InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
\r
97 * of the Audio Streaming interface.
\r
99 } State; /**< State data for the USB class interface within the device. All elements in this section
\r
100 * are reset to their defaults when the interface is enumerated.
\r
102 } USB_ClassInfo_Audio_Device_t;
\r
104 /* Function Prototypes: */
\r
105 /** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
\r
106 * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
\r
107 * given Audio interface is selected.
\r
109 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
111 * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
\r
113 bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
115 /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
\r
116 * linked to the library \ref EVENT_USB_Device_ControlRequest() event.
\r
118 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
120 void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
\r
122 /** Audio class driver callback for the setting and retrieval of streaming endpoint properties. This callback must be implemented
\r
123 * in the user application to handle property manipulations on streaming audio endpoints.
\r
125 * When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
\r
126 * the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations
\r
127 * to indicate the size of the retrieved data.
\r
129 * \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
\r
130 * of the \c DataLength parameter.
\r
132 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
133 * \param[in] EndpointProperty Property of the endpoint to get or set, a value from \ref Audio_ClassRequests_t.
\r
134 * \param[in] EndpointAddress Address of the streaming endpoint whose property is being referenced.
\r
135 * \param[in] EndpointControl Parameter of the endpoint to get or set, a value from \ref Audio_EndpointControls_t.
\r
136 * \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum
\r
137 * length of the retrieved data. When NULL, the function should return whether the given property
\r
138 * and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
\r
139 * \param[in,out] Data Pointer to a location where the parameter data is stored for SET operations, or where
\r
140 * the retrieved data is to be stored for GET operations.
\r
142 * \return Boolean \c true if the property GET/SET was successful, \c false otherwise
\r
144 bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
145 const uint8_t EndpointProperty,
\r
146 const uint8_t EndpointAddress,
\r
147 const uint8_t EndpointControl,
\r
148 uint16_t* const DataLength,
\r
149 uint8_t* Data) ATTR_NON_NULL_PTR_ARG(1);
\r
151 /** Audio class driver callback for the setting and retrieval of streaming interface properties. This callback must be implemented
\r
152 * in the user application to handle property manipulations on streaming audio interfaces.
\r
154 * When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for
\r
155 * the given entity and should return as fast as possible. When non-NULL, this value may be altered for GET operations
\r
156 * to indicate the size of the retrieved data.
\r
158 * \note The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value
\r
159 * of the \c DataLength parameter.
\r
161 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
162 * \param[in] Property Property of the interface to get or set, a value from \ref Audio_ClassRequests_t.
\r
163 * \param[in] EntityAddress Address of the audio entity whose property is being referenced.
\r
164 * \param[in] Parameter Parameter of the entity to get or set, specific to each type of entity (see USB Audio specification).
\r
165 * \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum
\r
166 * length of the retrieved data. When NULL, the function should return whether the given property
\r
167 * and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
\r
168 * \param[in,out] Data Pointer to a location where the parameter data is stored for SET operations, or where
\r
169 * the retrieved data is to be stored for GET operations.
\r
171 * \return Boolean \c true if the property GET/SET was successful, \c false otherwise
\r
173 bool CALLBACK_Audio_Device_GetSetInterfaceProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
174 const uint8_t Property,
\r
175 const uint8_t EntityAddress,
\r
176 const uint16_t Parameter,
\r
177 uint16_t* const DataLength,
\r
178 uint8_t* Data) ATTR_NON_NULL_PTR_ARG(1);
\r
180 /** Audio class driver event for an Audio Stream start/stop change. This event fires each time the device receives a stream enable or
\r
181 * disable control request from the host, to start and stop the audio stream. The current state of the stream can be determined by the
\r
182 * State.InterfaceEnabled value inside the Audio interface structure passed as a parameter.
\r
184 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
186 void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
\r
188 /* Inline Functions: */
\r
189 /** General management task for a given Audio class interface, required for the correct operation of the interface. This should
\r
190 * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
\r
192 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
194 static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
195 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
196 static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
198 (void)AudioInterfaceInfo;
\r
201 /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
\r
202 * OUT endpoint ready for reading.
\r
204 * \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
\r
205 * the call will fail.
\r
207 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
209 * \return Boolean \c true if the given Audio interface has a sample to be read, \c false otherwise.
\r
211 static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
212 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
213 static inline bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
215 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
\r
218 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataOUTEndpoint.Address);
\r
219 return Endpoint_IsOUTReceived();
\r
222 /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
\r
223 * the streaming IN endpoint ready for writing.
\r
225 * \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
\r
226 * the call will fail.
\r
228 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
230 * \return Boolean \c true if the given Audio interface is ready to accept the next sample, \c false otherwise.
\r
232 static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
233 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
234 static inline bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
236 if ((USB_DeviceState != DEVICE_STATE_Configured) || !(AudioInterfaceInfo->State.InterfaceEnabled))
\r
239 Endpoint_SelectEndpoint(AudioInterfaceInfo->Config.DataINEndpoint.Address);
\r
240 return Endpoint_IsINReady();
\r
243 /** Reads the next 8-bit audio sample from the current audio interface.
\r
245 * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
\r
246 * that the correct endpoint is selected and ready for data.
\r
248 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
250 * \return Signed 8-bit audio sample from the audio interface.
\r
252 static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
253 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
254 static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
258 (void)AudioInterfaceInfo;
\r
260 Sample = Endpoint_Read_8();
\r
262 if (!(Endpoint_BytesInEndpoint()))
\r
263 Endpoint_ClearOUT();
\r
268 /** Reads the next 16-bit audio sample from the current audio interface.
\r
270 * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
\r
271 * that the correct endpoint is selected and ready for data.
\r
273 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
275 * \return Signed 16-bit audio sample from the audio interface.
\r
277 static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
278 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
279 static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
283 (void)AudioInterfaceInfo;
\r
285 Sample = (int16_t)Endpoint_Read_16_LE();
\r
287 if (!(Endpoint_BytesInEndpoint()))
\r
288 Endpoint_ClearOUT();
\r
293 /** Reads the next 24-bit audio sample from the current audio interface.
\r
295 * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
\r
296 * that the correct endpoint is selected and ready for data.
\r
298 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
300 * \return Signed 24-bit audio sample from the audio interface.
\r
302 static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
303 ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
304 static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
308 (void)AudioInterfaceInfo;
\r
310 Sample = (((uint32_t)Endpoint_Read_8() << 16) | Endpoint_Read_16_LE());
\r
312 if (!(Endpoint_BytesInEndpoint()))
\r
313 Endpoint_ClearOUT();
\r
318 /** Writes the next 8-bit audio sample to the current audio interface.
\r
320 * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
\r
321 * ensure that the correct endpoint is selected and ready for data.
\r
323 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
324 * \param[in] Sample Signed 8-bit audio sample.
\r
326 static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
327 const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
328 static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
329 const int8_t Sample)
\r
331 Endpoint_Write_8(Sample);
\r
333 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpoint.Size)
\r
334 Endpoint_ClearIN();
\r
337 /** Writes the next 16-bit audio sample to the current audio interface.
\r
339 * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
\r
340 * ensure that the correct endpoint is selected and ready for data.
\r
342 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
343 * \param[in] Sample Signed 16-bit audio sample.
\r
345 static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
346 const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
347 static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
348 const int16_t Sample)
\r
350 Endpoint_Write_16_LE(Sample);
\r
352 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpoint.Size)
\r
353 Endpoint_ClearIN();
\r
356 /** Writes the next 24-bit audio sample to the current audio interface.
\r
358 * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
\r
359 * ensure that the correct endpoint is selected and ready for data.
\r
361 * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
\r
362 * \param[in] Sample Signed 24-bit audio sample.
\r
364 static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
365 const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
\r
366 static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
\r
367 const int32_t Sample)
\r
369 Endpoint_Write_16_LE(Sample);
\r
370 Endpoint_Write_8(Sample >> 16);
\r
372 if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpoint.Size)
\r
373 Endpoint_ClearIN();
\r
376 /* Private Interface - For use in library only: */
\r
377 #if !defined(__DOXYGEN__)
\r
378 /* Function Prototypes: */
\r
379 #if defined(__INCLUDE_FROM_AUDIO_DEVICE_C)
\r
380 void Audio_Device_Event_Stub(void) ATTR_CONST;
\r
382 void EVENT_Audio_Device_StreamStartStop(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
\r
383 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(Audio_Device_Event_Stub);
\r
388 /* Disable C linkage for C++ Compilers: */
\r
389 #if defined(__cplusplus)
\r