From: lgao4 Date: Fri, 25 Jul 2008 10:50:50 +0000 (+0000) Subject: Code Scrub for Protocol Definition X-Git-Tag: edk2-stable201903~20650 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=0f82bd55142af193e669e76fcaf02f8d835f3f39 Code Scrub for Protocol Definition git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5566 6f19259b-4bc3-4df7-8a09-765794883524 --- diff --git a/MdePkg/Include/Protocol/UsbIo.h b/MdePkg/Include/Protocol/UsbIo.h index 66131be38e..8f24f1a98c 100644 --- a/MdePkg/Include/Protocol/UsbIo.h +++ b/MdePkg/Include/Protocol/UsbIo.h @@ -1,6 +1,10 @@ /** @file - EFI Usb I/O Protocol - + EFI Usb I/O Protocol as defined in UEFI specification. + This protocol is used by code, typically drivers, running in the EFI + boot services environment to access USB devices like USB keyboards, + mice and mass storage devices. In particular, functions for managing devices + on USB buses are defined here. + Copyright (c) 2006 - 2008, 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 @@ -173,9 +177,9 @@ EFI_STATUS executed. @param DataLength Specifies the length, in bytes, of the data to be received from the USB device. - @param Context Data passed to the InterruptCallback function. @param InterruptCallback The Callback function. This function is called if the asynchronous interrupt transfer is completed. + @param Context Data passed to the InterruptCallback function. @retval EFI_SUCCESS The asynchronous USB transfer request transfer has been successfully executed. @retval EFI_DEVICE_ERROR The asynchronous USB transfer request failed. @@ -262,8 +266,8 @@ EFI_STATUS @param Data A pointer to the buffer of data that will be transmitted to USB device or received from USB device. @param DataLength The size, in bytes, of the data buffer specified by Data. - @param Context Data passed to the IsochronousCallback() function. @param IsochronousCallback The IsochronousCallback() function. + @param Context Data passed to the IsochronousCallback() function. @retval EFI_SUCCESS The asynchronous isochronous transfer has been successfully submitted to the system. @@ -419,9 +423,54 @@ EFI_STATUS OUT UINT16 *TableSize ); -// -// Protocol Interface Structure -// +/** + @par Protocol Description: + The EFI_USB_IO_PROTOCOL provides four basic transfers types described + in the USB 1.1 Specification. These include control transfer, interrupt + transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL + also provides some basic USB device/controller management and configuration + interfaces. A USB device driver uses the services of this protocol to manage USB devices. + + @param UsbControlTransfer + Accesses the USB Device through USB Control Transfer Pipe. + + @param UsbBulkTransfer + Accesses the USB Device through USB Bulk Transfer Pipe. + + @param UsbAsyncInterruptTransfer + Non-block USB interrupt transfer. + + @param UsbSyncInterruptTransfer + Accesses the USB Device through USB Synchronous + Interrupt Transfer Pipe. + + @param UsbIsochronousTransfer + Accesses the USB Device through USB Isochronous Transfer Pipe. + + @param UsbAsyncIsochronousTransfer + Nonblock USB isochronous transfer. + + @param UsbGetDeviceDescriptor + Retrieves the device descriptor of a USB device. + + @param UsbGetConfigDescriptor + Retrieves the activated configuration descriptor of a USB device. + + @param UsbGetInterfaceDescriptor + Retrieves the interface descriptor of a USB Controller. + + @param UsbGetEndpointDescriptor + Retrieves the endpoint descriptor of a USB Controller. + + @param UsbGetStringDescriptor + Retrieves the string descriptor inside a USB Device. + + @param UsbGetSupportedLanguages + Retrieves the array of languages that the USB device supports. + + @param UsbPortReset + Resets and reconfigures the USB controller. +**/ struct _EFI_USB_IO_PROTOCOL { // // IO transfer diff --git a/MdePkg/Include/Protocol/Variable.h b/MdePkg/Include/Protocol/Variable.h index 12f3aa4b62..ea60c20e6a 100644 --- a/MdePkg/Include/Protocol/Variable.h +++ b/MdePkg/Include/Protocol/Variable.h @@ -1,5 +1,5 @@ /** @file - Variable Architectural Protocol as defined in the DXE CIS + Variable Architectural Protocol as defined in PI Specification VOLUME 2 DXE This code is used to produce the UEFI 2.0 runtime variable services @@ -18,9 +18,6 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: - Version 0.91B. - **/ #ifndef __ARCH_PROTOCOL_VARIABLE_ARCH_H__ diff --git a/MdePkg/Include/Protocol/VariableWrite.h b/MdePkg/Include/Protocol/VariableWrite.h index c9d1fa5b4a..cb8050eb0d 100644 --- a/MdePkg/Include/Protocol/VariableWrite.h +++ b/MdePkg/Include/Protocol/VariableWrite.h @@ -1,5 +1,5 @@ /** @file - Variable Write Architectural Protocol as defined in the DXE CIS + Variable Write Architectural Protocol as defined in PI Specification VOLUME 2 DXE This code is used to produce the UEFI 2.0 runtime variable services @@ -17,9 +17,6 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: - Version 0.91B. - **/ #ifndef __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__ diff --git a/MdePkg/Include/Protocol/WatchdogTimer.h b/MdePkg/Include/Protocol/WatchdogTimer.h index f13d1fd5e5..d85dc5bb94 100644 --- a/MdePkg/Include/Protocol/WatchdogTimer.h +++ b/MdePkg/Include/Protocol/WatchdogTimer.h @@ -1,5 +1,5 @@ /** @file - Watchdog Timer Architectural Protocol as defined in the DXE CIS + Watchdog Timer Architectural Protocol as defined in PI Specification VOLUME 2 DXE Used to provide system watchdog timer services @@ -11,10 +11,6 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - - @par Revision Reference: - Version 0.91B. - **/ #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__