Demos/Host/LowLevel/MassStorageHost/MassStorageHost.c

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