Added Doxygen documentation to the Audio class driver. Added new modules for each...

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

diff --git a/Demos/Device/AudioInput/AudioInput.h b/Demos/Device/AudioInput/AudioInput.h
index b7174d1..e4dd7fe 100644 (file)
--- a/Demos/Device/AudioInput/AudioInput.h
+++ b/Demos/Device/AudioInput/AudioInput.h
@@ -30,11 +30,11 @@
 \r
 /** \file\r
  *\r
- *  Header file for AudioOutput.c.\r
+ *  Header file for AudioInput.c.\r
  */\r
  \r
-#ifndef _AUDIO_OUTPUT_H_\r
-#define _AUDIO_OUTPUT_H_\r
+#ifndef _AUDIO_INPUT_H_\r
+#define _AUDIO_INPUT_H_\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
@@ -43,48 +43,43 @@
 \r
                #include "Descriptors.h"\r
                                \r
-               #include <LUFA/Version.h>                      // Library Version Information\r
-               #include <LUFA/Drivers/USB/USB.h>              // USB Functionality\r
-               #include <LUFA/Drivers/Board/LEDs.h>           // LEDs driver\r
-               #include <LUFA/Drivers/Peripheral/ADC.h>       // ADC driver\r
-               #include <LUFA/Scheduler/Scheduler.h>          // Simple scheduler for task management\r
-\r
+               #include <LUFA/Version.h>\r
+               #include <LUFA/Drivers/Board/LEDs.h>\r
+               #include <LUFA/Drivers/Board/Joystick.h>\r
+               #include <LUFA/Drivers/Peripheral/ADC.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               #include <LUFA/Drivers/USB/Class/Device/Audio.h>\r
+               \r
        /* Macros: */\r
                /** ADC channel number for the microphone input. */\r
-               #define MIC_IN_ADC_CHANNEL               2\r
+               #define MIC_IN_ADC_CHANNEL        2\r
                \r
                /** Maximum ADC sample value for the microphone input. */\r
-               #define SAMPLE_MAX_RANGE                 0xFFFF\r
+               #define SAMPLE_MAX_RANGE          0xFFFF\r
 \r
                /** Maximum ADC range for the microphone input. */\r
-               #define ADC_MAX_RANGE                    0x3FF\r
-\r
-       /* Enums: */\r
-               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
-               enum AudioInput_StatusCodes_t\r
-               {\r
-                       Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */\r
-                       Status_USBEnumerating = 1, /**< USB interface is enumerating */\r
-                       Status_USBReady       = 2, /**< USB interface is connected and ready */\r
-               };\r
-\r
-       /* Task Definitions: */\r
-               TASK(USB_Audio_Task);\r
+               #define ADC_MAX_RANGE             0x3FF\r
 \r
-       /* Event Handlers: */\r
-               /** Indicates that this module will catch the USB_Connect event when thrown by the library. */\r
-               HANDLES_EVENT(USB_Connect);\r
-\r
-               /** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */\r
-               HANDLES_EVENT(USB_Disconnect);\r
+       /* Macros: */\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */\r
+               #define LEDMASK_USB_NOTREADY      LEDS_LED1\r
 \r
-               /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */\r
-               HANDLES_EVENT(USB_ConfigurationChanged);\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */\r
+               #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)\r
 \r
-               /** Indicates that this module will catch the USB_UnhandledControlPacket event when thrown by the library. */\r
-               HANDLES_EVENT(USB_UnhandledControlPacket);\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */\r
+               #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)\r
 \r
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */\r
+               #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)\r
+               \r
        /* Function Prototypes: */\r
-               void UpdateStatus(uint8_t CurrentStatus);\r
+               void SetupHardware(void);\r
+               void ProcessNextSample(void);\r
                \r
+               void EVENT_USB_Connect(void);\r
+               void EVENT_USB_Disconnect(void);\r
+               void EVENT_USB_ConfigurationChanged(void);\r
+               void EVENT_USB_UnhandledControlPacket(void);\r
+\r
 #endif\r