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