Demos/Host/ClassDriver/MassStorageHost/MassStorageHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
  40  *  passed to all Mass Storage Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_MS_Host_t FlashDisk_MS_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipeNumber       = 1,
  48                                 .DataINPipeDoubleBank   = false,
  49
  50                                 .DataOUTPipeNumber      = 2,
  51                                 .DataOUTPipeDoubleBank  = false,
  52                         },
  53         };
  54
  55
  56 /** Main program entry point. This routine configures the hardware required by the application, then
  57  *  enters a loop to run the application tasks in sequence.
  58  */
  59 int main(void)
  60 {
  61         SetupHardware();
  62
  63         puts_P(PSTR(ESC_FG_CYAN "Mass Storage Host Demo running.\r\n" ESC_FG_WHITE));
  64
  65         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  66         sei();
  67
  68         for (;;)
  69         {
  70                 MassStorageHost_Task();
  71
  72                 MS_Host_USBTask(&FlashDisk_MS_Interface);
  73                 USB_USBTask();
  74         }
  75 }
  76
  77 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  78 void SetupHardware(void)
  79 {
  80         /* Disable watchdog if enabled by bootloader/fuses */
  81         MCUSR &= ~(1 << WDRF);
  82         wdt_disable();
  83
  84         /* Disable clock division */
  85         clock_prescale_set(clock_div_1);
  86
  87         /* Hardware Initialization */
  88         Serial_Init(9600, false);
  89         LEDs_Init();
  90         USB_Init();
  91
  92         /* Create a stdio stream for the serial port for stdin and stdout */
  93         Serial_CreateStream(NULL);
  94 }
  95
  96 /** Task to manage an enumerated USB Mass Storage device once connected, to print out
  97  *  data from the device.
  98  */
  99 void MassStorageHost_Task(void)
 100 {
 101         if (USB_HostState != HOST_STATE_Configured)
 102           return;
 103
 104         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 105
 106         puts_P(PSTR("Waiting until ready...\r\n"));
 107
 108         for (;;)
 109         {
 110                 uint8_t ErrorCode = MS_Host_TestUnitReady(&FlashDisk_MS_Interface, 0);
 111
 112                 if (!(ErrorCode))
 113                   break;
 114
 115                 /* Check if an error other than a logical command error (device busy) received */
 116                 if (ErrorCode != MS_ERROR_LOGICAL_CMD_FAILED)
 117                 {
 118                         puts_P(PSTR("Error waiting for device to be ready.\r\n"));
 119                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 120                         USB_Host_SetDeviceConfiguration(0);
 121                         return;
 122                 }
 123         }
 124
 125         puts_P(PSTR("Retrieving Capacity...\r\n"));
 126
 127         SCSI_Capacity_t DiskCapacity;
 128         if (MS_Host_ReadDeviceCapacity(&FlashDisk_MS_Interface, 0, &DiskCapacity))
 129         {
 130                 puts_P(PSTR("Error retrieving device capacity.\r\n"));
 131                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 132                 USB_Host_SetDeviceConfiguration(0);
 133                 return;
 134         }
 135
 136         printf_P(PSTR("%lu blocks of %lu bytes.\r\n"), DiskCapacity.Blocks, DiskCapacity.BlockSize);
 137
 138         uint8_t BlockBuffer[DiskCapacity.BlockSize];
 139
 140         if (MS_Host_ReadDeviceBlocks(&FlashDisk_MS_Interface, 0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer))
 141         {
 142                 puts_P(PSTR("Error reading device block.\r\n"));
 143                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 144                 USB_Host_SetDeviceConfiguration(0);
 145                 return;
 146         }
 147
 148         puts_P(PSTR("\r\nContents of first block:\r\n"));
 149
 150         for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)
 151         {
 152                 uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];
 153
 154                 /* Print out the 16 bytes of the chunk in HEX format */
 155                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 156                 {
 157                         char CurrByte = *(ChunkPtr + ByteOffset);
 158                         printf_P(PSTR("%.2X "), CurrByte);
 159                 }
 160
 161                 printf_P(PSTR("    "));
 162
 163                 /* Print out the 16 bytes of the chunk in ASCII format */
 164                 for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)
 165                 {
 166                         char CurrByte = *(ChunkPtr + ByteOffset);
 167                         putchar(isprint(CurrByte) ? CurrByte : '.');
 168                 }
 169
 170                 printf_P(PSTR("\r\n"));
 171         }
 172
 173         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 174         USB_Host_SetDeviceConfiguration(0);
 175 }
 176
 177 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 178  *  starts the library USB task to begin the enumeration and USB management process.
 179  */
 180 void EVENT_USB_Host_DeviceAttached(void)
 181 {
 182         puts_P(PSTR("Device Attached.\r\n"));
 183         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 184 }
 185
 186 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 187  *  stops the library USB task management process.
 188  */
 189 void EVENT_USB_Host_DeviceUnattached(void)
 190 {
 191         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 192         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 193 }
 194
 195 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 196  *  enumerated by the host and is now ready to be used by the application.
 197  */
 198 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 199 {
 200         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 201
 202         uint16_t ConfigDescriptorSize;
 203         uint8_t  ConfigDescriptorData[512];
 204
 205         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 206                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 207         {
 208                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 209                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 210                 return;
 211         }
 212
 213         if (MS_Host_ConfigurePipes(&FlashDisk_MS_Interface,
 214                                    ConfigDescriptorSize, ConfigDescriptorData) != MS_ENUMERROR_NoError)
 215         {
 216                 puts_P(PSTR("Attached Device Not a Valid Mass Storage Device.\r\n"));
 217                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 218                 return;
 219         }
 220
 221         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 222         {
 223                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 224                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 225                 return;
 226         }
 227
 228         uint8_t MaxLUNIndex;
 229         if (MS_Host_GetMaxLUN(&FlashDisk_MS_Interface, &MaxLUNIndex))
 230         {
 231                 puts_P(PSTR("Error retrieving max LUN index.\r\n"));
 232                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 233                 USB_Host_SetDeviceConfiguration(0);
 234                 return;
 235         }
 236
 237         printf_P(PSTR("Total LUNs: %d - Using first LUN in device.\r\n"), (MaxLUNIndex + 1));
 238
 239         if (MS_Host_ResetMSInterface(&FlashDisk_MS_Interface))
 240         {
 241                 puts_P(PSTR("Error resetting Mass Storage interface.\r\n"));
 242                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 243                 USB_Host_SetDeviceConfiguration(0);
 244                 return;
 245         }
 246
 247         SCSI_Request_Sense_Response_t SenseData;
 248         if (MS_Host_RequestSense(&FlashDisk_MS_Interface, 0, &SenseData) != 0)
 249         {
 250                 puts_P(PSTR("Error retrieving device sense.\r\n"));
 251                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 252                 USB_Host_SetDeviceConfiguration(0);
 253                 return;
 254         }
 255
 256         if (MS_Host_PreventAllowMediumRemoval(&FlashDisk_MS_Interface, 0, true))
 257         {
 258                 puts_P(PSTR("Error setting Prevent Device Removal bit.\r\n"));
 259                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 260                 USB_Host_SetDeviceConfiguration(0);
 261                 return;
 262         }
 263
 264         SCSI_Inquiry_Response_t InquiryData;
 265         if (MS_Host_GetInquiryData(&FlashDisk_MS_Interface, 0, &InquiryData))
 266         {
 267                 puts_P(PSTR("Error retrieving device Inquiry data.\r\n"));
 268                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 269                 USB_Host_SetDeviceConfiguration(0);
 270                 return;
 271         }
 272
 273         printf_P(PSTR("Vendor \"%.8s\", Product \"%.16s\"\r\n"), InquiryData.VendorID, InquiryData.ProductID);
 274
 275         puts_P(PSTR("Mass Storage Device Enumerated.\r\n"));
 276         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 277 }
 278
 279 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 280 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 281 {
 282         USB_Disable();
 283
 284         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 285                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 286
 287         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 288         for(;;);
 289 }
 290
 291 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 292  *  enumerating an attached USB device.
 293  */
 294 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 295                                             const uint8_t SubErrorCode)
 296 {
 297         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 298                                  " -- Error Code %d\r\n"
 299                                  " -- Sub Error Code %d\r\n"
 300                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 301
 302         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 303 }
 304