MdeModulePkg/UsbBusDxe: Add UsbControlTransfer() error check
authorMichael D Kinney <>
Tue, 14 Nov 2017 23:41:08 +0000 (15:41 -0800)
committerMichael D Kinney <>
Mon, 20 Nov 2017 22:43:28 +0000 (14:43 -0800)

The USB I/O Protocol function ControlTransfer() has a DataLength
parameter that specifies the size of the Data buffer.  The
UsbBusDxe module implements the USB I/O Protocol using the
services of the USB2 Host Controller Protocol.  The DataLength
parameter in the USB2 Host Controller Protocol ControlTransfer()
service is an IN OUT parameter so the number of bytes actually
transferred is returned.  Since the USB I/O Protocol
ControlTransfer() service can not return the number of bytes
actually transferred, the only option if the number of bytes
actually transferred is less than the number of bytes requested
is to return EFI_DEVICE_ERROR.

The change fixes an issue with a USB mass storage device that
responds with 0 bytes to the Get MAX LUN command.

Cc: Star Zeng <>
Cc: Eric Dong <>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <>
Reviewed-by: Star Zeng <>

index 78220222f6ed68953afebd86b68f9b5663db9146..7c58fe8d36a26a67dea4d3f9712f17fd88b27b7b 100644 (file)
@@ -2,7 +2,7 @@
     Usb Bus Driver Binding and Bus IO Protocol.\r
-Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 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
@@ -76,6 +76,7 @@ UsbIoControlTransfer (
   USB_ENDPOINT_DESC       *EpDesc;\r
   EFI_TPL                 OldTpl;\r
   EFI_STATUS              Status;\r
+  UINTN                   RequestedDataLength;\r
   if (UsbStatus == NULL) {\r
@@ -86,6 +87,7 @@ UsbIoControlTransfer (
   Dev    = UsbIf->Device;\r
+  RequestedDataLength = DataLength;\r
   Status = UsbHcControlTransfer (\r
@@ -99,6 +101,18 @@ UsbIoControlTransfer (
+  //\r
+  // If the request completed sucessfully and the Direction of the request is\r
+  // EfiUsbDataIn or EfiUsbDataOut, then make sure the actual number of bytes\r
+  // transfered is the same as the number of bytes requested.  If a different\r
+  // number of bytes were transfered, then return EFI_DEVICE_ERROR.\r
+  //\r
+  if (!EFI_ERROR (Status)) {\r
+    if (Direction != EfiUsbNoData && DataLength != RequestedDataLength) {\r
+      Status = EFI_DEVICE_ERROR;\r
+      goto ON_EXIT;\r
+    }\r
+  }\r
   if (EFI_ERROR (Status) || (*UsbStatus != EFI_USB_NOERROR)) {\r