Seperated out OTG, Device and Host mode demos into seperate folders for clarity....
[pub/lufa.git] / Demos / Device / Joystick / Joystick.c
diff --git a/Demos/Device/Joystick/Joystick.c b/Demos/Device/Joystick/Joystick.c
new file mode 100644 (file)
index 0000000..cd88227
--- /dev/null
@@ -0,0 +1,264 @@
+/*\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 Joystick demo. This file contains the main tasks of the demo and\r
+ *  is responsible for the initial application hardware configuration.\r
+ */\r
+\r
+#include "Joystick.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "LUFA Joystick 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_Joystick_Report  , TaskStatus: TASK_STOP },\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
+ */\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
+       clock_prescale_set(clock_div_1);\r
+\r
+       /* Hardware Initialization */\r
+       Joystick_Init();\r
+       LEDs_Init();\r
+       HWB_Init();\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
+/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
+ *  starts the library USB task to begin the enumeration and USB management process.\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
+       UpdateStatus(Status_USBEnumerating);\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 and stops the USB management and joystick reporting tasks.\r
+ */\r
+EVENT_HANDLER(USB_Disconnect)\r
+{\r
+       /* Stop running joystick reporting and USB management tasks */\r
+       Scheduler_SetTaskMode(USB_Joystick_Report, 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 and the joystick reporting task started.\r
+ */ \r
+EVENT_HANDLER(USB_ConfigurationChanged)\r
+{\r
+       /* Setup Joystick Report Endpoint */\r
+       Endpoint_ConfigureEndpoint(JOYSTICK_EPNUM, EP_TYPE_INTERRUPT,\r
+                                      ENDPOINT_DIR_IN, JOYSTICK_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       /* Indicate USB connected and ready */\r
+       UpdateStatus(Status_USBReady);\r
+\r
+       /* Start joystick reporting task */\r
+       Scheduler_SetTaskMode(USB_Joystick_Report, TASK_RUN);\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 HID commands, which are\r
+ *  all issued via the control endpoint), so that they can be handled appropriately for the application.\r
+ */\r
+EVENT_HANDLER(USB_UnhandledControlPacket)\r
+{\r
+       /* Handle HID Class specific requests */\r
+       switch (bRequest)\r
+       {\r
+               case REQ_GetReport:\r
+                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               USB_JoystickReport_Data_t JoystickReportData;\r
+                               \r
+                               /* Create the next HID report to send to the host */                            \r
+                               GetNextReport(&JoystickReportData);\r
+\r
+                               /* Ignore report type and ID number value */\r
+                               Endpoint_Discard_Word();\r
+                               \r
+                               /* Ignore unused Interface number value */\r
+                               Endpoint_Discard_Word();\r
+\r
+                               /* Read in the number of bytes in the report to send to the host */\r
+                               uint16_t wLength = Endpoint_Read_Word_LE();\r
+                               \r
+                               /* If trying to send more bytes than exist to the host, clamp the value at the report size */\r
+                               if (wLength > sizeof(JoystickReportData))\r
+                                 wLength = sizeof(JoystickReportData);\r
+\r
+                               Endpoint_ClearSetupReceived();\r
+       \r
+                               /* Write the report data to the control endpoint */\r
+                               Endpoint_Write_Control_Stream_LE(&JoystickReportData, wLength);\r
+                               \r
+                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
+                               Endpoint_ClearSetupOUT();\r
+                       }\r
+               \r
+                       break;\r
+       }\r
+}\r
+\r
+/** Fills the given HID report data structure with the next HID report to send to the host.\r
+ *\r
+ *  \param ReportData  Pointer to a HID report data structure to be filled\r
+ *\r
+ *  \return Boolean true if the new report differs from the last report, false otherwise\r
+ */\r
+bool GetNextReport(USB_JoystickReport_Data_t* ReportData)\r
+{\r
+       static uint8_t PrevJoyStatus = 0;\r
+       uint8_t        JoyStatus_LCL        = Joystick_GetStatus();\r
+       bool           InputChanged         = false;\r
+\r
+       /* Clear the report contents */\r
+       memset(ReportData, 0, sizeof(USB_JoystickReport_Data_t));\r
+\r
+       if (JoyStatus_LCL & JOY_UP)\r
+         ReportData->Y = -100;\r
+       else if (JoyStatus_LCL & JOY_DOWN)\r
+         ReportData->Y =  100;\r
+\r
+       if (JoyStatus_LCL & JOY_RIGHT)\r
+         ReportData->X =  100;\r
+       else if (JoyStatus_LCL & JOY_LEFT)\r
+         ReportData->X = -100;\r
+\r
+       if (JoyStatus_LCL & JOY_PRESS)\r
+         ReportData->Button  = (1 << 1);\r
+         \r
+       if (HWB_GetStatus())\r
+         ReportData->Button |= (1 << 0);\r
+         \r
+       /* Check if the new report is different to the previous report */\r
+       InputChanged = (uint8_t)(PrevJoyStatus ^ JoyStatus_LCL);\r
+\r
+       /* Save the current joystick status for later comparison */\r
+       PrevJoyStatus = JoyStatus_LCL;\r
+\r
+       /* Return whether the new report is different to the previous report or not */\r
+       return InputChanged;\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 Joystick_StatusCodes_t enum\r
+ */\r
+void UpdateStatus(uint8_t CurrentStatus)\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
+       \r
+       /* Set the board LEDs to the new LED mask */\r
+       LEDs_SetAllLEDs(LEDMask);\r
+}\r
+\r
+/** Function to manage HID report generation and transmission to the host. */\r
+TASK(USB_Joystick_Report)\r
+{\r
+       /* Check if the USB System is connected to a Host */\r
+       if (USB_IsConnected)\r
+       {\r
+               /* Select the Joystick Report Endpoint */\r
+               Endpoint_SelectEndpoint(JOYSTICK_EPNUM);\r
+\r
+               /* Check if Joystick Endpoint Ready for Read/Write */\r
+               if (Endpoint_ReadWriteAllowed())\r
+               {\r
+                       USB_JoystickReport_Data_t JoystickReportData;\r
+                       \r
+                       /* Create the next HID report to send to the host */\r
+                       GetNextReport(&JoystickReportData);\r
+               \r
+                       /* Write Joystick Report Data */\r
+                       Endpoint_Write_Stream_LE(&JoystickReportData, sizeof(JoystickReportData));\r
+\r
+                       /* Finalize the stream transfer to send the last packet */\r
+                       Endpoint_ClearCurrentBank();\r
+                       \r
+                       /* Clear the report data afterwards */\r
+                       JoystickReportData.X      = 0;\r
+                       JoystickReportData.Y      = 0;\r
+                       JoystickReportData.Button = 0;\r
+               }\r
+       }\r
+}\r