/** \ingroup Group_USBClassAudio\r
* @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver\r
*\r
+ * \section Sec_Dependencies Module Source Dependencies\r
+ * The following files must be built with any user project that uses this module:\r
+ * - LUFA/Drivers/USB/Class/Device/Audio.c\r
+ *\r
* \section Module Description\r
* Device Mode USB Class driver framework interface, for the Audio USB Class driver.\r
*\r
* of the Audio Streaming interface.\r
*/\r
} State; /**< State data for the USB class interface within the device. All elements in this section\r
- * <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
- * the interface is enumerated.\r
+ * are reset to their defaults when the interface is enumerated.\r
*/ \r
} USB_ClassInfo_Audio_Device_t;\r
\r
/* Function Prototypes: */\r
/** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library\r
- * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
+ * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
* given Audio interface is selected.\r
*\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*\r
* \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
*/\r
- bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+ bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
*\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*/\r
- void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+ void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** General management task for a given Audio class interface, required for the correct operation of the interface. This should\r
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
*\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*/\r
- void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+ void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Reads the next 8-bit audio sample from the current audio interface.\r
*\r
* \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ *\r
* \return Signed 8-bit audio sample from the audio interface\r
*/\r
- int8_t Audio_Device_ReadSample8(void);\r
+ int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Reads the next 16-bit audio sample from the current audio interface.\r
*\r
* \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ *\r
* \return Signed 16-bit audio sample from the audio interface\r
*/\r
- int16_t Audio_Device_ReadSample16(void);\r
+ int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Reads the next 24-bit audio sample from the current audio interface.\r
*\r
* \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
* \return Signed 24-bit audio sample from the audio interface\r
*/\r
- int32_t Audio_Device_ReadSample24(void);\r
+ int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Writes the next 8-bit audio sample to the current audio interface.\r
*\r
* \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param Sample Signed 8-bit audio sample\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in] Sample Signed 8-bit audio sample\r
*/\r
- void Audio_Device_WriteSample8(int8_t Sample);\r
+ void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int8_t Sample) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Writes the next 16-bit audio sample to the current audio interface.\r
*\r
* \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param Sample Signed 16-bit audio sample\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in] Sample Signed 16-bit audio sample\r
*/\r
- void Audio_Device_WriteSample16(int16_t Sample);\r
+ void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int16_t Sample) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Writes the next 24-bit audio sample to the current audio interface.\r
*\r
* \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param Sample Signed 24-bit audio sample\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in] Sample Signed 24-bit audio sample\r
*/\r
- void Audio_Device_WriteSample24(int32_t Sample);\r
+ void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo, const int32_t Sample) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Determines if the given audio interface is ready for a sample to be read from it.\r
*\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*\r
* \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
*/\r
- bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+ bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
*\r
- * \param AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
*\r
* \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
*/\r
- bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+ bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
projects / pub / USBasp.git / blobdiff