Moved all source to the trunk directory.
[pub/lufa.git] / Demos / StillImageHost / StillImageHost.c
diff --git a/Demos/StillImageHost/StillImageHost.c b/Demos/StillImageHost/StillImageHost.c
new file mode 100644 (file)
index 0000000..50b2054
--- /dev/null
@@ -0,0 +1,436 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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 StillImageHost demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+\r
+#include "StillImageHost.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "LUFA SIMG Host App");\r
+BUTTLOADTAG(BuildTime,   __TIME__);\r
+BUTTLOADTAG(BuildDate,   __DATE__);\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
+ */\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
+       CLKPR = (1 << CLKPCE);\r
+       CLKPR = 0;\r
+\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
+\r
+       /* Startup 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
+EVENT_HANDLER(USB_DeviceAttached)\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
+}\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
+EVENT_HANDLER(USB_DeviceUnattached)\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
+}\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
+EVENT_HANDLER(USB_DeviceEnumerationComplete)\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
+}\r
+\r
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
+EVENT_HANDLER(USB_HostError)\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
+\r
+       UpdateStatus(Status_HardwareError);\r
+       for(;;);\r
+}\r
+\r
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while\r
+ *  enumerating an attached USB device.\r
+ */\r
+EVENT_HANDLER(USB_DeviceEnumerationFailed)\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
+/** 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
+{\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_HostRequest = (USB_Host_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
+                       /* Send the request, display error and wait for device detatch 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
+                               else\r
+                                 puts_P(PSTR("Invalid Device.\r\n"));\r
+\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
+                       puts_P(PSTR("Still Image Device Enumerated.\r\n"));\r
+                               \r
+                       USB_HostState = HOST_STATE_Ready;\r
+                       break;\r
+               case HOST_STATE_Ready:\r
+                       /* Indicate device busy via the status LEDs */\r
+                       UpdateStatus(Status_Busy);\r
+\r
+                       puts_P(PSTR("Retrieving Device Info...\r\n"));\r
+                       \r
+                       PIMA_SendBlock = (PIMA_Container_t)\r
+                               {\r
+                                       DataLength:    PIMA_COMMAND_SIZE(0),\r
+                                       Type:          CType_CommandBlock,\r
+                                       Code:          PIMA_OPERATION_GETDEVICEINFO,\r
+                                       TransactionID: 0x00000000,\r
+                                       Params:        {},\r
+                               };\r
+                       \r
+                       /* Send the GETDEVICEINFO block */\r
+                       SImage_SendBlockHeader();\r
+                       \r
+                       /* Recieve the response data block */\r
+                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)\r
+                       {\r
+                               ShowCommandError(ErrorCode, false);\r
+                               break;\r
+                       }\r
+                       \r
+                       /* Calculate the size of the returned device info data structure */\r
+                       uint16_t DeviceInfoSize = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));\r
+                       \r
+                       /* Create a buffer large enough to hold the entire device info */\r
+                       uint8_t DeviceInfo[DeviceInfoSize];\r
+\r
+                       /* Read in the data block data (containing device info) */\r
+                       SImage_ReadData(DeviceInfo, DeviceInfoSize);\r
+                       \r
+                       /* Once all the data has been read, the pipe must be cleared before the response can be sent */\r
+                       Pipe_ClearCurrentBank();\r
+                       \r
+                       /* Create a pointer for walking through the info dataset */\r
+                       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
+                       \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
+\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
+\r
+                       /* Extract and convert the Device Version Unicode string to ASCII and print it through the USART */\r
+                       char DeviceVersion[*DeviceInfoPos];\r
+                       UnicodeToASCII(DeviceInfoPos, DeviceVersion);\r
+                       printf_P(PSTR("   Device Version: %s\r\n"), DeviceVersion);\r
+\r
+                       /* Recieve the final response block from the device */\r
+                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)\r
+                       {\r
+                               ShowCommandError(ErrorCode, false);\r
+                               break;\r
+                       }\r
+                       \r
+                       /* Verify that the command completed successfully */\r
+                       if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))\r
+                       {\r
+                               ShowCommandError(PIMA_ReceivedBlock.Code, true);\r
+                               break;\r
+                       }\r
+                       \r
+                       puts_P(PSTR("Opening Session...\r\n"));\r
+                       \r
+                       PIMA_SendBlock = (PIMA_Container_t)\r
+                               {\r
+                                       DataLength:    PIMA_COMMAND_SIZE(1),\r
+                                       Type:          CType_CommandBlock,\r
+                                       Code:          PIMA_OPERATION_OPENSESSION,\r
+                                       TransactionID: 0x00000000,\r
+                                       Params:        {0x00000001},\r
+                               };\r
+                       \r
+                       /* Send the OPENSESSION block, open a session with an ID of 0x0001 */\r
+                       SImage_SendBlockHeader();\r
+                       \r
+                       /* Recieve the response block from the device */\r
+                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)\r
+                       {\r
+                               ShowCommandError(ErrorCode, false);\r
+                               break;\r
+                       }\r
+                       \r
+                       /* Verify that the command completed successfully */\r
+                       if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))\r
+                       {\r
+                               ShowCommandError(PIMA_ReceivedBlock.Code, true);\r
+                               break;\r
+                       }\r
+\r
+                       puts_P(PSTR("Closing Session...\r\n"));\r
+\r
+                       PIMA_SendBlock = (PIMA_Container_t)\r
+                               {\r
+                                       DataLength:    PIMA_COMMAND_SIZE(1),\r
+                                       Type:          CType_CommandBlock,\r
+                                       Code:          PIMA_OPERATION_CLOSESESSION,\r
+                                       TransactionID: 0x00000001,\r
+                                       Params:        {0x00000001},\r
+                               };\r
+                       \r
+                       /* Send the CLOSESESSION block, close the session with an ID of 0x0001 */\r
+                       SImage_SendBlockHeader();\r
+                       \r
+                       /* Recieve the response block from the device */\r
+                       if ((ErrorCode = SImage_RecieveBlockHeader()) != PIPE_RWSTREAM_ERROR_NoError)\r
+                       {\r
+                               ShowCommandError(ErrorCode, false);\r
+                               break;\r
+                       }\r
+\r
+                       /* Verify that the command completed successfully */\r
+                       if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))\r
+                       {\r
+                               ShowCommandError(PIMA_ReceivedBlock.Code, true);\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
+                       \r
+                       break;\r
+       }\r
+}\r
+\r
+/** 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
+ */\r
+void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer)\r
+{\r
+       /* Get the number of characters in the string, skip to the start of the string data */\r
+       uint8_t CharactersRemaining = *(UnicodeString++);\r
+       \r
+       /* 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
+               *(Buffer++) = *UnicodeString;\r
+               \r
+               /* Jump to the next unicode character */\r
+               UnicodeString += 2;\r
+       }\r
+       \r
+       /* Null terminate the string */\r
+       *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 ResponseErrorCode  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
+                       \r
+       /* Indicate error via status LEDs */\r
+       UpdateStatus(Status_PIMACommandError);\r
+                               \r
+       /* Wait until USB device disconnected */\r
+       while (USB_IsConnected);\r
+}\r