Added USB Missle Launcher project, submitted by Dave Fletcher.
[pub/lufa.git] / Projects / MissleLauncher / MissileLauncher.c
diff --git a/Projects/MissleLauncher/MissileLauncher.c b/Projects/MissleLauncher/MissileLauncher.c
new file mode 100644 (file)
index 0000000..cb12e2a
--- /dev/null
@@ -0,0 +1,317 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+          USB Missle Launcher Demo\r
+        Copyright (C) Dave Fletcher, 2009.\r
+         fletch at fletchtronics dot net\r
+ */\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2009  Dave Fletcher (fletch [at] fletchtronics [dot] net)\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
+ *  Missle Launcher host. This is a host driver for the popular USB-controller table top toy missle launchers,\r
+ *  which can typically aim and fire small foam "missles" from a spring-loaded turret. This project controls the\r
+ *  launcher via a joystick and button to aim and fire missles at targets without a PC.\r
+ */\r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the MissileLauncher application. This file contains the main tasks of\r
+ *  the application and is responsible for the initial application hardware configuration as well\r
+ *  as the sending of commands to the attached launcher toy.\r
+ */\r
\r
+#include "MissileLauncher.h"\r
+\r
+/** Command constants */\r
+uint8_t CMD_INITA[8]     = {  85, 83, 66, 67,  0,  0,  4,  0  };\r
+uint8_t CMD_INITB[8]     = {  85, 83, 66, 67,  0, 64,  2,  0  };\r
+uint8_t CMD_STOP[8]      = {   0,  0,  0,  0,  0,  0,  8,  8  };\r
+uint8_t CMD_LEFT[8]      = {   0,  1,  0,  0,  0,  0,  8,  8  };\r
+uint8_t CMD_RIGHT[8]     = {   0,  0,  1,  0,  0,  0,  8,  8  };\r
+uint8_t CMD_UP[8]        = {   0,  0,  0,  1,  0,  0,  8,  8  };\r
+uint8_t CMD_DOWN[8]      = {   0,  0,  0,  0,  1,  0,  8,  8  };\r
+uint8_t CMD_LEFTUP[8]    = {   0,  1,  0,  1,  0,  0,  8,  8  };\r
+uint8_t CMD_RIGHTUP[8]   = {   0,  0,  1,  1,  0,  0,  8,  8  };\r
+uint8_t CMD_LEFTDOWN[8]  = {   0,  1,  0,  0,  1,  0,  8,  8  };\r
+uint8_t CMD_RIGHTDOWN[8] = {   0,  0,  1,  0,  1,  0,  8,  8  };\r
+uint8_t CMD_FIRE[8]      = {   0,  0,  0,  0,  0,  1,  8,  8  };\r
+\r
+uint8_t *CmdState;\r
+uint8_t CmdBuffer[LAUNCHER_CMD_BUFFER_SIZE];\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
+       SetupHardware();\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+       \r
+       CmdState = CMD_STOP;\r
+\r
+       for (;;)\r
+       {\r
+               Read_Joystick_Status();\r
+       \r
+               HID_Host_Task();\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
+       Joystick_Init();\r
+       Buttons_Init();\r
+}\r
+\r
+/** Reads the joystick and button status, sending commands to the launcher as needed. */\r
+void Read_Joystick_Status(void)\r
+{\r
+       uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
+\r
+       if (BUTTONS_BUTTON1 && Buttons_GetStatus())\r
+         Send_Command(CMD_FIRE);\r
+       else if (JoyStatus_LCL & JOY_UP)\r
+         Send_Command(CMD_UP);\r
+       else if (JoyStatus_LCL & JOY_DOWN)\r
+         Send_Command(CMD_DOWN);\r
+       else if (JoyStatus_LCL & JOY_LEFT)\r
+         Send_Command(CMD_LEFT);\r
+       else if (JoyStatus_LCL & JOY_RIGHT)\r
+         Send_Command(CMD_RIGHT);\r
+       else if (CmdState != CMD_STOP)\r
+         Send_Command(CMD_STOP);\r
+}\r
+\r
+/** Lower level send routine, copies report into a larger buffer and sends.\r
+ *\r
+ *  \param Report  Report data to send.\r
+ *  \param ReportSize  Report length in bytes.\r
+ */\r
+void Send_Command_Report(uint8_t *Report, uint16_t ReportSize)\r
+{\r
+       memcpy(CmdBuffer, Report, 8);\r
+       WriteNextReport(CmdBuffer, ReportSize);\r
+}\r
+\r
+/** Send one of the CMD_* command constants listed above.\r
+ *\r
+ *  \param Command  One of the command constants.\r
+ */\r
+void Send_Command(uint8_t* Command)\r
+{\r
+       if ((CmdState == CMD_STOP && Command != CMD_STOP) ||\r
+               (CmdState != CMD_STOP && Command == CMD_STOP))\r
+       {\r
+               LEDs_ChangeLEDs(LEDS_LED4, ~LEDs_GetLEDs() & LEDS_LED4);\r
+\r
+               Send_Command_Report(CMD_INITA, 8);\r
+               Send_Command_Report(CMD_INITB, 8);\r
+               Send_Command_Report(Command, LAUNCHER_CMD_BUFFER_SIZE);\r
+       }\r
+       \r
+       CmdState = Command;\r
+}\r
+\r
+/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
+ *  starts the library USB task to begin the enumeration and USB management process.\r
+ */\r
+void EVENT_USB_DeviceAttached(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+}\r
+\r
+/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
+ *  stops the library USB task management process.\r
+ */\r
+void EVENT_USB_DeviceUnattached(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+}\r
+\r
+/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
+ *  enumerated by the host and is now ready to be used by the application.\r
+ */\r
+void EVENT_USB_DeviceEnumerationComplete(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+}\r
+\r
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
+void EVENT_USB_HostError(const uint8_t ErrorCode)\r
+{\r
+       USB_ShutDown();\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       for(;;);\r
+}\r
+\r
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
+ *  enumerating an attached USB device.\r
+ */\r
+void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+}\r
+\r
+/** Reads in and discards the next report from the attached device. */\r
+void DiscardNextReport(void)\r
+{\r
+       /* Select and unfreeze HID data IN pipe */\r
+       Pipe_SelectPipe(HID_DATA_IN_PIPE);\r
+       Pipe_Unfreeze();\r
+\r
+       /* Check to see if a packet has been received */\r
+       if (!(Pipe_IsINReceived()))\r
+       {\r
+               /* Refreeze HID data IN pipe */\r
+               Pipe_Freeze();\r
+                       \r
+               return;\r
+       }\r
+               \r
+       /* Clear the IN endpoint, ready for next data packet */\r
+       Pipe_ClearIN();\r
+       \r
+       /* Refreeze HID data IN pipe */\r
+       Pipe_Freeze();\r
+}\r
+\r
+/** Writes a report to the attached device.\r
+ *\r
+ *  \param ReportOUTData  Buffer containing the report to send to the device\r
+ *  \param ReportLength  Length of the report to send\r
+ */\r
+void WriteNextReport(uint8_t* ReportOUTData, uint16_t ReportLength)\r
+{\r
+       /* Select and unfreeze HID data OUT pipe */\r
+       Pipe_SelectPipe(HID_DATA_OUT_PIPE);\r
+       \r
+       /* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the\r
+        * control endpoint instead) - check to see if the OUT endpoint has been initialized */\r
+       if (Pipe_IsConfigured())\r
+       {\r
+               Pipe_Unfreeze();\r
+\r
+               /* Ensure pipe is ready to be written to before continuing */\r
+               if (!(Pipe_IsOUTReady()))\r
+               {\r
+                       /* Refreeze the data OUT pipe */\r
+                       Pipe_Freeze();\r
+                       \r
+                       return;\r
+               }\r
+               \r
+               /* Write out HID report data */\r
+               Pipe_Write_Stream_LE(ReportOUTData, ReportLength);                              \r
+                       \r
+               /* Clear the OUT endpoint, send last data packet */\r
+               Pipe_ClearOUT();\r
+\r
+               /* Refreeze the data OUT pipe */\r
+               Pipe_Freeze();\r
+       }\r
+       else\r
+       {\r
+               /* Class specific request to send a HID report to the device */\r
+               USB_ControlRequest = (USB_Request_Header_t)\r
+                       {\r
+                               .bmRequestType = 0x21,\r
+                               .bRequest      = 0x09,\r
+                               .wValue        = 0x02,\r
+                               .wIndex        = 0x01,\r
+                               .wLength       = ReportLength,\r
+                       };\r
+\r
+               /* Select the control pipe for the request transfer */\r
+               Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
+               /* Send the request to the device */\r
+               USB_Host_SendControlRequest(ReportOUTData);\r
+       }\r
+}\r
+\r
+/** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
+ *  HID reports from the device and to send reports if desired.\r
+ */\r
+void HID_Host_Task(void)\r
+{\r
+       uint8_t ErrorCode;\r
+\r
+       /* Switch to determine what user-application handled host state the host state machine is in */\r
+       switch (USB_HostState)\r
+       {\r
+               case HOST_STATE_Addressed:\r
+                       /* Get and process the configuration descriptor data */\r
+                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
+                       {\r
+                               /* Indicate error status */\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+\r
+                               /* Wait until USB device disconnected */\r
+                               while (USB_IsConnected);\r
+                               break;\r
+                       }\r
+\r
+                       /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */\r
+                       if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)\r
+                       {\r
+                               /* Indicate error status */\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                               \r
+                               /* Wait until USB device disconnected */\r
+                               while (USB_IsConnected);\r
+                               break;\r
+                       }\r
+                       \r
+                       USB_HostState = HOST_STATE_Configured;\r
+                       break;\r
+               case HOST_STATE_Configured:\r
+                       USB_HostState = HOST_STATE_Ready;\r
+                       break;\r
+               case HOST_STATE_Ready:\r
+                       DiscardNextReport();\r
+\r
+                       break;\r
+       }\r
+}\r