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

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

diff --git a/Demos/Device/AudioInput/AudioInput.c b/Demos/Device/AudioInput/AudioInput.c
index f41306f..93ffe0b 100644 (file)
--- a/Demos/Device/AudioInput/AudioInput.c
+++ b/Demos/Device/AudioInput/AudioInput.c
@@ -30,31 +30,46 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

- *  Main source file for the Audio Input demo. This file contains the main tasks of the demo and\r
- *  is responsible for the initial application hardware configuration.\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
  */\r
 \r
 #include "AudioInput.h"\r
 \r

-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,    "LUFA AudioIn App");\r
-BUTTLOADTAG(BuildTime,   __TIME__);\r
-BUTTLOADTAG(BuildDate,   __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
-       { Task: USB_Audio_Task       , TaskStatus: TASK_STOP },\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
+               .StreamingInterfaceNumber = 1,\r

 \r
 \r

+               .DataINEndpointNumber     = AUDIO_STREAM_EPNUM,\r
+               .DataINEndpointSize       = AUDIO_STREAM_EPSIZE,\r
+       };\r

 \r
 \r

-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  starts the scheduler to run the application tasks.\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
  */\r
 int main(void)\r
 {\r

+       SetupHardware();\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+       \r
+       for (;;)\r
+       {\r
+               if (Microphone_Audio_Interface.InterfaceEnabled)\r
+                 ProcessNextSample();\r
+\r
+               USB_Audio_USBTask(&Microphone_Audio_Interface);\r
+               USB_USBTask();\r
+       }\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
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r


@@ -64,165 +79,66 @@ int main(void)
        \r
        /* Hardware Initialization */\r
        LEDs_Init();\r
        \r
        /* Hardware Initialization */\r
        LEDs_Init();\r

+       USB_Init();\r

        ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32);\r
        ADC_SetupChannel(MIC_IN_ADC_CHANNEL);\r
        \r
        /* Start the ADC conversion in free running mode */\r
        ADC_StartReading(ADC_REFERENCE_AVCC | ADC_RIGHT_ADJUSTED | MIC_IN_ADC_CHANNEL);\r
        ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32);\r
        ADC_SetupChannel(MIC_IN_ADC_CHANNEL);\r
        \r
        /* Start the ADC conversion in free running mode */\r
        ADC_StartReading(ADC_REFERENCE_AVCC | ADC_RIGHT_ADJUSTED | MIC_IN_ADC_CHANNEL);\r

-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-       \r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
-\r
-       /* Initialize USB Subsystem */\r
-       USB_Init();\r
-\r
-       /* Scheduling - routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\r

 }\r
 \r
 }\r
 \r

-/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs, and\r
- *  configures the sample update and PWM timers.\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
  */\r

-EVENT_HANDLER(USB_Connect)\r
+void ProcessNextSample(void)\r

 {\r
 {\r

-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+       if ((TIFR0 & (1 << OCF0A)) && USB_Audio_IsReadyForNextSample(&Microphone_Audio_Interface))\r
+       {\r
+               TIFR0 |= (1 << OCF0A);\r
+\r
+               /* Audio sample is ADC value scaled to fit the entire range */\r
+               int16_t AudioSample = ((SAMPLE_MAX_RANGE / ADC_MAX_RANGE) * ADC_GetResult());\r
+               \r
+#if defined(MICROPHONE_BIASED_TO_HALF_RAIL)\r
+               /* Microphone is biased to half rail voltage, subtract the bias from the sample value */\r
+               AudioSample -= (SAMPLE_MAX_RANGE / 2));\r
+#endif\r

 \r
 \r

-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\r
+               USB_Audio_WriteSample16(AudioSample);\r
+       }\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

 \r
        /* Sample reload timer initialization */\r
 \r
        /* Sample reload timer initialization */\r

-       OCR0A   = (F_CPU / AUDIO_SAMPLE_FREQUENCY);\r
+       OCR0A   = (F_CPU / AUDIO_SAMPLE_FREQUENCY) - 1;\r

        TCCR0A  = (1 << WGM01);  // CTC mode\r
        TCCR0B  = (1 << CS00);   // Fcpu speed\r
 }\r
 \r
        TCCR0A  = (1 << WGM01);  // CTC mode\r
        TCCR0B  = (1 << CS00);   // Fcpu speed\r
 }\r
 \r

