Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...
[pub/USBasp.git] / Demos / Host / LowLevel / StillImageHost / StillImageHost.c
index 197e832..c4aadb1 100644 (file)
 \r
 #include "StillImageHost.h"\r
 \r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       { .Task = USB_SImage_Host      , .TaskStatus = TASK_STOP },\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 application tasks.\r
+ *  enters a loop to run the application tasks in sequence.\r
  */\r
 int main(void)\r
 {\r
+       SetupHardware();\r
+\r
+       puts_P(PSTR(ESC_FG_CYAN "Still Image Host Demo running.\r\n" ESC_FG_WHITE));\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               StillImage_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
@@ -60,153 +68,112 @@ int main(void)
        /* 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
-\r
-       /* Start-up message */\r
-       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
-              "Still Image 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
-void EVENT_USB_DeviceAttached(void)\r
+void EVENT_USB_Host_DeviceAttached(void)\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
-void EVENT_USB_DeviceUnattached(void)\r
+void EVENT_USB_Host_DeviceUnattached(void)\r
 {\r
-       /* Stop USB management and Still Image tasks */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_SImage_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
-void EVENT_USB_DeviceEnumerationComplete(void)\r
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
 {\r
-       /* Once device is fully enumerated, start the Still Image Host task */\r
-       Scheduler_SetTaskMode(USB_SImage_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
-void EVENT_USB_HostError(const uint8_t ErrorCode)\r
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\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
-       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
-void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+void EVENT_USB_Host_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
+       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
-       UpdateStatus(Status_EnumerationError);\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 print device information\r
  *  through the serial port.\r
  */\r
-TASK(USB_SImage_Host)\r
+void StillImage_Task(void)\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 (USB_Host_SendControlRequest(NULL) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               puts_P(PSTR("Control error.\r\n"));\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("Control Error (Get Configuration).\r\n"));\r
+                                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));\r
                                else\r
-                                 puts_P(PSTR("Invalid Device.\r\n"));\r
+                                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));\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
-                               UpdateStatus(Status_EnumerationError);\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 \r
                                /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
 \r
-                       puts_P(PSTR("Still Image Device Enumerated.\r\n"));\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
+                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"\r
+                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
+\r
+                               /* Indicate error via status LEDs */\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+\r
+                               /* Wait until USB device disconnected */\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                               break;\r
+                       }\r
                                \r
-                       USB_HostState = HOST_STATE_Ready;\r
+                       puts_P(PSTR("Still Image Device Enumerated.\r\n"));\r
+\r
+                       USB_HostState = HOST_STATE_Configured;\r
                        break;\r
-               case HOST_STATE_Ready:\r
+               case HOST_STATE_Configured:\r
                        /* Indicate device busy via the status LEDs */\r
-                       UpdateStatus(Status_Busy);\r
-\r
+                       LEDs_SetAllLEDs(LEDMASK_USB_BUSY);\r
+                       \r
                        puts_P(PSTR("Retrieving Device Info...\r\n"));\r
                        \r
                        PIMA_SendBlock = (PIMA_Container_t)\r
@@ -222,9 +189,11 @@ TASK(USB_SImage_Host)
                        SImage_SendBlockHeader();\r
                        \r
                        /* Receive the response data block */\r
-                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
+                       if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
                        {\r
                                ShowCommandError(ErrorCode, false);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
@@ -244,28 +213,28 @@ TASK(USB_SImage_Host)
                        uint8_t* DeviceInfoPos = DeviceInfo;\r
                        \r
                        /* Skip over the data before the unicode device information strings */\r
-                       DeviceInfoPos += 8;                                      // Skip to VendorExtensionDesc String\r
-                       DeviceInfoPos += ((*DeviceInfoPos << 1) + 1);            // Skip over VendorExtensionDesc String\r
-                       DeviceInfoPos += 2;                                      // Skip over FunctionalMode\r
-                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over OperationCode Array\r
-                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over EventCode Array\r
-                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over DevicePropCode Array\r
-                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over ObjectFormatCode Array\r
-                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1)); // Skip over ObjectFormatCode Array\r
+                       DeviceInfoPos +=  8;                                          // Skip to VendorExtensionDesc String\r
+                       DeviceInfoPos += (1 + UNICODE_STRING_LENGTH(*DeviceInfoPos)); // Skip over VendorExtensionDesc String\r
+                       DeviceInfoPos +=  2;                                          // Skip over FunctionalMode\r
+                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over OperationCode Array\r
+                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over EventCode Array\r
+                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over DevicePropCode Array\r
+                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over ObjectFormatCode Array\r
+                       DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over ObjectFormatCode Array\r
                        \r
                        /* Extract and convert the Manufacturer Unicode string to ASCII and print it through the USART */\r
                        char Manufacturer[*DeviceInfoPos];\r
                        UnicodeToASCII(DeviceInfoPos, Manufacturer);\r
                        printf_P(PSTR("   Manufacturer: %s\r\n"), Manufacturer);\r
 \r
