From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.65; helo=mga03.intel.com; envelope-from=michael.d.kinney@intel.com; receiver=edk2-devel@lists.01.org Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 047E320349DB8 for ; Wed, 15 Nov 2017 19:27:20 -0800 (PST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 Nov 2017 19:31:29 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.44,402,1505804400"; d="scan'208";a="2817758" Received: from orsmsx104.amr.corp.intel.com ([10.22.225.131]) by orsmga003.jf.intel.com with ESMTP; 15 Nov 2017 19:31:29 -0800 Received: from orsmsx160.amr.corp.intel.com (10.22.226.43) by ORSMSX104.amr.corp.intel.com (10.22.225.131) with Microsoft SMTP Server (TLS) id 14.3.319.2; Wed, 15 Nov 2017 19:31:29 -0800 Received: from orsmsx113.amr.corp.intel.com ([169.254.9.80]) by ORSMSX160.amr.corp.intel.com ([169.254.13.61]) with mapi id 14.03.0319.002; Wed, 15 Nov 2017 19:31:29 -0800 From: "Kinney, Michael D" To: "Zeng, Star" , "edk2-devel@lists.01.org" , "Kinney, Michael D" CC: "Dong, Eric" Thread-Topic: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: Add UsbControlTransfer() error check Thread-Index: AQHTXbsGBWNUSpHQskCqhBHAc21bvaMUu3jggACKmoD//4fw0IAAj2CAgABItOCAASkCAP//iXLg Date: Thu, 16 Nov 2017 03:31:28 +0000 Message-ID: References: <20171115010236.1344-1-michael.d.kinney@intel.com> <20171115010236.1344-2-michael.d.kinney@intel.com> <0C09AFA07DD0434D9E2A0C6AEB0483103B9B550D@shsmsx102.ccr.corp.intel.com> <0C09AFA07DD0434D9E2A0C6AEB0483103B9B5581@shsmsx102.ccr.corp.intel.com> <0C09AFA07DD0434D9E2A0C6AEB0483103B9B56B2@shsmsx102.ccr.corp.intel.com> <0C09AFA07DD0434D9E2A0C6AEB0483103B9B5E92@shsmsx102.ccr.corp.intel.com> In-Reply-To: <0C09AFA07DD0434D9E2A0C6AEB0483103B9B5E92@shsmsx102.ccr.corp.intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNGE5NzA4MTQtNzI0Zi00NDdlLWExMTItZTIyYjNlNmRiZTJiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjIuNS4xOCIsIlRydXN0ZWRMYWJlbEhhc2giOiJFaWdFS2QrdlIzUmV2clQ0ckZOWjk4SWRZbHVvMlJab3RcL1hneDNENzM2OGxlNmdhbStqWUdmeWtEcDArdjd1bCJ9 dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [10.22.254.138] MIME-Version: 1.0 Subject: Re: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: Add UsbControlTransfer() error check X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Nov 2017 03:27:21 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Star, I agree they are optional. The description says DataLength should be 0 and Data should be NULL for the EfiUsbNoData case. That is why I did not think Direction needed to be evaluated if DataLength must be 0 in this case. In fact, the Host Controller implementations return an error if this is not the case: if ((TransferDirection =3D=3D EfiUsbNoData) && ((Data !=3D NULL) || (*DataLength !=3D 0))) { return EFI_INVALID_PARAMETER; } So I think the logic in the current patch is safe. However, since there are questions on this topic, I agree I can update the logic to only check for short data if Direction is not EfiUsbNoData. That should help reduce questions in future reviews of this function. I will also add more comments. Thanks for the feedback. Mike =20 > -----Original Message----- > From: Zeng, Star > Sent: Wednesday, November 15, 2017 6:26 PM > To: Kinney, Michael D ; > edk2-devel@lists.01.org > Cc: Dong, Eric ; Zeng, Star > > Subject: RE: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: Add > UsbControlTransfer() error check >=20 > Mike, >=20 > Yes, the DataLength could be read. And Data/DataLength > is optional when Direction is EfiUsbNoData per my > understanding. >=20 > IN OUT VOID *Data, OPTIONAL > IN UINTN DataLength, OPTIONAL >=20 >=20 > Thanks, > Star > -----Original Message----- > From: Kinney, Michael D > Sent: Thursday, November 16, 2017 12:44 AM > To: Zeng, Star ; edk2- > devel@lists.01.org; Kinney, Michael D > > Cc: Dong, Eric > Subject: RE: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: Add > UsbControlTransfer() error check >=20 > Star, >=20 > I have read that section, and I do not see anything > that says the DataLength parameter can not be read. >=20 > Mike >=20 > > -----Original Message----- > > From: Zeng, Star > > Sent: Tuesday, November 14, 2017 8:23 PM > > To: Kinney, Michael D ; > > edk2-devel@lists.01.org > > Cc: Dong, Eric ; Zeng, Star > > > Subject: RE: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: > Add > > UsbControlTransfer() error check > > > > Mike, > > > > UEFI spec, EFI_USB_IO_PROTOCOL.UsbControlTransfer(), > in the > > description. > > > > Thanks, > > Star > > -----Original Message----- > > From: Kinney, Michael D > > Sent: Wednesday, November 15, 2017 12:00 PM > > To: Zeng, Star ; edk2- > devel@lists.01.org; > > Kinney, Michael D > > Cc: Dong, Eric > > Subject: RE: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: > Add > > UsbControlTransfer() error check > > > > Star, > > > > I am curious. Which spec statement are you referring > to? > > > > Mike > > > > > -----Original Message----- > > > From: Zeng, Star > > > Sent: Tuesday, November 14, 2017 6:59 PM > > > To: Kinney, Michael D ; > > > edk2-devel@lists.01.org > > > Cc: Dong, Eric ; Zeng, Star > > > > > Subject: RE: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: > > Add > > > UsbControlTransfer() error check > > > > > > Mike, > > > > > > I do not insist on the check that the Direction is > > not EfiUsbNoData, > > > and I know the functionality should have no > > improvement with the > > > check. > > > So, you can have my Reviewed-by: Star Zeng > > . > > > > > > I raised the question just for consideration from > > literally, as > > > according to the spec, the code could not touch > > DataLength at all when > > > Direction is EfiUsbNoData. > > > > > > You can decide to have / have not the check when > > pushing. :) > > > > > > > > > Thanks, > > > Star > > > -----Original Message----- > > > From: Kinney, Michael D > > > Sent: Wednesday, November 15, 2017 10:46 AM > > > To: Zeng, Star ; edk2- > > devel@lists.01.org; > > > Kinney, Michael D > > > Cc: Dong, Eric > > > Subject: RE: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: > > Add > > > UsbControlTransfer() error check > > > > > > Star, > > > > > > For that case both DataLength and > RequestedDataLength > > will be 0 and > > > the new path will not be taken. > > > > > > Are you concerned that the USB HC Protocol could > > return a non zero > > > DataLength for the EfiUsbNoData case? Even if it > > does, the new path > > > can never be taken because 0 is less than all UINTN > > values. > > > > > > Mike > > > > > > > -----Original Message----- > > > > From: Zeng, Star > > > > Sent: Tuesday, November 14, 2017 6:40 PM > > > > To: Kinney, Michael D > ; > > > > edk2-devel@lists.01.org > > > > Cc: Dong, Eric ; Zeng, Star > > > > > > > Subject: RE: [Patch V2 1/2] > MdeModulePkg/UsbBusDxe: > > > Add > > > > UsbControlTransfer() error check > > > > > > > > Mike, > > > > > > > > Do you think it is better or not to also check > the > > > Direction is not > > > > EfiUsbNoData? > > > > > > > > UEFI spec, > > EFI_USB_IO_PROTOCOL.UsbControlTransfer(): > > > > If the Direction parameter is EfiUsbNoData, Data > is > > > NULL, and > > > > DataLength is 0, then no data phase exists for > the > > > control transfer. > > > > > > > > Thanks, > > > > Star > > > > -----Original Message----- > > > > From: Kinney, Michael D > > > > Sent: Wednesday, November 15, 2017 9:03 AM > > > > To: edk2-devel@lists.01.org > > > > Cc: Zeng, Star ; Dong, Eric > > > > > > > Subject: [Patch V2 1/2] MdeModulePkg/UsbBusDxe: > Add > > > > UsbControlTransfer() error check > > > > > > > > > https://bugzilla.tianocore.org/show_bug.cgi?id=3D767 > > > > > > > > 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 > > > > > > > > --- > > > > MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.c | 8 > > +++++++- > > > > 1 file changed, 7 insertions(+), 1 deletion(-) > > > > > > > > diff --git > > a/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.c > > > > b/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.c > > > > index 78220222f6..b0ad7938e9 100644 > > > > --- a/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.c > > > > +++ b/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbBus.c > > > > @@ -2,7 +2,7 @@ > > > > > > > > Usb Bus Driver Binding and Bus IO Protocol. > > > > > > > > -Copyright (c) 2004 - 2016, Intel Corporation. > All > > > rights > > > > reserved.
> > > > +Copyright (c) 2004 - 2017, Intel Corporation. > All > > > > rights reserved.
> > > > This program and the accompanying materials are > > > licensed and made > > > > available under the terms and conditions of the > BSD > > > License which > > > > accompanies this distribution. The full text of > > the > > > license may be > > > > found at @@ -76,6 +76,7 @@ UsbIoControlTransfer ( > > > > USB_ENDPOINT_DESC *EpDesc; > > > > EFI_TPL OldTpl; > > > > EFI_STATUS Status; > > > > + UINTN RequestedDataLength; > > > > > > > > if (UsbStatus =3D=3D NULL) { > > > > return EFI_INVALID_PARAMETER; @@ -86,6 +87,7 > @@ > > > > UsbIoControlTransfer ( > > > > UsbIf =3D USB_INTERFACE_FROM_USBIO (This); > > > > Dev =3D UsbIf->Device; > > > > > > > > + RequestedDataLength =3D DataLength; > > > > Status =3D UsbHcControlTransfer ( > > > > Dev->Bus, > > > > Dev->Address, > > > > @@ -99,6 +101,10 @@ UsbIoControlTransfer ( > > > > &Dev->Translator, > > > > UsbStatus > > > > ); > > > > + if (!EFI_ERROR (Status) && DataLength < > > > > RequestedDataLength) { > > > > + Status =3D EFI_DEVICE_ERROR; > > > > + goto ON_EXIT; > > > > + } > > > > > > > > if (EFI_ERROR (Status) || (*UsbStatus !=3D > > > > EFI_USB_NOERROR)) { > > > > // > > > > -- > > > > 2.14.2.windows.3