3 This file provides a definition of the EFI IPv4 Configuration
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __EFI_IP4CONFIG_PROTOCOL_H__
17 #define __EFI_IP4CONFIG_PROTOCOL_H__
19 #include <Protocol/Ip4.h>
21 #define EFI_IP4_CONFIG_PROTOCOL_GUID \
23 0x3b95aa31, 0x3793, 0x434b, {0x86, 0x67, 0xc8, 0x07, 0x08, 0x92, 0xe0, 0x5e } \
26 typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL
;
28 #define IP4_CONFIG_VARIABLE_ATTRIBUTES \
29 (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | \
30 EFI_VARIABLE_RUNTIME_ACCESS)
33 EFI_IPv4_ADDRESS StationAddress
;
34 EFI_IPv4_ADDRESS SubnetMask
;
35 UINT32 RouteTableSize
;
36 EFI_IP4_ROUTE_TABLE
*RouteTable
; //OPTIONAL
37 } EFI_IP4_IPCONFIG_DATA
;
41 Starts running the configuration policy for the EFI IPv4 Protocol driver.
43 @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
44 @param DoneEvent Event that will be signaled when the EFI IPv4 Protocol driver
45 configuration policy completes execution. This event must be of
46 type EVT_NOTIFY_SIGNAL.
47 @param ReconfigEvent Event that will be signaled when the EFI IPv4 Protocol driver
48 configuration needs to be updated. This event must be of type
51 @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol driver is now
53 @retval EFI_INVALID_PARAMETER This, DoneEvent, or ReconfigEvent is NULL.
54 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
55 @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol driver was
57 @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.
58 @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol driver
64 (EFIAPI
*EFI_IP4_CONFIG_START
)(
65 IN EFI_IP4_CONFIG_PROTOCOL
*This
,
66 IN EFI_EVENT DoneEvent
,
67 IN EFI_EVENT ReconfigEvent
71 Stops running the configuration policy for the EFI IPv4 Protocol driver.
73 @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
75 @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol driver has been stopped.
76 @retval EFI_INVALID_PARAMETER This is NULL.
77 @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol driver was not started.
82 (EFIAPI
*EFI_IP4_CONFIG_STOP
)(
83 IN EFI_IP4_CONFIG_PROTOCOL
*This
87 Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
89 @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
90 @param IpConfigDataSize On input, the size of the IpConfigData buffer.
91 On output, the count of bytes that were written into the IpConfigData buffer.
92 @param IpConfigData Pointer to the EFI IPv4 Configuration Protocol driver
93 configuration data structure.
95 @retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned.
96 @retval EFI_INVALID_PARAMETER This is NULL.
97 @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol driver is not
99 @retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running.
100 @retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete.
101 @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration data
102 buffer or IpConfigData is NULL.
107 (EFIAPI
*EFI_IP4_CONFIG_GET_DATA
)(
108 IN EFI_IP4_CONFIG_PROTOCOL
*This
,
109 IN OUT UINTN
*IpConfigDataSize
,
110 OUT EFI_IP4_IPCONFIG_DATA
*IpConfigData OPTIONAL
114 @par Protocol Description:
115 The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent
116 configuration for the EFI IPv4 Protocol driver.
119 Starts running the configuration policy for the EFI IPv4 Protocol driver.
122 Stops running the configuration policy for the EFI IPv4 Protocol driver.
125 Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
128 struct _EFI_IP4_CONFIG_PROTOCOL
{
129 EFI_IP4_CONFIG_START Start
;
130 EFI_IP4_CONFIG_STOP Stop
;
131 EFI_IP4_CONFIG_GET_DATA GetData
;
134 extern EFI_GUID gEfiIp4ConfigProtocolGuid
;