Doc updates

2012-08-30 14:21:17 +01:00
parent e449050b40
commit 99cdee6e2b
45 changed files with 0 additions and 0 deletions
--- a/module_usb_audio/audio.h
+++ b/module_usb_audio/audio.h
@@ -0,0 +1,18 @@
+#ifndef __audio_h__
+#define __audio_h__
+
+/** The audio driver thread.
+ *
+ *  This function drives I2S ports and handles samples to/from other digital 
+ *  I/O threads.
+ * 
+ *  \param c_in Audio sample channel connected to the mixer() thread or the
+ *              decouple() thread
+ *  \param c_dig channel connected to the clockGen() thread for 
+ *               receiving/transmitting samples
+ *  \param c_config An optional channel that will be passed on to the 
+ *                  CODEC configuration functions.
+ */
+void audio(chanend c_in, chanend ?c_dig, chanend ?c_config, chanend ?c_adc);
+
+#endif // __audio_h__