Demos/Host/LowLevel/MassStorageHost/MassStorageHost.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 MassStorageHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MassStorageHost.h"
  38
  39 /** Index of the highest available LUN (Logical Unit) in the attached Mass Storage Device */
  40 uint8_t MassStore_MaxLUNIndex;
  41
  42
  43 /** Main program entry point. This routine configures the hardware required by the application, then
  44  *  enters a loop to run the application tasks in sequence.
  45  */
  46 int main(void)
  47 {
  48         SetupHardware();
  49
  50         puts_P(PSTR(ESC_FG_CYAN "Mass Storage Host Demo running.\r\n" ESC_FG_WHITE));
  51
  52         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  53
  54         for (;;)
  55         {
  56                 MassStorage_Task();
  57                 USB_USBTask();
  58         }
  59 }
  60
  61 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  62 void SetupHardware(void)
  63 {
  64         /* Disable watchdog if enabled by bootloader/fuses */
  65         MCUSR &= ~(1 << WDRF);
  66         wdt_disable();
  67
  68         /* Disable clock division */
  69         clock_prescale_set(clock_div_1);
  70
  71         /* Hardware Initialization */
  72         SerialStream_Init(9600, false);
  73         LEDs_Init();
  74         Buttons_Init();
  75         USB_Init();
  76 }
  77
  78 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  79  *  starts the library USB task to begin the enumeration and USB management process.
  80  */
  81 void EVENT_USB_Host_DeviceAttached(void)
  82 {
  83         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  84         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  85 }
  86
  87 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  88  *  stops the library USB task management process.
  89  */
  90 void EVENT_USB_Host_DeviceUnattached(void)
  91 {
  92         puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
  93         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  94 }
  95
  96 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  97  *  enumerated by the host and is now ready to be used by the application.
  98  */
  99 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 100 {
 101         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 102 }
 103
 104 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 105 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 106 {
 107         USB_ShutDown();
 108
 109         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 110                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 111
 112         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 113         for(;;);
 114 }
 115
 116 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 117  *  enumerating an attached USB device.
 118  */
 119 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 120 {
 121         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 122                                  " -- Error Code %d\r\n"
 123                                  " -- Sub Error Code %d\r\n"
 124                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 125
 126         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 127 }
 128
 129 /** Task to set the configuration of the attached device after it has been enumerated, and to read in blocks from
 130  *  the device and print them to the serial port.
 131  */
 132 void MassStorage_Task(void)
 133 {
 134         uint8_t ErrorCode;
 135
 136         switch (USB_HostState)
 137         {
 138                 case HOST_STATE_Addressed:
 139                         puts_P(PSTR("Getting Config Data.\r\n"));
 140
 141                         /* Get and process the configuration descriptor data */
 142                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 143                         {
 144                                 if (ErrorCode == ControlError)
 145                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 146                                 else
 147                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 148
 149                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 150
 151                                 /* Indicate error via status LEDs */
 152                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 153
 154                                 /* Wait until USB device disconnected */
 155                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 156                                 break;
 157                         }
 158
 159                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 160                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 161                         {
 162                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 163                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 164
 165                                 /* Indicate error via status LEDs */
 166                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 167
 168                                 /* Wait until USB device disconnected */
 169                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 170                                 break;
 171                         }
 172
 173                         puts_P(PSTR("Mass Storage Disk Enumerated.\r\n"));
 174
 175                         USB_HostState = HOST_STATE_Configured;
 176                         break;
 177                 case HOST_STATE_Configured:
 178                         /* Indicate device busy via the status LEDs */
 179                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 180
 181                         /* Send the request, display error and wait for device detach if request fails */
 182                         if ((ErrorCode = MassStore_GetMaxLUN(&MassStore_MaxLUNIndex)) != HOST_SENDCONTROL_Successful)
 183                         {
 184                                 ShowDiskReadError(PSTR("Get Max LUN"), ErrorCode);
 185
 186                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 187                                 break;
 188                         }
 189
 190                         /* Print number of LUNs detected in the attached device */
 191                         printf_P(PSTR("Total LUNs: %d - Using first LUN in device.\r\n"), (MassStore_MaxLUNIndex + 1));
 192
 193                         /* Reset the Mass Storage device interface, ready for use */
 194                         if ((ErrorCode = MassStore_MassStorageReset()) != HOST_SENDCONTROL_Successful)
 195                         {
 196                                 ShowDiskReadError(PSTR("Mass Storage Reset"), ErrorCode);
 197
 198                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 199                                 break;
 200                         }
 201
 202                         /* Get sense data from the device - many devices will not accept any other commands until the sense data
 203                          * is read - both on start-up and after a failed command */
 204                         SCSI_Request_Sense_Response_t SenseData;
 205                         if ((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0)
 206                         {
 207                                 ShowDiskReadError(PSTR("Request Sense"), ErrorCode);
 208                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 209                                 break;
 210                         }
 211
 212                         /* Set the prevent removal flag for the device, allowing it to be accessed */
 213                         if ((ErrorCode = MassStore_PreventAllowMediumRemoval(0, true)) != 0)
 214                         {
 215                                 ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), ErrorCode);
 216
 217                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 218                                 break;
 219                         }
 220
 221                         /* Get inquiry data from the device */
 222                         SCSI_Inquiry_Response_t InquiryData;
 223                         if ((ErrorCode = MassStore_Inquiry(0, &InquiryData)) != 0)
 224                         {
 225                                 ShowDiskReadError(PSTR("Inquiry"), ErrorCode);
 226
 227                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 228                                 break;
 229                         }
 230
 231                         /* Print vendor and product names of attached device */
 232                         printf_P(PSTR("Vendor \"%.8s\", Product \"%.16s\"\r\n"), InquiryData.VendorID, InquiryData.ProductID);
 233
 234                         /* Wait until disk ready */
 235                         puts_P(PSTR("Waiting until ready.."));
 236
 237                         for (;;)
 238                         {
 239                                 Serial_TxByte('.');
 240
 241                                 /* Abort if device removed */
 242                                 if (USB_HostState == HOST_STATE_Unattached)
 243                                   break;
 244
 245                                 /* Check to see if the attached device is ready for new commands */
 246                                 ErrorCode = MassStore_TestUnitReady(0);
 247
 248                                 /* If attached device is ready, abort the loop */
 249                                 if (!(ErrorCode))
 250                                   break;
 251
 252                                 /* If an error other than a logical command failure (indicating device busy) returned, abort */
 253                                 if (ErrorCode != MASS_STORE_SCSI_COMMAND_FAILED)
 254                                 {
 255                                         ShowDiskReadError(PSTR("Test Unit Ready"), ErrorCode);
 256
 257                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 258                                         break;
 259                                 }
 260                         }
 261
 262                         puts_P(PSTR("\r\nRetrieving Capacity... "));
 263
 264                         /* Create new structure for the disk's capacity in blocks and block size */
 265                         SCSI_Capacity_t DiskCapacity;
 266
 267                         /* Retrieve disk capacity */
 268                         if ((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0)
 269                         {
 270                                 ShowDiskReadError(PSTR("Read Capacity"), ErrorCode);
 271
 272                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 273                                 break;
 274                         }
 275
 276                         /* Display the disk capacity in blocks * block size bytes */
 277                         printf_P(PSTR("%lu blocks of %lu bytes.\r\n"), DiskCapacity.Blocks, DiskCapacity.BlockSize);
 278
 279                         /* Create a new buffer capable of holding a single block from the device */
 280                         uint8_t BlockBuffer[DiskCapacity.BlockSize];
 281
 282                         /* Read in the first 512 byte block from the device */
 283                         if ((ErrorCode = MassStore_ReadDeviceBlock(0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)
 284                         {
 285                                 ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);
 286
 287                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 288                                 break;
 289                         }
 290
 291                         puts_P(PSTR("\r\nContents of first block:\r\n"));
 292
 293                         /* Print out the first block in both HEX and ASCII, 16 bytes per line */
 294                         for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)
 295                         {
 296                                 /* Pointer to the start of the current 16-byte chunk in the read block of data */
 297                                 uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];
 298
 299                                 /* Print out the 16 bytes of the chunk in HEX format */
 300                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 301                                 {
 302                                         char CurrByte = *(ChunkPtr + ByteOffset);
 303
 304                                         printf_P(PSTR("%.2X "), CurrByte);
 305                                 }
 306
 307                                 puts_P(PSTR("    "));
 308
 309                                 /* Print out the 16 bytes of the chunk in ASCII format */
 310                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 311                                 {
 312                                         char CurrByte = *(ChunkPtr + ByteOffset);
 313
 314                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 315                                 }
 316
 317                                 puts_P(PSTR("\r\n"));
 318                         }
 319
 320                         puts_P(PSTR("\r\n\r\nPress board button to read entire ASCII contents of disk...\r\n\r\n"));
 321
 322                         /* Wait for the board button to be pressed */
 323                         while (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
 324                         {
 325                                 /* Abort if device removed */
 326                                 if (USB_HostState == HOST_STATE_Unattached)
 327                                   break;
 328                         }
 329
 330                         /* Abort if device removed */
 331                         if (USB_HostState == HOST_STATE_Unattached)
 332                           break;
 333
 334                         /* Print out the entire disk contents in ASCII format */
 335                         for (uint32_t CurrBlockAddress = 0; CurrBlockAddress < DiskCapacity.Blocks; CurrBlockAddress++)
 336                         {
 337                                 /* Read in the next block of data from the device */
 338                                 if ((ErrorCode = MassStore_ReadDeviceBlock(0, CurrBlockAddress, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)
 339                                 {
 340                                         ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);
 341
 342                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 343                                         break;
 344                                 }
 345
 346                                 /* Send the ASCII data in the read in block to the serial port */
 347                                 for (uint16_t Byte = 0; Byte < DiskCapacity.BlockSize; Byte++)
 348                                 {
 349                                         char CurrByte = BlockBuffer[Byte];
 350
 351                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 352                                 }
 353
 354                                 /* Abort if device removed */
 355                                 if (USB_HostState == HOST_STATE_Unattached)
 356                                   break;
 357                         }
 358
 359                         /* Indicate device no longer busy */
 360                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 361
 362                         /* Wait until USB device disconnected */
 363                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 364                         break;
 365         }
 366 }
 367
 368 /** Indicates that a communication error has occurred with the attached Mass Storage Device,
 369  *  printing error codes to the serial port and waiting until the device is removed before
 370  *  continuing.
 371  *
 372  *  \param[in] CommandString  ASCII string located in PROGMEM space indicating what operation failed
 373  *  \param[in] ErrorCode      Error code of the function which failed to complete successfully
 374  */
 375 void ShowDiskReadError(char* CommandString, uint8_t ErrorCode)
 376 {
 377         if (ErrorCode == MASS_STORE_SCSI_COMMAND_FAILED)
 378         {
 379                 /* Display the error code */
 380                 printf_P(PSTR(ESC_FG_RED "SCSI command error (%S).\r\n"), CommandString);
 381         }
 382         else
 383         {
 384                 /* Display the error code */
 385                 printf_P(PSTR(ESC_FG_RED "Command error (%S).\r\n"), CommandString);
 386                 printf_P(PSTR("  -- Error Code: %d" ESC_FG_WHITE), ErrorCode);
 387         }
 388
 389         Pipe_Freeze();
 390
 391         /* Indicate device error via the status LEDs */
 392         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 393 }