Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Device / LowLevel / Keyboard / Keyboard.c
index e27b228..2d5e366 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  Denver Gingerich (denver [at] ossguy [dot] com)\r
-      Based on code by 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 Keyboard demo. This file contains the main tasks of the demo and\r
- *  is responsible for the initial application hardware configuration.\r
- */\r
\r
-#include "Keyboard.h"\r
-\r
-/* Global Variables */\r
-/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot\r
- *  protocol reporting mode.\r
- */\r
-bool UsingReportProtocol = true;\r
-\r
-/** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports\r
- *  for either the entire idle duration, or until the report status changes (e.g. the user presses a key).\r
- */\r
-uint16_t IdleCount = 500;\r
-\r
-/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle\r
- *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request \r
- *  the current idle period via a Get Idle HID class request, thus its value must be preserved.\r
- */\r
-uint16_t IdleMSRemaining = 0;\r
-\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
-       SetupHardware();\r
-       \r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-\r
-       for (;;)\r
-       {\r
-               HID_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
-       Joystick_Init();\r
-       LEDs_Init();\r
-       USB_Init();\r
-       \r
-       /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */\r
-       OCR0A  = 0x7D;\r
-       TCCR0A = (1 << WGM01);\r
-       TCCR0B = ((1 << CS01) | (1 << CS00));\r
-       TIMSK0 = (1 << OCIE0A);\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
-void EVENT_USB_Connect(void)\r
-{\r
-       /* Indicate USB enumerating */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
-\r
-       /* Default to report protocol on connect */\r
-       UsingReportProtocol = true;\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.\r
- */\r
-void EVENT_USB_Disconnect(void)\r
-{\r
-       /* Indicate USB not ready */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\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 device endpoints.\r
- */\r
-void EVENT_USB_ConfigurationChanged(void)\r
-{      \r
-       /* Indicate USB connected and ready */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
-\r
-       /* Setup Keyboard Keycode Report Endpoint */\r
-       if (!(Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,\r
-                                            ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }\r
-       \r
-       /* Setup Keyboard LED Report Endpoint */\r
-       if (!(Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,\r
-                                            ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }\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
-void EVENT_USB_UnhandledControlPacket(void)\r
-{\r
-       /* Handle HID Class specific requests */\r
-       switch (USB_ControlRequest.bRequest)\r
-       {\r
-               case REQ_GetReport:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               USB_KeyboardReport_Data_t KeyboardReportData;\r
-\r
-                               Endpoint_ClearSETUP();\r
-       \r
-                               /* Create the next keyboard report for transmission to the host */\r
-                               CreateKeyboardReport(&KeyboardReportData);\r
-\r
-                               /* Write the report data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
-                               \r
-                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearOUT();\r
-                       }\r
-               \r
-                       break;\r
-               case REQ_SetReport:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* Wait until the LED report has been sent by the host */\r
-                               while (!(Endpoint_IsOUTReceived()))\r
-                               {\r
-                                       if (USB_DeviceState == DEVICE_STATE_Unattached)\r
-                                         return;\r
-                               }\r
-\r
-                               /* Read in the LED report from the host */\r
-                               uint8_t LEDStatus = Endpoint_Read_Byte();\r
-\r
-                               /* Process the incoming LED report */\r
-                               ProcessLEDReport(LEDStatus);\r
-                       \r
-                               /* Clear the endpoint data */\r
-                               Endpoint_ClearOUT();\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_GetProtocol:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* Write the current protocol flag to the host */\r
-                               Endpoint_Write_Byte(UsingReportProtocol);\r
-                               \r
-                               /* Send the flag to the host */\r
-                               Endpoint_ClearIN();\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetProtocol:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-\r
-                               /* Set or clear the flag depending on what the host indicates that the current Protocol should be */\r
-                               UsingReportProtocol = (USB_ControlRequest.wValue != 0);\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetIdle:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* Get idle period in MSB, IdleCount must be multiplied by 4 to get number of milliseconds */\r
-                               IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);\r
-                               \r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_GetIdle:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {               \r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* Write the current idle duration to the host, must be divided by 4 before sent to host */\r
-                               Endpoint_Write_Byte(IdleCount >> 2);\r
-                               \r
-                               /* Send the flag to the host */\r
-                               Endpoint_ClearIN();\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-\r
-                       break;\r
-       }\r
-}\r
-\r
-/** ISR for the timer 0 compare vector. This ISR fires once each millisecond, and increments the\r
- *  scheduler elapsed idle period counter when the host has set an idle period.\r
- */\r
-ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
-{\r
-       /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */\r
-       if (IdleMSRemaining)\r
-         IdleMSRemaining--;\r
-}\r
-\r
-/** Fills the given HID report data structure with the next HID report to send to the host.\r
- *\r
- *  \param[out] ReportData  Pointer to a HID report data structure to be filled\r
- */\r
-void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)\r
-{\r
-       uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
-\r
-       /* Clear the report contents */\r
-       memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));\r
-\r
-       if (JoyStatus_LCL & JOY_UP)\r
-         ReportData->KeyCode[0] = 0x04; // A\r
-       else if (JoyStatus_LCL & JOY_DOWN)\r
-         ReportData->KeyCode[0] = 0x05; // B\r
-\r
-       if (JoyStatus_LCL & JOY_LEFT)\r
-         ReportData->KeyCode[0] = 0x06; // C\r
-       else if (JoyStatus_LCL & JOY_RIGHT)\r
-         ReportData->KeyCode[0] = 0x07; // D\r
-\r
-       if (JoyStatus_LCL & JOY_PRESS)\r
-         ReportData->KeyCode[0] = 0x08; // E\r
-}\r
-\r
-/** Processes a received LED report, and updates the board LEDs states to match.\r
- *\r
- *  \param[in] LEDReport  LED status report from the host\r
- */\r
-void ProcessLEDReport(uint8_t LEDReport)\r
-{\r
-       uint8_t LEDMask = LEDS_LED2;\r
-       \r
-       if (LEDReport & 0x01) // NUM Lock\r
-         LEDMask |= LEDS_LED1;\r
-       \r
-       if (LEDReport & 0x02) // CAPS Lock\r
-         LEDMask |= LEDS_LED3;\r
-\r
-       if (LEDReport & 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
-\r
-/** Sends the next HID report to the host, via the keyboard data endpoint. */\r
-void SendNextReport(void)\r
-{\r
-       static USB_KeyboardReport_Data_t PrevKeyboardReportData;\r
-       USB_KeyboardReport_Data_t        KeyboardReportData;\r
-       bool                             SendReport = true;\r
-       \r
-       /* Create the next keyboard report for transmission to the host */\r
-       CreateKeyboardReport(&KeyboardReportData);\r
-       \r
-       /* Check to see if the report data has changed - if so a report MUST be sent */\r
-       SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);\r
-       \r
-       /* Save the current report data for later comparison to check for changes */\r
-       PrevKeyboardReportData = KeyboardReportData;\r
-       \r
-       /* Check if the idle period is set and has elapsed */\r
-       if ((IdleCount != HID_IDLE_CHANGESONLY) && (!(IdleMSRemaining)))\r
-       {\r
-               /* Reset the idle time remaining counter */\r
-               IdleMSRemaining = IdleCount;\r
-               \r
-               /* Idle period is set and has elapsed, must send a report to the host */\r
-               SendReport = true;\r
-       }\r
-       \r
-       /* Select the Keyboard Report Endpoint */\r
-       Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
-\r
-       /* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */\r
-       if (Endpoint_IsReadWriteAllowed() && SendReport)\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_ClearIN();\r
-       }\r
-}\r
-\r
-/** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */\r
-void ReceiveNextReport(void)\r
-{\r
-       /* Select the Keyboard LED Report Endpoint */\r
-       Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
-\r
-       /* Check if Keyboard LED Endpoint contains a packet */\r
-       if (Endpoint_IsOUTReceived())\r
-       {\r
-               /* Check to see if the packet contains data */\r
-               if (Endpoint_IsReadWriteAllowed())\r
-               {\r
-                       /* Read in the LED report from the host */\r
-                       uint8_t LEDReport = Endpoint_Read_Byte();\r
-\r
-                       /* Process the read LED report from the host */\r
-                       ProcessLEDReport(LEDReport);\r
-               }\r
-\r
-               /* Handshake the OUT Endpoint - clear endpoint and ready for next report */\r
-               Endpoint_ClearOUT();\r
-       }\r
-}\r
-\r
-/** Function to manage HID report generation and transmission to the host, when in report mode. */\r
-void HID_Task(void)\r
-{\r
-       /* Device must be connected and configured for the task to run */\r
-       if (USB_DeviceState != DEVICE_STATE_Configured)\r
-         return;\r
-         \r
-       /* Send the next keypress report to the host */\r
-       SendNextReport();\r
-               \r
-       /* Process the LED report sent from the host */\r
-       ReceiveNextReport();\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [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.
+*/
+
+/** \file
+ *
+ *  Main source file for the Keyboard demo. This file contains the main tasks of the demo and
+ *  is responsible for the initial application hardware configuration.
+ */
+
+#include "Keyboard.h"
+
+/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
+ *  protocol reporting mode.
+ */
+static bool UsingReportProtocol = true;
+
+/** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports
+ *  for either the entire idle duration, or until the report status changes (e.g. the user presses a key).
+ */
+static uint16_t IdleCount = 500;
+
+/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
+ *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request
+ *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
+ */
+static uint16_t IdleMSRemaining = 0;
+
+
+/** Main program entry point. This routine configures the hardware required by the application, then
+ *  enters a loop to run the application tasks in sequence.
+ */
+int main(void)
+{
+       SetupHardware();
+
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+       sei();
+
+       for (;;)
+       {
+               HID_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 */
+       Joystick_Init();
+       LEDs_Init();
+       USB_Init();
+       Buttons_Init();
+}
+
+/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
+ *  starts the library USB task to begin the enumeration and USB management process.
+ */
+void EVENT_USB_Device_Connect(void)
+{
+       /* Indicate USB enumerating */
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+
+       /* Default to report protocol on connect */
+       UsingReportProtocol = true;
+}
+
+/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
+ *  the status LEDs.
+ */
+void EVENT_USB_Device_Disconnect(void)
+{
+       /* Indicate USB not ready */
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+}
+
+/** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
+ *  of the USB device after enumeration, and configures the keyboard device endpoints.
+ */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       bool ConfigSuccess = true;
+
+       /* Setup HID Report Endpoints */
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
+                                                   KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE);
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
+                                                   KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE);
+
+       /* Turn on Start-of-Frame events for tracking HID report period expiry */
+       USB_Device_EnableSOFEvents();
+
+       /* Indicate endpoint configuration success or failure */
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
+}
+
+/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
+ *  the device from the USB host before passing along unhandled control requests to the library for processing
+ *  internally.
+ */
+void EVENT_USB_Device_ControlRequest(void)
+{
+       /* Handle HID Class specific requests */
+       switch (USB_ControlRequest.bRequest)
+       {
+               case HID_REQ_GetReport:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               USB_KeyboardReport_Data_t KeyboardReportData;
+
+                               /* Create the next keyboard report for transmission to the host */
+                               CreateKeyboardReport(&KeyboardReportData);
+
+                               Endpoint_ClearSETUP();
+
+                               /* Write the report data to the control endpoint */
+                               Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
+                               Endpoint_ClearOUT();
+                       }
+
+                       break;
+               case HID_REQ_SetReport:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+
+                               /* Wait until the LED report has been sent by the host */
+                               while (!(Endpoint_IsOUTReceived()))
+                               {
+                                       if (USB_DeviceState == DEVICE_STATE_Unattached)
+                                         return;
+                               }
+
+                               /* Read in the LED report from the host */
+                               uint8_t LEDStatus = Endpoint_Read_8();
+
+                               Endpoint_ClearOUT();
+                               Endpoint_ClearStatusStage();
+
+                               /* Process the incoming LED report */
+                               ProcessLEDReport(LEDStatus);
+                       }
+
+                       break;
+               case HID_REQ_GetProtocol:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+
+                               /* Write the current protocol flag to the host */
+                               Endpoint_Write_8(UsingReportProtocol);
+
+                               Endpoint_ClearIN();
+                               Endpoint_ClearStatusStage();
+                       }
+
+                       break;
+               case HID_REQ_SetProtocol:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+                               Endpoint_ClearStatusStage();
+
+                               /* Set or clear the flag depending on what the host indicates that the current Protocol should be */
+                               UsingReportProtocol = (USB_ControlRequest.wValue != 0);
+                       }
+
+                       break;
+               case HID_REQ_SetIdle:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+                               Endpoint_ClearStatusStage();
+
+                               /* Get idle period in MSB, IdleCount must be multiplied by 4 to get number of milliseconds */
+                               IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
+                       }
+
+                       break;
+               case HID_REQ_GetIdle:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+
+                               /* Write the current idle duration to the host, must be divided by 4 before sent to host */
+                               Endpoint_Write_8(IdleCount >> 2);
+
+                               Endpoint_ClearIN();
+                               Endpoint_ClearStatusStage();
+                       }
+
+                       break;
+       }
+}
+
+/** Event handler for the USB device Start Of Frame event. */
+void EVENT_USB_Device_StartOfFrame(void)
+{
+       /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */
+       if (IdleMSRemaining)
+         IdleMSRemaining--;
+}
+
+/** Fills the given HID report data structure with the next HID report to send to the host.
+ *
+ *  \param[out] ReportData  Pointer to a HID report data structure to be filled
+ */
+void CreateKeyboardReport(USB_KeyboardReport_Data_t* const ReportData)
+{
+       uint8_t JoyStatus_LCL     = Joystick_GetStatus();
+       uint8_t ButtonStatus_LCL  = Buttons_GetStatus();
+
+       uint8_t UsedKeyCodes      = 0;
+
+       /* Clear the report contents */
+       memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));
+
+       /* Make sent key uppercase by indicating that the left shift key is pressed */
+       ReportData->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
+
+       if (JoyStatus_LCL & JOY_UP)
+         ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_A;
+       else if (JoyStatus_LCL & JOY_DOWN)
+         ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_B;
+
+       if (JoyStatus_LCL & JOY_LEFT)
+         ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_C;
+       else if (JoyStatus_LCL & JOY_RIGHT)
+         ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_D;
+
+       if (JoyStatus_LCL & JOY_PRESS)
+         ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_E;
+
+       if (ButtonStatus_LCL & BUTTONS_BUTTON1)
+         ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_F;
+}
+
+/** Processes a received LED report, and updates the board LEDs states to match.
+ *
+ *  \param[in] LEDReport  LED status report from the host
+ */
+void ProcessLEDReport(const uint8_t LEDReport)
+{
+       uint8_t LEDMask = LEDS_LED2;
+
+       if (LEDReport & HID_KEYBOARD_LED_NUMLOCK)
+         LEDMask |= LEDS_LED1;
+
+       if (LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
+         LEDMask |= LEDS_LED3;
+
+       if (LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
+         LEDMask |= LEDS_LED4;
+
+       /* Set the status LEDs to the current Keyboard LED status */
+       LEDs_SetAllLEDs(LEDMask);
+}
+
+/** Sends the next HID report to the host, via the keyboard data endpoint. */
+void SendNextReport(void)
+{
+       static USB_KeyboardReport_Data_t PrevKeyboardReportData;
+       USB_KeyboardReport_Data_t        KeyboardReportData;
+       bool                             SendReport = true;
+
+       /* Create the next keyboard report for transmission to the host */
+       CreateKeyboardReport(&KeyboardReportData);
+
+       /* Check to see if the report data has changed - if so a report MUST be sent */
+       SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);
+
+       /* Check if the idle period is set and has elapsed */
+       if (IdleCount && (!(IdleMSRemaining)))
+       {
+               /* Reset the idle time remaining counter */
+               IdleMSRemaining = IdleCount;
+
+               /* Idle period is set and has elapsed, must send a report to the host */
+               SendReport = true;
+       }
+
+       /* Select the Keyboard Report Endpoint */
+       Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
+
+       /* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */
+       if (Endpoint_IsReadWriteAllowed() && SendReport)
+       {
+               /* Save the current report data for later comparison to check for changes */
+               PrevKeyboardReportData = KeyboardReportData;
+
+               /* Write Keyboard Report Data */
+               Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData), NULL);
+
+               /* Finalize the stream transfer to send the last packet */
+               Endpoint_ClearIN();
+       }
+}
+
+/** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */
+void ReceiveNextReport(void)
+{
+       /* Select the Keyboard LED Report Endpoint */
+       Endpoint_SelectEndpoint(KEYBOARD_OUT_EPNUM);
+
+       /* Check if Keyboard LED Endpoint contains a packet */
+       if (Endpoint_IsOUTReceived())
+       {
+               /* Check to see if the packet contains data */
+               if (Endpoint_IsReadWriteAllowed())
+               {
+                       /* Read in the LED report from the host */
+                       uint8_t LEDReport = Endpoint_Read_8();
+
+                       /* Process the read LED report from the host */
+                       ProcessLEDReport(LEDReport);
+               }
+
+               /* Handshake the OUT Endpoint - clear endpoint and ready for next report */
+               Endpoint_ClearOUT();
+       }
+}
+
+/** Function to manage HID report generation and transmission to the host, when in report mode. */
+void HID_Task(void)
+{
+       /* Device must be connected and configured for the task to run */
+       if (USB_DeviceState != DEVICE_STATE_Configured)
+         return;
+
+       /* Send the next keypress report to the host */
+       SendNextReport();
+
+       /* Process the LED report sent from the host */
+       ReceiveNextReport();
+}
+