aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Class/Device/Audio.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-01-04 13:34:02 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-01-04 13:34:02 +0000
commit6122ba93cf957bd495fdd1838bac16fb24896a17 (patch)
treeb8cef2eb41161e5beb7523f30b54ac03dfd7e9b4 /LUFA/Drivers/USB/Class/Device/Audio.h
parent1e1cf2c499d7ac0cfae536e1264af4645350813b (diff)
downloadlufa-6122ba93cf957bd495fdd1838bac16fb24896a17.tar.gz
lufa-6122ba93cf957bd495fdd1838bac16fb24896a17.tar.bz2
lufa-6122ba93cf957bd495fdd1838bac16fb24896a17.zip
Fix MassStorageKeyboard demo USE_INTERNAL_SERIAL check being performed before the required library headers were included, causing a compilation error.
Added notes to the class driver functions indicating which functions require what Device/Host state machine states to function.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device/Audio.h')
-rw-r--r--LUFA/Drivers/USB/Class/Device/Audio.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index fcfd65d72..e516b7101 100644
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -123,6 +123,9 @@
/** 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.
*
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+ * the call will fail.
+ *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
*
* \return Boolean true if the given Audio interface has a sample to be read, false otherwise
@@ -132,6 +135,9 @@
/** 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.
*
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+ * the call will fail.
+ *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
*
* \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise