iPXE
Ip4Config.h
Go to the documentation of this file.
1 /** @file
2  This file provides a definition of the EFI IPv4 Configuration
3  Protocol.
4 
5 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available under
7 the terms and conditions of the BSD License that accompanies this distribution.
8 The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
10 
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 
14  @par Revision Reference:
15  This Protocol is introduced in UEFI Specification 2.0.
16 
17 **/
18 #ifndef __EFI_IP4CONFIG_PROTOCOL_H__
19 #define __EFI_IP4CONFIG_PROTOCOL_H__
20 
21 FILE_LICENCE ( BSD3 );
22 
23 #include <ipxe/efi/Protocol/Ip4.h>
24 
25 #define EFI_IP4_CONFIG_PROTOCOL_GUID \
26  { \
27  0x3b95aa31, 0x3793, 0x434b, {0x86, 0x67, 0xc8, 0x07, 0x08, 0x92, 0xe0, 0x5e } \
28  }
29 
31 
32 #define IP4_CONFIG_VARIABLE_ATTRIBUTES \
33  (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)
34 
35 ///
36 /// EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data
37 /// that is needed to start basic network communication. The StationAddress
38 /// and SubnetMask must be a valid unicast IP address and subnet mask.
39 /// If RouteTableSize is not zero, then RouteTable contains a properly
40 /// formatted routing table for the StationAddress/SubnetMask, with the
41 /// last entry in the table being the default route.
42 ///
43 typedef struct {
44  ///
45  /// Default station IP address, stored in network byte order.
46  ///
48  ///
49  /// Default subnet mask, stored in network byte order.
50  ///
52  ///
53  /// Number of entries in the following RouteTable. May be zero.
54  ///
56  ///
57  /// Default routing table data (stored in network byte order).
58  /// Ignored if RouteTableSize is zero.
59  ///
62 
63 
64 /**
65  Starts running the configuration policy for the EFI IPv4 Protocol driver.
66 
67  The Start() function is called to determine and to begin the platform
68  configuration policy by the EFI IPv4 Protocol driver. This determination may
69  be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol
70  driver configuration policy. It may be as involved as loading some defaults
71  from nonvolatile storage, downloading dynamic data from a DHCP server, and
72  checking permissions with a site policy server.
73  Starting the configuration policy is just the beginning. It may finish almost
74  instantly or it may take several minutes before it fails to retrieve configuration
75  information from one or more servers. Once the policy is started, drivers
76  should use the DoneEvent parameter to determine when the configuration policy
77  has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to
78  determine if the configuration succeeded or failed.
79  Until the configuration completes successfully, EFI IPv4 Protocol driver instances
80  that are attempting to use default configurations must return EFI_NO_MAPPING.
81  Once the configuration is complete, the EFI IPv4 Configuration Protocol driver
82  signals DoneEvent. The configuration may need to be updated in the future.
83  Note that in this case the EFI IPv4 Configuration Protocol driver must signal
84  ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default
85  configurations must return EFI_NO_MAPPING until the configuration policy has
86  been rerun.
87 
88  @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
89  @param DoneEvent Event that will be signaled when the EFI IPv4
90  Protocol driver configuration policy completes
91  execution. This event must be of type EVT_NOTIFY_SIGNAL.
92  @param ReconfigEvent Event that will be signaled when the EFI IPv4
93  Protocol driver configuration needs to be updated.
94  This event must be of type EVT_NOTIFY_SIGNAL.
95 
96  @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
97  driver is now running.
98  @retval EFI_INVALID_PARAMETER One or more of the following parameters is NULL:
99  This
100  DoneEvent
101  ReconfigEvent
102  @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
103  @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol
104  driver was already started.
105  @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.
106  @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol
107  driver configuration.
108 
109 **/
110 typedef
114  IN EFI_EVENT DoneEvent,
115  IN EFI_EVENT ReconfigEvent
116  );
117 
118 /**
119  Stops running the configuration policy for the EFI IPv4 Protocol driver.
120 
121  The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver.
122  All configuration data will be lost after calling Stop().
123 
124  @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
125 
126  @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
127  driver has been stopped.
128  @retval EFI_INVALID_PARAMETER This is NULL.
129  @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol
130  driver was not started.
131 
132 **/
133 typedef
137  );
138 
139 /**
140  Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
141 
142  The GetData() function returns the current configuration data for the EFI IPv4
143  Protocol driver after the configuration policy has completed.
144 
145  @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
146  @param IpConfigDataSize On input, the size of the IpConfigData buffer.
147  On output, the count of bytes that were written
148  into the IpConfigData buffer.
149  @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol
150  driver configuration data structure.
151  Type EFI_IP4_IPCONFIG_DATA is defined in
152  "Related Definitions" below.
153 
154  @retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned.
155  @retval EFI_INVALID_PARAMETER This is NULL.
156  @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol
157  driver is not running.
158  @retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running.
159  @retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete.
160  @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration
161  data buffer or IpConfigData is NULL.
162 
163 **/
164 typedef
168  IN OUT UINTN *IpConfigDataSize,
169  OUT EFI_IP4_IPCONFIG_DATA *IpConfigData OPTIONAL
170  );
171 
172 ///
173 /// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent
174 /// configurations for the EFI IPv4 Protocol driver.
175 ///
180 };
181 
183 
184 #endif
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:340
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
VOID * EFI_EVENT
Handle to an event structure.
Definition: UefiBaseType.h:43
EFI_STATUS(EFIAPI * EFI_IP4_CONFIG_START)(IN EFI_IP4_CONFIG_PROTOCOL *This, IN EFI_EVENT DoneEvent, IN EFI_EVENT ReconfigEvent)
Starts running the configuration policy for the EFI IPv4 Protocol driver.
Definition: Ip4Config.h:112
The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent configurations fo...
Definition: Ip4Config.h:176
unsigned int UINT32
Definition: ProcessorBind.h:56
EFI_IP4_ROUTE_TABLE * RouteTable
Default routing table data (stored in network byte order).
Definition: Ip4Config.h:60
EFI_STATUS(EFIAPI * EFI_IP4_CONFIG_STOP)(IN EFI_IP4_CONFIG_PROTOCOL *This)
Stops running the configuration policy for the EFI IPv4 Protocol driver.
Definition: Ip4Config.h:135
#define OUT
Definition: mlx_utils.h:29
This file defines the EFI IPv4 (Internet Protocol version 4) Protocol interface.
EFI_GUID gEfiIp4ConfigProtocolGuid
FILE_LICENCE(BSD3)
4-byte buffer.
Definition: Base.h:273
EFI_IP4_CONFIG_GET_DATA GetData
Definition: Ip4Config.h:179
#define EFIAPI
EFI_IP4_CONFIG_STOP Stop
Definition: Ip4Config.h:178
UINT64 UINTN
Unsigned value of native width.
Definition: ProcessorBind.h:71
EFI_IPv4_ADDRESS StationAddress
Default station IP address, stored in network byte order.
Definition: Ip4Config.h:47
#define IN
Definition: mlx_utils.h:28
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
EFI_IP4_CONFIG_START Start
Definition: Ip4Config.h:177
EFI_STATUS(EFIAPI * EFI_IP4_CONFIG_GET_DATA)(IN EFI_IP4_CONFIG_PROTOCOL *This, IN OUT UINTN *IpConfigDataSize, OUT EFI_IP4_IPCONFIG_DATA *IpConfigData OPTIONAL)
Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
Definition: Ip4Config.h:166
EFI_IP4_IPCONFIG_DATA contains the minimum IPv4 configuration data that is needed to start basic netw...
Definition: Ip4Config.h:43
EFI_IPv4_ADDRESS SubnetMask
Default subnet mask, stored in network byte order.
Definition: Ip4Config.h:51
UINT32 RouteTableSize
Number of entries in the following RouteTable.
Definition: Ip4Config.h:55