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                         /* Standard request to set the device configuration to configuration 1 */
 142                         USB_ControlRequest = (USB_Request_Header_t)
 143                                 {
 144                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 145                                         .bRequest      = REQ_SetConfiguration,
 146                                         .wValue        = 1,
 147                                         .wIndex        = 0,
 148                                         .wLength       = 0,
 149                                 };
 150
 151                         /* Select the control pipe for the request transfer */
 152                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 153
 154                         /* Send the request, display error and wait for device detach if request fails */
 155                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 156                         {
 157                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 158                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 159
 160                                 /* Indicate error via status LEDs */
 161                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 162
 163                                 /* Wait until USB device disconnected */
 164                                 while (USB_IsConnected);
 165                                 break;
 166                         }
 167
 168                         USB_HostState = HOST_STATE_Configured;
 169                         break;
 170                 case HOST_STATE_Configured:
 171                         puts_P(PSTR("Getting Config Data.\r\n"));
 172
 173                         /* Get and process the configuration descriptor data */
 174                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 175                         {
 176                                 if (ErrorCode == ControlError)
 177                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 178                                 else
 179                                   puts_P(PSTR("Invalid Device.\r\n"));
 180
 181                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 182
 183                                 /* Indicate error via status LEDs */
 184                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 185
 186                                 /* Wait until USB device disconnected */
 187                                 while (USB_IsConnected);
 188                                 break;
 189                         }
 190
 191                         puts_P(PSTR("Mass Storage Disk Enumerated.\r\n"));
 192
 193                         USB_HostState = HOST_STATE_Ready;
 194                         break;
 195                 case HOST_STATE_Ready:
 196                         /* Indicate device busy via the status LEDs */
 197                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 198
 199                         /* Send the request, display error and wait for device detach if request fails */
 200                         if ((ErrorCode = MassStore_GetMaxLUN(&MassStore_MaxLUNIndex)) != HOST_SENDCONTROL_Successful)
 201                         {
 202                                 ShowDiskReadError(PSTR("Get Max LUN"), false, ErrorCode);
 203                                 break;
 204                         }
 205
 206                         /* Print number of LUNs detected in the attached device */
 207                         printf_P(PSTR("Total LUNs: %d.\r\n"), (MassStore_MaxLUNIndex + 1));
 208
 209                         /* Reset the Mass Storage device interface, ready for use */
 210                         if ((ErrorCode = MassStore_MassStorageReset()) != HOST_SENDCONTROL_Successful)
 211                         {
 212                                 ShowDiskReadError(PSTR("Mass Storage Reset"), false, ErrorCode);
 213                                 break;
 214                         }
 215
 216                         /* Get sense data from the device - many devices will not accept any other commands until the sense data
 217                          * is read - both on start-up and after a failed command */
 218                         SCSI_Request_Sense_Response_t SenseData;
 219                         if (((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0) || (SCSICommandStatus.Status != Command_Pass))
 220                         {
 221                                 ShowDiskReadError(PSTR("Request Sense"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 222                                 break;
 223                         }
 224
 225                         /* Set the prevent removal flag for the device, allowing it to be accessed */
 226                         if (((ErrorCode = MassStore_PreventAllowMediumRemoval(0, true)) != 0) || (SCSICommandStatus.Status != Command_Pass))
 227                         {
 228                                 ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 229                                 break;
 230                         }
 231
 232                         puts_P(PSTR("Waiting until ready.."));
 233
 234                         /* Wait until disk ready */
 235                         do
 236                         {
 237                                 Serial_TxByte('.');
 238
 239                                 if ((ErrorCode = MassStore_TestUnitReady(0)) != 0)
 240                                 {
 241                                         ShowDiskReadError(PSTR("Test Unit Ready"), false, ErrorCode);
 242                                         break;
 243                                 }
 244                         }
 245                         while ((SCSICommandStatus.Status != Command_Pass) && USB_IsConnected);
 246
 247                         /* Abort if device removed */
 248                         if (!(USB_IsConnected))
 249                           break;
 250
 251                         puts_P(PSTR("\r\nRetrieving Capacity... "));
 252
 253                         /* Create new structure for the disk's capacity in blocks and block size */
 254                         SCSI_Capacity_t DiskCapacity;
 255
 256                         /* Retrieve disk capacity */
 257                         if (((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0) || (SCSICommandStatus.Status != Command_Pass))
 258                         {
 259                                 ShowDiskReadError(PSTR("Read Capacity"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 260                                 break;
 261                         }
 262
 263                         /* Display the disk capacity in blocks * block size bytes */
 264                         printf_P(PSTR("%lu blocks of %lu bytes.\r\n"), DiskCapacity.Blocks, DiskCapacity.BlockSize);
 265
 266                         /* Create a new buffer capabable of holding a single block from the device */
 267                         uint8_t BlockBuffer[DiskCapacity.BlockSize];
 268
 269                         /* Read in the first 512 byte block from the device */
 270                         if (((ErrorCode = MassStore_ReadDeviceBlock(0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0) ||
 271                             (SCSICommandStatus.Status != Command_Pass))
 272                         {
 273                                 ShowDiskReadError(PSTR("Read Device Block"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 274                                 break;
 275                         }
 276
 277                         puts_P(PSTR("\r\nContents of first block:\r\n"));
 278
 279                         /* Print out the first block in both HEX and ASCII, 16 bytes per line */
 280                         for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)
 281                         {
 282                                 /* Pointer to the start of the current 16-byte chunk in the read block of data */
 283                                 uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];
 284
 285                                 /* Print out the 16 bytes of the chunk in HEX format */
 286                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 287                                 {
 288                                         char CurrByte = *(ChunkPtr + ByteOffset);
 289
 290                                         printf_P(PSTR("%.2X "), CurrByte);
 291                                 }
 292
 293                                 puts_P(PSTR("    "));
 294
 295                                 /* Print out the 16 bytes of the chunk in ASCII format */
 296                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 297                                 {
 298                                         char CurrByte = *(ChunkPtr + ByteOffset);
 299
 300                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 301                                 }
 302
 303                                 puts_P(PSTR("\r\n"));
 304                         }
 305
 306                         puts_P(PSTR("\r\n\r\nPress board button to read entire ASCII contents of disk...\r\n\r\n"));
 307
 308                         /* Wait for the board button to be pressed */
 309                         while (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
 310                         {
 311                                 /* Abort if device removed */
 312                                 if (!(USB_IsConnected))
 313                                   break;
 314                         }
 315
 316                         /* Print out the entire disk contents in ASCII format */
 317                         for (uint32_t CurrBlock = 0; CurrBlock < DiskCapacity.Blocks; CurrBlock++)
 318                         {
 319                                 /* Read in the next block of data from the device */
 320                                 if (((ErrorCode = MassStore_ReadDeviceBlock(0, CurrBlock, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0) ||
 321                                     (SCSICommandStatus.Status != Command_Pass))
 322                                 {
 323                                         ShowDiskReadError(PSTR("Read Device Block"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);
 324                                         break;
 325                                 }
 326
 327                                 /* Send the ASCII data in the read in block to the serial port */
 328                                 for (uint16_t Byte = 0; Byte < DiskCapacity.BlockSize; Byte++)
 329                                 {
 330                                         char CurrByte = BlockBuffer[Byte];
 331
 332                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 333                                 }
 334
 335                                 /* Abort if device removed */
 336                                 if (!(USB_IsConnected))
 337                                   break;
 338                         }
 339
 340                         /* Indicate device no longer busy */
 341                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 342
 343                         /* Wait until USB device disconnected */
 344                         while (USB_IsConnected);
 345
 346                         break;
 347         }
 348 }
 349
 350 /** Indicates that a communication error has occurred with the attached Mass Storage Device,
 351  *  printing error codes to the serial port and waiting until the device is removed before
 352  *  continuing.
 353  *
 354  *  \param CommandString  ASCII string located in PROGMEM space indicating what operation failed
 355  *  \param FailedAtSCSILayer  Indicates if the command failed at the (logical) SCSI layer or at the physical USB layer
 356  *  \param ErrorCode      Error code of the function which failed to complete successfully
 357  */
 358 void ShowDiskReadError(char* CommandString, bool FailedAtSCSILayer, uint8_t ErrorCode)
 359 {
 360         if (FailedAtSCSILayer)
 361         {
 362                 /* Display the error code */
 363                 printf_P(PSTR(ESC_BG_RED "SCSI command error (%S).\r\n"), CommandString);
 364                 printf_P(PSTR("  -- Status Code: %d"), ErrorCode);
 365         }
 366         else
 367         {
 368                 /* Display the error code */
 369                 printf_P(PSTR(ESC_BG_RED "Command error (%S).\r\n"), CommandString);
 370                 printf_P(PSTR("  -- Error Code: %d"), ErrorCode);
 371         }
 372
 373         Pipe_Freeze();
 374
 375         /* Indicate device error via the status LEDs */
 376         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 377
 378         /* Wait until USB device disconnected */
 379         while (USB_IsConnected);
 380 }