LUFA Library  210130
Audio 1.0 Class Device Mode Driver

Data Structures

struct  USB_ClassInfo_Audio_Device_t
 Audio Class Device Mode Configuration and State Structure. More...
 

Functions

bool Audio_Device_ConfigureEndpoints (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1)
 
static bool Audio_Device_IsReadyForNextSample (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static bool Audio_Device_IsSampleReceived (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
void Audio_Device_ProcessControlRequest (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1)
 
static int16_t Audio_Device_ReadSample16 (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static int32_t Audio_Device_ReadSample24 (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static int8_t Audio_Device_ReadSample8 (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static void Audio_Device_USBTask (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static void Audio_Device_WriteSample16 (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo, const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static void Audio_Device_WriteSample24 (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo, const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
static void Audio_Device_WriteSample8 (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo, const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE
 
bool CALLBACK_Audio_Device_GetSetEndpointProperty (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo, const uint8_t EndpointProperty, const uint8_t EndpointAddress, const uint8_t EndpointControl, uint16_t *const DataLength, uint8_t *Data) ATTR_NON_NULL_PTR_ARG(1)
 
bool CALLBACK_Audio_Device_GetSetInterfaceProperty (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo, const uint8_t Property, const uint8_t EntityAddress, const uint16_t Parameter, uint16_t *const DataLength, uint8_t *Data) ATTR_NON_NULL_PTR_ARG(1)
 
void EVENT_Audio_Device_StreamStartStop (USB_ClassInfo_Audio_Device_t *const AudioInterfaceInfo)
 

Detailed Description

Module Source Dependencies

The following files must be built with any user project that uses this module:

Module Description

Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.

Function Documentation

◆ Audio_Device_ConfigureEndpoints()

bool Audio_Device_ConfigureEndpoints ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)

Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the given Audio interface is selected.

Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
Returns
Boolean true if the endpoints were successfully configured, false otherwise.

◆ Audio_Device_IsReadyForNextSample()

static bool Audio_Device_IsReadyForNextSample ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)
inlinestatic

Determines if the given audio interface is ready to accept the next sample to be written to it, and selects the streaming IN endpoint ready for writing.

Precondition
This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or the call will fail.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
Returns
Boolean true if the given Audio interface is ready to accept the next sample, false otherwise.

◆ Audio_Device_IsSampleReceived()

static bool Audio_Device_IsSampleReceived ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)
inlinestatic

Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming OUT endpoint ready for reading.

Precondition
This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or the call will fail.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
Returns
Boolean true if the given Audio interface has a sample to be read, false otherwise.

◆ Audio_Device_ProcessControlRequest()

void Audio_Device_ProcessControlRequest ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)

Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be linked to the library EVENT_USB_Device_ControlRequest() event.

Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.

◆ Audio_Device_ReadSample16()

static int16_t Audio_Device_ReadSample16 ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)
inlinestatic

Reads the next 16-bit audio sample from the current audio interface.

Precondition
This should be preceded immediately by a call to the Audio_Device_IsSampleReceived() function to ensure that the correct endpoint is selected and ready for data.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
Returns
Signed 16-bit audio sample from the audio interface.

◆ Audio_Device_ReadSample24()

static int32_t Audio_Device_ReadSample24 ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)
inlinestatic

Reads the next 24-bit audio sample from the current audio interface.

Precondition
This should be preceded immediately by a call to the Audio_Device_IsSampleReceived() function to ensure that the correct endpoint is selected and ready for data.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
Returns
Signed 24-bit audio sample from the audio interface.

◆ Audio_Device_ReadSample8()

static int8_t Audio_Device_ReadSample8 ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)
inlinestatic

Reads the next 8-bit audio sample from the current audio interface.

Precondition
This should be preceded immediately by a call to the Audio_Device_IsSampleReceived() function to ensure that the correct endpoint is selected and ready for data.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
Returns
Signed 8-bit audio sample from the audio interface.

◆ Audio_Device_USBTask()

static void Audio_Device_USBTask ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)
inlinestatic

General management task for a given Audio class interface, required for the correct operation of the interface. This should be called frequently in the main program loop, before the master USB management task USB_USBTask().

Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.

◆ Audio_Device_WriteSample16()

static void Audio_Device_WriteSample16 ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo,
const int16_t  Sample 
)
inlinestatic

Writes the next 16-bit audio sample to the current audio interface.