-/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
- *  the status LEDs, disables the sample update and PWM output timers and stops the USB and Audio management tasks.\r
- */\r
-EVENT_HANDLER(USB_Disconnect)\r
+/** Event handler for the library USB Disconnection event. */\r
+void EVENT_USB_Disconnect(void)\r

 {\r
        /* Stop the sample reload timer */\r
        TCCR0B = 0;\r
 \r
 {\r
        /* Stop the sample reload timer */\r
        TCCR0B = 0;\r
 \r

-       /* Stop running audio and USB management tasks */\r
-       Scheduler_SetTaskMode(USB_Audio_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-\r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-}\r
-\r
-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
- *  of the USB device after enumeration - the device endpoints are configured.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
-       /* Setup audio stream endpoint */\r
-       Endpoint_ConfigureEndpoint(AUDIO_STREAM_EPNUM, EP_TYPE_ISOCHRONOUS,\r
-                                      ENDPOINT_DIR_IN, AUDIO_STREAM_EPSIZE,\r
-                                  ENDPOINT_BANK_DOUBLE);\r
-\r
-       /* Indicate USB connected and ready */\r
-       UpdateStatus(Status_USBReady);\r
-}\r
-\r
-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
- *  control requests that are not handled internally by the USB library (including the Audio class-specific\r
- *  requests) so that they can be handled appropriately for the application.\r
- */\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
-{\r
-       /* Process General and Audio specific control requests */\r
-       switch (bRequest)\r
-       {\r
-               case REQ_SetInterface:\r
-                       /* Set Interface is not handled by the library, as its function is application-specific */\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_INTERFACE))\r
-                       {\r
-                               uint16_t wValue = Endpoint_Read_Word_LE();\r
-                               \r
-                               Endpoint_ClearSetupReceived();\r
-                               \r
-                               /* Check if the host is enabling the audio interface (setting AlternateSetting to 1) */\r
-                               if (wValue)\r
-                               {\r
-                                       /* Start audio task */\r
-                                       Scheduler_SetTaskMode(USB_Audio_Task, TASK_RUN);\r
-                               }\r
-                               else\r
-                               {\r
-                                       /* Stop audio task */\r
-                                       Scheduler_SetTaskMode(USB_Audio_Task, TASK_STOP);                               \r
-                               }\r
-                               \r
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsSetupINReady()));\r
-                               Endpoint_ClearSetupIN();\r
-                       }\r
-\r
-                       break;\r
-       }\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r

 }\r
 \r
 }\r
 \r

-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- *  log to a serial port, or anything else that is suitable for status updates.\r
- *\r
- *  \param CurrentStatus  Current status of the system, from the AudioInput_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
+/** Event handler for the library USB Configuration Changed event. */\r
+void EVENT_USB_ConfigurationChanged(void)\r

 {\r
 {\r

-       uint8_t LEDMask = LEDS_NO_LEDS;\r
-       \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2 | LEDS_LED4);\r
-                       break;\r
-       }\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

        \r
        \r

-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
+       if (!(USB_Audio_ConfigureEndpoints(&Microphone_Audio_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

 }\r
 \r
 }\r
 \r

-/** Task to manage the Audio interface, reading in ADC samples from the microphone, and them to the host. */\r
-TASK(USB_Audio_Task)\r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
+void EVENT_USB_UnhandledControlPacket(void)\r

 {\r
 {\r

-       /* Select the audio stream endpoint */\r
-       Endpoint_SelectEndpoint(AUDIO_STREAM_EPNUM);\r
-       \r
-       /* Check if the current endpoint can be read from (contains a packet) and that the next sample should be stored */\r
-       if (Endpoint_ReadWriteAllowed() && (TIFR0 & (1 << OCF0A)))\r
-       {\r
-               /* Clear the sample reload timer */\r
-               TIFR0 |= (1 << OCF0A);\r
-\r
-               /* Audio sample is ADC value scaled to fit the entire range */\r
-               int16_t AudioSample = ((SAMPLE_MAX_RANGE / ADC_MAX_RANGE) * ADC_GetResult());\r
-               \r
-#if defined(MICROPHONE_BIASED_TO_HALF_RAIL)\r
-               /* Microphone is biased to half rail voltage, subtract the bias from the sample value */\r
-               AudioSample -= (SAMPLE_MAX_RANGE / 2));\r
-#endif\r
-\r
-               /* Write the sample to the buffer */\r
-               Endpoint_Write_Word_LE(AudioSample);\r
-\r
-               /* Check to see if the bank is now full */\r
-               if (!(Endpoint_ReadWriteAllowed()))\r
-               {\r
-                       /* Send the full packet to the host */\r
-                       Endpoint_ClearCurrentBank();\r
-               }\r
-       }\r
+       USB_Audio_ProcessControlPacket(&Microphone_Audio_Interface);\r

 }\r
 }\r