Add tag for the 120219 release.
[pub/USBasp.git] / Demos / Device / Incomplete / Sideshow / Sideshow.h
index 7b88182..71ebe3f 100644 (file)
@@ -1,64 +1,79 @@
-/*\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
-#ifndef _SIDESHOW_H_\r
-#define _SIDESHOW_H_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/wdt.h>\r
-\r
-               #include "Descriptors.h"\r
-               #include "SideshowCommands.h"\r
-\r
-               #include <LUFA/Version.h>                    // Library Version Information\r
-               #include <LUFA/Common/ButtLoadTag.h>         // PROGMEM tags readable by the ButtLoad project\r
-               #include <LUFA/Drivers/USB/USB.h>            // USB Functionality\r
-               #include <LUFA/Drivers/Board/HWB.h>          // HWB button driver\r
-               #include <LUFA/Drivers/Board/LEDs.h>         // LEDs driver\r
-               #include <LUFA/Drivers/Board/Dataflash.h>    // Dataflash chip driver\r
-               #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management\r
-               #include <LUFA/Drivers/AT90USBXXX/Serial_Stream.h> // Serial stream driver\r
-\r
-       /* Macros: */\r
-               #define REQ_GetOSFeatureDescriptor        0x01\r
-               \r
-               #define EXTENDED_COMPAT_ID_DESCRIPTOR     0x0004\r
-\r
-       /* Task Definitions: */\r
-               TASK(USB_Sideshow);\r
-               \r
-       /* Event Handlers: */\r
-               HANDLES_EVENT(USB_Connect);\r
-               HANDLES_EVENT(USB_Disconnect);\r
-               HANDLES_EVENT(USB_ConfigurationChanged);\r
-               HANDLES_EVENT(USB_UnhandledControlPacket);\r
-\r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  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.
+*/
+
+#ifndef _SIDESHOW_H_
+#define _SIDESHOW_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/wdt.h>
+               #include <avr/power.h>
+               #include <avr/interrupt.h>
+
+               #include "Descriptors.h"
+               #include "Lib/SideshowCommands.h"
+
+               #include <LUFA/Version.h>
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/Board/LEDs.h>
+               #include <LUFA/Drivers/Peripheral/Serial.h>
+
+       /* Macros: */
+               /** Device control request for used in the Microsoft OS Descriptor for retrieving the OS Feature
+                *  descriptors of the device.
+                */
+               #define REQ_GetOSFeatureDescriptor        0x01
+
+               /** Descriptor index for a Microsoft Proprietary Extended Device Compatibility descriptor. */
+               #define EXTENDED_COMPAT_ID_DESCRIPTOR     0x0004
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
+               #define LEDMASK_USB_NOTREADY              LEDS_LED1
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
+               #define LEDMASK_USB_ENUMERATING          (LEDS_LED2 | LEDS_LED3)
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
+               #define LEDMASK_USB_READY                (LEDS_LED2 | LEDS_LED4)
+
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
+               #define LEDMASK_USB_ERROR                (LEDS_LED1 | LEDS_LED3)
+
+       /* Function Prototypes: */
+               void SetupHardware(void);
+               void SideShow_Task(void);
+
+               void EVENT_USB_Device_Connect(void);
+               void EVENT_USB_Device_Disconnect(void);
+               void EVENT_USB_Device_ConfigurationChanged(void);
+               void EVENT_USB_Device_ControlRequest(void);
+
+#endif
+