Documentation improvements - put driver example code into its own section, fix incorr...
[pub/USBasp.git] / Demos / Device / Incomplete / Sideshow / Sideshow.c
index c963359..8115cdb 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
-/*\r
-       SideShow Class demonstration application. This give a reference\r
-       for implementing Microsoft SideShow compatible devices in an\r
-       embedded environment. SideShow allows for gadget data displayed\r
-       on a Vista machine to also be displayed on an externally connected\r
-       interactive display. Upon enumeration on a Vista system, this will\r
-       appear as a new SideShow device which can have gadgets loaded onto\r
-       it.\r
-       \r
-       Note that while the incomming content is buffered in packet struct\r
-       form, the data is not actually displayed. It is left to the user to\r
-       write sufficient code to read out the packed data for display to a\r
-       screen.\r
-       \r
-       Installed gadgets can be accessed through the InstalledApplications\r
-       array, with entries that have their InUse flag set being active. As\r
-       only the active content is displayed on the device due to memory\r
-       constraints, new content can be requested as needed.\r
-*/\r
-\r
-/*\r
-       USB Mode:           Device\r
-       USB Class:          Sideshow Device (Microsoft Only)\r
-       USB Subclass:       Bulk Only\r
-       Relevant Standards: Microsoft Sideshow Specification\r
-                           Microsoft OS Descriptors Specification\r
-                           XML Specification\r
-       Usable Speeds:      Full Speed Mode\r
-*/\r
-\r
-#include "Sideshow.h"\r
-\r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,     "LUFA Sideshow 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_Sideshow         , TaskStatus: TASK_STOP },\r
-};\r
-\r
-int main(void)\r
-{\r
-       /* Disable watchdog if enabled by bootloader/fuses */\r
-       MCUSR &= ~(1 << WDRF);\r
-       wdt_disable();\r
-\r
-       /* Disable Clock Division */\r
-       SetSystemClockPrescaler(0);\r
-\r
-       /* Hardware Initialization */\r
-       SerialStream_Init(9600, false);\r
-       LEDs_Init();\r
-       HWB_Init();\r
-       \r
-       /* Indicate USB not ready */\r
-       LEDs_SetAllLEDs(LEDS_LED1 | LEDS_LED3);\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
-EVENT_HANDLER(USB_Connect)\r
-{\r
-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r
-       /* Indicate USB enumerating */\r
-       LEDs_SetAllLEDs(LEDS_LED1 | LEDS_LED4);\r
-}\r
-\r
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
-       /* Stop running mass storage and USB management tasks */\r
-       Scheduler_SetTaskMode(USB_Sideshow, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-\r
-       /* Indicate USB not ready */\r
-       LEDs_SetAllLEDs(LEDS_LED1 | LEDS_LED3);\r
-}\r
-\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
-       /* Setup Sideshow In and Out Endpoints */\r
-       Endpoint_ConfigureEndpoint(SIDESHOW_IN_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_IN, SIDESHOW_IO_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(SIDESHOW_OUT_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_OUT, SIDESHOW_IO_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Indicate USB connected and ready */\r
-       LEDs_SetAllLEDs(LEDS_LED2 | LEDS_LED4);\r
-       \r
-       /* Start Sideshow task */\r
-       Scheduler_SetTaskMode(USB_Sideshow, TASK_RUN);\r
-}\r
-\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
-{\r
-       /* Process UFI specific control requests */\r
-       switch (bRequest)\r
-       {\r
-               case REQ_GetOSFeatureDescriptor:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))\r
-                       {\r
-                               uint16_t wValue  = Endpoint_Read_Word_LE();\r
-                               uint16_t wIndex  = Endpoint_Read_Word_LE();\r
-                               uint16_t wLength = Endpoint_Read_Word_LE();\r
-\r
-                               void*    DescriptorPointer;\r
-                               uint16_t DescriptorSize;\r
-\r
-                               bool     SendZLP = true;\r
-                               \r
-                               if (!(USB_GetOSFeatureDescriptor(wValue, wIndex, &DescriptorPointer, &DescriptorSize)))\r
-                                 return;\r
-\r
-                               Endpoint_ClearSetupReceived();\r
-                               \r
-                               if (wLength > DescriptorSize)\r
-                                 wLength = DescriptorSize;\r
-                               \r
-                               while (wLength && (!(Endpoint_IsSetupOUTReceived())))\r
-                               {\r
-                                       while (!(Endpoint_IsSetupINReady()));\r
-                                       \r
-                                       while (wLength && (Endpoint_BytesInEndpoint() < USB_ControlEndpointSize))\r
-                                       {\r
-                                               #if defined(USE_RAM_DESCRIPTORS)\r
-                                               Endpoint_Write_Byte(*((uint8_t*)DescriptorPointer++));\r
-                                               #elif defined (USE_EEPROM_DESCRIPTORS)\r
-                                               Endpoint_Write_Byte(eeprom_read_byte(DescriptorPointer++));                     \r
-                                               #else\r
-                                               Endpoint_Write_Byte(pgm_read_byte(DescriptorPointer++));\r
-                                               #endif\r
-                                               \r
-                                               wLength--;\r
-                                       }\r
-                                       \r
-                                       SendZLP = (Endpoint_BytesInEndpoint() == USB_ControlEndpointSize);\r
-                                       Endpoint_ClearSetupIN();\r
-                               }\r
-                               \r
-                               if (Endpoint_IsSetupOUTReceived())\r
-                               {\r
-                                       Endpoint_ClearSetupOUT();\r
-                                       return;\r
-                               }\r
-                               \r
-                               if (SendZLP)\r
-                               {\r
-                                       while (!(Endpoint_IsSetupINReady()));\r
-                                       Endpoint_ClearSetupIN();\r
-                               }\r
-\r
-                               while (!(Endpoint_IsSetupOUTReceived()));\r
-                               Endpoint_ClearSetupOUT();                               \r
-                       }\r
-\r
-                       break;\r
-       }\r
-}\r
-       \r
-TASK(USB_Sideshow)\r
-{\r
-       /* Check if the USB System is connected to a Host */\r
-       if (USB_IsConnected)\r
-       {\r
-               /* Select the SideShow data out endpoint */\r
-               Endpoint_SelectEndpoint(SIDESHOW_OUT_EPNUM);\r
-               \r
-               /* Check to see if a new SideShow message has been received */\r
-               if (Endpoint_ReadWriteAllowed())\r
-               {\r
-                       /* Process the received SideShow message */\r
-                       Sideshow_ProcessCommandPacket();\r
-               }\r
-       }\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.
+*/
+
+/*
+       SideShow Class demonstration application. This give a reference
+       for implementing Microsoft SideShow compatible devices in an
+       embedded environment. SideShow allows for gadget data displayed
+       on a Windows Vista or later machine to also be displayed on an
+       externally connected interactive display. Upon enumeration, this will
+       appear as a new SideShow device which can have gadgets loaded onto
+       it.
+
+       Note that while the incoming content is buffered in packet struct
+       form, the data is not actually displayed. It is left to the user to
+       write sufficient code to read out the packed data for display to a
+       screen.
+
+       Installed gadgets can be accessed through the InstalledApplications
+       array, with entries that have their InUse flag set being active. As
+       only the active content is displayed on the device due to memory
+       constraints, new content can be requested as needed.
+*/
+
+#include "Sideshow.h"
+
+/** 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 (;;)
+       {
+               SideShow_Task();
+               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();
+       SerialStream_Init(9600, false);
+}
+
+void EVENT_USB_Device_Connect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+}
+
+void EVENT_USB_Device_Disconnect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+}
+
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       bool ConfigSuccess = true;
+
+       /* Setup Sideshow Data Endpoints */
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(SIDESHOW_IN_EPNUM,  EP_TYPE_BULK, ENDPOINT_DIR_IN,
+                                                   SIDESHOW_IO_EPSIZE, ENDPOINT_BANK_SINGLE);
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(SIDESHOW_OUT_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
+                                                   SIDESHOW_IO_EPSIZE, ENDPOINT_BANK_SINGLE);
+
+       /* Indicate endpoint configuration success or failure */
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
+}
+
+void EVENT_USB_Device_ControlRequest(void)
+{
+       switch (USB_ControlRequest.bRequest)
+       {
+               case REQ_GetOSFeatureDescriptor:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))
+                       {
+                               const void* DescriptorPointer;
+                               uint16_t    DescriptorSize = USB_GetOSFeatureDescriptor(USB_ControlRequest.wValue,
+                                                                                       USB_ControlRequest.wIndex,
+                                                                                       &DescriptorPointer);
+
+                               if (DescriptorSize == NO_DESCRIPTOR)
+                                 return;
+
+                               Endpoint_ClearSETUP();
+
+                               Endpoint_Write_Control_PStream_LE(DescriptorPointer, DescriptorSize);
+                               Endpoint_ClearOUT();
+                       }
+
+                       break;
+       }
+}
+
+void SideShow_Task(void)
+{
+       /* Device must be connected and configured for the task to run */
+       if (USB_DeviceState != DEVICE_STATE_Configured)
+         return;
+
+       /* Select the SideShow data out endpoint */
+       Endpoint_SelectEndpoint(SIDESHOW_OUT_EPNUM);
+
+       /* Check to see if a new SideShow message has been received */
+       if (Endpoint_IsReadWriteAllowed())
+       {
+               /* Process the received SideShow message */
+               Sideshow_ProcessCommandPacket();
+       }
+}
+