| cff298f4 |
1 | /** @file\r |
| 2 | This file defines the EFI DNSv6 (Domain Name Service version 6) Protocol. It is split\r |
| 3 | into the following two main sections:\r |
| 4 | DNSv6 Service Binding Protocol (DNSv6SB)\r |
| 5 | DNSv6 Protocol (DNSv6)\r |
| 6 | \r |
| 4c4cbee9 |
7 | Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r |
| cff298f4 |
8 | This program and the accompanying materials\r |
| 9 | are licensed and made available under the terms and conditions of the BSD License\r |
| 10 | which accompanies this distribution. The full text of the license may be found at\r |
| 11 | http://opensource.org/licenses/bsd-license.php\r |
| 12 | \r |
| 13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
| 14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| 15 | \r |
| 16 | @par Revision Reference:\r |
| 17 | This Protocol is introduced in UEFI Specification 2.5\r |
| 18 | \r |
| 19 | **/\r |
| 20 | \r |
| 21 | #ifndef __EFI_DNS6_PROTOCOL_H__\r |
| 22 | #define __EFI_DNS6_PROTOCOL_H__\r |
| 23 | \r |
| 24 | #define EFI_DNS6_SERVICE_BINDING_PROTOCOL_GUID \\r |
| 25 | { \\r |
| 26 | 0x7f1647c8, 0xb76e, 0x44b2, {0xa5, 0x65, 0xf7, 0xf, 0xf1, 0x9c, 0xd1, 0x9e } \\r |
| 27 | }\r |
| 28 | \r |
| 29 | #define EFI_DNS6_PROTOCOL_GUID \\r |
| 30 | { \\r |
| 31 | 0xca37bc1f, 0xa327, 0x4ae9, {0x82, 0x8a, 0x8c, 0x40, 0xd8, 0x50, 0x6a, 0x17 } \\r |
| 32 | }\r |
| 33 | \r |
| 34 | typedef struct _EFI_DNS6_PROTOCOL EFI_DNS6_PROTOCOL;\r |
| 35 | \r |
| 36 | ///\r |
| 37 | /// EFI_DNS6_CONFIG_DATA\r |
| 38 | ///\r |
| 39 | typedef struct {\r |
| 40 | ///\r |
| 41 | /// If TRUE, enable DNS cache function for this DNS instance. If FALSE, all DNS query\r |
| 42 | /// will not lookup local DNS cache.\r |
| 43 | ///\r |
| 44 | BOOLEAN EnableDnsCache;\r |
| 45 | ///\r |
| 46 | /// Use the protocol number defined in\r |
| 47 | /// http://www.iana.org/assignments/protocol-numbers. Beside TCP/UDP, Other protocol\r |
| 48 | /// is invalid value. An implementation can choose to support UDP, or both TCP and UDP.\r |
| 49 | ///\r |
| 50 | UINT8 Protocol;\r |
| 51 | ///\r |
| 52 | /// The local IP address to use. Set to zero to let the underlying IPv6 \r |
| 53 | /// driver choose a source address. If not zero it must be one of the \r |
| 54 | /// configured IP addresses in the underlying IPv6 driver.\r |
| 55 | ///\r |
| 56 | EFI_IPv6_ADDRESS StationIp;\r |
| 57 | ///\r |
| 58 | /// Local port number. Set to zero to use the automatically assigned port number.\r |
| 59 | ///\r |
| 60 | UINT16 LocalPort;\r |
| 61 | ///\r |
| 62 | /// Count of the DNS servers. When used with GetModeData(), \r |
| 63 | /// this field is the count of originally configured servers when \r |
| 64 | /// Configure() was called for this instance. When used with \r |
| 65 | /// Configure() this is the count of caller-supplied servers. If the \r |
| 66 | /// DnsServerListCount is zero, the DNS server configuration \r |
| 67 | /// will be retrieved from DHCP server automatically.\r |
| 68 | ///\r |
| 69 | UINT32 DnsServerCount;\r |
| 70 | ///\r |
| 71 | /// Pointer to DNS server list containing DnsServerListCount\r |
| 72 | /// entries or NULL if DnsServerListCount is 0. For Configure(), \r |
| 73 | /// this will be NULL when there are no caller supplied server addresses \r |
| 74 | /// and the DNS instance will retrieve DNS server from DHCP Server. \r |
| 75 | /// The provided DNS server list is recommended to be filled up in the sequence \r |
| 76 | /// of preference. When used with GetModeData(), the buffer containing the list \r |
| 77 | /// will be allocated by the driver implementing this protocol and must be \r |
| 78 | /// freed by the caller. When used with Configure(), the buffer \r |
| 79 | /// containing the list will be allocated and released by the caller.\r |
| 80 | ///\r |
| 81 | EFI_IPv6_ADDRESS *DnsServerList;\r |
| 82 | ///\r |
| 83 | /// Retry number if no response received after RetryInterval.\r |
| 84 | ///\r |
| 85 | UINT32 RetryCount;\r |
| 86 | ///\r |
| 87 | /// Minimum interval of retry is 2 second. If the retry interval is less than 2\r |
| 88 | /// seconds, then use the 2 seconds.\r |
| 89 | UINT32 RetryInterval;\r |
| 90 | } EFI_DNS6_CONFIG_DATA;\r |
| 91 | \r |
| 92 | ///\r |
| 93 | /// EFI_DNS6_CACHE_ENTRY\r |
| 94 | ///\r |
| 95 | typedef struct {\r |
| 96 | ///\r |
| 97 | /// Host name. This should be interpreted as Unicode characters.\r |
| 98 | ///\r |
| 99 | CHAR16 *HostName;\r |
| 100 | ///\r |
| 101 | /// IP address of this host.\r |
| 102 | ///\r |
| 103 | EFI_IPv6_ADDRESS *IpAddress;\r |
| 104 | ///\r |
| 105 | /// Time in second unit that this entry will remain in DNS cache. A value of zero means\r |
| 106 | /// that this entry is permanent. A nonzero value will override the existing one if\r |
| 107 | /// this entry to be added is dynamic entry. Implementations may set its default\r |
| 108 | /// timeout value for the dynamically created DNS cache entry after one DNS resolve\r |
| 109 | /// succeeds.\r |
| 110 | UINT32 Timeout;\r |
| 111 | } EFI_DNS6_CACHE_ENTRY;\r |
| 112 | \r |
| 113 | ///\r |
| 114 | /// EFI_DNS6_MODE_DATA\r |
| 115 | ///\r |
| 116 | typedef struct {\r |
| 117 | ///\r |
| 118 | /// The configuration data of this instance.\r |
| 119 | ///\r |
| 120 | EFI_DNS6_CONFIG_DATA DnsConfigData;\r |
| 121 | ///\r |
| 122 | /// Number of configured DNS6 servers.\r |
| 123 | ///\r |
| 124 | UINT32 DnsServerCount;\r |
| 125 | ///\r |
| 126 | /// Pointer to common list of addresses of all configured DNS server used by EFI_DNS6_PROTOCOL \r |
| 127 | /// instances. List will include DNS servers configured by this or any other EFI_DNS6_PROTOCOL \r |
| 128 | /// instance. The storage for this list is allocated by the driver publishing this protocol, \r |
| 129 | /// and must be freed by the caller.\r |
| 130 | ///\r |
| 131 | EFI_IPv6_ADDRESS *DnsServerList;\r |
| 132 | ///\r |
| 133 | /// Number of DNS Cache entries. The DNS Cache is shared among all DNS instances.\r |
| 134 | ///\r |
| 135 | UINT32 DnsCacheCount;\r |
| 136 | ///\r |
| 137 | /// Pointer to a buffer containing DnsCacheCount DNS Cache \r |
| 138 | /// entry structures. The storage for thislist is allocated by the driver \r |
| 139 | /// publishing this protocol and must be freed by caller.\r |
| 140 | ///\r |
| 141 | EFI_DNS6_CACHE_ENTRY *DnsCacheList;\r |
| 142 | } EFI_DNS6_MODE_DATA;\r |
| 143 | \r |
| 144 | ///\r |
| 145 | /// DNS6_HOST_TO_ADDR_DATA\r |
| 146 | ///\r |
| 147 | typedef struct {\r |
| 148 | ///\r |
| 149 | /// Number of the returned IP address.\r |
| 150 | ///\r |
| 151 | UINT32 IpCount;\r |
| 152 | ///\r |
| 153 | /// Pointer to the all the returned IP address.\r |
| 154 | ///\r |
| 155 | EFI_IPv6_ADDRESS *IpList;\r |
| 156 | } DNS6_HOST_TO_ADDR_DATA;\r |
| 157 | \r |
| 158 | ///\r |
| 159 | /// DNS6_ADDR_TO_HOST_DATA\r |
| 160 | ///\r |
| 161 | typedef struct {\r |
| 162 | ///\r |
| 163 | /// Pointer to the primary name for this host address. It's the caller's\r |
| 164 | /// responsibility to free the response memory.\r |
| 165 | ///\r |
| 166 | CHAR16 *HostName;\r |
| 167 | } DNS6_ADDR_TO_HOST_DATA;\r |
| 168 | \r |
| 169 | ///\r |
| 170 | /// DNS6_RESOURCE_RECORD\r |
| 171 | ///\r |
| 172 | typedef struct {\r |
| 173 | ///\r |
| 174 | /// The Owner name.\r |
| 175 | ///\r |
| 176 | CHAR8 *QName;\r |
| 177 | ///\r |
| 178 | /// The Type Code of this RR.\r |
| 179 | ///\r |
| 180 | UINT16 QType;\r |
| 181 | ///\r |
| 182 | /// The CLASS code of this RR.\r |
| 183 | ///\r |
| 184 | UINT16 QClass;\r |
| 185 | ///\r |
| 186 | /// 32 bit integer which specify the time interval that the resource record may be\r |
| 187 | /// cached before the source of the information should again be consulted. Zero means\r |
| 188 | /// this RR cannot be cached.\r |
| 189 | ///\r |
| 190 | UINT32 TTL;\r |
| 191 | ///\r |
| 192 | /// 16 big integer which specify the length of RData.\r |
| 193 | ///\r |
| 194 | UINT16 DataLength;\r |
| 195 | ///\r |
| 196 | /// A string of octets that describe the resource, the format of this information\r |
| 197 | /// varies according to QType and QClass difference.\r |
| 198 | ///\r |
| 199 | CHAR8 *RData;\r |
| 200 | } DNS6_RESOURCE_RECORD;\r |
| 201 | \r |
| 202 | ///\r |
| 203 | /// DNS6_GENERAL_LOOKUP_DATA\r |
| 204 | ///\r |
| 205 | typedef struct {\r |
| 206 | ///\r |
| 207 | /// Number of returned matching RRs.\r |
| 208 | ///\r |
| 209 | UINTN RRCount;\r |
| 210 | ///\r |
| 211 | /// Pointer to the all the returned matching RRs. It's caller responsibility to free\r |
| 212 | /// the allocated memory to hold the returned RRs.\r |
| 213 | ///\r |
| 214 | DNS6_RESOURCE_RECORD *RRList;\r |
| 215 | } DNS6_GENERAL_LOOKUP_DATA;\r |
| 216 | \r |
| 217 | ///\r |
| 218 | /// EFI_DNS6_COMPLETION_TOKEN\r |
| 219 | ///\r |
| 220 | typedef struct {\r |
| 221 | ///\r |
| 222 | /// This Event will be signaled after the Status field is updated by the EFI DNSv6\r |
| 223 | /// protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.\r |
| 224 | ///\r |
| 225 | EFI_EVENT Event;\r |
| 226 | ///\r |
| 227 | /// Will be set to one of the following values:\r |
| 228 | /// EFI_SUCCESS: The host name to address translation completed successfully.\r |
| 229 | /// EFI_NOT_FOUND: No matching Resource Record (RR) is found.\r |
| 230 | /// EFI_TIMEOUT: No DNS server reachable, or RetryCount was exhausted without\r |
| 231 | /// response from all specified DNS servers.\r |
| 232 | /// EFI_DEVICE_ERROR: An unexpected system or network error occurred.\r |
| 233 | /// EFI_NO_MEDIA: There was a media error.\r |
| 234 | ///\r |
| 235 | EFI_STATUS Status;\r |
| 236 | ///\r |
| 237 | /// The parameter configured through DNSv6.Configure() interface. Retry number if no\r |
| 238 | /// response received after RetryInterval.\r |
| 239 | ///\r |
| 240 | UINT32 RetryCount;\r |
| 241 | ///\r |
| 242 | /// The parameter configured through DNSv6.Configure() interface. Minimum interval of\r |
| 243 | /// retry is 2 seconds. If the retry interval is less than 2 seconds, then use the 2\r |
| 244 | /// seconds.\r |
| 245 | ///\r |
| 246 | UINT32 RetryInterval;\r |
| 247 | ///\r |
| 248 | /// DNSv6 completion token data\r |
| 249 | ///\r |
| 250 | union {\r |
| 251 | ///\r |
| 252 | /// When the Token is used for host name to address translation, H2AData is a pointer\r |
| 253 | /// to the DNS6_HOST_TO_ADDR_DATA.\r |
| 254 | ///\r |
| 255 | DNS6_HOST_TO_ADDR_DATA *H2AData;\r |
| 256 | ///\r |
| 257 | /// When the Token is used for host address to host name translation, A2HData is a\r |
| 258 | /// pointer to the DNS6_ADDR_TO_HOST_DATA.\r |
| 259 | ///\r |
| 260 | DNS6_ADDR_TO_HOST_DATA *A2HData;\r |
| 261 | ///\r |
| 262 | /// When the Token is used for a general lookup function, GLookupDATA is a pointer to\r |
| 263 | /// the DNS6_GENERAL_LOOKUP_DATA.\r |
| 264 | ///\r |
| 265 | DNS6_GENERAL_LOOKUP_DATA *GLookupData;\r |
| 266 | } RspData;\r |
| 267 | } EFI_DNS6_COMPLETION_TOKEN;\r |
| 268 | \r |
| 269 | /**\r |
| 270 | Retrieve mode data of this DNS instance.\r |
| 271 | \r |
| 272 | This function is used to retrieve DNS mode data for this DNS instance.\r |
| 273 | \r |
| 274 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 275 | @param[out] DnsModeData Pointer to the caller-allocated storage for the \r |
| 276 | EFI_DNS6_MODE_DATA data.\r |
| 277 | \r |
| 278 | @retval EFI_SUCCESS The operation completed successfully.\r |
| 279 | @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data\r |
| 280 | is available because this instance has not been\r |
| 281 | configured.\r |
| 282 | @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r |
| 283 | @retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.\r |
| 284 | **/\r |
| 285 | typedef\r |
| 286 | EFI_STATUS\r |
| 287 | (EFIAPI * EFI_DNS6_GET_MODE_DATA)(\r |
| 288 | IN EFI_DNS6_PROTOCOL *This,\r |
| 289 | OUT EFI_DNS6_MODE_DATA *DnsModeData\r |
| 290 | );\r |
| 291 | \r |
| 292 | /**\r |
| 293 | Configure this DNS instance.\r |
| 294 | \r |
| 295 | The Configure() function is used to set and change the configuration data for this\r |
| 296 | EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL.\r |
| 297 | \r |
| 298 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 299 | @param[in] DnsConfigData Pointer to the configuration data structure. All associated \r |
| 300 | storage to be allocated and released by caller.\r |
| 301 | \r |
| 302 | @retval EFI_SUCCESS The operation completed successfully.\r |
| 00b7cc0f |
303 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
| 4c4cbee9 |
304 | The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r |
| cff298f4 |
305 | DnsServerList is NULL while DnsServerList Count is not ZERO.\r |
| 306 | DnsServerList Count is ZERO while DnsServerList is not NULL.\r |
| 307 | @retval EFI_OUT_OF_RESOURCES The DNS instance data or required space could not be allocated.\r |
| 308 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The\r |
| 309 | EFI DNSv6 Protocol instance is not configured.\r |
| 310 | @retval EFI_UNSUPPORTED The designated protocol is not supported.\r |
| 311 | @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To \r |
| 312 | reconfigure the instance the caller must call Configure() with \r |
| 313 | NULL first to return driver to unconfigured state.\r |
| 314 | **/\r |
| 315 | typedef\r |
| 316 | EFI_STATUS\r |
| 317 | (EFIAPI * EFI_DNS6_CONFIGURE)(\r |
| 318 | IN EFI_DNS6_PROTOCOL *This,\r |
| 319 | IN EFI_DNS6_CONFIG_DATA *DnsConfigData\r |
| 320 | );\r |
| 321 | \r |
| 322 | /**\r |
| 323 | Host name to host address translation.\r |
| 324 | \r |
| 325 | The HostNameToIp () function is used to translate the host name to host IP address. A\r |
| 4c4cbee9 |
326 | type AAAA query is used to get the one or more IPv6 addresses for this host.\r |
| cff298f4 |
327 | \r |
| 328 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 4c4cbee9 |
329 | @param[in] HostName Host name.\r |
| cff298f4 |
330 | @param[in] Token Point to the completion token to translate host name\r |
| 331 | to host address.\r |
| 332 | \r |
| 333 | @retval EFI_SUCCESS The operation completed successfully.\r |
| 334 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
| 335 | This is NULL.\r |
| 336 | Token is NULL.\r |
| 337 | Token.Event is NULL.\r |
| 338 | HostName is NULL or buffer contained unsupported characters.\r |
| 339 | @retval EFI_NO_MAPPING There's no source address is available for use.\r |
| 340 | @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r |
| 341 | @retval EFI_NOT_STARTED This instance has not been started.\r |
| 342 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r |
| 343 | **/\r |
| 344 | typedef\r |
| 345 | EFI_STATUS\r |
| 346 | (EFIAPI *EFI_DNS6_HOST_NAME_TO_IP) (\r |
| 347 | IN EFI_DNS6_PROTOCOL *This,\r |
| 348 | IN CHAR16 *HostName,\r |
| 349 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r |
| 350 | );\r |
| 351 | \r |
| 352 | /**\r |
| 353 | Host address to host name translation.\r |
| 354 | \r |
| 355 | The IpToHostName () function is used to translate the host address to host name. A\r |
| 356 | type PTR query is used to get the primary name of the host. Implementation can choose\r |
| 357 | to support this function or not.\r |
| 358 | \r |
| 359 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 360 | @param[in] IpAddress Ip Address.\r |
| 361 | @param[in] Token Point to the completion token to translate host\r |
| 362 | address to host name.\r |
| 363 | \r |
| 364 | @retval EFI_SUCCESS The operation completed successfully.\r |
| 365 | @retval EFI_UNSUPPORTED This function is not supported.\r |
| 366 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
| 367 | This is NULL.\r |
| 368 | Token is NULL.\r |
| 369 | Token.Event is NULL.\r |
| 370 | IpAddress is not valid IP address.\r |
| 371 | @retval EFI_NO_MAPPING There's no source address is available for use.\r |
| 372 | @retval EFI_NOT_STARTED This instance has not been started.\r |
| 373 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r |
| 374 | **/\r |
| 375 | typedef\r |
| 376 | EFI_STATUS\r |
| 377 | (EFIAPI *EFI_DNS6_IP_TO_HOST_NAME) (\r |
| 378 | IN EFI_DNS6_PROTOCOL *This,\r |
| 379 | IN EFI_IPv6_ADDRESS IpAddress,\r |
| 380 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r |
| 381 | );\r |
| 382 | \r |
| 383 | /**\r |
| 384 | This function provides capability to retrieve arbitrary information from the DNS\r |
| 385 | server.\r |
| 386 | \r |
| 387 | This GeneralLookup() function retrieves arbitrary information from the DNS. The caller\r |
| 388 | supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All\r |
| 389 | RR content (e.g., TTL) was returned. The caller need parse the returned RR to get\r |
| 390 | required information. The function is optional. Implementation can choose to support\r |
| 391 | it or not.\r |
| 392 | \r |
| 393 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 394 | @param[in] QName Pointer to Query Name.\r |
| 395 | @param[in] QType Query Type.\r |
| 396 | @param[in] QClass Query Name.\r |
| 397 | @param[in] Token Point to the completion token to retrieve arbitrary\r |
| 398 | information.\r |
| 399 | \r |
| 400 | @retval EFI_SUCCESS The operation completed successfully.\r |
| 401 | @retval EFI_UNSUPPORTED This function is not supported. Or the requested\r |
| 402 | QType is not supported\r |
| 403 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
| 404 | This is NULL.\r |
| 405 | Token is NULL.\r |
| 406 | Token.Event is NULL.\r |
| 407 | QName is NULL.\r |
| 408 | @retval EFI_NO_MAPPING There's no source address is available for use.\r |
| 409 | @retval EFI_NOT_STARTED This instance has not been started.\r |
| 410 | @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r |
| 411 | **/\r |
| 412 | typedef\r |
| 413 | EFI_STATUS\r |
| 414 | (EFIAPI *EFI_DNS6_GENERAL_LOOKUP) (\r |
| 415 | IN EFI_DNS6_PROTOCOL *This,\r |
| 416 | IN CHAR8 *QName,\r |
| 417 | IN UINT16 QType,\r |
| 418 | IN UINT16 QClass,\r |
| 419 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r |
| 420 | );\r |
| 421 | \r |
| 422 | /**\r |
| 423 | This function is to update the DNS Cache.\r |
| 424 | \r |
| 425 | The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache\r |
| 426 | can be normally dynamically updated after the DNS resolve succeeds. This function\r |
| 427 | provided capability to manually add/delete/modify the DNS cache.\r |
| 428 | \r |
| 429 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 430 | @param[in] DeleteFlag If FALSE, this function is to add one entry to the\r |
| 431 | DNS Cahce. If TRUE, this function will delete\r |
| 432 | matching DNS Cache entry.\r |
| 433 | @param[in] Override If TRUE, the maching DNS cache entry will be\r |
| 434 | overwritten with the supplied parameter. If FALSE,\r |
| 435 | EFI_ACCESS_DENIED will be returned if the entry to\r |
| 436 | be added is already existed.\r |
| 437 | @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r |
| 438 | \r |
| 439 | @retval EFI_SUCCESS The operation completed successfully.\r |
| 440 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
| 441 | This is NULL.\r |
| 442 | DnsCacheEntry.HostName is NULL.\r |
| 443 | DnsCacheEntry.IpAddress is NULL.\r |
| 444 | DnsCacheEntry.Timeout is zero.\r |
| 445 | @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is\r |
| 446 | not TRUE.\r |
| 447 | @retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.\r |
| 448 | **/\r |
| 449 | typedef\r |
| 450 | EFI_STATUS\r |
| 451 | (EFIAPI *EFI_DNS6_UPDATE_DNS_CACHE) (\r |
| 452 | IN EFI_DNS6_PROTOCOL *This,\r |
| 453 | IN BOOLEAN DeleteFlag,\r |
| 454 | IN BOOLEAN Override,\r |
| 455 | IN EFI_DNS6_CACHE_ENTRY DnsCacheEntry\r |
| 456 | );\r |
| 457 | \r |
| 458 | /**\r |
| 459 | Polls for incoming data packets and processes outgoing data packets.\r |
| 460 | \r |
| 461 | The Poll() function can be used by network drivers and applications to increase the\r |
| 462 | rate that data packets are moved between the communications device and the transmit\r |
| 463 | and receive queues.\r |
| 464 | \r |
| 465 | In some systems, the periodic timer event in the managed network driver may not poll\r |
| 466 | the underlying communications device fast enough to transmit and/or receive all data\r |
| 467 | packets without missing incoming packets or dropping outgoing packets. Drivers and\r |
| 468 | applications that are experiencing packet loss should try calling the Poll()\r |
| 469 | function more often.\r |
| 470 | \r |
| 471 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 472 | \r |
| 473 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r |
| 474 | @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started.\r |
| 475 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
| 476 | @retval EFI_NO_MAPPING There is no source address is available for use.\r |
| 477 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
| 478 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive\r |
| 479 | queue. Consider increasing the polling rate.\r |
| 480 | **/\r |
| 481 | typedef\r |
| 482 | EFI_STATUS\r |
| 483 | (EFIAPI *EFI_DNS6_POLL) (\r |
| 484 | IN EFI_DNS6_PROTOCOL *This\r |
| 485 | );\r |
| 486 | \r |
| 487 | /**\r |
| 488 | Abort an asynchronous DNS operation, including translation between IP and Host, and\r |
| 489 | general look up behavior.\r |
| 490 | \r |
| 491 | The Cancel() function is used to abort a pending resolution request. After calling\r |
| 492 | this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r |
| 493 | signaled. If the token is not in one of the queues, which usually means that the\r |
| 494 | asynchronous operation has completed, this function will not signal the token and\r |
| 495 | EFI_NOT_FOUND is returned.\r |
| 496 | \r |
| 497 | @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r |
| 498 | @param[in] Token Pointer to a token that has been issued by\r |
| 499 | EFI_DNS6_PROTOCOL.HostNameToIp (),\r |
| 500 | EFI_DNS6_PROTOCOL.IpToHostName() or\r |
| 501 | EFI_DNS6_PROTOCOL.GeneralLookup().\r |
| 502 | If NULL, all pending tokens are aborted.\r |
| 503 | \r |
| 504 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r |
| 505 | @retval EFI_NOT_STARTED This EFI DNS6 Protocol instance has not been started.\r |
| 506 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
| 507 | @retval EFI_NO_MAPPING There's no source address is available for use.\r |
| 508 | @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS\r |
| 509 | operation was not found in the transmit queue. It\r |
| 510 | was either completed or was not issued by\r |
| 511 | HostNameToIp(), IpToHostName() or GeneralLookup().\r |
| 512 | **/\r |
| 513 | typedef\r |
| 514 | EFI_STATUS\r |
| 515 | (EFIAPI *EFI_DNS6_CANCEL) (\r |
| 516 | IN EFI_DNS6_PROTOCOL *This,\r |
| 517 | IN EFI_DNS6_COMPLETION_TOKEN *Token\r |
| 518 | );\r |
| 519 | \r |
| 520 | ///\r |
| 521 | /// The EFI_DNS6_PROTOCOL provides the function to get the host name and address\r |
| 522 | /// mapping, also provide pass through interface to retrieve arbitrary information from\r |
| 523 | /// DNSv6.\r |
| 524 | ///\r |
| 525 | struct _EFI_DNS6_PROTOCOL {\r |
| 526 | EFI_DNS6_GET_MODE_DATA GetModeData;\r |
| 527 | EFI_DNS6_CONFIGURE Configure;\r |
| 528 | EFI_DNS6_HOST_NAME_TO_IP HostNameToIp;\r |
| 529 | EFI_DNS6_IP_TO_HOST_NAME IpToHostName;\r |
| 530 | EFI_DNS6_GENERAL_LOOKUP GeneralLookUp;\r |
| 531 | EFI_DNS6_UPDATE_DNS_CACHE UpdateDnsCache;\r |
| 532 | EFI_DNS6_POLL Poll;\r |
| 533 | EFI_DNS6_CANCEL Cancel;\r |
| 534 | };\r |
| 535 | \r |
| 536 | extern EFI_GUID gEfiDns6ServiceBindingProtocolGuid;\r |
| 537 | extern EFI_GUID gEfiDns6ProtocolGuid;\r |
| 538 | \r |
| 539 | #endif\r |
projects / mirror_edk2.git / blame