Minor documentation page updates.

[pub/USBasp.git] / Demos / Device / AudioInput / AudioInput.c

diff --git a/Demos/Device/AudioInput/AudioInput.c b/Demos/Device/AudioInput/AudioInput.c
index bcfb04b..31b3159 100644 (file)
--- a/Demos/Device/AudioInput/AudioInput.c
+++ b/Demos/Device/AudioInput/AudioInput.c
@@ -28,16 +28,29 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *\r
+ *  Main source file for the AudioInput demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+\r
 #include "AudioInput.h"\r
 \r
+/** LUFA Audio Class driver interface configuration and state information. This structure is\r
+ *  passed to all Audio Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another.\r
+ */\r
 USB_ClassInfo_Audio_t Microphone_Audio_Interface =\r
        {\r
-               .InterfaceNumber      = 0,\r
+               .StreamingInterfaceNumber = 1,\r
 \r
-               .DataINEndpointNumber = AUDIO_STREAM_EPNUM,\r
-               .DataINEndpointSize   = AUDIO_STREAM_EPSIZE,\r
+               .DataINEndpointNumber     = AUDIO_STREAM_EPNUM,\r
+               .DataINEndpointSize       = AUDIO_STREAM_EPSIZE,\r
        };\r
-               \r
+\r
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ *  setup of all components and the main program loop.\r
+ */\r
 int main(void)\r
 {\r
        SetupHardware();\r
@@ -53,6 +66,7 @@ int main(void)
        }\r
 }\r
 \r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
 void SetupHardware(void)\r
 {\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
@@ -72,6 +86,9 @@ void SetupHardware(void)
        ADC_StartReading(ADC_REFERENCE_AVCC | ADC_RIGHT_ADJUSTED | MIC_IN_ADC_CHANNEL);\r
 }\r
 \r
+/** Processes the next audio sample by reading the last ADC conversion and writing it to the audio\r
+ *  interface, each time the sample reload timer period elapses to give a constant sample rate.\r
+ */\r
 void ProcessNextSample(void)\r
 {\r
        if ((TIFR0 & (1 << OCF0A)) && USB_Audio_IsReadyForNextSample(&Microphone_Audio_Interface))\r
@@ -90,6 +107,7 @@ void ProcessNextSample(void)
        }\r
 }\r
 \r
+/** Event handler for the library USB Connection event. */\r
 void EVENT_USB_Connect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
@@ -100,6 +118,7 @@ void EVENT_USB_Connect(void)
        TCCR0B  = (1 << CS00);   // Fcpu speed\r
 }\r
 \r
+/** Event handler for the library USB Disconnection event. */\r
 void EVENT_USB_Disconnect(void)\r
 {\r
        /* Stop the sample reload timer */\r
@@ -108,6 +127,7 @@ void EVENT_USB_Disconnect(void)
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 }\r
 \r
+/** Event handler for the library USB Configuration Changed event. */\r
 void EVENT_USB_ConfigurationChanged(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
@@ -116,6 +136,7 @@ void EVENT_USB_ConfigurationChanged(void)
          LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
 void EVENT_USB_UnhandledControlPacket(void)\r
 {\r
        USB_Audio_ProcessControlPacket(&Microphone_Audio_Interface);\r