public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Star Zeng <star.zeng@intel.com>
To: edk2-devel@lists.01.org
Cc: Star Zeng <star.zeng@intel.com>, Liming Gao <liming.gao@intel.com>
Subject: [PATCH] MdePkg UsbFunctionIo.h: Update comments for GetDeviceInfo return status
Date: Wed, 19 Jul 2017 18:28:44 +0800	[thread overview]
Message-ID: <1500460124-292660-1-git-send-email-star.zeng@intel.com> (raw)

UEFI spec 2.6 errata B update Status Codes Returned table of the
EFI_USBFN_IO_PROTOCOL.GetDeviceInfo function as follows:

1. Update EFI_INVALID_PARAMETER description:
Original text:
A parameter is invalid.
New text:
One or more of the following conditions is TRUE:
BufferSize is NULL.
*BufferSize is not 0 and Buffer is NULL.
Id in invalid.

2. Update EFI_BUFFER_TOO_SMALL description:
Original text:
Supplied buffer isn’t large enough to hold the request string.
New text:
The buffer is too small to hold the buffer.
*BufferSize has been updated with the size needed to hold the
request string.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdePkg/Include/Protocol/UsbFunctionIo.h | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/MdePkg/Include/Protocol/UsbFunctionIo.h b/MdePkg/Include/Protocol/UsbFunctionIo.h
index 923c1d3527ed..ce556bdbaf31 100644
--- a/MdePkg/Include/Protocol/UsbFunctionIo.h
+++ b/MdePkg/Include/Protocol/UsbFunctionIo.h
@@ -11,7 +11,7 @@
   or interrupt transfers, alternate interfaces, or USB 3.0 functionality.
   Future revisions of this protocol may support these or additional features.
 
-  Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
   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
@@ -273,9 +273,13 @@ EFI_STATUS
                                 as a Unicode string.
 
   @retval EFI_SUCCESS           The function returned successfully.
-  @retval EFI_INVALID_PARAMETER A parameter is invalid.
+  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
+                                BufferSize is NULL.
+                                *BufferSize is not 0 and Buffer is NULL.
+                                Id in invalid.
   @retval EFI_DEVICE_ERROR      The physical device reported an error.
-  @retval EFI_BUFFER_TOO_SMALL  Supplied buffer isn't large enough to hold the request string.
+  @retval EFI_BUFFER_TOO_SMALL  The buffer is too small to hold the buffer.
+                                *BufferSize has been updated with the size needed to hold the request string.
 
 **/
 typedef
-- 
2.7.0.windows.1



             reply	other threads:[~2017-07-19 10:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-19 10:28 Star Zeng [this message]
2017-07-21  9:46 ` [PATCH] MdePkg UsbFunctionIo.h: Update comments for GetDeviceInfo return status Gao, Liming

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1500460124-292660-1-git-send-email-star.zeng@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox