projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| d1f95000 | 1 | /** @file\r |
| c311f86b | 2 | This file defines the EFI IPv4 (Internet Protocol version 4)\r |
| 3 | Protocol interface. It is split into the following three main\r | |
| 4 | sections:\r | |
| 5 | - EFI IPv4 Service Binding Protocol\r | |
| 6 | - EFI IPv4 Variable\r | |
| bdb140d7 | 7 | - EFI IPv4 Protocol\r |
| 8 | The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,\r | |
| 9 | which includes support foR a subset of the Internet Control Message \r | |
| 10 | Protocol (ICMP) and may include support for the Internet Group Management\r | |
| 11 | Protocol (IGMP).\r | |
| c311f86b | 12 | \r |
| c8c44377 | 13 | Copyright (c) 2006 - 2009, Intel Corporation \r |
| d1f95000 | 14 | All rights reserved. This program and the accompanying materials \r |
| 15 | are licensed and made available under the terms and conditions of the BSD License \r | |
| 16 | which accompanies this distribution. The full text of the license may be found at \r | |
| 17 | http://opensource.org/licenses/bsd-license.php \r | |
| 18 | \r | |
| 19 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 5899caf0 | 20 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 21 | \r | |
| 22 | @par Revision Reference: \r | |
| 23 | This Protocol is introduced in UEFI Specification 2.0 \r | |
| d1f95000 | 24 | \r |
| d1f95000 | 25 | **/\r |
| 26 | \r | |
| 27 | #ifndef __EFI_IP4_PROTOCOL_H__\r | |
| 28 | #define __EFI_IP4_PROTOCOL_H__\r | |
| 29 | \r | |
| 30 | #include <Protocol/ManagedNetwork.h>\r | |
| 31 | \r | |
| 32 | #define EFI_IP4_SERVICE_BINDING_PROTOCOL_GUID \\r | |
| 33 | { \\r | |
| 34 | 0xc51711e7, 0xb4bf, 0x404a, {0xbf, 0xb8, 0x0a, 0x04, 0x8e, 0xf1, 0xff, 0xe4 } \\r | |
| 35 | }\r | |
| 36 | \r | |
| 37 | #define EFI_IP4_PROTOCOL_GUID \\r | |
| 38 | { \\r | |
| 39 | 0x41d94cd2, 0x35b6, 0x455a, {0x82, 0x58, 0xd4, 0xe5, 0x13, 0x34, 0xaa, 0xdd } \\r | |
| 40 | }\r | |
| 41 | \r | |
| 42 | typedef struct _EFI_IP4_PROTOCOL EFI_IP4_PROTOCOL;\r | |
| 43 | \r | |
| 44 | typedef struct {\r | |
| 45 | EFI_HANDLE InstanceHandle;\r | |
| 46 | EFI_IPv4_ADDRESS Ip4Address;\r | |
| 47 | EFI_IPv4_ADDRESS SubnetMask;\r | |
| 48 | } EFI_IP4_ADDRESS_PAIR; \r | |
| 49 | \r | |
| 50 | typedef struct {\r | |
| 51 | EFI_HANDLE DriverHandle;\r | |
| 52 | UINT32 AddressCount;\r | |
| 53 | EFI_IP4_ADDRESS_PAIR AddressPairs[1];\r | |
| 54 | } EFI_IP4_VARIABLE_DATA;\r | |
| 55 | \r | |
| 56 | typedef struct {\r | |
| 992f22b9 LG |
57 | ///\r |
| 58 | /// The default IPv4 protocol packets to send and receive. Ignored\r | |
| 59 | /// when AcceptPromiscuous is TRUE.\r | |
| 60 | ///\r | |
| d1f95000 | 61 | UINT8 DefaultProtocol;\r |
| 992f22b9 LG |
62 | ///\r |
| 63 | /// Set to TRUE to receive all IPv4 packets that get through the receive filters.\r | |
| 64 | /// Set to FALSE to receive only the DefaultProtocol IPv4\r | |
| 65 | /// packets that get through the receive filters.\r | |
| 66 | ///\r | |
| d1f95000 | 67 | BOOLEAN AcceptAnyProtocol;\r |
| 992f22b9 LG |
68 | ///\r |
| 69 | /// Set to TRUE to receive ICMP error report packets. Ignored when\r | |
| 70 | /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.\r | |
| 71 | ///\r | |
| d1f95000 | 72 | BOOLEAN AcceptIcmpErrors;\r |
| 992f22b9 LG |
73 | ///\r |
| 74 | /// Set to TRUE to receive broadcast IPv4 packets. Ignored when\r | |
| 75 | /// AcceptPromiscuous is TRUE.\r | |
| 76 | /// Set to FALSE to stop receiving broadcast IPv4 packets.\r | |
| 77 | ///\r | |
| d1f95000 | 78 | BOOLEAN AcceptBroadcast;\r |
| 992f22b9 LG |
79 | ///\r |
| 80 | /// Set to TRUE to receive all IPv4 packets that are sent to any\r | |
| 81 | /// hardware address or any protocol address.\r | |
| 82 | /// Set to FALSE to stop receiving all promiscuous IPv4 packets\r | |
| 83 | ///\r | |
| d1f95000 | 84 | BOOLEAN AcceptPromiscuous;\r |
| 992f22b9 LG |
85 | ///\r |
| 86 | /// Set to TRUE to use the default IPv4 address and default routing table.\r | |
| 87 | ///\r | |
| d1f95000 | 88 | BOOLEAN UseDefaultAddress;\r |
| 992f22b9 LG |
89 | ///\r |
| 90 | /// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.\r | |
| 91 | ///\r | |
| d1f95000 | 92 | EFI_IPv4_ADDRESS StationAddress;\r |
| 992f22b9 LG |
93 | ///\r |
| 94 | /// The subnet address mask that is associated with the station address.\r | |
| 95 | ///\r | |
| d1f95000 | 96 | EFI_IPv4_ADDRESS SubnetMask;\r |
| 992f22b9 LG |
97 | ///\r |
| 98 | /// TypeOfService field in transmitted IPv4 packets.\r | |
| 99 | ///\r | |
| d1f95000 | 100 | UINT8 TypeOfService;\r |
| 992f22b9 LG |
101 | ///\r |
| 102 | /// TimeToLive field in transmitted IPv4 packets.\r | |
| 103 | ///\r | |
| d1f95000 | 104 | UINT8 TimeToLive;\r |
| 992f22b9 LG |
105 | ///\r |
| 106 | /// State of the DoNotFragment bit in transmitted IPv4 packets.\r | |
| 107 | ///\r | |
| d1f95000 | 108 | BOOLEAN DoNotFragment;\r |
| 992f22b9 LG |
109 | ///\r |
| 110 | /// Set to TRUE to send and receive unformatted packets. The other\r | |
| 111 | /// IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.\r | |
| 112 | ///\r | |
| d1f95000 | 113 | BOOLEAN RawData;\r |
| 992f22b9 LG |
114 | ///\r |
| 115 | /// The timer timeout value (number of microseconds) for the\r | |
| 116 | /// receive timeout event to be associated with each assembled\r | |
| 117 | /// packet. Zero means do not drop assembled packets.\r | |
| 118 | ///\r | |
| d1f95000 | 119 | UINT32 ReceiveTimeout;\r |
| 992f22b9 LG |
120 | ///\r |
| 121 | /// The timer timeout value (number of microseconds) for the\r | |
| 122 | /// transmit timeout event to be associated with each outgoing\r | |
| 123 | /// packet. Zero means do not drop outgoing packets.\r | |
| 124 | ///\r | |
| d1f95000 | 125 | UINT32 TransmitTimeout;\r |
| 126 | } EFI_IP4_CONFIG_DATA;\r | |
| 127 | \r | |
| 128 | \r | |
| 129 | typedef struct {\r | |
| 130 | EFI_IPv4_ADDRESS SubnetAddress;\r | |
| 131 | EFI_IPv4_ADDRESS SubnetMask;\r | |
| 132 | EFI_IPv4_ADDRESS GatewayAddress;\r | |
| 133 | } EFI_IP4_ROUTE_TABLE;\r | |
| 134 | \r | |
| 135 | typedef struct {\r | |
| 136 | UINT8 Type;\r | |
| 137 | UINT8 Code;\r | |
| 138 | } EFI_IP4_ICMP_TYPE;\r | |
| 139 | \r | |
| 140 | typedef struct {\r | |
| 992f22b9 LG |
141 | ///\r |
| 142 | /// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.\r | |
| 143 | ///\r | |
| d1f95000 | 144 | BOOLEAN IsStarted;\r |
| 992f22b9 LG |
145 | ///\r |
| 146 | /// Current configuration settings.\r | |
| 147 | ///\r | |
| d1f95000 | 148 | EFI_IP4_CONFIG_DATA ConfigData;\r |
| 992f22b9 LG |
149 | ///\r |
| 150 | /// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.\r | |
| 151 | ///\r | |
| d1f95000 | 152 | BOOLEAN IsConfigured;\r |
| 992f22b9 LG |
153 | ///\r |
| 154 | /// Number of joined multicast groups.\r | |
| 155 | ///\r | |
| d1f95000 | 156 | UINT32 GroupCount;\r |
| 992f22b9 LG |
157 | ///\r |
| 158 | /// List of joined multicast group addresses.\r | |
| 159 | ///\r | |
| d1f95000 | 160 | EFI_IPv4_ADDRESS *GroupTable;\r |
| 992f22b9 LG |
161 | ///\r |
| 162 | /// Number of entries in the routing table.\r | |
| 163 | ///\r | |
| d1f95000 | 164 | UINT32 RouteCount;\r |
| 992f22b9 LG |
165 | ///\r |
| 166 | /// Routing table entries.\r | |
| 167 | ///\r | |
| d1f95000 | 168 | EFI_IP4_ROUTE_TABLE *RouteTable;\r |
| 992f22b9 LG |
169 | ///\r |
| 170 | /// Number of entries in the supported ICMP types list.\r | |
| 171 | ///\r | |
| d1f95000 | 172 | UINT32 IcmpTypeCount;\r |
| 992f22b9 LG |
173 | ///\r |
| 174 | /// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver\r | |
| 175 | ///\r | |
| d1f95000 | 176 | EFI_IP4_ICMP_TYPE *IcmpTypeList;\r |
| 177 | } EFI_IP4_MODE_DATA;\r | |
| 178 | \r | |
| 179 | #pragma pack(1)\r | |
| 180 | \r | |
| 181 | typedef struct {\r | |
| d1f95000 | 182 | UINT8 HeaderLength:4;\r |
| 183 | UINT8 Version:4;\r | |
| d1f95000 | 184 | UINT8 TypeOfService;\r |
| 185 | UINT16 TotalLength;\r | |
| 186 | UINT16 Identification;\r | |
| 187 | UINT16 Fragmentation;\r | |
| 188 | UINT8 TimeToLive;\r | |
| 189 | UINT8 Protocol;\r | |
| 190 | UINT16 Checksum;\r | |
| 191 | EFI_IPv4_ADDRESS SourceAddress;\r | |
| 192 | EFI_IPv4_ADDRESS DestinationAddress;\r | |
| 193 | } EFI_IP4_HEADER;\r | |
| 194 | #pragma pack()\r | |
| 195 | \r | |
| 196 | \r | |
| 197 | typedef struct {\r | |
| 198 | UINT32 FragmentLength;\r | |
| 199 | VOID *FragmentBuffer;\r | |
| 200 | } EFI_IP4_FRAGMENT_DATA;\r | |
| 201 | \r | |
| 202 | \r | |
| 203 | typedef struct {\r | |
| 204 | EFI_TIME TimeStamp;\r | |
| 205 | EFI_EVENT RecycleSignal;\r | |
| 206 | UINT32 HeaderLength;\r | |
| 207 | EFI_IP4_HEADER *Header;\r | |
| 208 | UINT32 OptionsLength;\r | |
| 209 | VOID *Options;\r | |
| 210 | UINT32 DataLength;\r | |
| 211 | UINT32 FragmentCount;\r | |
| 212 | EFI_IP4_FRAGMENT_DATA FragmentTable[1];\r | |
| 213 | } EFI_IP4_RECEIVE_DATA;\r | |
| 214 | \r | |
| 215 | \r | |
| 216 | typedef struct {\r | |
| 217 | EFI_IPv4_ADDRESS SourceAddress;\r | |
| 218 | EFI_IPv4_ADDRESS GatewayAddress;\r | |
| 219 | UINT8 Protocol;\r | |
| 220 | UINT8 TypeOfService;\r | |
| 221 | UINT8 TimeToLive;\r | |
| 222 | BOOLEAN DoNotFragment;\r | |
| 223 | } EFI_IP4_OVERRIDE_DATA;\r | |
| 224 | \r | |
| 225 | typedef struct {\r | |
| 226 | EFI_IPv4_ADDRESS DestinationAddress;\r | |
| 227 | EFI_IP4_OVERRIDE_DATA *OverrideData; //OPTIONAL\r | |
| 228 | UINT32 OptionsLength; //OPTIONAL\r | |
| 229 | VOID *OptionsBuffer; //OPTIONAL\r | |
| 230 | UINT32 TotalDataLength;\r | |
| 231 | UINT32 FragmentCount;\r | |
| 232 | EFI_IP4_FRAGMENT_DATA FragmentTable[1];\r | |
| 233 | } EFI_IP4_TRANSMIT_DATA;\r | |
| 234 | \r | |
| 235 | typedef struct {\r | |
| 992f22b9 LG |
236 | ///\r |
| 237 | /// This Event will be signaled after the Status field is updated\r | |
| 238 | /// by the EFI IPv4 Protocol driver. The type of Event must be\r | |
| 239 | /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r | |
| 240 | /// Event must be lower than or equal to TPL_CALLBACK.\r | |
| 241 | ///\r | |
| d1f95000 | 242 | EFI_EVENT Event;\r |
| 992f22b9 LG |
243 | ///\r |
| 244 | /// The status that is returned to the caller at the end of the operation\r | |
| 245 | /// to indicate whether this operation completed successfully.\r | |
| 246 | ///\r | |
| d1f95000 | 247 | EFI_STATUS Status;\r |
| 248 | union {\r | |
| 992f22b9 LG |
249 | ///\r |
| 250 | /// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.\r | |
| 251 | ///\r | |
| d1f95000 | 252 | EFI_IP4_RECEIVE_DATA *RxData;\r |
| 992f22b9 LG |
253 | ///\r |
| 254 | /// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.\r | |
| 255 | ///\r | |
| d1f95000 | 256 | EFI_IP4_TRANSMIT_DATA *TxData;\r |
| 257 | } Packet;\r | |
| 258 | } EFI_IP4_COMPLETION_TOKEN;\r | |
| 259 | \r | |
| 260 | /**\r | |
| 261 | Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r | |
| 83497f5d | 262 | \r |
| 263 | The GetModeData() function returns the current operational mode data for this\r | |
| 264 | driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r | |
| 265 | function is used optionally to retrieve the operational mode data of underlying\r | |
| 266 | networks or drivers.\r | |
| d1f95000 | 267 | \r |
| 268 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
| 269 | @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r | |
| 270 | @param MnpConfigData Pointer to the managed network configuration data structure.\r | |
| 4ca9b6c4 | 271 | @param SnpModeData Pointer to the simple network mode data structure.\r |
| d1f95000 | 272 | \r |
| 273 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| 274 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
| 275 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
| 276 | \r | |
| 277 | **/\r | |
| 278 | typedef\r | |
| 279 | EFI_STATUS\r | |
| 8b13229b | 280 | (EFIAPI *EFI_IP4_GET_MODE_DATA)(\r |
| d1f95000 | 281 | IN CONST EFI_IP4_PROTOCOL *This,\r |
| 282 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r | |
| 283 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r | |
| 284 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r | |
| ed66e1bc | 285 | ); \r |
| d1f95000 | 286 | \r |
| 287 | /**\r | |
| 288 | Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r | |
| 83497f5d | 289 | \r |
| 290 | The Configure() function is used to set, change, or reset the operational\r | |
| 291 | parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r | |
| 292 | parameters have been set, no network traffic can be sent or received by this\r | |
| 293 | instance. Once the parameters have been reset (by calling this function with\r | |
| 294 | IpConfigData set to NULL), no more traffic can be sent or received until these\r | |
| 295 | parameters have been set again. Each EFI IPv4 Protocol instance can be started\r | |
| 296 | and stopped independently of each other by enabling or disabling their receive\r | |
| 297 | filter settings with the Configure() function.\r | |
| 298 | \r | |
| 299 | When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r | |
| 300 | be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r | |
| 301 | driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r | |
| 302 | to retrieve the default IPv4 address if it is not available yet. Clients could\r | |
| 303 | frequently call GetModeData() to check the status to ensure that the default IPv4\r | |
| 304 | address is ready.\r | |
| 305 | \r | |
| 306 | If operational parameters are reset or changed, any pending transmit and receive\r | |
| 307 | requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r | |
| 308 | and their events will be signaled.\r | |
| d1f95000 | 309 | \r |
| 310 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
| 311 | @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r | |
| 312 | \r | |
| 313 | @retval EFI_SUCCESS The driver instance was successfully opened.\r | |
| 314 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
| 315 | RARP, etc.) is not finished yet.\r | |
| c8c44377 | 316 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
| 317 | This is NULL.\r | |
| 318 | IpConfigData.StationAddress is not a unicast IPv4 address.\r | |
| 319 | IpConfigData.SubnetMask is not a valid IPv4 subnet \r | |
| d1f95000 | 320 | @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r |
| 321 | A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r | |
| 322 | not be located when clients choose to use the default IPv4\r | |
| 323 | address. This EFI IPv4 Protocol implementation does not\r | |
| 324 | support this requested filter or timeout setting.\r | |
| 325 | @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r | |
| 326 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r | |
| 327 | IPv4 address or subnet mask can be changed. The interface must\r | |
| 328 | also be stopped when switching to/from raw packet mode.\r | |
| 329 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r | |
| 4ca9b6c4 | 330 | Protocol driver instance is not opened.\r |
| d1f95000 | 331 | \r |
| 332 | **/\r | |
| 333 | typedef \r | |
| 334 | EFI_STATUS\r | |
| 8b13229b | 335 | (EFIAPI *EFI_IP4_CONFIGURE)(\r |
| d1f95000 | 336 | IN EFI_IP4_PROTOCOL *This,\r |
| 337 | IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r | |
| ed66e1bc | 338 | ); \r |
| d1f95000 | 339 | \r |
| 340 | /**\r | |
| 341 | Joins and leaves multicast groups.\r | |
| 83497f5d | 342 | \r |
| 343 | The Groups() function is used to join and leave multicast group sessions. Joining\r | |
| 344 | a group will enable reception of matching multicast packets. Leaving a group will\r | |
| 345 | disable the multicast packet reception.\r | |
| 346 | \r | |
| 347 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r | |
| d1f95000 | 348 | \r |
| 349 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
| 350 | @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r | |
| 351 | @param GroupAddress Pointer to the IPv4 multicast address.\r | |
| 352 | \r | |
| 353 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| 354 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r | |
| 355 | - This is NULL.\r | |
| 356 | - JoinFlag is TRUE and GroupAddress is NULL.\r | |
| 357 | - GroupAddress is not NULL and *GroupAddress is\r | |
| bdb140d7 | 358 | not a multicast IPv4 address.\r |
| d1f95000 | 359 | @retval EFI_NOT_STARTED This instance has not been started.\r |
| 360 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
| 361 | RARP, etc.) is not finished yet.\r | |
| 362 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r | |
| 363 | @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r | |
| 364 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r | |
| 365 | JoinFlag is TRUE).\r | |
| 366 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r | |
| 367 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
| 368 | \r | |
| 369 | **/\r | |
| 370 | typedef \r | |
| 371 | EFI_STATUS\r | |
| 8b13229b | 372 | (EFIAPI *EFI_IP4_GROUPS)(\r |
| d1f95000 | 373 | IN EFI_IP4_PROTOCOL *This,\r |
| 374 | IN BOOLEAN JoinFlag,\r | |
| 375 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r | |
| ed66e1bc | 376 | ); \r |
| d1f95000 | 377 | \r |
| 378 | /**\r | |
| 379 | Adds and deletes routing table entries.\r | |
| 380 | \r | |
| 83497f5d | 381 | The Routes() function adds a route to or deletes a route from the routing table.\r |
| 382 | \r | |
| 383 | Routes are determined by comparing the SubnetAddress with the destination IPv4\r | |
| 384 | address arithmetically AND-ed with the SubnetMask. The gateway address must be\r | |
| 385 | on the same subnet as the configured station address.\r | |
| 386 | \r | |
| 387 | The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r | |
| 388 | The default route matches all destination IPv4 addresses that do not match any\r | |
| 389 | other routes.\r | |
| 390 | \r | |
| 391 | A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r | |
| 392 | IP address if it can be found in the ARP cache or on the local subnet. One automatic\r | |
| 393 | nonroute entry will be inserted into the routing table for outgoing packets that\r | |
| 394 | are addressed to a local subnet (gateway address of 0.0.0.0).\r | |
| 395 | \r | |
| 396 | Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r | |
| 397 | IPv4 Protocol instances that use the default IPv4 address will also have copies\r | |
| 398 | of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r | |
| 399 | copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r | |
| 400 | instances. As a result, client modification to the routing table will be lost.\r | |
| 401 | \r | |
| d1f95000 | 402 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r |
| 403 | @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r | |
| 404 | FALSE to add this route to the routing table. SubnetAddress\r | |
| 405 | and SubnetMask are used as the key to each route entry.\r | |
| 406 | @param SubnetAddress The address of the subnet that needs to be routed.\r | |
| 407 | @param SubnetMask The subnet mask of SubnetAddress.\r | |
| 408 | @param GatewayAddress The unicast gateway IPv4 address for this route.\r | |
| 409 | \r | |
| 410 | @retval EFI_SUCCESS The operation completed successfully.\r | |
| 411 | @retval EFI_NOT_STARTED The driver instance has not been started.\r | |
| 412 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
| 413 | RARP, etc.) is not finished yet.\r | |
| 414 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
| 415 | - This is NULL.\r | |
| 416 | - SubnetAddress is NULL.\r | |
| 417 | - SubnetMask is NULL.\r | |
| 418 | - GatewayAddress is NULL.\r | |
| 419 | - *SubnetAddress is not a valid subnet address.\r | |
| 420 | - *SubnetMask is not a valid subnet mask.\r | |
| 421 | - *GatewayAddress is not a valid unicast IPv4 address.\r | |
| 422 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r | |
| 423 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r | |
| 424 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r | |
| bdb140d7 | 425 | DeleteRoute is FALSE).\r |
| d1f95000 | 426 | \r |
| 427 | **/\r | |
| 428 | typedef \r | |
| 429 | EFI_STATUS\r | |
| 8b13229b | 430 | (EFIAPI *EFI_IP4_ROUTES)(\r |
| d1f95000 | 431 | IN EFI_IP4_PROTOCOL *This,\r |
| 432 | IN BOOLEAN DeleteRoute,\r | |
| 433 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r | |
| 434 | IN EFI_IPv4_ADDRESS *SubnetMask,\r | |
| 435 | IN EFI_IPv4_ADDRESS *GatewayAddress \r | |
| ed66e1bc | 436 | ); \r |
| d1f95000 | 437 | \r |
| 438 | /**\r | |
| 439 | Places outgoing data packets into the transmit queue.\r | |
| 440 | \r | |
| 83497f5d | 441 | The Transmit() function places a sending request in the transmit queue of this\r |
| 442 | EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r | |
| 443 | errors occur, the event in the token will be signaled and the status is updated.\r | |
| 444 | \r | |
| d1f95000 | 445 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r |
| 446 | @param Token Pointer to the transmit token.\r | |
| 447 | \r | |
| 448 | @retval EFI_SUCCESS The data has been queued for transmission.\r | |
| 449 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
| 450 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
| 451 | RARP, etc.) is not finished yet.\r | |
| 452 | @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r | |
| 453 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r | |
| 454 | was already in the transmit queue.\r | |
| 455 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r | |
| 456 | queue is full. \r | |
| 457 | @retval EFI_NOT_FOUND Not route is found to destination address.\r | |
| 458 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r | |
| 459 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r | |
| 460 | short to transmit.\r | |
| 461 | @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r | |
| 462 | greater than MTU (or greater than the maximum packet size if\r | |
| 463 | Token.Packet.TxData.OverrideData.\r | |
| 464 | DoNotFragment is TRUE.)\r | |
| 465 | \r | |
| 466 | **/\r | |
| 467 | typedef \r | |
| 468 | EFI_STATUS\r | |
| 8b13229b | 469 | (EFIAPI *EFI_IP4_TRANSMIT)(\r |
| d1f95000 | 470 | IN EFI_IP4_PROTOCOL *This,\r |
| 471 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
| ed66e1bc | 472 | ); \r |
| d1f95000 | 473 | \r |
| 474 | /**\r | |
| 475 | Places a receiving request into the receiving queue.\r | |
| 83497f5d | 476 | \r |
| 477 | The Receive() function places a completion token into the receive packet queue.\r | |
| 478 | This function is always asynchronous.\r | |
| 479 | \r | |
| 480 | The Token.Event field in the completion token must be filled in by the caller\r | |
| 481 | and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r | |
| 482 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r | |
| 483 | is signaled.\r | |
| d1f95000 | 484 | \r |
| 485 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
| 486 | @param Token Pointer to a token that is associated with the receive data descriptor.\r | |
| 487 | \r | |
| 488 | @retval EFI_SUCCESS The receive completion token was cached.\r | |
| 489 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
| 490 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r | |
| 491 | is not finished yet.\r | |
| 492 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
| 493 | - This is NULL.\r | |
| 494 | - Token is NULL.\r | |
| 495 | - Token.Event is NULL.\r | |
| 496 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r | |
| 497 | resources (usually memory).\r | |
| 498 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
| 499 | The EFI IPv4 Protocol instance has been reset to startup defaults.\r | |
| bdb140d7 | 500 | @retval EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r |
| d1f95000 | 501 | in the receive queue.\r |
| 502 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r | |
| 503 | @retval EFI_ICMP_ERROR An ICMP error packet was received.\r | |
| 504 | \r | |
| 505 | **/\r | |
| 506 | typedef \r | |
| 507 | EFI_STATUS\r | |
| 8b13229b | 508 | (EFIAPI *EFI_IP4_RECEIVE)(\r |
| d1f95000 | 509 | IN EFI_IP4_PROTOCOL *This,\r |
| 510 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
| ed66e1bc | 511 | ); \r |
| d1f95000 | 512 | \r |
| 513 | /**\r | |
| 514 | Abort an asynchronous transmit or receive request.\r | |
| 83497f5d | 515 | \r |
| 516 | The Cancel() function is used to abort a pending transmit or receive request.\r | |
| f754f721 | 517 | If the token is in the transmit or receive request queues, after calling this\r |
| 83497f5d | 518 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r |
| 519 | be signaled. If the token is not in one of the queues, which usually means the\r | |
| 520 | asynchronous operation has completed, this function will not signal the token\r | |
| 521 | and EFI_NOT_FOUND is returned.\r | |
| d1f95000 | 522 | \r |
| 523 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
| 524 | @param Token Pointer to a token that has been issued by\r | |
| 525 | EFI_IP4_PROTOCOL.Transmit() or\r | |
| 526 | EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r | |
| 527 | tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r | |
| 528 | defined in EFI_IP4_PROTOCOL.Transmit().\r | |
| 529 | \r | |
| 530 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r | |
| bdb140d7 | 531 | Token->Event was signaled. When Token is NULL, all\r |
| d1f95000 | 532 | pending requests were aborted and their events were signaled.\r |
| 533 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
| 534 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
| 535 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
| 536 | RARP, etc.) is not finished yet.\r | |
| 537 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r | |
| 538 | not found in the transmit or receive queue. It has either completed\r | |
| 539 | or was not issued by Transmit() and Receive().\r | |
| 540 | \r | |
| 541 | **/\r | |
| 542 | typedef\r | |
| 543 | EFI_STATUS\r | |
| 8b13229b | 544 | (EFIAPI *EFI_IP4_CANCEL)(\r |
| d1f95000 | 545 | IN EFI_IP4_PROTOCOL *This,\r |
| 546 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r | |
| ed66e1bc | 547 | ); \r |
| d1f95000 | 548 | \r |
| 549 | /**\r | |
| 550 | Polls for incoming data packets and processes outgoing data packets.\r | |
| 83497f5d | 551 | \r |
| 552 | The Poll() function polls for incoming data packets and processes outgoing data\r | |
| 553 | packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r | |
| 554 | function to increase the rate that data packets are moved between the communications\r | |
| 555 | device and the transmit and receive queues.\r | |
| 556 | \r | |
| 557 | In some systems the periodic timer event may not poll the underlying communications\r | |
| 558 | device fast enough to transmit and/or receive all data packets without missing\r | |
| 559 | incoming packets or dropping outgoing packets. Drivers and applications that are\r | |
| 560 | experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r | |
| 561 | more often.\r | |
| d1f95000 | 562 | \r |
| 563 | @param This Pointer to the EFI_IP4_PROTOCOL instance.\r | |
| 564 | \r | |
| 565 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
| 566 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
| 567 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
| 568 | RARP, etc.) is not finished yet.\r | |
| 569 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
| 570 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
| 571 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r | |
| 572 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r | |
| 573 | Consider increasing the polling rate.\r | |
| 574 | \r | |
| 575 | **/\r | |
| 576 | typedef \r | |
| 577 | EFI_STATUS\r | |
| 8b13229b | 578 | (EFIAPI *EFI_IP4_POLL)(\r |
| d1f95000 | 579 | IN EFI_IP4_PROTOCOL *This\r |
| ed66e1bc | 580 | ); \r |
| d1f95000 | 581 | \r |
| 44717a39 | 582 | ///\r |
| 583 | /// The EFI IPv4 Protocol implements a simple packet-oriented interface that can be \r | |
| 584 | /// used by drivers, daemons, and applications to transmit and receive network packets.\r | |
| 585 | ///\r | |
| d1f95000 | 586 | struct _EFI_IP4_PROTOCOL {\r |
| 587 | EFI_IP4_GET_MODE_DATA GetModeData;\r | |
| 588 | EFI_IP4_CONFIGURE Configure;\r | |
| 589 | EFI_IP4_GROUPS Groups;\r | |
| 590 | EFI_IP4_ROUTES Routes;\r | |
| 591 | EFI_IP4_TRANSMIT Transmit;\r | |
| 592 | EFI_IP4_RECEIVE Receive;\r | |
| 593 | EFI_IP4_CANCEL Cancel;\r | |
| 594 | EFI_IP4_POLL Poll;\r | |
| 595 | };\r | |
| 596 | \r | |
| 597 | extern EFI_GUID gEfiIp4ServiceBindingProtocolGuid;\r | |
| 598 | extern EFI_GUID gEfiIp4ProtocolGuid;\r | |
| 599 | \r | |
| 600 | #endif\r |