Seperated out OTG, Device and Host mode demos into seperate folders for clarity....
[pub/lufa.git] / Demos / MassStorageHost / MassStorageHost.c
diff --git a/Demos/MassStorageHost/MassStorageHost.c b/Demos/MassStorageHost/MassStorageHost.c
deleted file mode 100644 (file)
index d042b78..0000000
+++ /dev/null
@@ -1,420 +0,0 @@
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Main source file for the MassStorageHost demo. This file contains the main tasks of\r
- *  the demo and is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#include "MassStorageHost.h"\r
-\r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,    "LUFA MS Host App");\r
-BUTTLOADTAG(BuildTime,   __TIME__);\r
-BUTTLOADTAG(BuildDate,   __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
-       { Task: USB_MassStore_Host   , TaskStatus: TASK_STOP },\r
-};\r
-\r
-/* Globals */\r
-/** Index of the highest available LUN (Logical Unit) in the attached Mass Storage Device */\r
-uint8_t MassStore_MaxLUNIndex;\r
-\r
-\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  starts the scheduler to run the application tasks.\r
- */\r
-int main(void)\r
-{\r
-       /* Disable watchdog if enabled by bootloader/fuses */\r
-       MCUSR &= ~(1 << WDRF);\r
-       wdt_disable();\r
-\r
-       /* Disable clock division */\r
-       clock_prescale_set(clock_div_1);\r
-\r
-       /* Hardware Initialization */\r
-       SerialStream_Init(9600, false);\r
-       LEDs_Init();\r
-       HWB_Init();\r
-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-\r
-       /* Startup message */\r
-       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
-              "MassStore Host Demo running.\r\n" ESC_INVERSE_OFF));\r
-                  \r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
-\r
-       /* Initialize USB Subsystem */\r
-       USB_Init();\r
-       \r
-       /* Scheduling routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\r
-}\r
-\r
-/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
- *  starts the library USB task to begin the enumeration and USB management process.\r
- */\r
-EVENT_HANDLER(USB_DeviceAttached)\r
-{\r
-       puts_P(PSTR("Device Attached.\r\n"));\r
-       UpdateStatus(Status_USBEnumerating);\r
-       \r
-       /* Start USB management task to enumerate the device */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-}\r
-\r
-/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
- *  stops the library USB task management process.\r
- */\r
-EVENT_HANDLER(USB_DeviceUnattached)\r
-{\r
-       /* Stop USB management and Mass Storage tasks */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_MassStore_Host, TASK_STOP);\r
-\r
-       puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
-       UpdateStatus(Status_USBNotReady);\r
-}\r
-\r
-/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
- *  enumerated by the host and is now ready to be used by the application.\r
- */\r
-EVENT_HANDLER(USB_DeviceEnumerationComplete)\r
-{\r
-       /* Once device is fully enumerated, start the Mass Storage Host task */\r
-       Scheduler_SetTaskMode(USB_MassStore_Host, TASK_RUN);\r
-       \r
-       /* Indicate device enumeration complete */\r
-       UpdateStatus(Status_USBReady);\r
-}\r
-\r
-/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
-EVENT_HANDLER(USB_HostError)\r
-{\r
-       USB_ShutDown();\r
-\r
-       puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
-\r
-       UpdateStatus(Status_HardwareError);\r
-       for(;;);\r
-}\r
-\r
-/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while\r
- *  enumerating an attached USB device.\r
- */\r
-EVENT_HANDLER(USB_DeviceEnumerationFailed)\r
-{\r
-       puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
-       printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);\r
-       printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);\r
-       \r
-       UpdateStatus(Status_EnumerationError);\r
-}\r
-\r
-/** Task to set the configuration of the attached device after it has been enumerated, and to read in blocks from\r
- *  the device and print them to the serial port.\r
- */\r
-TASK(USB_MassStore_Host)\r
-{\r
-       uint8_t ErrorCode;\r
-\r
-       switch (USB_HostState)\r
-       {\r
-               case HOST_STATE_Addressed:\r
-                       /* Standard request to set the device configuration to configuration 1 */\r
-                       USB_HostRequest = (USB_Host_Request_Header_t)\r
-                               {\r
-                                       bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
-                                       bRequest:      REQ_SetConfiguration,\r
-                                       wValue:        1,\r
-                                       wIndex:        0,\r
-                                       wLength:       0,\r
-                               };\r
-                               \r
-                       /* Send the request, display error and wait for device detatch if request fails */\r
-                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               puts_P(PSTR("Control Error (Set Configuration).\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-\r
-                               /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-                               \r
-                       USB_HostState = HOST_STATE_Configured;\r
-                       break;\r
-               case HOST_STATE_Configured:\r
-                       puts_P(PSTR("Getting Config Data.\r\n"));\r
-               \r
-                       /* Get and process the configuration descriptor data */\r
-                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
-                       {\r
-                               if (ErrorCode == ControlError)\r
-                                 puts_P(PSTR("Control Error (Get Configuration).\r\n"));\r
-                               else\r
-                                 puts_P(PSTR("Invalid Device.\r\n"));\r
-\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-                               \r
-                               /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-\r
-                       puts_P(PSTR("Mass Storage Disk Enumerated.\r\n"));\r
-                               \r
-                       USB_HostState = HOST_STATE_Ready;\r
-                       break;\r
-               case HOST_STATE_Ready:\r
-                       /* Indicate device busy via the status LEDs */\r
-                       UpdateStatus(Status_Busy);\r
-                       \r
-                       /* Reset the Mass Storage device interface, ready for use */\r
-                       if ((ErrorCode = MassStore_MassStorageReset()) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               ShowDiskReadError(PSTR("Mass Storage Reset"), ErrorCode);\r
-                               break;\r
-                       }\r
-                       \r
-                       /* Send the request, display error and wait for device detatch if request fails */\r
-                       if ((ErrorCode = MassStore_GetMaxLUN(&MassStore_MaxLUNIndex)) != HOST_SENDCONTROL_Successful)\r
-                       {       \r
-                               ShowDiskReadError(PSTR("Get Max LUN"), ErrorCode);\r
-                               break;\r
-                       }\r
-                       \r
-                       /* Print number of LUNs detected in the attached device */\r
-                       printf_P(PSTR("Total LUNs: %d.\r\n"), (MassStore_MaxLUNIndex + 1));\r
-\r
-                       /* Set the prevent removal flag for the device, allowing it to be accessed */\r
-                       if ((ErrorCode = MassStore_PreventAllowMediumRemoval(0, true)) != 0)\r
-                       {\r
-                               ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), ErrorCode);\r
-                               break;\r
-                       }\r
-                       \r
-                       /* Get sense data from the device - many devices will not accept any other commands until the sense data\r
-                        * is read - both on startup and after a failed command */\r
-                       SCSI_Request_Sense_Response_t SenseData;\r
-                       if ((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0)\r
-                       {\r
-                               ShowDiskReadError(PSTR("Request Sense"), ErrorCode);\r
-                               break;\r
-                       }\r
-\r
-                       puts_P(PSTR("Waiting until ready"));\r
-                       \r
-                       /* Wait until disk ready */\r
-                       do\r
-                       {\r
-                               Serial_TxByte('.');\r
-                               MassStore_TestUnitReady(0);\r
-                       }\r
-                       while ((SCSICommandStatus.Status != Command_Pass) && USB_IsConnected);\r
-                       \r
-                       /* Abort if device removed */\r
-                       if (!(USB_IsConnected))\r
-                         break;\r
-\r
-                       puts_P(PSTR("\r\nRetrieving Capacity... "));\r
-\r
-                       /* Create new structure for the disk's capacity in blocks and block size */\r
-                       SCSI_Capacity_t DiskCapacity;\r
-\r
-                       /* Retrieve disk capacity */\r
-                       if ((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0)\r
-                       {\r
-                               ShowDiskReadError(PSTR("Read Capacity"), ErrorCode);\r
-                               break;\r
-                       }\r
-                       \r
-                       /* Display the disk capacity in blocks * block size bytes */\r
-                       printf_P(PSTR("%lu blocks of %lu bytes.\r\n"), DiskCapacity.Blocks, DiskCapacity.BlockSize);\r
-                       \r
-                       /* Create a new buffer capabable of holding a single block from the device */\r
-                       uint8_t BlockBuffer[DiskCapacity.BlockSize];\r
-\r
-                       /* Read in the first 512 byte block from the device */\r
-                       if ((ErrorCode = MassStore_ReadDeviceBlock(0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)\r
-                       {\r
-                               ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);\r
-                               break;\r
-                       }\r
-                       \r
-                       /* Show the number of bytes not transferred in the previous command */\r
-                       printf_P(PSTR("Transfer Residue: %lu\r\n"), SCSICommandStatus.DataTransferResidue);\r
-                       \r
-                       puts_P(PSTR("\r\nContents of first block:\r\n"));\r
-\r
-                       /* Print out the first block in both HEX and ASCII, 16 bytes per line */\r
-                       for (uint16_t Chunk = 0; Chunk < (DiskCapacity.BlockSize >> 4); Chunk++)\r
-                       {\r
-                               /* Pointer to the start of the current 16-byte chunk in the read block of data */\r
-                               uint8_t* ChunkPtr = &BlockBuffer[Chunk << 4];\r
-                               \r
-                               /* Print out the 16 bytes of the chunk in HEX format */\r
-                               for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)\r
-                               {\r
-                                       char CurrByte = *(ChunkPtr + ByteOffset);\r
-                               \r
-                                       printf_P(PSTR("%.2X "), CurrByte);\r
-                               }\r
-                               \r
-                               puts_P(PSTR("    "));\r
-\r
-                               /* Print out the 16 bytes of the chunk in ASCII format */\r
-                               for (uint8_t ByteOffset = 0; ByteOffset < (1 << 4); ByteOffset++)\r
-                               {\r
-                                       char CurrByte = *(ChunkPtr + ByteOffset);\r
-                               \r
-                                       putchar(isprint(CurrByte) ? CurrByte : '.');\r
-                               }\r
-                               \r
-                               puts_P(PSTR("\r\n"));\r
-                       }\r
-                       \r
-                       puts_P(PSTR("\r\n\r\nPress HWB to read entire ASCII contents of disk...\r\n\r\n"));\r
-                       \r
-                       /* Wait for HWB to be pressed */\r
-                       while (!(HWB_GetStatus()))\r
-                       {\r
-                               /* Abort if device removed */\r
-                               if (!(USB_IsConnected))\r
-                                 break;\r
-                       }\r
-                       \r
-                       /* Print out the entire disk contents in ASCII format */\r
-                       for (uint32_t CurrBlock = 0; CurrBlock < DiskCapacity.Blocks; CurrBlock++)\r
-                       {\r
-                               /* Read in the next block of data from the device */\r
-                               if ((ErrorCode = MassStore_ReadDeviceBlock(0, CurrBlock, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)\r
-                               {\r
-                                       ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);\r
-                                       break;\r
-                               }\r
-\r
-                               /* Send the ASCII data in the read in block to the serial port */\r
-                               for (uint16_t Byte = 0; Byte < DiskCapacity.BlockSize; Byte++)\r
-                               {\r
-                                       char CurrByte = BlockBuffer[Byte];\r
-                                       \r
-                                       putchar(isprint(CurrByte) ? CurrByte : '.');\r
-                               }\r
-\r
-                               /* Abort if device removed */\r
-                               if (!(USB_IsConnected))\r
-                                 break;\r
-                       }\r
-                       \r
-                       /* Indicate device no longer busy */\r
-                       UpdateStatus(Status_USBReady);\r
-                       \r
-                       /* Wait until USB device disconnected */\r
-                       while (USB_IsConnected);\r
-                       \r
-                       break;\r
-       }\r
-}\r
-\r
-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- *  log to a serial port, or anything else that is suitable for status updates.\r
- *\r
- *  \param CurrentStatus  Current status of the system, from the MassStorageHost_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
-       uint8_t LEDMask = LEDS_NO_LEDS;\r
-       \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2);\r
-                       break;\r
-               case Status_EnumerationError:\r
-               case Status_HardwareError:\r
-               case Status_SCSICommandError:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED3);\r
-                       break;\r
-               case Status_Busy:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED4);\r
-                       break;\r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Indicates that a communication error has ocurred with the attached Mass Storage Device,\r
- *  printing error codes to the serial port and waiting until the device is removed before\r
- *  continuing.\r
- *\r
- *  \param CommandString  ASCII string located in PROGMEM space indicating what operation failed\r
- *  \param ErrorCode      Error code of the function which failed to complete successfully\r
- */\r
-void ShowDiskReadError(char* CommandString, uint8_t ErrorCode)\r
-{\r
-       /* Display the error code */\r
-       printf_P(PSTR(ESC_BG_RED "Command error (%S).\r\n"), CommandString);\r
-       printf_P(PSTR("  -- Error Code: %d"), ErrorCode);\r
-       \r
-       Pipe_Freeze();\r
-\r
-       /* Indicate device error via the status LEDs */\r
-       UpdateStatus(Status_SCSICommandError);\r
-\r
-       /* Wait until USB device disconnected */\r
-       while (USB_IsConnected);\r
-}\r