Commit of new class abstraction APIs for all device demos other than the MIDI demo...

[pub/USBasp.git] / Demos / Device / Keyboard / Keyboard.c

diff --git a/Demos/Device/Keyboard/Keyboard.c b/Demos/Device/Keyboard/Keyboard.c
index 6abd193..d8893bf 100644 (file)
--- a/Demos/Device/Keyboard/Keyboard.c
+++ b/Demos/Device/Keyboard/Keyboard.c
@@ -28,397 +28,120 @@
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\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
  \r
 #include "Keyboard.h"\r
 \r

-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },     \r
-       { .Task = USB_Keyboard_Report  , .TaskStatus = TASK_STOP },\r
-};\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
+USB_ClassInfo_HID_t Keyboard_HID_Interface =\r
+    {\r
+        .InterfaceNumber         = 0,\r

 \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
+        .ReportINEndpointNumber  = KEYBOARD_EPNUM,\r
+        .ReportINEndpointSize    = KEYBOARD_EPSIZE,\r

 \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
+        .ReportOUTEndpointNumber = KEYBOARD_LEDS_EPNUM,\r
+        .ReportOUTEndpointSize   = KEYBOARD_EPSIZE,\r
+        \r
+               .ReportBufferSize        = sizeof(USB_KeyboardReport_Data_t),\r

 \r
 \r

+        .IdleCount               = 500,\r
+    };\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
 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
-       \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
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-\r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
+    SetupHardware();\r
+\r
+    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+    \r
+    for (;;)\r
+    {\r
+        USB_HID_USBTask(&Keyboard_HID_Interface);\r
+        USB_USBTask();\r
+    }\r
+}\r

 \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
+void SetupHardware()\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
+    Buttons_Init();\r
+    USB_Init();\r

 }\r
 \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
 void EVENT_USB_Connect(void)\r
 {\r

-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r
-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\r
-\r
-       /* Default to report protocol on connect */\r
-       UsingReportProtocol = true;\r
+    LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r

 }\r
 \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
 void EVENT_USB_Disconnect(void)\r
 {\r

-       /* Stop running keyboard reporting and USB management tasks */\r
-       Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
+    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r

 }\r
 \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
 void EVENT_USB_ConfigurationChanged(void)\r
 {\r

-       /* Setup Keyboard Keycode Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Setup Keyboard LED Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
+    LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

 \r
 \r

-       /* Indicate USB connected and ready */\r
-       UpdateStatus(Status_USBReady);\r
-\r
-       /* Start running keyboard reporting task */\r
-       Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);\r
+    if (!(USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface)))\r
+      LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

 }\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
 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
-                               /* 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
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearIN();\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
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsOUTReceived()));\r
-                               Endpoint_ClearOUT();\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
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearIN();\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 */\r
-                               IdleCount = (USB_ControlRequest.wValue >> 8);\r
-                               \r
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearIN();\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 */\r
-                               Endpoint_Write_Byte(IdleCount);\r
-                               \r
-                               /* Send the flag to the host */\r
-                               Endpoint_ClearIN();\r
-\r
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsOUTReceived()));\r
-                               Endpoint_ClearOUT();\r
-                       }\r
-\r
-                       break;\r
-       }\r
+    USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r

 }\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
+void EVENT_USB_StartOfFrame(void)\r

 {\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 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 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, must multiply by 4 to get the duration in milliseconds */\r
-               IdleMSRemaining = (IdleCount << 2);\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
+    USB_HID_RegisterStartOfFrame(&Keyboard_HID_Interface);\r

 }\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 Keyboard_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
+uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r

 {\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
+    USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
+    \r
+    uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r
+    uint8_t ButtonStatus_LCL = Buttons_GetStatus();\r
+\r
+    if (JoyStatus_LCL & JOY_UP)\r
+      KeyboardReport->KeyCode[0] = 0x04; // A\r
+    else if (JoyStatus_LCL & JOY_DOWN)\r
+      KeyboardReport->KeyCode[0] = 0x05; // B\r
+\r
+    if (JoyStatus_LCL & JOY_LEFT)\r
+      KeyboardReport->KeyCode[0] = 0x06; // C\r
+    else if (JoyStatus_LCL & JOY_RIGHT)\r
+      KeyboardReport->KeyCode[0] = 0x07; // D\r
+\r
+    if (JoyStatus_LCL & JOY_PRESS)\r
+      KeyboardReport->KeyCode[0] = 0x08; // E\r
+      \r
+    if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
+      KeyboardReport->KeyCode[0] = 0x09; // F\r
+      \r
+    return sizeof(USB_KeyboardReport_Data_t);\r

 }\r
 \r
 }\r
 \r

-/** Function to manage HID report generation and transmission to the host, when in report mode. */\r
-TASK(USB_Keyboard_Report)\r
+void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)\r

 {\r
 {\r

-       /* Check if the USB system is connected to a host */\r
-       if (USB_IsConnected)\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
+    uint8_t  LEDMask   = LEDS_NO_LEDS;\r
+    uint8_t* LEDReport = (uint8_t*)ReportData;\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
+    LEDs_SetAllLEDs(LEDMask);\r

 }\r
 }\r