Moved all source to the trunk directory.
[pub/lufa.git] / Demos / KeyboardMouse / KeyboardMouse.c
diff --git a/Demos/KeyboardMouse/KeyboardMouse.c b/Demos/KeyboardMouse/KeyboardMouse.c
new file mode 100644 (file)
index 0000000..383c66a
--- /dev/null
@@ -0,0 +1,369 @@
+/*\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
+  Copyright 2009  Denver Gingerich (denver [at] ossguy [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 KeyboardMouse demo. This file contains the main tasks of the demo and\r
+ *  is responsible for the initial application hardware configuration.\r
+ */\r
\r
+#include "KeyboardMouse.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "LUFA MouseKBD 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_Mouse                 , TaskStatus: TASK_RUN },\r
+       { Task: USB_Keyboard              , TaskStatus: TASK_RUN },\r
+};\r
+\r
+/* Global Variables */\r
+/** Global structure to hold the current keyboard interface HID report, for transmission to the host */\r
+USB_KeyboardReport_Data_t KeyboardReportData;\r
+\r
+/** Global structure to hold the current mouse interface HID report, for transmission to the host */\r
+USB_MouseReport_Data_t    MouseReportData;\r
+\r
+/** Main program entry point. This routine configures the hardware required by the application, then\r
+ *  starts the scheduler to run the USB management task.\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
+       Joystick_Init();\r
+       LEDs_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 task.\r
+ */\r
+EVENT_HANDLER(USB_Disconnect)\r
+{\r
+       /* Stop running HID reporting and USB management tasks */\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 sets the current configuration\r
+ *  of the USB device after enumeration, and configures the keyboard and mouse device endpoints.\r
+ */\r
+EVENT_HANDLER(USB_ConfigurationChanged)\r
+{\r
+       /* Setup Keyboard Report Endpoint */\r
+       Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT,\r
+                                      ENDPOINT_DIR_IN, HID_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       /* Setup Keyboard LED Report Endpoint */\r
+       Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT,\r
+                                      ENDPOINT_DIR_OUT, HID_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       /* Setup Mouse Report Endpoint */\r
+       Endpoint_ConfigureEndpoint(MOUSE_IN_EPNUM, EP_TYPE_INTERRUPT,\r
+                                      ENDPOINT_DIR_IN, HID_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       /* Indicate USB connected and ready */\r
+       UpdateStatus(Status_USBReady);\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
+       uint8_t* ReportData;\r
+       uint8_t  ReportSize;\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
+                               Endpoint_Ignore_Word();\r
+                       \r
+                               uint16_t wIndex = Endpoint_Read_Word_LE();\r
+                               \r
+                               /* Determine if it is the mouse or the keyboard data that is being requested */\r
+                               if (!(wIndex))\r
+                               {\r
+                                       ReportData = (uint8_t*)&KeyboardReportData;\r
+                                       ReportSize = sizeof(KeyboardReportData);\r
+                               }\r
+                               else\r
+                               {\r
+                                       ReportData = (uint8_t*)&MouseReportData;\r
+                                       ReportSize = sizeof(MouseReportData);\r
+                               }\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 > ReportSize)\r
+                                 wLength = ReportSize;\r
+\r
+                               Endpoint_ClearSetupReceived();\r
+       \r
+                               /* Write the report data to the control endpoint */\r
+                               Endpoint_Write_Control_Stream_LE(ReportData, wLength);\r
+\r
+                               /* Clear the report data afterwards */\r
+                               memset(ReportData, 0, ReportSize);\r
+                               \r
+                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
+                               Endpoint_ClearSetupOUT();\r
+                       }\r
+               \r
+                       break;\r
+               case REQ_SetReport:\r
+                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               Endpoint_ClearSetupReceived();\r
+                               \r
+                               /* Wait until the LED report has been sent by the host */\r
+                               while (!(Endpoint_IsSetupOUTReceived()));\r
+\r
+                               /* Read in the LED report from the host */\r
+                               uint8_t LEDStatus = Endpoint_Read_Byte();\r
+                               uint8_t LEDMask   = LEDS_LED2;\r
+                               \r
+                               if (LEDStatus & 0x01) // NUM Lock\r
+                                 LEDMask |= LEDS_LED1;\r
+                               \r
+                               if (LEDStatus & 0x02) // CAPS Lock\r
+                                 LEDMask |= LEDS_LED3;\r
+\r
+                               if (LEDStatus & 0x04) // SCROLL Lock\r
+                                 LEDMask |= LEDS_LED4;\r
+\r
+                               /* Set the status LEDs to the current HID LED status */\r
+                               LEDs_SetAllLEDs(LEDMask);\r
+\r
+                               /* Clear the endpoint data */\r
+                               Endpoint_ClearSetupOUT();\r
+\r
+                               /* Wait until the host is ready to receive the request confirmation */\r
+                               while (!(Endpoint_IsSetupINReady()));\r
+                               \r
+                               /* Handshake the request by sending an empty IN packet */\r
+                               Endpoint_ClearSetupIN();\r
+                       }\r
+                       \r
+                       break;\r
+       }\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 KeyboardMouse_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
+/** Keyboard task. This generates the next keyboard HID report for the host, and transmits it via the\r
+ *  keyboard IN endpoint when the host is ready for more data. Additionally, it processes host LED status\r
+ *  reports sent to the device via the keyboard OUT reporting endpoint.\r
+ */\r
+TASK(USB_Keyboard)\r
+{\r
+       uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
+\r
+       /* Check if HWB is not pressed, if so mouse mode enabled */\r
+       if (!(HWB_GetStatus()))\r
+       {\r
+               if (JoyStatus_LCL & JOY_UP)\r
+                 KeyboardReportData.KeyCode[0] = 0x04; // A\r
+               else if (JoyStatus_LCL & JOY_DOWN)\r
+                 KeyboardReportData.KeyCode[0] = 0x05; // B\r
+\r
+               if (JoyStatus_LCL & JOY_LEFT)\r
+                 KeyboardReportData.KeyCode[0] = 0x06; // C\r
+               else if (JoyStatus_LCL & JOY_RIGHT)\r
+                 KeyboardReportData.KeyCode[0] = 0x07; // D\r
+\r
+               if (JoyStatus_LCL & JOY_PRESS)\r
+                 KeyboardReportData.KeyCode[0] = 0x08; // E\r
+       }\r
+       \r
+       /* Check if the USB system is connected to a host and report protocol mode is enabled */\r
+       if (USB_IsConnected)\r
+       {\r
+               /* Select the Keyboard Report Endpoint */\r
+               Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);\r
+\r
+               /* Check if Keyboard Endpoint Ready for Read/Write */\r
+               if (Endpoint_ReadWriteAllowed())\r
+               {\r
+                       /* Write Keyboard Report Data */\r
+                       Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
+\r
+                       /* Finalize the stream transfer to send the last packet */\r
+                       Endpoint_ClearCurrentBank();\r
+\r
+                       /* Clear the report data afterwards */\r
+                       memset(&KeyboardReportData, 0, sizeof(KeyboardReportData));\r
+               }\r
+\r
+               /* Select the Keyboard LED Report Endpoint */\r
+               Endpoint_SelectEndpoint(KEYBOARD_OUT_EPNUM);\r
+\r
+               /* Check if Keyboard LED Endpoint Ready for Read/Write */\r
+               if (Endpoint_ReadWriteAllowed())\r
+               {               \r
+                       /* Read in the LED report from the host */\r
+                       uint8_t LEDStatus = Endpoint_Read_Byte();\r
+                       uint8_t LEDMask   = LEDS_LED2;\r
+                       \r
+                       if (LEDStatus & 0x01) // NUM Lock\r
+                         LEDMask |= LEDS_LED1;\r
+                       \r
+                       if (LEDStatus & 0x02) // CAPS Lock\r
+                         LEDMask |= LEDS_LED3;\r
+\r
+                       if (LEDStatus & 0x04) // SCROLL Lock\r
+                         LEDMask |= LEDS_LED4;\r
+\r
+                       /* Set the status LEDs to the current Keyboard LED status */\r
+                       LEDs_SetAllLEDs(LEDMask);\r
+\r
+                       /* Handshake the OUT Endpoint - clear endpoint and ready for next report */\r
+                       Endpoint_ClearCurrentBank();\r
+               }\r
+       }\r
+}\r
+\r
+/** Mouse task. This generates the next mouse HID report for the host, and transmits it via the\r
+ *  mouse IN endpoint when the host is ready for more data.\r
+ */\r
+TASK(USB_Mouse)\r
+{\r
+       uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
+\r
+       /* Check if HWB is pressed, if so mouse mode enabled */\r
+       if (HWB_GetStatus())\r
+       {\r
+               if (JoyStatus_LCL & JOY_UP)\r
+                 MouseReportData.Y =  1;\r
+               else if (JoyStatus_LCL & JOY_DOWN)\r
+                 MouseReportData.Y = -1;\r
+\r
+               if (JoyStatus_LCL & JOY_RIGHT)\r
+                 MouseReportData.X =  1;\r
+               else if (JoyStatus_LCL & JOY_LEFT)\r
+                 MouseReportData.X = -1;\r
+\r
+               if (JoyStatus_LCL & JOY_PRESS)\r
+                 MouseReportData.Button  = (1 << 0);\r
+       }\r
+\r
+       /* Check if the USB system is connected to a host and report protocol mode is enabled */\r
+       if (USB_IsConnected)\r
+       {\r
+               /* Select the Mouse Report Endpoint */\r
+               Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);\r
+\r
+               /* Check if Mouse Endpoint Ready for Read/Write */\r
+               if (Endpoint_ReadWriteAllowed())\r
+               {\r
+                       /* Write Mouse Report Data */\r
+                       Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));\r
+\r
+                       /* Finalize the stream transfer to send the last packet */\r
+                       Endpoint_ClearCurrentBank();\r
+\r
+                       /* Clear the report data afterwards */\r
+                       memset(&MouseReportData, 0, sizeof(MouseReportData));\r
+               }\r
+       }\r
+}\r