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                                 while (USB_IsConnected);
 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                                 while (USB_IsConnected);
 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                                 break;
 191                         }
 192
 193                         /* Print number of LUNs detected in the attached device */
 194                         printf_P(PSTR("Total LUNs: %d - Using first LUN in device.\r\n"), (MassStore_MaxLUNIndex + 1));
 195
 196                         /* Reset the Mass Storage device interface, ready for use */
 197                         if ((ErrorCode = MassStore_MassStorageReset()) != HOST_SENDCONTROL_Successful)
 198                         {
 199                                 ShowDiskReadError(PSTR("Mass Storage Reset"), false, ErrorCode);
 200                                 break;
 201                         }
 202
 203                         /* Get sense data from the device - many devices will not accept any other commands until the sense data
 204                          * is read - both on start-up and after a failed command */
 205                         SCSI_Request_Sense_Response_t SenseData;
 206                         if (((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0) || (SCSICommandStatus.Status != Command_Pass))
 207                         {
 208                                 ShowDiskReadError(PSTR("Request Sense"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 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) || (SCSICommandStatus.Status != Command_Pass))
 214                         {
 215                                 ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 216                                 break;
 217                         }
 218
 219                         /* Get inquiry data from the device */
 220                         SCSI_Inquiry_Response_t InquiryData;
 221                         if (((ErrorCode = MassStore_Inquiry(0, &InquiryData)) != 0) || (SCSICommandStatus.Status != Command_Pass))
 222                         {
 223                                 ShowDiskReadError(PSTR("Inquiry"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 224                                 break;
 225                         }
 226
 227                         /* Print vendor and product names of attached device */
 228                         printf_P(PSTR("Vendor: %s, Product: %s\r\n"), InquiryData.VendorID, InquiryData.ProductID);
 229
 230                         /* Wait until disk ready */
 231                         puts_P(PSTR("Waiting until ready.."));
 232
 233                         do
 234                         {
 235                                 Serial_TxByte('.');
 236
 237                                 if ((ErrorCode = MassStore_TestUnitReady(0)) != 0)
 238                                 {
 239                                         ShowDiskReadError(PSTR("Test Unit Ready"), false, ErrorCode);
 240                                         break;
 241                                 }
 242                         }
 243                         while ((SCSICommandStatus.Status != Command_Pass) && USB_IsConnected);
 244
 245                         /* Abort if device removed */
 246                         if (!(USB_IsConnected))
 247                           break;
 248
 249                         puts_P(PSTR("\r\nRetrieving Capacity... "));
 250
 251                         /* Create new structure for the disk's capacity in blocks and block size */
 252                         SCSI_Capacity_t DiskCapacity;
 253
 254                         /* Retrieve disk capacity */
 255                         if (((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0) || (SCSICommandStatus.Status != Command_Pass))
 256                         {
 257                                 ShowDiskReadError(PSTR("Read Capacity"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 258                                 break;
 259                         }
 260
 261                         /* Display the disk capacity in blocks * block size bytes */
 262                         printf_P(PSTR("%lu blocks of %lu bytes.\r\n"), DiskCapacity.Blocks, DiskCapacity.BlockSize);
 263
 264                         /* Create a new buffer capabable of holding a single block from the device */
 265                         uint8_t BlockBuffer[DiskCapacity.BlockSize];
 266
 267                         /* Read in the first 512 byte block from the device */
 268                         if (((ErrorCode = MassStore_ReadDeviceBlock(0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0) ||
 269                             (SCSICommandStatus.Status != Command_Pass))
 270                         {
 271                                 ShowDiskReadError(PSTR("Read Device Block"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 272                                 break;
 273                         }
 274
 275                         puts_P(PSTR("\r\nContents of first block:\r\n"));
 276
 277                         /* Print out the first block in both HEX and ASCII, 16 bytes per line */
 278                         for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)
 279                         {
 280                                 /* Pointer to the start of the current 16-byte chunk in the read block of data */
 281                                 uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];
 282
 283                                 /* Print out the 16 bytes of the chunk in HEX format */
 284                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 285                                 {
 286                                         char CurrByte = *(ChunkPtr + ByteOffset);
 287
 288                                         printf_P(PSTR("%.2X "), CurrByte);
 289                                 }
 290
 291                                 puts_P(PSTR("    "));
 292
 293                                 /* Print out the 16 bytes of the chunk in ASCII format */
 294                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 295                                 {
 296                                         char CurrByte = *(ChunkPtr + ByteOffset);
 297
 298                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 299                                 }
 300
 301                                 puts_P(PSTR("\r\n"));
 302                         }
 303
 304                         puts_P(PSTR("\r\n\r\nPress board button to read entire ASCII contents of disk...\r\n\r\n"));
 305
 306                         /* Wait for the board button to be pressed */
 307                         while (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
 308                         {
 309                                 /* Abort if device removed */
 310                                 if (!(USB_IsConnected))
 311                                   break;
 312                         }
 313
 314                         /* Print out the entire disk contents in ASCII format */
 315                         for (uint32_t CurrBlock = 0; CurrBlock < DiskCapacity.Blocks; CurrBlock++)
 316                         {
 317                                 /* Read in the next block of data from the device */
 318                                 if (((ErrorCode = MassStore_ReadDeviceBlock(0, CurrBlock, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0) ||
 319                                     (SCSICommandStatus.Status != Command_Pass))
 320                                 {
 321                                         ShowDiskReadError(PSTR("Read Device Block"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 322                                         break;
 323                                 }
 324
 325                                 /* Send the ASCII data in the read in block to the serial port */
 326                                 for (uint16_t Byte = 0; Byte < DiskCapacity.BlockSize; Byte++)
 327                                 {
 328                                         char CurrByte = BlockBuffer[Byte];
 329
 330                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 331                                 }
 332
 333                                 /* Abort if device removed */
 334                                 if (!(USB_IsConnected))
 335                                   break;
 336                         }
 337
 338                         /* Indicate device no longer busy */
 339                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 340
 341                         /* Wait until USB device disconnected */
 342                         while (USB_IsConnected);
 343
 344                         break;
 345         }
 346 }
 347
 348 /** Indicates that a communication error has occurred with the attached Mass Storage Device,
 349  *  printing error codes to the serial port and waiting until the device is removed before
 350  *  continuing.
 351  *
 352  *  \param CommandString  ASCII string located in PROGMEM space indicating what operation failed
 353  *  \param FailedAtSCSILayer  Indicates if the command failed at the (logical) SCSI layer or at the physical USB layer
 354  *  \param ErrorCode      Error code of the function which failed to complete successfully
 355  */
 356 void ShowDiskReadError(char* CommandString, bool FailedAtSCSILayer, uint8_t ErrorCode)
 357 {
 358         if (FailedAtSCSILayer)
 359         {
 360                 /* Display the error code */
 361                 printf_P(PSTR(ESC_BG_RED "SCSI command error (%S).\r\n"), CommandString);
 362                 printf_P(PSTR("  -- Status Code: %d"), ErrorCode);
 363         }
 364         else
 365         {
 366                 /* Display the error code */
 367                 printf_P(PSTR(ESC_BG_RED "Command error (%S).\r\n"), CommandString);
 368                 printf_P(PSTR("  -- Error Code: %d"), ErrorCode);
 369         }
 370
 371         Pipe_Freeze();
 372
 373         /* Indicate device error via the status LEDs */
 374         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 375
 376         /* Wait until USB device disconnected */
 377         while (USB_IsConnected);
 378 }