This file provides a definition of the EFI IPv4 Configuration\r
Protocol.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at<BR>\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ @par Revision Reference:\r
+ This Protocol is introduced in UEFI Specification 2.0.\r
\r
**/\r
#ifndef __EFI_IP4CONFIG_PROTOCOL_H__\r
typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL;\r
\r
#define IP4_CONFIG_VARIABLE_ATTRIBUTES \\r
- (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | \\r
- EFI_VARIABLE_RUNTIME_ACCESS)\r
+ (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)\r
\r
///\r
-/// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data \r
-/// that is needed to start basic network communication. The StationAddress \r
+/// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data\r
+/// that is needed to start basic network communication. The StationAddress\r
/// and SubnetMask must be a valid unicast IP address and subnet mask.\r
-/// If RouteTableSize is not zero, then RouteTable contains a properly \r
-/// formatted routing table for the StationAddress/SubnetMask, with the \r
+/// If RouteTableSize is not zero, then RouteTable contains a properly\r
+/// formatted routing table for the StationAddress/SubnetMask, with the\r
/// last entry in the table being the default route.\r
///\r
typedef struct {\r
\r
/**\r
Starts running the configuration policy for the EFI IPv4 Protocol driver.\r
- \r
- The Start() function is called to determine and to begin the platform \r
- configuration policy by the EFI IPv4 Protocol driver. This determination may \r
- be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol \r
- driver configuration policy. It may be as involved as loading some defaults \r
- from nonvolatile storage, downloading dynamic data from a DHCP server, and \r
+\r
+ The Start() function is called to determine and to begin the platform\r
+ configuration policy by the EFI IPv4 Protocol driver. This determination may\r
+ be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol\r
+ driver configuration policy. It may be as involved as loading some defaults\r
+ from nonvolatile storage, downloading dynamic data from a DHCP server, and\r
checking permissions with a site policy server.\r
- Starting the configuration policy is just the beginning. It may finish almost \r
- instantly or it may take several minutes before it fails to retrieve configuration \r
- information from one or more servers. Once the policy is started, drivers \r
- should use the DoneEvent parameter to determine when the configuration policy \r
- has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to \r
+ Starting the configuration policy is just the beginning. It may finish almost\r
+ instantly or it may take several minutes before it fails to retrieve configuration\r
+ information from one or more servers. Once the policy is started, drivers\r
+ should use the DoneEvent parameter to determine when the configuration policy\r
+ has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to\r
determine if the configuration succeeded or failed.\r
- Until the configuration completes successfully, EFI IPv4 Protocol driver instances \r
+ Until the configuration completes successfully, EFI IPv4 Protocol driver instances\r
that are attempting to use default configurations must return EFI_NO_MAPPING.\r
- Once the configuration is complete, the EFI IPv4 Configuration Protocol driver \r
- signals DoneEvent. The configuration may need to be updated in the future, \r
- however; in this case, the EFI IPv4 Configuration Protocol driver must signal \r
- ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default \r
- configurations must return EFI_NO_MAPPING until the configuration policy has \r
+ Once the configuration is complete, the EFI IPv4 Configuration Protocol driver\r
+ signals DoneEvent. The configuration may need to be updated in the future.\r
+ Note that in this case the EFI IPv4 Configuration Protocol driver must signal\r
+ ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default\r
+ configurations must return EFI_NO_MAPPING until the configuration policy has\r
been rerun.\r
\r
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
- @param DoneEvent Event that will be signaled when the EFI IPv4 \r
- Protocol driver configuration policy completes \r
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
+ @param DoneEvent Event that will be signaled when the EFI IPv4\r
+ Protocol driver configuration policy completes\r
execution. This event must be of type EVT_NOTIFY_SIGNAL.\r
- @param ReconfigEvent Event that will be signaled when the EFI IPv4 \r
- Protocol driver configuration needs to be updated. \r
+ @param ReconfigEvent Event that will be signaled when the EFI IPv4\r
+ Protocol driver configuration needs to be updated.\r
This event must be of type EVT_NOTIFY_SIGNAL.\r
- \r
- @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol \r
+\r
+ @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol\r
driver is now running.\r
@retval EFI_INVALID_PARAMETER One or more of the following parameters is NULL:\r
This\r
DoneEvent\r
ReconfigEvent\r
@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
- @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol \r
+ @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol\r
driver was already started.\r
@retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.\r
- @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol \r
+ @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol\r
driver configuration.\r
\r
**/\r
\r
/**\r
Stops running the configuration policy for the EFI IPv4 Protocol driver.\r
- \r
- The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver. \r
+\r
+ The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver.\r
All configuration data will be lost after calling Stop().\r
\r
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
\r
- @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol \r
+ @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol\r
driver has been stopped.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
- @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol \r
+ @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol\r
driver was not started.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
/**\r
Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.\r
\r
- The GetData() function returns the current configuration data for the EFI IPv4 \r
+ The GetData() function returns the current configuration data for the EFI IPv4\r
Protocol driver after the configuration policy has completed.\r
- \r
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
- @param IpConfigDataSize On input, the size of the IpConfigData buffer. \r
- On output, the count of bytes that were written \r
+\r
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
+ @param IpConfigDataSize On input, the size of the IpConfigData buffer.\r
+ On output, the count of bytes that were written\r
into the IpConfigData buffer.\r
- @param IpConfigData Pointer to the EFI IPv4 Configuration Protocol \r
- driver configuration data structure. \r
- Type EFI_IP4_IPCONFIG_DATA is defined in \r
+ @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol\r
+ driver configuration data structure.\r
+ Type EFI_IP4_IPCONFIG_DATA is defined in\r
"Related Definitions" below.\r
\r
@retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
- @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol \r
+ @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol\r
driver is not running.\r
@retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running.\r
@retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete.\r
- @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration \r
+ @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration\r
data buffer or IpConfigData is NULL.\r
\r
**/\r
);\r
\r
///\r
-/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent \r
-/// configuration for the EFI IPv4 Protocol driver. \r
+/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent\r
+/// configurations for the EFI IPv4 Protocol driver.\r
///\r
struct _EFI_IP4_CONFIG_PROTOCOL {\r
EFI_IP4_CONFIG_START Start;\r
projects / mirror_edk2.git / blobdiff