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