-                       DeviceInfoPos += ((*DeviceInfoPos << 1) + 1);            // Skip over Manufacturer String\r
+                       DeviceInfoPos += 1 + UNICODE_STRING_LENGTH(*DeviceInfoPos);   // Skip over Manufacturer String\r
 \r
                        /* Extract and convert the Model Unicode string to ASCII and print it through the USART */\r
                        char Model[*DeviceInfoPos];\r
                        UnicodeToASCII(DeviceInfoPos, Model);\r
                        printf_P(PSTR("   Model: %s\r\n"), Model);\r
 \r
-                       DeviceInfoPos += ((*DeviceInfoPos << 1) + 1);            // Skip over Model String\r
+                       DeviceInfoPos += 1 + UNICODE_STRING_LENGTH(*DeviceInfoPos);   // Skip over Model String\r
 \r
                        /* Extract and convert the Device Version Unicode string to ASCII and print it through the USART */\r
                        char DeviceVersion[*DeviceInfoPos];\r
@@ -273,9 +242,11 @@ TASK(USB_SImage_Host)
                        printf_P(PSTR("   Device Version: %s\r\n"), DeviceVersion);\r
 \r
                        /* Receive the final response block from the device */\r
-                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
+                       if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
                        {\r
                                ShowCommandError(ErrorCode, false);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
@@ -283,6 +254,8 @@ TASK(USB_SImage_Host)
                        if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))\r
                        {\r
                                ShowCommandError(PIMA_ReceivedBlock.Code, true);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
@@ -301,9 +274,11 @@ TASK(USB_SImage_Host)
                        SImage_SendBlockHeader();\r
                        \r
                        /* Receive the response block from the device */\r
-                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
+                       if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
                        {\r
                                ShowCommandError(ErrorCode, false);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
@@ -311,6 +286,8 @@ TASK(USB_SImage_Host)
                        if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))\r
                        {\r
                                ShowCommandError(PIMA_ReceivedBlock.Code, true);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
 \r
@@ -329,9 +306,11 @@ TASK(USB_SImage_Host)
                        SImage_SendBlockHeader();\r
                        \r
                        /* Receive the response block from the device */\r
-                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
+                       if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)\r
                        {\r
                                ShowCommandError(ErrorCode, false);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
 \r
@@ -339,17 +318,17 @@ TASK(USB_SImage_Host)
                        if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))\r
                        {\r
                                ShowCommandError(PIMA_ReceivedBlock.Code, true);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
 \r
                        puts_P(PSTR("Done.\r\n"));\r
 \r
                        /* Indicate device no longer busy */\r
-                       UpdateStatus(Status_USBReady);\r
-                       \r
-                       /* Wait until USB device disconnected */\r
-                       while (USB_IsConnected);\r
+                       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
                        \r
+                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                        break;\r
        }\r
 }\r
@@ -357,8 +336,8 @@ TASK(USB_SImage_Host)
 /** Function to convert a given Unicode encoded string to ASCII. This function will only work correctly on Unicode\r
  *  strings which contain ASCII printable characters only.\r
  *\r
- *  \param UnicodeString  Pointer to a Unicode encoded input string\r
- *  \param Buffer         Pointer to a buffer where the converted ASCII string should be stored\r
+ *  \param[in] UnicodeString  Pointer to a Unicode encoded input string\r
+ *  \param[out] Buffer        Pointer to a buffer where the converted ASCII string should be stored\r
  */\r
 void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer)\r
 {\r
@@ -368,7 +347,7 @@ void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer)
        /* Loop through the entire unicode string */\r
        while (CharactersRemaining--)\r
        {\r
-               /* Load in the next unicode character (only the lower byte, only Unicode coded ASCII supported) */\r
+               /* Load in the next unicode character (only the lower byte, as only Unicode coded ASCII is supported) */\r
                *(Buffer++) = *UnicodeString;\r
                \r
                /* Jump to the next unicode character */\r
@@ -379,56 +358,18 @@ void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer)
        *Buffer = 0;\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 StillImageHost_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);\r
-                       break;\r
-               case Status_EnumerationError:\r
-               case Status_HardwareError:\r
-               case Status_PIMACommandError:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED3);\r
-                       break;\r
-               case Status_Busy:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED3 | LEDS_LED4);\r
-                       break;\r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
 /** Displays a PIMA command error via the device's serial port.\r
  *\r
- *  \param ErrorCode          Error code of the function which failed to complete successfully\r
- *  \param ResponseCodeError  Indicates if the error is due to a command failed indication from the device, or a communication failure\r
+ *  \param[in] ErrorCode          Error code of the function which failed to complete successfully\r
+ *  \param[in] ResponseCodeError  Indicates if the error is due to a command failed indication from the device, or a communication failure\r
  */\r
 void ShowCommandError(uint8_t ErrorCode, bool ResponseCodeError)\r
 {\r
        char* FailureType = ((ResponseCodeError) ? PSTR("Response Code != OK") : PSTR("Transaction Fail"));\r
 \r
-       printf_P(PSTR(ESC_BG_RED "Command Error (%S).\r\n"), FailureType);\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
+       printf_P(PSTR(ESC_FG_RED "Command Error (%S).\r\n"\r
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), FailureType, ErrorCode);\r
                        \r
        /* Indicate error via status LEDs */\r
-       UpdateStatus(Status_PIMACommandError);\r
-                               \r
-       /* Wait until USB device disconnected */\r
-       while (USB_IsConnected);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r