Precondition
This should be preceded immediately by a call to the Audio_Device_IsReadyForNextSample() function to ensure that the correct endpoint is selected and ready for data.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
[in]SampleSigned 16-bit audio sample.

◆ Audio_Device_WriteSample24()

static void Audio_Device_WriteSample24 ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo,
const int32_t  Sample 
)
inlinestatic

Writes the next 24-bit audio sample to the current audio interface.

Precondition
This should be preceded immediately by a call to the Audio_Device_IsReadyForNextSample() function to ensure that the correct endpoint is selected and ready for data.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
[in]SampleSigned 24-bit audio sample.

◆ Audio_Device_WriteSample8()

static void Audio_Device_WriteSample8 ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo,
const int8_t  Sample 
)
inlinestatic

Writes the next 8-bit audio sample to the current audio interface.

Precondition
This should be preceded immediately by a call to the Audio_Device_IsReadyForNextSample() function to ensure that the correct endpoint is selected and ready for data.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
[in]SampleSigned 8-bit audio sample.

◆ CALLBACK_Audio_Device_GetSetEndpointProperty()

bool CALLBACK_Audio_Device_GetSetEndpointProperty ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo,
const uint8_t  EndpointProperty,
const uint8_t  EndpointAddress,
const uint8_t  EndpointControl,
uint16_t *const  DataLength,
uint8_t *  Data 
)

Audio class driver callback for the setting and retrieval of streaming endpoint properties. This callback must be implemented in the user application to handle property manipulations on streaming audio endpoints.

When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for the given endpoint index, and should return as fast as possible. When non-NULL, this value may be altered for GET operations to indicate the size of the retrieved data.

Note
The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value of the DataLength parameter.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
[in]EndpointPropertyProperty of the endpoint to get or set, a value from Audio_ClassRequests_t.
[in]EndpointAddressAddress of the streaming endpoint whose property is being referenced.
[in]EndpointControlParameter of the endpoint to get or set, a value from Audio_EndpointControls_t.
[in,out]DataLengthFor SET operations, the length of the parameter data to set. For GET operations, the maximum length of the retrieved data. When NULL, the function should return whether the given property and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
[in,out]DataPointer to a location where the parameter data is stored for SET operations, or where the retrieved data is to be stored for GET operations.
Returns
Boolean true if the property GET/SET was successful, false otherwise

◆ CALLBACK_Audio_Device_GetSetInterfaceProperty()

bool CALLBACK_Audio_Device_GetSetInterfaceProperty ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo,
const uint8_t  Property,
const uint8_t  EntityAddress,
const uint16_t  Parameter,
uint16_t *const  DataLength,
uint8_t *  Data 
)

Audio class driver callback for the setting and retrieval of streaming interface properties. This callback must be implemented in the user application to handle property manipulations on streaming audio interfaces.

When the DataLength parameter is NULL, this callback should only indicate whether the specified operation is valid for the given entity and should return as fast as possible. When non-NULL, this value may be altered for GET operations to indicate the size of the retrieved data.

Note
The length of the retrieved data stored into the Data buffer on GET operations should not exceed the initial value of the DataLength parameter.
Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.
[in]PropertyProperty of the interface to get or set, a value from Audio_ClassRequests_t.
[in]EntityAddressAddress of the audio entity whose property is being referenced.
[in]ParameterParameter of the entity to get or set, specific to each type of entity (see USB Audio specification).
[in,out]DataLengthFor SET operations, the length of the parameter data to set. For GET operations, the maximum length of the retrieved data. When NULL, the function should return whether the given property and parameter is valid for the requested endpoint without reading or modifying the Data buffer.
[in,out]DataPointer to a location where the parameter data is stored for SET operations, or where the retrieved data is to be stored for GET operations.
Returns
Boolean true if the property GET/SET was successful, false otherwise

◆ EVENT_Audio_Device_StreamStartStop()

void EVENT_Audio_Device_StreamStartStop ( USB_ClassInfo_Audio_Device_t *const  AudioInterfaceInfo)

Audio class driver event for an Audio Stream start/stop change. This event fires each time the device receives a stream enable or disable control request from the host, to start and stop the audio stream. The current state of the stream can be determined by the State.InterfaceEnabled value inside the Audio interface structure passed as a parameter.

Parameters
[in,out]AudioInterfaceInfoPointer to a structure containing an Audio Class configuration and state.