Demos/Host/LowLevel/StillImageHost/StillImageHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the StillImageHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "StillImageHost.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Still Image Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         sei();
  50
  51         for (;;)
  52         {
  53                 StillImage_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable Clock Division */
  66         CLKPR = (1 << CLKPCE);
  67         CLKPR = 0;
  68
  69         /* Hardware Initialization */
  70         SerialStream_Init(9600, false);
  71         LEDs_Init();
  72         USB_Init();
  73 }
  74
  75 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  76  *  starts the library USB task to begin the enumeration and USB management process.
  77  */
  78 void EVENT_USB_Host_DeviceAttached(void)
  79 {
  80         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  81         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  82 }
  83
  84 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  85  *  stops the library USB task management process.
  86  */
  87 void EVENT_USB_Host_DeviceUnattached(void)
  88 {
  89         puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
  90         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  91 }
  92
  93 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  94  *  enumerated by the host and is now ready to be used by the application.
  95  */
  96 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  97 {
  98         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  99 }
 100
 101 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 102 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 103 {
 104         USB_ShutDown();
 105
 106         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 107                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 108
 109         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 110         for(;;);
 111 }
 112
 113 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 114  *  enumerating an attached USB device.
 115  */
 116 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 117 {
 118         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 119                                  " -- Error Code %d\r\n"
 120                                  " -- Sub Error Code %d\r\n"
 121                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 122
 123         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 124 }
 125
 126 /** Task to set the configuration of the attached device after it has been enumerated, and to print device information
 127  *  through the serial port.
 128  */
 129 void StillImage_Task(void)
 130 {
 131         uint8_t ErrorCode;
 132
 133         switch (USB_HostState)
 134         {
 135                 case HOST_STATE_Addressed:
 136                         puts_P(PSTR("Getting Config Data.\r\n"));
 137
 138                         /* Get and process the configuration descriptor data */
 139                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 140                         {
 141                                 if (ErrorCode == ControlError)
 142                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 143                                 else
 144                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 145
 146                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 147
 148                                 /* Indicate error via status LEDs */
 149                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 150
 151                                 /* Wait until USB device disconnected */
 152                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 153                                 break;
 154                         }
 155
 156                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 157                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 158                         {
 159                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 160                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 161
 162                                 /* Indicate error via status LEDs */
 163                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 164
 165                                 /* Wait until USB device disconnected */
 166                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 167                                 break;
 168                         }
 169
 170                         puts_P(PSTR("Still Image Device Enumerated.\r\n"));
 171                         USB_HostState = HOST_STATE_Configured;
 172                         break;
 173                 case HOST_STATE_Configured:
 174                         /* Indicate device busy via the status LEDs */
 175                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 176
 177                         puts_P(PSTR("Retrieving Device Info...\r\n"));
 178
 179                         PIMA_SendBlock = (PIMA_Container_t)
 180                                 {
 181                                         .DataLength    = PIMA_COMMAND_SIZE(0),
 182                                         .Type          = CType_CommandBlock,
 183                                         .Code          = PIMA_OPERATION_GETDEVICEINFO,
 184                                         .TransactionID = 0x00000000,
 185                                         .Params        = {},
 186                                 };
 187
 188                         /* Send the GETDEVICEINFO block */
 189                         SImage_SendBlockHeader();
 190
 191                         /* Receive the response data block */
 192                         if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)
 193                         {
 194                                 ShowCommandError(ErrorCode, false);
 195
 196                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 197                                 break;
 198                         }
 199
 200                         /* Calculate the size of the returned device info data structure */
 201                         uint16_t DeviceInfoSize = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));
 202
 203                         /* Create a buffer large enough to hold the entire device info */
 204                         uint8_t DeviceInfo[DeviceInfoSize];
 205
 206                         /* Read in the data block data (containing device info) */
 207                         SImage_ReadData(DeviceInfo, DeviceInfoSize);
 208
 209                         /* Once all the data has been read, the pipe must be cleared before the response can be sent */
 210                         Pipe_ClearIN();
 211
 212                         /* Create a pointer for walking through the info dataset */
 213                         uint8_t* DeviceInfoPos = DeviceInfo;
 214
 215                         /* Skip over the data before the unicode device information strings */
 216                         DeviceInfoPos +=  8;                                          // Skip to VendorExtensionDesc String
 217                         DeviceInfoPos += (1 + UNICODE_STRING_LENGTH(*DeviceInfoPos)); // Skip over VendorExtensionDesc String
 218                         DeviceInfoPos +=  2;                                          // Skip over FunctionalMode
 219                         DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over Supported Operations Array
 220                         DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over Supported Events Array
 221                         DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over Supported Device Properties Array
 222                         DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over Capture Formats Array
 223                         DeviceInfoPos += (4 + (*(uint32_t*)DeviceInfoPos << 1));      // Skip over Image Formats Array
 224
 225                         /* Extract and convert the Manufacturer Unicode string to ASCII and print it through the USART */
 226                         char Manufacturer[*DeviceInfoPos];
 227                         UnicodeToASCII(DeviceInfoPos, Manufacturer);
 228                         printf_P(PSTR("   Manufacturer: %s\r\n"), Manufacturer);
 229
 230                         DeviceInfoPos += 1 + UNICODE_STRING_LENGTH(*DeviceInfoPos);   // Skip over Manufacturer String
 231
 232                         /* Extract and convert the Model Unicode string to ASCII and print it through the USART */
 233                         char Model[*DeviceInfoPos];
 234                         UnicodeToASCII(DeviceInfoPos, Model);
 235                         printf_P(PSTR("   Model: %s\r\n"), Model);
 236
 237                         DeviceInfoPos += 1 + UNICODE_STRING_LENGTH(*DeviceInfoPos);   // Skip over Model String
 238
 239                         /* Extract and convert the Device Version Unicode string to ASCII and print it through the USART */
 240                         char DeviceVersion[*DeviceInfoPos];
 241                         UnicodeToASCII(DeviceInfoPos, DeviceVersion);
 242                         printf_P(PSTR("   Device Version: %s\r\n"), DeviceVersion);
 243
 244                         /* Receive the final response block from the device */
 245                         if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)
 246                         {
 247                                 ShowCommandError(ErrorCode, false);
 248
 249                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 250                                 break;
 251                         }
 252
 253                         /* Verify that the command completed successfully */
 254                         if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))
 255                         {
 256                                 ShowCommandError(PIMA_ReceivedBlock.Code, true);
 257
 258                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 259                                 break;
 260                         }
 261
 262                         puts_P(PSTR("Opening Session...\r\n"));
 263
 264                         PIMA_SendBlock = (PIMA_Container_t)
 265                                 {
 266                                         .DataLength    = PIMA_COMMAND_SIZE(1),
 267                                         .Type          = CType_CommandBlock,
 268                                         .Code          = PIMA_OPERATION_OPENSESSION,
 269                                         .TransactionID = 0x00000000,
 270                                         .Params        = {0x00000001},
 271                                 };
 272
 273                         /* Send the OPENSESSION block, open a session with an ID of 0x0001 */
 274                         SImage_SendBlockHeader();
 275
 276                         /* Receive the response block from the device */
 277                         if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)
 278                         {
 279                                 ShowCommandError(ErrorCode, false);
 280
 281                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 282                                 break;
 283                         }
 284
 285                         /* Verify that the command completed successfully */
 286                         if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))
 287                         {
 288                                 ShowCommandError(PIMA_ReceivedBlock.Code, true);
 289
 290                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 291                                 break;
 292                         }
 293
 294                         puts_P(PSTR("Closing Session...\r\n"));
 295
 296                         PIMA_SendBlock = (PIMA_Container_t)
 297                                 {
 298                                         .DataLength    = PIMA_COMMAND_SIZE(1),
 299                                         .Type          = CType_CommandBlock,
 300                                         .Code          = PIMA_OPERATION_CLOSESESSION,
 301                                         .TransactionID = 0x00000001,
 302                                         .Params        = {0x00000001},
 303                                 };
 304
 305                         /* Send the CLOSESESSION block, close the session with an ID of 0x0001 */
 306                         SImage_SendBlockHeader();
 307
 308                         /* Receive the response block from the device */
 309                         if ((ErrorCode = SImage_ReceiveBlockHeader()) != PIPE_RWSTREAM_NoError)
 310                         {
 311                                 ShowCommandError(ErrorCode, false);
 312
 313                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 314                                 break;
 315                         }
 316
 317                         /* Verify that the command completed successfully */
 318                         if ((PIMA_ReceivedBlock.Type != CType_ResponseBlock) || (PIMA_ReceivedBlock.Code != PIMA_RESPONSE_OK))
 319                         {
 320                                 ShowCommandError(PIMA_ReceivedBlock.Code, true);
 321
 322                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 323                                 break;
 324                         }
 325
 326                         puts_P(PSTR("Done.\r\n"));
 327
 328                         /* Indicate device no longer busy */
 329                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 330
 331                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 332                         break;
 333         }
 334 }
 335
 336 /** Function to convert a given Unicode encoded string to ASCII. This function will only work correctly on Unicode
 337  *  strings which contain ASCII printable characters only.
 338  *
 339  *  \param[in] UnicodeString  Pointer to a Unicode encoded input string
 340  *  \param[out] Buffer        Pointer to a buffer where the converted ASCII string should be stored
 341  */
 342 void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer)
 343 {
 344         /* Get the number of characters in the string, skip to the start of the string data */
 345         uint8_t CharactersRemaining = *(UnicodeString++);
 346
 347         /* Loop through the entire unicode string */
 348         while (CharactersRemaining--)
 349         {
 350                 /* Load in the next unicode character (only the lower byte, as only Unicode coded ASCII is supported) */
 351                 *(Buffer++) = *UnicodeString;
 352
 353                 /* Jump to the next unicode character */
 354                 UnicodeString += 2;
 355         }
 356
 357         /* Null terminate the string */
 358         *Buffer = 0;
 359 }
 360
 361 /** Displays a PIMA command error via the device's serial port.
 362  *
 363  *  \param[in] ErrorCode          Error code of the function which failed to complete successfully
 364  *  \param[in] ResponseCodeError  Indicates if the error is due to a command failed indication from the device, or a communication failure
 365  */
 366 void ShowCommandError(uint8_t ErrorCode, bool ResponseCodeError)
 367 {
 368         char* FailureType = ((ResponseCodeError) ? PSTR("Response Code != OK") : PSTR("Transaction Fail"));
 369
 370         printf_P(PSTR(ESC_FG_RED "Command Error (%S).\r\n"
 371                                  " -- Error Code %d\r\n" ESC_FG_WHITE), FailureType, ErrorCode);
 372
 373         /* Indicate error via status LEDs */
 374         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 375 }