Add FatFS library to the Webserver project, extend the HTTP server so that it now...
[pub/USBasp.git] / Demos / Host / LowLevel / KeyboardHostWithParser / KeyboardHostWithParser.c
index 840cb90..778220b 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
  \r
 #include "KeyboardHostWithParser.h"\r
 \r
  \r
 #include "KeyboardHostWithParser.h"\r
 \r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       { .Task = USB_Keyboard_Host    , .TaskStatus = TASK_STOP },\r
-};\r
-\r
-\r
 /** Main program entry point. This routine configures the hardware required by the application, then\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
+ *  enters a loop to run the application tasks in sequence.\r
  */\r
 int main(void)\r
 {\r
  */\r
 int main(void)\r
 {\r
+       SetupHardware();\r
+\r
+       puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Parser Host Demo running.\r\n" ESC_FG_WHITE));\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               Keyboard_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
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
@@ -59,207 +67,148 @@ int main(void)
        /* Hardware Initialization */\r
        SerialStream_Init(9600, false);\r
        LEDs_Init();\r
        /* Hardware Initialization */\r
        SerialStream_Init(9600, false);\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
        USB_Init();\r
-\r
-       /* Start-up message */\r
-       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
-              "Keyboard Host Demo running.\r\n" ESC_INVERSE_OFF));\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_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
 }\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
+void EVENT_USB_Host_DeviceAttached(void)\r
 {\r
 {\r
-       puts_P(PSTR("Device Attached.\r\n"));\r
-       UpdateStatus(Status_USBEnumerating);\r
-\r
-       /* Start USB management task to enumerate the device */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+       puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));\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
 }\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
+void EVENT_USB_Host_DeviceUnattached(void)\r
 {\r
 {\r
-       /* Stop keyboard and USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_STOP);\r
-\r
-       puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
-       UpdateStatus(Status_USBNotReady);\r
+       puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));\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
 }\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
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
 {\r
 {\r
-       /* Start Keyboard Host task */\r
-       Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_RUN);\r
-       \r
-       /* Indicate device enumeration complete */\r
-       UpdateStatus(Status_USBReady);\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
 }\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
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\r
 {\r
        USB_ShutDown();\r
 \r
 {\r
        USB_ShutDown();\r
 \r
-       puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
+       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r
 \r
 \r
-       UpdateStatus(Status_HardwareError);\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
        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
-       puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
-       printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);\r
-       printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);\r
-       \r
-       UpdateStatus(Status_EnumerationError);\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 KeyboardHostWithParser_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\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);\r
-                       break;\r
-               case Status_EnumerationError:\r
-               case Status_HardwareError:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED3);\r
-                       break;\r
-               case Status_Busy:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED4);\r
-                       break;\r
-       }\r
+       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"\r
+                                " -- Error Code %d\r\n"\r
+                                " -- Sub Error Code %d\r\n"\r
+                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);\r
        \r
        \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.\r
  */\r
 }\r
 \r
 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.\r
  */\r
-TASK(USB_Keyboard_Host)\r
+void Keyboard_HID_Task(void)\r
 {\r
        uint8_t ErrorCode;\r
 \r
        switch (USB_HostState)\r
        {\r
                case HOST_STATE_Addressed:\r
 {\r
        uint8_t ErrorCode;\r
 \r
        switch (USB_HostState)\r
        {\r
                case HOST_STATE_Addressed:\r
-                       /* Standard request to set the device configuration to configuration 1 */\r
-                       USB_ControlRequest = (USB_Request_Header_t)\r
-                               {\r
-                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
-                                       .bRequest      = REQ_SetConfiguration,\r
-                                       .wValue        = 1,\r
-                                       .wIndex        = 0,\r
-                                       .wLength       = 0,\r
-                               };\r
-\r
-                       /* Select the control pipe for the request transfer */\r
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-                       /* Send the request, display error and wait for device detach if request fails */\r
-                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               puts_P(PSTR("Control Error (Set Configuration).\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-\r
-                               /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\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
                        puts_P(PSTR("Getting Config Data.\r\n"));\r
                \r
                        /* Get and process the configuration descriptor data */\r
                        if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
                        {\r
                                if (ErrorCode == ControlError)\r
                        puts_P(PSTR("Getting Config Data.\r\n"));\r
                \r
                        /* Get and process the configuration descriptor data */\r
                        if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
                        {\r
                                if (ErrorCode == ControlError)\r
-                                 puts_P(PSTR("Control Error (Get Configuration).\r\n"));\r
+                                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));\r
                                else\r
                                else\r
-                                 puts_P(PSTR("Invalid Device.\r\n"));\r
+                                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));\r
 \r
 \r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
+                               printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
                                \r
                                /* Indicate error via status LEDs */\r
                                \r
                                /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 \r
                                /* Wait until USB device disconnected */\r
 \r
                                /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                                break;\r
                        }\r
-                                       \r
-                       puts_P(PSTR("Processing HID Report.\r\n"));\r
 \r
 \r
-                       /* LEDs one and two on to indicate busy processing */\r
-                       UpdateStatus(Status_Busy);\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
+                       {\r
+                               puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));\r
+                               printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
+\r
+                               /* Indicate error via status LEDs */\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 \r
 \r
+                               /* Wait until USB device disconnected */\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                               break;\r
+                       }\r
+                               \r
+                       printf_P(PSTR("Processing HID Report (Size %d Bytes).\r\n"), HIDReportSize);\r
+                                               \r
                        /* Get and process the device's first HID report descriptor */\r
                        if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)\r
                        {\r
                        /* Get and process the device's first HID report descriptor */\r
                        if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)\r
                        {\r
-                               puts_P(PSTR("Report Parse Error.\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
+                               puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));\r
+\r
+                               if (!(HIDReportInfo.TotalReportItems))\r
+                                       puts_P(PSTR("Not a valid Keyboard." ESC_FG_WHITE));\r
+                               else\r
+                                       printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
                        \r
                                /* Indicate error via status LEDs */\r
                        \r
                                /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
                                \r
                                /* Wait until USB device disconnected */\r
                                \r
                                /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;  \r
                        }\r
                                break;  \r
                        }\r
