Remove old OTG demo directory with useless TestApp demo. Add new DualRole directory...
[pub/USBasp.git] / Demos / Host / LowLevel / MassStorageHost / MassStorageHost.c
index a2e6631..855ce8d 100644 (file)
 \r
 #include "MassStorageHost.h"\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
@@ -53,6 +46,22 @@ uint8_t MassStore_MaxLUNIndex;
  */\r
 int main(void)\r
 {\r
+       SetupHardware();\r
+\r
+       puts_P(PSTR(ESC_FG_CYAN "Mass Storage Host Demo running.\r\n" ESC_FG_WHITE));\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               MassStorage_Task();\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
+void SetupHardware(void)\r
+{\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
@@ -64,205 +73,192 @@ int main(void)
        SerialStream_Init(9600, false);\r
        LEDs_Init();\r
        Buttons_Init();\r
-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-\r
-       /* Start-up 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
-void EVENT_USB_DeviceAttached(void)\r
+void EVENT_USB_Host_DeviceAttached(void)\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
+       puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\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
-void EVENT_USB_DeviceUnattached(void)\r
+void EVENT_USB_Host_DeviceUnattached(void)\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
+       puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\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
-void EVENT_USB_DeviceEnumerationComplete(void)\r
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\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
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
 }\r
 \r
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
-void EVENT_USB_HostError(const uint8_t ErrorCode)\r
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\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
+       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r
 \r
-       UpdateStatus(Status_HardwareError);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
        for(;;);\r
 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
  *  enumerating an attached USB device.\r
  */\r
-void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\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
+       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"\r
+                                " -- Error Code %d\r\n"\r
+                                " -- Sub Error Code %d\r\n"\r
+                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);\r
        \r
-       UpdateStatus(Status_EnumerationError);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\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
+void MassStorage_Task(void)\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_ControlRequest = (USB_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
-                       /* Select the control pipe for the request transfer */\r
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-                       /* Send the request, display error and wait for device detach 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
+                                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));\r
                                else\r
-                                 puts_P(PSTR("Invalid Device.\r\n"));\r
+                                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));\r
 \r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
+                               printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
                                \r
                                /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 \r
                                /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
 \r
-                       puts_P(PSTR("Mass Storage Disk Enumerated.\r\n"));\r
+                       /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */\r
+                       if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)\r
+                       {\r
+                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"\r
+                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
+\r
+                               /* Indicate error via status LEDs */\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+\r
+                               /* Wait until USB device disconnected */\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                               break;\r
+                       }\r
                                \r
-                       USB_HostState = HOST_STATE_Ready;\r
+                       puts_P(PSTR("Mass Storage Disk Enumerated.\r\n"));\r
+\r
+                       USB_HostState = HOST_STATE_Configured;\r
                        break;\r
-               case HOST_STATE_Ready:\r
+               case HOST_STATE_Configured:\r
                        /* Indicate device busy via the status LEDs */\r
-                       UpdateStatus(Status_Busy);\r
+                       LEDs_SetAllLEDs(LEDMASK_USB_BUSY);\r
                        \r
                        /* Send the request, display error and wait for device detach if request fails */\r
                        if ((ErrorCode = MassStore_GetMaxLUN(&MassStore_MaxLUNIndex)) != HOST_SENDCONTROL_Successful)\r
                        {       \r
-                               ShowDiskReadError(PSTR("Get Max LUN"), false, ErrorCode);\r
+                               ShowDiskReadError(PSTR("Get Max LUN"), ErrorCode);\r
+\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\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
+                       printf_P(PSTR("Total LUNs: %d - Using first LUN in device.\r\n"), (MassStore_MaxLUNIndex + 1));\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"), false, ErrorCode);\r
+                               ShowDiskReadError(PSTR("Mass Storage Reset"), ErrorCode);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\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 start-up and after a failed command */\r
                        SCSI_Request_Sense_Response_t SenseData;\r
-                       if (((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0) || (SCSICommandStatus.Status != Command_Pass))\r
+                       if ((ErrorCode = MassStore_RequestSense(0, &SenseData)) != 0)\r
                        {\r
-                               ShowDiskReadError(PSTR("Request Sense"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);\r
+                               ShowDiskReadError(PSTR("Request Sense"), ErrorCode);\r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
                        /* Set the prevent removal flag for the device, allowing it to be accessed */\r
-                       if (((ErrorCode = MassStore_PreventAllowMediumRemoval(0, true)) != 0) || (SCSICommandStatus.Status != Command_Pass))\r
+                       if ((ErrorCode = MassStore_PreventAllowMediumRemoval(0, true)) != 0)\r
                        {\r
-                               ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);\r
+                               ShowDiskReadError(PSTR("Prevent/Allow Medium Removal"), ErrorCode);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
 \r
-                       puts_P(PSTR("Waiting until ready.."));\r
-                       \r
+                       /* Get inquiry data from the device */\r
+                       SCSI_Inquiry_Response_t InquiryData;\r
+                       if ((ErrorCode = MassStore_Inquiry(0, &InquiryData)) != 0)\r
+                       {\r
+                               ShowDiskReadError(PSTR("Inquiry"), ErrorCode);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                               break;\r
+                       }\r
+\r
+                       /* Print vendor and product names of attached device */\r
+                       printf_P(PSTR("Vendor \"%.8s\", Product \"%.16s\"\r\n"), InquiryData.VendorID, InquiryData.ProductID);\r
+                                               \r
                        /* Wait until disk ready */\r
-                       do\r
+                       puts_P(PSTR("Waiting until ready.."));\r
+\r
+                       for (;;)\r
                        {\r
                                Serial_TxByte('.');\r
-                               \r
-                               if ((ErrorCode = MassStore_TestUnitReady(0)) != 0)\r
+\r
+                               /* Abort if device removed */\r
+                               if (USB_HostState == HOST_STATE_Unattached)\r
+                                 break;\r
+\r
+                               /* Check to see if the attached device is ready for new commands */\r
+                               ErrorCode = MassStore_TestUnitReady(0);\r
+                                 \r
+                               /* If attached device is ready, abort the loop */\r
+                               if (!(ErrorCode))\r
+                                 break;\r
+\r
+                               /* If an error othe than a logical command failure (indicating device busy) returned, abort */\r
+                               if (ErrorCode != MASS_STORE_SCSI_COMMAND_FAILED)\r
                                {\r
-                                       ShowDiskReadError(PSTR("Test Unit Ready"), false, ErrorCode);\r
-                                       break;                          \r
+                                       ShowDiskReadError(PSTR("Test Unit Ready"), ErrorCode);\r
+\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
                                }\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
@@ -270,9 +266,11 @@ TASK(USB_MassStore_Host)
                        SCSI_Capacity_t DiskCapacity;\r
 \r
                        /* Retrieve disk capacity */\r
-                       if (((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0) || (SCSICommandStatus.Status != Command_Pass))\r
+                       if ((ErrorCode = MassStore_ReadCapacity(0, &DiskCapacity)) != 0)\r
                        {\r
-                               ShowDiskReadError(PSTR("Read Capacity"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);\r
+                               ShowDiskReadError(PSTR("Read Capacity"), ErrorCode);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
@@ -283,10 +281,11 @@ TASK(USB_MassStore_Host)
                        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
-                           (SCSICommandStatus.Status != Command_Pass))\r
+                       if ((ErrorCode = MassStore_ReadDeviceBlock(0, 0x00000000, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)\r
                        {\r
-                               ShowDiskReadError(PSTR("Read Device Block"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);\r
+                               ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);\r
+                               \r
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                break;\r
                        }\r
                        \r
@@ -325,18 +324,23 @@ TASK(USB_MassStore_Host)
                        while (!(Buttons_GetStatus() & BUTTONS_BUTTON1))\r
                        {\r
                                /* Abort if device removed */\r
-                               if (!(USB_IsConnected))\r
+                               if (USB_HostState == HOST_STATE_Unattached)\r
                                  break;\r
                        }\r
+\r
+                       /* Abort if device removed */\r
+                       if (USB_HostState == HOST_STATE_Unattached)\r
+                         break;\r
                        \r
                        /* Print out the entire disk contents in ASCII format */\r
-                       for (uint32_t CurrBlock = 0; CurrBlock < DiskCapacity.Blocks; CurrBlock++)\r
+                       for (uint32_t CurrBlockAddress = 0; CurrBlockAddress < DiskCapacity.Blocks; CurrBlockAddress++)\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
-                                   (SCSICommandStatus.Status != Command_Pass))\r
+                               if ((ErrorCode = MassStore_ReadDeviceBlock(0, CurrBlockAddress, 1, DiskCapacity.BlockSize, BlockBuffer)) != 0)\r
                                {\r
-                                       ShowDiskReadError(PSTR("Read Device Block"), (SCSICommandStatus.Status != Command_Pass), ErrorCode);\r
+                                       ShowDiskReadError(PSTR("Read Device Block"), ErrorCode);\r
+                                       \r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
                                        break;\r
                                }\r
 \r
@@ -349,83 +353,42 @@ TASK(USB_MassStore_Host)
                                }\r
 \r
                                /* Abort if device removed */\r
-                               if (!(USB_IsConnected))\r
+                               if (USB_HostState == HOST_STATE_Unattached)\r
                                  break;\r
                        }\r
                        \r
                        /* Indicate device no longer busy */\r
-                       UpdateStatus(Status_USBReady);\r
+                       LEDs_SetAllLEDs(LEDMASK_USB_READY);\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
+                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\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 occurred 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 FailedAtSCSILayer  Indicates if the command failed at the (logical) SCSI layer or at the physical USB layer\r
- *  \param ErrorCode      Error code of the function which failed to complete successfully\r
+ *  \param[in] CommandString  ASCII string located in PROGMEM space indicating what operation failed\r
+ *  \param[in] ErrorCode      Error code of the function which failed to complete successfully\r
  */\r
-void ShowDiskReadError(char* CommandString, bool FailedAtSCSILayer, uint8_t ErrorCode)\r
+void ShowDiskReadError(char* CommandString, uint8_t ErrorCode)\r
 {\r
-       if (FailedAtSCSILayer)\r
+       if (ErrorCode == MASS_STORE_SCSI_COMMAND_FAILED)\r
        {\r
                /* Display the error code */\r
-               printf_P(PSTR(ESC_BG_RED "SCSI command error (%S).\r\n"), CommandString);\r
-               printf_P(PSTR("  -- Status Code: %d"), ErrorCode);\r
+               printf_P(PSTR(ESC_FG_RED "SCSI command error (%S).\r\n"), CommandString);\r
        }\r
        else\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
+               printf_P(PSTR(ESC_FG_RED "Command error (%S).\r\n"), CommandString);\r
+               printf_P(PSTR("  -- Error Code: %d" ESC_FG_WHITE), ErrorCode);  \r
        }\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
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r