tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update comments per review comments. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8463 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2009-06-04 09:22:50 +00:00
parent 630b41877e
commit c8c44377af
11 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
MdePkg/Include/Protocol/DeviceIo.h
View File

@ -4,7 +4,7 @@
Device IO is used to abstract hardware access to devices. It includes Device IO is used to abstract hardware access to devices. It includes
memory mapped IO, IO, PCI Config space, and DMA. memory mapped IO, IO, PCI Config space, and DMA.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -135,6 +135,7 @@ typedef enum {
@param Operation Indicates if the bus master is going to read or write to system memory. @param Operation Indicates if the bus master is going to read or write to system memory.
@param HostAddress The system memory address to map to the device. @param HostAddress The system memory address to map to the device.
@param NumberOfBytes On input, the number of bytes to map. @param NumberOfBytes On input, the number of bytes to map.
On output the number of bytes that were mapped.
@param DeviceAddress The resulting map address for the bus master device to use to access the @param DeviceAddress The resulting map address for the bus master device to use to access the
hosts HostAddress. hosts HostAddress.
@param Mapping A resulting value to pass to Unmap(). @param Mapping A resulting value to pass to Unmap().

4
MdePkg/Include/Protocol/DriverBinding.h
View File

@ -4,7 +4,7 @@
This protocol is produced by every driver that follows the UEFI Driver Model, This protocol is produced by every driver that follows the UEFI Driver Model,
and it is the central component that allows drivers and controllers to be managed. and it is the central component that allows drivers and controllers to be managed.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -113,7 +113,7 @@ EFI_STATUS
to use to stop the device. to use to stop the device.
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.Not used. @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.Not used.
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
if NumberOfChildren is 0.Not used. if NumberOfChildren is 0.
@retval EFI_SUCCESS The device was stopped. @retval EFI_SUCCESS The device was stopped.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.

24
MdePkg/Include/Protocol/HiiConfigRouting.h
View File

@ -5,7 +5,7 @@
information from configuration applications, routing the information from configuration applications, routing the
results to the appropriate drivers. results to the appropriate drivers.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -108,7 +108,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI * EFI_HII_ROUTING_EXTRACT_CONFIG)( (EFIAPI * EFI_HII_EXTRACT_CONFIG)(
IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
IN CONST EFI_STRING Request, IN CONST EFI_STRING Request,
OUT EFI_STRING *Progress, OUT EFI_STRING *Progress,
@ -124,7 +124,7 @@ EFI_STATUS
call has deceptively few inputs but the implementation is likely call has deceptively few inputs but the implementation is likely
to be somewhat complex. The requirement is to scan all IFR in to be somewhat complex. The requirement is to scan all IFR in
the HII database to determine the list of names and then request the HII database to determine the list of names and then request
the configuration using the corresponding drivers?? the configuration using the corresponding drivers.
EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig() interfaces below. EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig() interfaces below.
@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.
@ -152,7 +152,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI * EFI_HII_ROUTING_EXPORT_CONFIG)( (EFIAPI * EFI_HII_EXPORT_CONFIG)(
IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
OUT EFI_STRING *Results OUT EFI_STRING *Results
); );
@ -199,7 +199,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI * EFI_HII_ROUTING_ROUTE_CONFIG)( (EFIAPI * EFI_HII_ROUTE_CONFIG)(
IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
IN CONST EFI_STRING Configuration, IN CONST EFI_STRING Configuration,
OUT EFI_STRING *Progress OUT EFI_STRING *Progress
@ -269,7 +269,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI * EFI_HII_ROUTING_BLOCK_TO_CONFIG)( (EFIAPI * EFI_HII_BLOCK_TO_CONFIG)(
IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
IN CONST EFI_STRING ConfigRequest, IN CONST EFI_STRING ConfigRequest,
IN CONST UINT8 *Block, IN CONST UINT8 *Block,
@ -339,7 +339,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI * EFI_HII_ROUTING_CONFIG_TO_BLOCK)( (EFIAPI * EFI_HII_CONFIG_TO_BLOCK)(
IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
IN CONST EFI_STRING ConfigResp, IN CONST EFI_STRING ConfigResp,
IN OUT UINT8 *Block, IN OUT UINT8 *Block,
@ -397,11 +397,11 @@ EFI_STATUS
/// instance of this protocol in the system. /// instance of this protocol in the system.
/// ///
struct _EFI_HII_CONFIG_ROUTING_PROTOCOL { struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {
EFI_HII_ROUTING_EXTRACT_CONFIG ExtractConfig; EFI_HII_EXTRACT_CONFIG ExtractConfig;
EFI_HII_ROUTING_EXPORT_CONFIG ExportConfig; EFI_HII_EXPORT_CONFIG ExportConfig;
EFI_HII_ROUTING_ROUTE_CONFIG RouteConfig; EFI_HII_ROUTE_CONFIG RouteConfig;
EFI_HII_ROUTING_BLOCK_TO_CONFIG BlockToConfig; EFI_HII_BLOCK_TO_CONFIG BlockToConfig;
EFI_HII_ROUTING_CONFIG_TO_BLOCK ConfigToBlock; EFI_HII_CONFIG_TO_BLOCK ConfigToBlock;
EFI_HII_GET_ALT_CFG GetAltConfig; EFI_HII_GET_ALT_CFG GetAltConfig;
}; };

5
MdePkg/Include/Protocol/HiiFont.h
View File

@ -1,7 +1,7 @@
/** @file /** @file
The file provides services to retrieve font information. The file provides services to retrieve font information.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -251,8 +251,7 @@ EFI_STATUS
EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the
behavior of EFI_HII_OUT_FLAG_CLIP so that if a row's bottom behavior of EFI_HII_OUT_FLAG_CLIP so that if a row's bottom
most pixel cannot fit, then it will not be drawn at all. This most pixel cannot fit, then it will not be drawn at all. This
flag requires that EFI_HII_OUT_FLAG_CLIP be set. Draft for flag requires that EFI_HII_OUT_FLAG_CLIP be set. If
Review HII Protocols Version 2.1 November 3, 2006 1285 If
EFI_HII_OUT_FLAG_WRAP is set, then text will be wrapped at the EFI_HII_OUT_FLAG_WRAP is set, then text will be wrapped at the
right-most line-break opportunity prior to a character whose right-most line-break opportunity prior to a character whose
right-most extent would exceed Width. If no line-break right-most extent would exceed Width. If no line-break

7
MdePkg/Include/Protocol/Ip4.h
View File

@ -11,7 +11,7 @@
may include support for the Internet Group Management may include support for the Internet Group Management
Protocol (IGMP). Protocol (IGMP).
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -311,7 +311,10 @@ EFI_STATUS
@retval EFI_SUCCESS The driver instance was successfully opened. @retval EFI_SUCCESS The driver instance was successfully opened.
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
RARP, etc.) is not finished yet. RARP, etc.) is not finished yet.
@retval EFI_INVALID_PARAMETER At least one of the parameters was invalid. @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
IpConfigData.StationAddress is not a unicast IPv4 address.
IpConfigData.SubnetMask is not a valid IPv4 subnet
@retval EFI_UNSUPPORTED One or more of the following conditions is TRUE: @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:
A configuration protocol (DHCP, BOOTP, RARP, etc.) could A configuration protocol (DHCP, BOOTP, RARP, etc.) could
not be located when clients choose to use the default IPv4 not be located when clients choose to use the default IPv4

3
MdePkg/Include/Protocol/Pcd.h
View File

@ -1,7 +1,7 @@
/** @file /** @file
Platform Configuration Database (PCD) Protocol Platform Configuration Database (PCD) Protocol
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -43,7 +43,6 @@ extern EFI_GUID gPcdProtocolGuid;
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
set values associated with a PCD token. set values associated with a PCD token.
@retval VOID
**/ **/
typedef typedef

7
MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
View File

@ -5,7 +5,7 @@
by a UEFI Driver in its Start() function. This protocol allows the driver to receive by a UEFI Driver in its Start() function. This protocol allows the driver to receive
configuration information as part of being started. configuration information as part of being started.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -290,10 +290,7 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
**/ **/
typedef struct { typedef struct {
CHAR8 *CLPCommand; ///< A pointer to the DMTF SM CLP command line null-terminated string that the CHAR8 *CLPCommand; ///< A pointer to the DMTF SM CLP command line null-terminated string that the
///< driver is required to parse and process. EFI_SUCCESS The platform ///< driver is required to parse and process when this function is called.
///< return parameter information for ControllerHandle. EFI_NOT_FOUND Instance
///< was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid
///< EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. Function is called.
///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the ///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the
///< format and syntax of the CLP command line string. CLPCommand buffer ///< format and syntax of the CLP command line string. CLPCommand buffer
///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL. ///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.

2
MdePkg/Include/Protocol/RealTimeClock.h
View File

@ -11,7 +11,7 @@
No CRC of the EFI system table is required, since that is done in the DXE core. No CRC of the EFI system table is required, since that is done in the DXE core.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

2
MdePkg/Include/Protocol/SimpleTextIn.h
View File

@ -1,5 +1,5 @@
/** @file /** @file
Simple Text In protocol from the UEFI 2.0 specification. Simple Text Input protocol from the UEFI 2.0 specification.
Abstraction of a very simple input device like a keyboard or serial Abstraction of a very simple input device like a keyboard or serial
terminal. terminal.

9
MdePkg/Include/Protocol/SimpleTextInEx.h
View File

@ -1,8 +1,9 @@
/** @file /** @file
The file defines the protocol to obtain input from the Simple Text Input Ex protocol from the UEFI 2.0 specification.
ConsoleIn device. The EFI specification requires that the
EFI_SIMPLE_TEXT_INPUT_PROTOCOL supports the same languages as This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
the corresponding which exposes much more state and modifier information from the input device,
also allows one to register a notification for a particular keystroke.
Copyright (c) 2006 - 2009, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials

4
MdePkg/Include/Protocol/SmbusHc.h
View File

@ -2,7 +2,7 @@
The file provides basic SMBus host controller management The file provides basic SMBus host controller management
and basic data transactions over the SMBus. and basic data transactions over the SMBus.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -32,7 +32,7 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
operation as defined in the System Management Bus (SMBus) operation as defined in the System Management Bus (SMBus)
Specification. The resulting transaction will be either that Specification. The resulting transaction will be either that
the SMBus slave devices accept this transaction or that this the SMBus slave devices accept this transaction or that this
function returns with error. Status Codes Returned function returns with error.
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance. @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
SlaveAddress The SMBus slave address of the device SlaveAddress The SMBus slave address of the device