summaryrefslogtreecommitdiffstats
path: root/MdePkg/Include/Protocol/Ip4Config.h
diff options
context:
space:
mode:
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-12 22:19:12 +0000
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-12 22:19:12 +0000
commitaf2dc6a70b9380d702bd0720cdb029d630c505e3 (patch)
treec529d460dbe0b6adbf5b2177f4e532dbb27868d2 /MdePkg/Include/Protocol/Ip4Config.h
parent636f2be673b2f43518167d8fddae56b714f19314 (diff)
downloadedk2-af2dc6a70b9380d702bd0720cdb029d630c505e3.tar.gz
edk2-af2dc6a70b9380d702bd0720cdb029d630c505e3.tar.bz2
edk2-af2dc6a70b9380d702bd0720cdb029d630c505e3.zip
Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/Ip4Config.h')
-rw-r--r--MdePkg/Include/Protocol/Ip4Config.h34
1 files changed, 17 insertions, 17 deletions
diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h
index 7d21ad4994..d144442055 100644
--- a/MdePkg/Include/Protocol/Ip4Config.h
+++ b/MdePkg/Include/Protocol/Ip4Config.h
@@ -2,17 +2,17 @@
This file provides a definition of the EFI IPv4 Configuration
Protocol.
- Copyright (c) 2006 - 2009, Intel Corporation.<BR>
- 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<BR>
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2010, 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 that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+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:
- This Protocol is introduced in UEFI Specification 2.0
+ This Protocol is introduced in UEFI Specification 2.0.
**/
#ifndef __EFI_IP4CONFIG_PROTOCOL_H__
@@ -78,13 +78,13 @@ typedef struct {
Until the configuration completes successfully, EFI IPv4 Protocol driver instances
that are attempting to use default configurations must return EFI_NO_MAPPING.
Once the configuration is complete, the EFI IPv4 Configuration Protocol driver
- signals DoneEvent. The configuration may need to be updated in the future,
- however; in this case, the EFI IPv4 Configuration Protocol driver must signal
+ signals DoneEvent. The configuration may need to be updated in the future.
+ Note that in this case the EFI IPv4 Configuration Protocol driver must signal
ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default
configurations must return EFI_NO_MAPPING until the configuration policy has
been rerun.
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param DoneEvent Event that will be signaled when the EFI IPv4
Protocol driver configuration policy completes
execution. This event must be of type EVT_NOTIFY_SIGNAL.
@@ -120,7 +120,7 @@ EFI_STATUS
The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver.
All configuration data will be lost after calling Stop().
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
driver has been stopped.
@@ -141,11 +141,11 @@ EFI_STATUS
The GetData() function returns the current configuration data for the EFI IPv4
Protocol driver after the configuration policy has completed.
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param IpConfigDataSize On input, the size of the IpConfigData buffer.
On output, the count of bytes that were written
into the IpConfigData buffer.
- @param IpConfigData Pointer to the EFI IPv4 Configuration Protocol
+ @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol
driver configuration data structure.
Type EFI_IP4_IPCONFIG_DATA is defined in
"Related Definitions" below.
@@ -169,8 +169,8 @@ EFI_STATUS
);
///
-/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent
-/// configuration for the EFI IPv4 Protocol driver.
+/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent
+/// configurations for the EFI IPv4 Protocol driver.
///
struct _EFI_IP4_CONFIG_PROTOCOL {
EFI_IP4_CONFIG_START Start;