Documentation improvements - put driver example code into its own section, fix incorr...
[pub/USBasp.git] / Demos / Device / ClassDriver / AudioOutput / AudioOutput.c
index 8c3bf61..4650cd8 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Main source file for the AudioOutput demo. This file contains the main tasks of\r
- *  the demo and is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#include "AudioOutput.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 Speaker_Audio_Interface =\r
-       {\r
-               .StreamingInterfaceNumber = 1,\r
-\r
-               .DataOUTEndpointNumber    = AUDIO_STREAM_EPNUM,\r
-               .DataOUTEndpointSize      = AUDIO_STREAM_EPSIZE,\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
-\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-       \r
-       for (;;)\r
-       {\r
-               if (Speaker_Audio_Interface.InterfaceEnabled)\r
-                 ProcessNextSample();\r
-\r
-               USB_Audio_USBTask(&Speaker_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
-\r
-       /* Disable clock division */\r
-       clock_prescale_set(clock_div_1);\r
-\r
-       /* Hardware Initialization */\r
-       LEDs_Init();\r
-       USB_Init();\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_IsSampleReceived(&Speaker_Audio_Interface))\r
-       {\r
-               /* Clear the sample reload timer */\r
-               TIFR0 |= (1 << OCF0A);\r
-\r
-               /* Retrieve the signed 16-bit left and right audio samples */\r
-               int16_t LeftSample_16Bit  = (int16_t)USB_Audio_ReadSample16();\r
-               int16_t RightSample_16Bit = (int16_t)USB_Audio_ReadSample16();\r
-\r
-               /* Massage signed 16-bit left and right audio samples into signed 8-bit */\r
-               int8_t  LeftSample_8Bit   = (LeftSample_16Bit  >> 8);\r
-               int8_t  RightSample_8Bit  = (RightSample_16Bit >> 8);\r
-                       \r
-               /* Mix the two channels together to produce a mono, 8-bit sample */\r
-               int8_t  MixedSample_8Bit  = (((int16_t)LeftSample_8Bit + (int16_t)RightSample_8Bit) >> 1);\r
-\r
-#if defined(AUDIO_OUT_MONO)\r
-               /* Load the sample into the PWM timer channel */\r
-               OCRxA = ((uint8_t)MixedSample_8Bit ^ (1 << 7));\r
-#elif defined(AUDIO_OUT_STEREO)\r
-               /* Load the dual 8-bit samples into the PWM timer channels */\r
-               OCRxA = ((uint8_t)LeftSample_8Bit  ^ (1 << 7));\r
-               OCRxB = ((uint8_t)RightSample_8Bit ^ (1 << 7));\r
-#elif defined(AUDIO_OUT_PORTC)\r
-               PORTC = MixedSample_8Bit;\r
-#else\r
-               uint8_t LEDMask = LEDS_NO_LEDS;\r
-\r
-               /* Make mixed sample value positive (absolute) */\r
-               if (MixedSample_8Bit < 0)\r
-                 MixedSample_8Bit = -MixedSample_8Bit;\r
-\r
-               if (MixedSample_8Bit > ((128 / 8) * 1))\r
-                 LEDMask |= LEDS_LED1;\r
-                 \r
-               if (MixedSample_8Bit > ((128 / 8) * 2))\r
-                 LEDMask |= LEDS_LED2;\r
-                 \r
-               if (MixedSample_8Bit > ((128 / 8) * 3))\r
-                 LEDMask |= LEDS_LED3;\r
-\r
-               if (MixedSample_8Bit > ((128 / 8) * 4))\r
-                 LEDMask |= LEDS_LED4;\r
-\r
-               LEDs_SetAllLEDs(LEDMask);\r
-#endif\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
-       OCR0A   = (F_CPU / AUDIO_SAMPLE_FREQUENCY) - 1;\r
-       TCCR0A  = (1 << WGM01);  // CTC mode\r
-       TCCR0B  = (1 << CS00);   // Fcpu speed\r
-\r
-#if defined(AUDIO_OUT_MONO)\r
-       /* Set speaker as output */\r
-       DDRC   |= (1 << 6);\r
-#elif defined(AUDIO_OUT_STEREO)\r
-       /* Set speakers as outputs */\r
-       DDRC   |= ((1 << 6) | (1 << 5));\r
-#elif defined(AUDIO_OUT_PORTC)\r
-       /* Set PORTC as outputs */\r
-       DDRC   |= 0xFF;\r
-#endif\r
-\r
-#if (defined(AUDIO_OUT_MONO) || defined(AUDIO_OUT_STEREO))\r
-       /* PWM speaker timer initialization */\r
-       TCCRxA  = ((1 << WGMx0) | (1 << COMxA1) | (1 << COMxA0)\r
-                                                       | (1 << COMxB1) | (1 << COMxB0)); // Set on match, clear on TOP\r
-       TCCRxB  = ((1 << WGMx2) | (1 << CSx0));  // Fast 8-Bit PWM, Fcpu speed\r
-#endif \r
-}\r
-\r
-/** Event handler for the library USB Disconnection event. */\r
-void EVENT_USB_Disconnect(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-\r
-       /* Stop the sample reload timer */\r
-       TCCR0B = 0;\r
-\r
-#if (defined(AUDIO_OUT_MONO) || defined(AUDIO_OUT_STEREO))\r
-       /* Stop the PWM generation timer */\r
-       TCCRxB = 0;\r
-#endif         \r
-\r
-#if defined(AUDIO_OUT_MONO)\r
-       /* Set speaker as input to reduce current draw */\r
-       DDRC   &= ~(1 << 6);\r
-#elif defined(AUDIO_OUT_STEREO)\r
-       /* Set speakers as inputs to reduce current draw */\r
-       DDRC   &= ~((1 << 6) | (1 << 5));\r
-#elif defined(AUDIO_OUT_PORTC)\r
-       /* Set PORTC low */\r
-       PORTC  = 0x00;\r
-#endif\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
-       \r
-       if (!(USB_Audio_ConfigureEndpoints(&Speaker_Audio_Interface)))\r
-         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(&Speaker_Audio_Interface);\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the AudioOutput demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+
+#include "AudioOutput.h"
+
+/** LUFA Audio Class driver interface configuration and state information. This structure is
+ *  passed to all Audio Class driver functions, so that multiple instances of the same class
+ *  within a device can be differentiated from one another.
+ */
+USB_ClassInfo_Audio_Device_t Speaker_Audio_Interface =
+       {
+               .Config =
+                       {
+                               .StreamingInterfaceNumber = 1,
+
+                               .DataOUTEndpointNumber    = AUDIO_STREAM_EPNUM,
+                               .DataOUTEndpointSize      = AUDIO_STREAM_EPSIZE,
+                       },
+       };
+
+/** Main program entry point. This routine contains the overall program flow, including initial
+ *  setup of all components and the main program loop.
+ */
+int main(void)
+{
+       SetupHardware();
+
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+       sei();
+
+       for (;;)
+       {
+               Audio_Device_USBTask(&Speaker_Audio_Interface);
+               USB_USBTask();
+       }
+}
+
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
+void SetupHardware(void)
+{
+       /* Disable watchdog if enabled by bootloader/fuses */
+       MCUSR &= ~(1 << WDRF);
+       wdt_disable();
+
+       /* Disable clock division */
+       clock_prescale_set(clock_div_1);
+
+       /* Hardware Initialization */
+       LEDs_Init();
+       USB_Init();
+}
+
+/** ISR to handle the reloading of the PWM timer with the next sample. */
+ISR(TIMER0_COMPA_vect, ISR_BLOCK)
+{
+       uint8_t PrevEndpoint = Endpoint_GetCurrentEndpoint();
+
+       if (Audio_Device_IsSampleReceived(&Speaker_Audio_Interface))
+       {
+               /* Retrieve the signed 16-bit left and right audio samples, convert to 8-bit */
+               int8_t LeftSample_8Bit  = (Audio_Device_ReadSample16(&Speaker_Audio_Interface) >> 8);
+               int8_t RightSample_8Bit = (Audio_Device_ReadSample16(&Speaker_Audio_Interface) >> 8);
+
+               /* Mix the two channels together to produce a mono, 8-bit sample */
+               int8_t MixedSample_8Bit = (((int16_t)LeftSample_8Bit + (int16_t)RightSample_8Bit) >> 1);
+
+               #if defined(AUDIO_OUT_MONO)
+               /* Load the sample into the PWM timer channel */
+               OCR3A = (MixedSample_8Bit ^ (1 << 7));
+               #elif defined(AUDIO_OUT_STEREO)
+               /* Load the dual 8-bit samples into the PWM timer channels */
+               OCR3A = (LeftSample_8Bit  ^ (1 << 7));
+               OCR3B = (RightSample_8Bit ^ (1 << 7));
+               #elif defined(AUDIO_OUT_PORTC)
+               /* Load the 8-bit mixed sample into PORTC */
+               PORTC = MixedSample_8Bit;
+               #endif
+
+               uint8_t LEDMask = LEDS_NO_LEDS;
+
+               /* Turn on LEDs as the sample amplitude increases */
+               if (MixedSample_8Bit > 16)
+                 LEDMask = (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4);
+               else if (MixedSample_8Bit > 8)
+                 LEDMask = (LEDS_LED1 | LEDS_LED2 | LEDS_LED3);
+               else if (MixedSample_8Bit > 4)
+                 LEDMask = (LEDS_LED1 | LEDS_LED2);
+               else if (MixedSample_8Bit > 2)
+                 LEDMask = (LEDS_LED1);
+
+               LEDs_SetAllLEDs(LEDMask);
+       }
+       
+       Endpoint_SelectEndpoint(PrevEndpoint);  
+}
+
+/** Event handler for the library USB Connection event. */
+void EVENT_USB_Device_Connect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+
+       /* Sample reload timer initialization */
+       TIMSK0  = (1 << OCIE0A);
+       OCR0A   = ((F_CPU / 8 / AUDIO_SAMPLE_FREQUENCY) - 1);
+       TCCR0A  = (1 << WGM01);  // CTC mode
+       TCCR0B  = (1 << CS01);   // Fcpu/8 speed
+
+       #if defined(AUDIO_OUT_MONO)
+       /* Set speaker as output */
+       DDRC   |= (1 << 6);
+       #elif defined(AUDIO_OUT_STEREO)
+       /* Set speakers as outputs */
+       DDRC   |= ((1 << 6) | (1 << 5));
+       #elif defined(AUDIO_OUT_PORTC)
+       /* Set PORTC as outputs */
+       DDRC   |= 0xFF;
+       #endif
+
+       #if (defined(AUDIO_OUT_MONO) || defined(AUDIO_OUT_STEREO))
+       /* PWM speaker timer initialization */
+       TCCR3A  = ((1 << WGM30) | (1 << COM3A1) | (1 << COM3A0)
+               | (1 << COM3B1) | (1 << COM3B0)); // Set on match, clear on TOP
+       TCCR3B  = ((1 << WGM32) | (1 << CS30));  // Fast 8-Bit PWM, F_CPU speed
+       #endif
+}
+
+/** Event handler for the library USB Disconnection event. */
+void EVENT_USB_Device_Disconnect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+
+       /* Stop the sample reload timer */
+       TCCR0B = 0;
+
+       #if (defined(AUDIO_OUT_MONO) || defined(AUDIO_OUT_STEREO))
+       /* Stop the PWM generation timer */
+       TCCR3B = 0;
+       #endif
+
+       #if defined(AUDIO_OUT_MONO)
+       /* Set speaker as input to reduce current draw */
+       DDRC  &= ~(1 << 6);
+       #elif defined(AUDIO_OUT_STEREO)
+       /* Set speakers as inputs to reduce current draw */
+       DDRC  &= ~((1 << 6) | (1 << 5));
+       #elif defined(AUDIO_OUT_PORTC)
+       /* Set PORTC low */
+       PORTC = 0x00;
+       #endif
+}
+
+/** Event handler for the library USB Configuration Changed event. */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       bool ConfigSuccess = true;
+
+       ConfigSuccess &= Audio_Device_ConfigureEndpoints(&Speaker_Audio_Interface);
+
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
+}
+
+/** Event handler for the library USB Control Request reception event. */
+void EVENT_USB_Device_ControlRequest(void)
+{
+       Audio_Device_ProcessControlRequest(&Speaker_Audio_Interface);
+}
+