sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Second set of changes based on a review of the code comments in the Include directory for typos, grammar issues, and language clarity.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8467 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
pkandel
2009-06-04 16:16:15 +00:00
parent 7076244ef4
commit 1a2f870c9b
38 changed files with 268 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
MdePkg/Include/Library/UefiUsbLib.h
View File

@@ -1,6 +1,6 @@
/** @file
Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec
and the standard requests defined in Usb 1.1 spec.
Provides most USB APIs to support the Hid requests defined in USB Hid 1.1 spec
and the standard requests defined in USB 1.1 spec.
Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
@@ -18,12 +18,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define __USB_DXE_LIB_H__
#include <Protocol/UsbIo.h>
#include <IndustryStandard/Usb.h>
/**
Get the descriptor of the specified USB HID interface.
Submit a USB get HID descriptor request for the USB device specified by UsbIo
and Interface and return the HID descriptor in HidDescriptor.
Submit a UsbGetHidDescriptor() request for the USB device specified by UsbIo
and Interface, and return the HID descriptor in HidDescriptor.
If UsbIo is NULL, then ASSERT().
If HidDescriptor is NULL, then ASSERT().
@@ -51,7 +52,7 @@ UsbGetHidDescriptor (
Get the report descriptor of the specified USB HID interface.
Submit a USB get HID report descriptor request for the USB device specified by
UsbIo and Interface and return the report descriptor in DescriptorBuffer.
UsbIo and Interface, and return the report descriptor in DescriptorBuffer.
If UsbIo is NULL, then ASSERT().
If DescriptorBuffer is NULL, then ASSERT().
@@ -81,7 +82,7 @@ UsbGetReportDescriptor (
Get the HID protocol of the specified USB HID interface.
Submit a USB get HID protocol request for the USB device specified by UsbIo
and Interface and return the protocol retrieved in Protocol.
and Interface, and return the protocol retrieved in Protocol.
If UsbIo is NULL, then ASSERT().
If Protocol is NULL, then ASSERT().
@@ -106,7 +107,7 @@ UsbGetProtocolRequest (
Set the HID protocol of the specified USB HID interface.
Submit a USB set HID protocol request for the USB device specified by UsbIo
and Interface and set the protocol to the value specified by Protocol.
and Interface, and set the protocol to the value specified by Protocol.
If UsbIo is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@@ -501,7 +502,7 @@ UsbClearFeature (
Get the status of the specified device.
Submit a USB device get status request for the USB device specified by UsbIo,
Recipient, and Target and place the result in the buffer specified by DeviceStatus.
Recipient, and Target, and place the result in the buffer specified by DeviceStatus.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If DeviceStatus is NULL, then ASSERT().