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.lufa-lib.org
   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         sei();
  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_Host_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_Host_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_Host_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_Host_HostError(const uint8_t ErrorCode)
 107 {
 108         USB_ShutDown();
 109
 110         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 111                                  " -- 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_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 121                                             const uint8_t SubErrorCode)
 122 {
 123         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 124                                  " -- Error Code %d\r\n"
 125                                  " -- Sub Error Code %d\r\n"
 126                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, 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(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 148                                 else
 149                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 150
 151                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), 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                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 165                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), 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                         puts_P(PSTR("Mass Storage Disk Enumerated.\r\n"));
 176
 177                         USB_HostState = HOST_STATE_Configured;
 178                         break;
 179                 case HOST_STATE_Configured:
 180                         /* Indicate device busy via the status LEDs */
 181                         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 182
 183                         /* Send the request, display error and wait for device detach if request fails */
 184                         if ((ErrorCode = MassStore_GetMaxLUN(&MassStore_MaxLUNIndex)) != HOST_SENDCONTROL_Successful)
 185                         {
 186                                 ShowDiskReadError(PSTR("Get Max LUN"), ErrorCode);
 187
 188                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 189                                 break;
 190                         }
 191
 192                         /* Print number of LUNs detected in the attached device */
 193                         printf_P(PSTR("Total LUNs: %d - Using first LUN in device.\r\n"), (MassStore_MaxLUNIndex + 1));
 194
 195                         /* Reset the Mass Storage device interface, ready for use */
 196                         if ((ErrorCode = MassStore_MassStorageReset()) != HOST_SENDCONTROL_Successful)
 197                         {
 198                                 ShowDiskReadError(PSTR("Mass Storage Reset"), ErrorCode);
 199
 200                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 201                                 break;
 202                         }
 203
 204                         /* Get sense data from the device - many devices will not accept any other commands until the sense data
 205                          * is read - both on start-up and after a failed command */
 206                         SCSI_Request_Sense_Response_t SenseData;
 207                         if ((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0)
 208                         {
 209                                 ShowDiskReadError(PSTR("Request Sense"), ErrorCode);
 210                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 211                                 break;
 212                         }
 213
 214                         /* Set the prevent removal flag for the device, allowing it to be accessed */
 215                         if ((ErrorCode = MassStore_PreventAllowMediumRemoval(0, true)) != 0)
 216                         {
 217                                 ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), ErrorCode);
 218
 219                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 220                                 break;
 221                         }
 222
 223                         /* Get inquiry data from the device */
 224                         SCSI_Inquiry_Response_t InquiryData;
 225                         if ((ErrorCode = MassStore_Inquiry(0, &InquiryData)) != 0)
 226                         {
 227                                 ShowDiskReadError(PSTR("Inquiry"), ErrorCode);
 228
 229                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 230                                 break;
 231                         }
 232
 233                         /* Print vendor and product names of attached device */
 234                         printf_P(PSTR("Vendor \"%.8s\", Product \"%.16s\"\r\n"), InquiryData.VendorID, InquiryData.ProductID);
 235
 236                         /* Wait until disk ready */
 237                         puts_P(PSTR("Waiting until ready.."));
 238
 239                         for (;;)
 240                         {
 241                                 Serial_TxByte('.');
 242
 243                                 /* Abort if device removed */
 244                                 if (USB_HostState == HOST_STATE_Unattached)
 245                                   break;
 246
 247                                 /* Check to see if the attached device is ready for new commands */
 248                                 ErrorCode = MassStore_TestUnitReady(0);
 249
 250                                 /* If attached device is ready, abort the loop */
 251                                 if (!(ErrorCode))
 252                                   break;
 253
 254                                 /* If an error other than a logical command failure (indicating device busy) returned, abort */
 255                                 if (ErrorCode != MASS_STORE_SCSI_COMMAND_FAILED)
 256                                 {
 257                                         ShowDiskReadError(PSTR("Test Unit Ready"), ErrorCode);
 258
 259                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 260                                         break;
 261                                 }
 262                         }
 263
 264                         puts_P(PSTR("\r\nRetrieving Capacity... "));
 265
 266                         /* Create new structure for the disk's capacity in blocks and block size */
 267                         SCSI_Capacity_t DiskCapacity;
 268
 269                         /* Retrieve disk capacity */
 270                         if ((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0)
 271                         {
 272                                 ShowDiskReadError(PSTR("Read Capacity"), ErrorCode);
 273
 274                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 275                                 break;
 276                         }
 277
 278                         /* Display the disk capacity in blocks * block size bytes */
 279                         printf_P(PSTR("%lu blocks of %lu bytes.\r\n"), DiskCapacity.Blocks, DiskCapacity.BlockSize);
 280
 281                         /* Create a new buffer capable of holding a single block from the device */
 282                         uint8_t BlockBuffer[DiskCapacity.BlockSize];
 283
 284                         /* Read in the first 512 byte block from the device */
 285                         if ((ErrorCode = MassStore_ReadDeviceBlock(0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)
 286                         {
 287                                 ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);
 288
 289                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 290                                 break;
 291                         }
 292
 293                         puts_P(PSTR("\r\nContents of first block:\r\n"));
 294
 295                         /* Print out the first block in both HEX and ASCII, 16 bytes per line */
 296                         for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)
 297                         {
 298                                 /* Pointer to the start of the current 16-byte chunk in the read block of data */
 299                                 uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];
 300
 301                                 /* Print out the 16 bytes of the chunk in HEX format */
 302                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 303                                 {
 304                                         char CurrByte = *(ChunkPtr + ByteOffset);
 305
 306                                         printf_P(PSTR("%.2X "), CurrByte);
 307                                 }
 308
 309                                 puts_P(PSTR("    "));
 310
 311                                 /* Print out the 16 bytes of the chunk in ASCII format */
 312                                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 313                                 {
 314                                         char CurrByte = *(ChunkPtr + ByteOffset);
 315
 316                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 317                                 }
 318
 319                                 puts_P(PSTR("\r\n"));
 320                         }
 321
 322                         puts_P(PSTR("\r\n\r\nPress board button to read entire ASCII contents of disk...\r\n\r\n"));
 323
 324                         /* Wait for the board button to be pressed */
 325                         while (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
 326                         {
 327                                 /* Abort if device removed */
 328                                 if (USB_HostState == HOST_STATE_Unattached)
 329                                   break;
 330                         }
 331
 332                         /* Abort if device removed */
 333                         if (USB_HostState == HOST_STATE_Unattached)
 334                           break;
 335
 336                         /* Print out the entire disk contents in ASCII format */
 337                         for (uint32_t CurrBlockAddress = 0; CurrBlockAddress < DiskCapacity.Blocks; CurrBlockAddress++)
 338                         {
 339                                 /* Read in the next block of data from the device */
 340                                 if ((ErrorCode = MassStore_ReadDeviceBlock(0, CurrBlockAddress, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)
 341                                 {
 342                                         ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);
 343
 344                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 345                                         break;
 346                                 }
 347
 348                                 /* Send the ASCII data in the read in block to the serial port */
 349                                 for (uint16_t Byte = 0; Byte < DiskCapacity.BlockSize; Byte++)
 350                                 {
 351                                         char CurrByte = BlockBuffer[Byte];
 352
 353                                         putchar(isprint(CurrByte) ? CurrByte : '.');
 354                                 }
 355
 356                                 /* Abort if device removed */
 357                                 if (USB_HostState == HOST_STATE_Unattached)
 358                                   break;
 359                         }
 360
 361                         /* Indicate device no longer busy */
 362                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 363
 364                         /* Wait until USB device disconnected */
 365                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 366                         break;
 367         }
 368 }
 369
 370 /** Indicates that a communication error has occurred with the attached Mass Storage Device,
 371  *  printing error codes to the serial port and waiting until the device is removed before
 372  *  continuing.
 373  *
 374  *  \param[in] CommandString  ASCII string located in PROGMEM space indicating what operation failed
 375  *  \param[in] ErrorCode      Error code of the function which failed to complete successfully
 376  */
 377 void ShowDiskReadError(char* CommandString,
 378                        const uint8_t ErrorCode)
 379 {
 380         if (ErrorCode == MASS_STORE_SCSI_COMMAND_FAILED)
 381         {
 382                 /* Display the error code */
 383                 printf_P(PSTR(ESC_FG_RED "SCSI command error (%S).\r\n"), CommandString);
 384         }
 385         else
 386         {
 387                 /* Display the error code */
 388                 printf_P(PSTR(ESC_FG_RED "Command error (%S).\r\n"), CommandString);
 389                 printf_P(PSTR("  -- Error Code: %d" ESC_FG_WHITE), ErrorCode);
 390         }
 391
 392         Pipe_Freeze();
 393
 394         /* Indicate device error via the status LEDs */
 395         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 396 }
 397