MdeModulePkg/UsbMassStorageDxe: Check Get Max LUN status/value

https://bugzilla.tianocore.org/show_bug.cgi?id=767

If a USB Mass Storage device does not support the Get
Max LUN command, then the USB I/O Protocol ControlTransfer()
service may return an error.  If an error is returned for
this command, then assume that the device does not support
multiple LUNs and return a maximum LUN value of 0.

The USB Mass Storage Class Specification states that a
maximum LUN value larger than 0x0F is invalid.  Add
a check to make sure this maximum LUN value is in this
valid range, and if it is not, then assume that the
device does not support multiple LUNs and return a
maximum LUN value of 0.

This change improves compatibility with USB FLASH drives
that do not support the Get Max LUN command or return
an invalid maximum LUN value.

Cc: Star Zeng <star.zeng@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

diff --git a/MdeModulePkg/Bus/Usb/UsbMassStorageDxe/UsbMassBot.c b/MdeModulePkg/Bus/Usb/UsbMassStorageDxe/UsbMassBot.c
index 4bb7222b89edd91c12610d9373c2bbe5f78b3eec..477bfa79528bdff4c472b3875c3ce18ec3a2fe66 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMassStorageDxe/UsbMassBot.c
+++ b/MdeModulePkg/Bus/Usb/UsbMassStorageDxe/UsbMassBot.c
@@ -2,7 +2,7 @@
   Implementation of the USB mass storage Bulk-Only Transport protocol,\r
   according to USB Mass Storage Class Bulk-Only Transport, Revision 1.0.\r
 \r
-Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -552,8 +552,10 @@ UsbBotGetMaxLun (
   UINT32                  Result;\r
   UINT32                  Timeout;\r
 \r
-  ASSERT (Context);\r
-  \r
+  if (Context == NULL || MaxLun == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
   UsbBot = (USB_BOT_PROTOCOL *) Context;\r
 \r
   //\r
@@ -576,8 +578,20 @@ UsbBotGetMaxLun (
                             1,\r
                             &Result\r
                             );\r
+  if (EFI_ERROR (Status) || *MaxLun > USB_BOT_MAX_LUN) {\r
+    //\r
+    // If the Get LUN request returns an error or the MaxLun is larger than\r
+    // the maximum LUN value (0x0f) supported by the USB Mass Storage Class\r
+    // Bulk-Only Transport Spec, then set MaxLun to 0.\r
+    //\r
+    // This improves compatibility with USB FLASH drives that have a single LUN\r
+    // and either do not return a max LUN value or return an invalid maximum LUN\r
+    // value.\r
+    //\r
+    *MaxLun = 0;\r
+  }\r
 \r
-  return Status;\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 /**\r