-                       \r
-                       /* All LEDs off - ready to indicate key presses */\r
-                       UpdateStatus(Status_USBReady);\r
+\r
+                       printf("Total Reports: %d\r\n", HIDReportInfo.TotalDeviceReports);\r
+\r
+                       for (uint8_t i = 0; i < HIDReportInfo.TotalDeviceReports; i++)\r
+                       {\r
+                               HID_ReportSizeInfo_t* CurrReportIDInfo = &HIDReportInfo.ReportIDSizes[i];\r
+                               \r
+                               uint8_t ReportSizeInBits      = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_In];\r
+                               uint8_t ReportSizeOutBits     = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Out];\r
+                               uint8_t ReportSizeFeatureBits = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Feature];\r
+\r
+                               /* Print out the byte sizes of each report within the device */\r
+                               printf_P(PSTR("  + Report ID %d - In: %d bytes, Out: %d bytes, Feature: %d bytes\r\n"),\r
+                                        CurrReportIDInfo->ReportID,\r
+                                        ((ReportSizeInBits      >> 3) + ((ReportSizeInBits      & 0x07) != 0)),\r
+                                        ((ReportSizeOutBits     >> 3) + ((ReportSizeOutBits     & 0x07) != 0)),\r
+                                        ((ReportSizeFeatureBits >> 3) + ((ReportSizeFeatureBits & 0x07) != 0)));\r
+                       }\r
 \r
                        puts_P(PSTR("Keyboard Enumerated.\r\n"));\r
 \r
 \r
                        puts_P(PSTR("Keyboard Enumerated.\r\n"));\r
 \r
-                       USB_HostState = HOST_STATE_Ready;\r
+                       USB_HostState = HOST_STATE_Configured;\r
                        break;\r
                        break;\r
-               case HOST_STATE_Ready:\r
+               case HOST_STATE_Configured:\r
                        /* Select and unfreeze keyboard data pipe */\r
                        Pipe_SelectPipe(KEYBOARD_DATAPIPE);     \r
                        Pipe_Unfreeze();\r
                        /* Select and unfreeze keyboard data pipe */\r
                        Pipe_SelectPipe(KEYBOARD_DATAPIPE);     \r
                        Pipe_Unfreeze();\r
@@ -293,7 +242,7 @@ TASK(USB_Keyboard_Host)
 /** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results\r
  *  as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.\r
  *\r
 /** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results\r
  *  as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.\r
  *\r
- *  \param KeyboardReport  Pointer to a HID report from an attached keyboard device\r
+ *  \param[in] KeyboardReport  Pointer to a HID report from an attached keyboard device\r
  */\r
 void ProcessKeyboardReport(uint8_t* KeyboardReport)\r
 {\r
  */\r
 void ProcessKeyboardReport(uint8_t* KeyboardReport)\r
 {\r
@@ -323,10 +272,7 @@ void ProcessKeyboardReport(uint8_t* KeyboardReport)
                        if (KeyCode)\r
                        {\r
                                /* Toggle status LED to indicate keypress */\r
                        if (KeyCode)\r
                        {\r
                                /* Toggle status LED to indicate keypress */\r
-                               if (LEDs_GetLEDs() & LEDS_LED2)\r
-                                 LEDs_TurnOffLEDs(LEDS_LED2);\r
-                               else\r
-                                 LEDs_TurnOnLEDs(LEDS_LED2);\r
+                               LEDs_ToggleLEDs(LEDS_LED2);\r
 \r
                                char PressedKey = 0;\r
 \r
 \r
                                char PressedKey = 0;\r
 \r