NetworkPkg/DnsDxe/DnsImpl.h

   1 /** @file
   2 DnsDxe support functions implementation.
   3
   4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __EFI_DNS_IMPL_H_
  16 #define __EFI_DNS_IMPL_H_
  17
  18 #include <Uefi.h>
  19
  20 //
  21 // Libraries classes
  22 //
  23 #include <Library/BaseLib.h>
  24 #include <Library/UefiLib.h>
  25 #include <Library/UefiBootServicesTableLib.h>
  26 #include <Library/UefiDriverEntryPoint.h>
  27 #include <Library/UefiRuntimeServicesTableLib.h>
  28 #include <Library/BaseMemoryLib.h>
  29 #include <Library/MemoryAllocationLib.h>
  30 #include <Library/NetLib.h>
  31 #include <Library/DebugLib.h>
  32 #include <Library/DpcLib.h>
  33 #include <Library/PrintLib.h>
  34 #include <Library/UdpIoLib.h>
  35
  36 //
  37 // UEFI Driver Model Protocols
  38 //
  39 #include <Protocol/DriverBinding.h>
  40 #include <Protocol/ComponentName2.h>
  41 #include <Protocol/ComponentName.h>
  42
  43 #include <Protocol/Udp4.h>
  44 #include <Protocol/Dhcp4.h>
  45 #include <Protocol/Dns4.h>
  46
  47 #include <Protocol/Udp6.h>
  48 #include <Protocol/Dhcp6.h>
  49 #include <Protocol/Dns6.h>
  50
  51 #include <Protocol/Ip4Config2.h>
  52
  53 #include "DnsDriver.h"
  54 #include "DnsDhcp.h"
  55
  56 //
  57 // Driver Version
  58 //
  59 #define DNS_VERSION  0x00000000
  60
  61 //
  62 // Protocol instances
  63 //
  64 extern EFI_COMPONENT_NAME_PROTOCOL   gDnsComponentName;
  65 extern EFI_COMPONENT_NAME2_PROTOCOL  gDnsComponentName2;
  66 extern EFI_UNICODE_STRING_TABLE      *gDnsControllerNameTable;
  67
  68 extern EFI_DRIVER_BINDING_PROTOCOL   gDns4DriverBinding;
  69 extern EFI_SERVICE_BINDING_PROTOCOL  mDns4ServiceBinding;
  70 extern EFI_DNS4_PROTOCOL             mDns4Protocol;
  71
  72 extern EFI_DRIVER_BINDING_PROTOCOL   gDns6DriverBinding;
  73 extern EFI_SERVICE_BINDING_PROTOCOL  mDns6ServiceBinding;
  74 extern EFI_DNS6_PROTOCOL             mDns6Protocol;
  75
  76 //
  77 // DNS related
  78 //
  79 #define DNS_SERVER_PORT   53
  80
  81 #define DNS_PROTOCOL_UDP   EFI_IP_PROTO_UDP
  82 #define DNS_PROTOCOL_TCP   EFI_IP_PROTO_TCP
  83
  84 #define DNS_STATE_UNCONFIGED     0
  85 #define DNS_STATE_CONFIGED       1
  86 #define DNS_STATE_DESTROY        2
  87
  88 #define DNS_DEFAULT_TIMEOUT      2
  89
  90 #define DNS_TIME_TO_GETMAP       5
  91
  92 #pragma pack(1)
  93
  94 typedef union _DNS_FLAGS  DNS_FLAGS;
  95
  96 typedef struct {
  97   LIST_ENTRY             AllCacheLink;
  98   EFI_DNS4_CACHE_ENTRY   DnsCache;
  99 } DNS4_CACHE;
 100
 101 typedef struct {
 102   LIST_ENTRY             AllCacheLink;
 103   EFI_DNS6_CACHE_ENTRY   DnsCache;
 104 } DNS6_CACHE;
 105
 106 typedef struct {
 107   LIST_ENTRY             AllServerLink;
 108   EFI_IPv4_ADDRESS       Dns4ServerIp;
 109 } DNS4_SERVER_IP;
 110
 111 typedef struct {
 112   LIST_ENTRY             AllServerLink;
 113   EFI_IPv6_ADDRESS       Dns6ServerIp;
 114 } DNS6_SERVER_IP;
 115
 116 typedef struct {
 117   UINT32                     RetryCounting;
 118   UINT32                     PacketToLive;
 119   CHAR16                     *QueryHostName;
 120   EFI_IPv4_ADDRESS           QueryIpAddress;
 121   BOOLEAN                    GeneralLookUp;
 122   EFI_DNS4_COMPLETION_TOKEN  *Token;
 123 } DNS4_TOKEN_ENTRY;
 124
 125 typedef struct {
 126   UINT32                     RetryCounting;
 127   UINT32                     PacketToLive;
 128   CHAR16                     *QueryHostName;
 129   EFI_IPv6_ADDRESS           QueryIpAddress;
 130   BOOLEAN                    GeneralLookUp;
 131   EFI_DNS6_COMPLETION_TOKEN  *Token;
 132 } DNS6_TOKEN_ENTRY;
 133
 134 union _DNS_FLAGS{
 135   struct {
 136     UINT16     RCode:4;
 137     UINT16     Zero:3;
 138     UINT16     RA:1;
 139     UINT16     RD:1;
 140     UINT16     TC:1;
 141     UINT16     AA:1;
 142     UINT16     OpCode:4;
 143     UINT16     QR:1;
 144   } Bits;
 145   UINT16  Uint16;
 146 };
 147
 148 #define DNS_FLAGS_QR_QUERY     0
 149 #define DNS_FLAGS_QR_RESPONSE  1
 150
 151 #define DNS_FLAGS_OPCODE_STANDARD     0
 152 #define DNS_FLAGS_OPCODE_INVERSE      1
 153 #define DNS_FLAGS_OPCODE_SERVER_STATE 2
 154
 155 #define DNS_FLAGS_RCODE_NO_ERROR    0
 156 #define DNS_FLAGS_RCODE_NAME_ERROR  3
 157
 158 typedef struct {
 159   UINT16      Identification;
 160   DNS_FLAGS   Flags;
 161   UINT16      QuestionsNum;
 162   UINT16      AnswersNum;
 163   UINT16      AuthorityNum;
 164   UINT16      AditionalNum;
 165 } DNS_HEADER;
 166
 167 typedef struct {
 168   UINT16      Type;
 169   UINT16      Class;
 170 } DNS_QUERY_SECTION;
 171
 172 typedef struct {
 173   UINT16      Type;
 174   UINT16      Class;
 175   UINT32      Ttl;
 176   UINT16      DataLength;
 177 } DNS_ANSWER_SECTION;
 178
 179 #define DNS4_DOMAIN  L"in-addr.arpa"
 180 #define DNS6_DOMAIN  L"IP6.ARPA"
 181
 182
 183 #pragma pack()
 184
 185 /**
 186   Remove TokenEntry from TokenMap.
 187
 188   @param[in] TokenMap          All DNSv4 Token entrys.
 189   @param[in] TokenEntry        TokenEntry need to be removed.
 190
 191   @retval EFI_SUCCESS          Remove TokenEntry from TokenMap sucessfully.
 192   @retval EFI_NOT_FOUND        TokenEntry is not found in TokenMap.
 193
 194 **/
 195 EFI_STATUS
 196 Dns4RemoveTokenEntry (
 197   IN NET_MAP                    *TokenMap,
 198   IN DNS4_TOKEN_ENTRY           *TokenEntry
 199   );
 200
 201 /**
 202   Remove TokenEntry from TokenMap.
 203
 204   @param[in] TokenMap           All DNSv6 Token entrys.
 205   @param[in] TokenEntry         TokenEntry need to be removed.
 206
 207   @retval EFI_SUCCESS           Remove TokenEntry from TokenMap sucessfully.
 208   @retval EFI_NOT_FOUND         TokenEntry is not found in TokenMap.
 209
 210 **/
 211 EFI_STATUS
 212 Dns6RemoveTokenEntry (
 213   IN NET_MAP                    *TokenMap,
 214   IN DNS6_TOKEN_ENTRY           *TokenEntry
 215   );
 216
 217 /**
 218   This function cancle the token specified by Arg in the Map.
 219
 220   @param[in]  Map             Pointer to the NET_MAP.
 221   @param[in]  Item            Pointer to the NET_MAP_ITEM.
 222   @param[in]  Arg             Pointer to the token to be cancelled. If NULL, all
 223                               the tokens in this Map will be cancelled.
 224                               This parameter is optional and may be NULL.
 225
 226   @retval EFI_SUCCESS         The token is cancelled if Arg is NULL, or the token
 227                               is not the same as that in the Item, if Arg is not
 228                               NULL.
 229   @retval EFI_ABORTED         Arg is not NULL, and the token specified by Arg is
 230                               cancelled.
 231
 232 **/
 233 EFI_STATUS
 234 EFIAPI
 235 Dns4CancelTokens (
 236   IN NET_MAP       *Map,
 237   IN NET_MAP_ITEM  *Item,
 238   IN VOID          *Arg OPTIONAL
 239   );
 240
 241 /**
 242   This function cancle the token specified by Arg in the Map.
 243
 244   @param[in]  Map             Pointer to the NET_MAP.
 245   @param[in]  Item            Pointer to the NET_MAP_ITEM.
 246   @param[in]  Arg             Pointer to the token to be cancelled. If NULL, all
 247                               the tokens in this Map will be cancelled.
 248                               This parameter is optional and may be NULL.
 249
 250   @retval EFI_SUCCESS         The token is cancelled if Arg is NULL, or the token
 251                               is not the same as that in the Item, if Arg is not
 252                               NULL.
 253   @retval EFI_ABORTED         Arg is not NULL, and the token specified by Arg is
 254                               cancelled.
 255
 256 **/
 257 EFI_STATUS
 258 EFIAPI
 259 Dns6CancelTokens (
 260   IN NET_MAP       *Map,
 261   IN NET_MAP_ITEM  *Item,
 262   IN VOID          *Arg OPTIONAL
 263   );
 264
 265 /**
 266   Get the TokenEntry from the TokensMap.
 267
 268   @param[in]  TokensMap           All DNSv4 Token entrys
 269   @param[in]  Token               Pointer to the token to be get.
 270   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.
 271
 272   @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.
 273   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.
 274
 275 **/
 276 EFI_STATUS
 277 EFIAPI
 278 GetDns4TokenEntry (
 279   IN     NET_MAP                   *TokensMap,
 280   IN     EFI_DNS4_COMPLETION_TOKEN *Token,
 281      OUT DNS4_TOKEN_ENTRY          **TokenEntry
 282   );
 283
 284 /**
 285   Get the TokenEntry from the TokensMap.
 286
 287   @param[in]  TokensMap           All DNSv6 Token entrys
 288   @param[in]  Token               Pointer to the token to be get.
 289   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.
 290
 291   @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.
 292   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.
 293
 294 **/
 295 EFI_STATUS
 296 EFIAPI
 297 GetDns6TokenEntry (
 298   IN     NET_MAP                   *TokensMap,
 299   IN     EFI_DNS6_COMPLETION_TOKEN *Token,
 300      OUT DNS6_TOKEN_ENTRY          **TokenEntry
 301   );
 302
 303 /**
 304   Cancel DNS4 tokens from the DNS4 instance.
 305
 306   @param[in]  Instance           Pointer to the DNS instance context data.
 307   @param[in]  Token              Pointer to the token to be canceled. If NULL, all
 308                                  tokens in this instance will be cancelled.
 309                                  This parameter is optional and may be NULL.
 310
 311   @retval EFI_SUCCESS            The Token is cancelled.
 312   @retval EFI_NOT_FOUND          The Token is not found.
 313
 314 **/
 315 EFI_STATUS
 316 Dns4InstanceCancelToken (
 317   IN DNS_INSTANCE               *Instance,
 318   IN EFI_DNS4_COMPLETION_TOKEN  *Token
 319   );
 320
 321 /**
 322   Cancel DNS6 tokens from the DNS6 instance.
 323
 324   @param[in]  Instance           Pointer to the DNS instance context data.
 325   @param[in]  Token              Pointer to the token to be canceled. If NULL, all
 326                                  tokens in this instance will be cancelled.
 327                                  This parameter is optional and may be NULL.
 328
 329   @retval EFI_SUCCESS            The Token is cancelled.
 330   @retval EFI_NOT_FOUND          The Token is not found.
 331
 332 **/
 333 EFI_STATUS
 334 Dns6InstanceCancelToken (
 335   IN DNS_INSTANCE               *Instance,
 336   IN EFI_DNS6_COMPLETION_TOKEN  *Token
 337   );
 338
 339 /**
 340   Free the resource related to the configure parameters.
 341
 342   @param  Config                 The DNS configure data
 343
 344 **/
 345 VOID
 346 Dns4CleanConfigure (
 347   IN OUT EFI_DNS4_CONFIG_DATA  *Config
 348   );
 349
 350 /**
 351   Free the resource related to the configure parameters.
 352
 353   @param  Config                 The DNS configure data
 354
 355 **/
 356 VOID
 357 Dns6CleanConfigure (
 358   IN OUT EFI_DNS6_CONFIG_DATA  *Config
 359   );
 360
 361 /**
 362   Allocate memory for configure parameter such as timeout value for Dst,
 363   then copy the configure parameter from Src to Dst.
 364
 365   @param[out]  Dst               The destination DHCP configure data.
 366   @param[in]   Src               The source DHCP configure data.
 367
 368   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.
 369   @retval EFI_SUCCESS            The configure is copied.
 370
 371 **/
 372 EFI_STATUS
 373 Dns4CopyConfigure (
 374   OUT EFI_DNS4_CONFIG_DATA  *Dst,
 375   IN  EFI_DNS4_CONFIG_DATA  *Src
 376   );
 377
 378 /**
 379   Allocate memory for configure parameter such as timeout value for Dst,
 380   then copy the configure parameter from Src to Dst.
 381
 382   @param[out]  Dst               The destination DHCP configure data.
 383   @param[in]   Src               The source DHCP configure data.
 384
 385   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.
 386   @retval EFI_SUCCESS            The configure is copied.
 387
 388 **/
 389 EFI_STATUS
 390 Dns6CopyConfigure (
 391   OUT EFI_DNS6_CONFIG_DATA  *Dst,
 392   IN  EFI_DNS6_CONFIG_DATA  *Src
 393   );
 394
 395 /**
 396   Callback of Dns packet. Does nothing.
 397
 398   @param Arg           The context.
 399
 400 **/
 401 VOID
 402 EFIAPI
 403 DnsDummyExtFree (
 404   IN VOID                   *Arg
 405   );
 406
 407 /**
 408   Poll the UDP to get the IP4 default address, which may be retrieved
 409   by DHCP.
 410
 411   The default time out value is 5 seconds. If IP has retrieved the default address,
 412   the UDP is reconfigured.
 413
 414   @param  Instance               The DNS instance
 415   @param  UdpIo                  The UDP_IO to poll
 416   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO
 417
 418   @retval TRUE                   The default address is retrieved and UDP is reconfigured.
 419   @retval FALSE                  Some error occured.
 420
 421 **/
 422 BOOLEAN
 423 Dns4GetMapping (
 424   IN DNS_INSTANCE           *Instance,
 425   IN UDP_IO                 *UdpIo,
 426   IN EFI_UDP4_CONFIG_DATA   *UdpCfgData
 427   );
 428
 429 /**
 430   Configure the opened Udp6 instance until the corresponding Ip6 instance
 431   has been configured.
 432
 433   @param  Instance               The DNS instance
 434   @param  UdpIo                  The UDP_IO to poll
 435   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO
 436
 437   @retval TRUE                   Configure the Udp6 instance successfully.
 438   @retval FALSE                  Some error occured.
 439
 440 **/
 441 BOOLEAN
 442 Dns6GetMapping (
 443   IN DNS_INSTANCE           *Instance,
 444   IN UDP_IO                 *UdpIo,
 445   IN EFI_UDP6_CONFIG_DATA   *UdpCfgData
 446   );
 447
 448 /**
 449   Configure the UDP.
 450
 451   @param  Instance               The DNS session
 452   @param  UdpIo                  The UDP_IO instance
 453
 454   @retval EFI_SUCCESS            The UDP is successfully configured for the
 455                                  session.
 456
 457 **/
 458 EFI_STATUS
 459 Dns4ConfigUdp (
 460   IN DNS_INSTANCE           *Instance,
 461   IN UDP_IO                 *UdpIo
 462   );
 463
 464 /**
 465   Configure the UDP.
 466
 467   @param  Instance               The DNS session
 468   @param  UdpIo                  The UDP_IO instance
 469
 470   @retval EFI_SUCCESS            The UDP is successfully configured for the
 471                                  session.
 472
 473 **/
 474 EFI_STATUS
 475 Dns6ConfigUdp (
 476   IN DNS_INSTANCE           *Instance,
 477   IN UDP_IO                 *UdpIo
 478   );
 479
 480 /**
 481   Update Dns4 cache to shared list of caches of all DNSv4 instances.
 482
 483   @param  Dns4CacheList      All Dns4 cache list.
 484   @param  DeleteFlag         If FALSE, this function is to add one entry to the DNS Cache.
 485                              If TRUE, this function will delete matching DNS Cache entry.
 486   @param  Override           If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.
 487                              If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.
 488   @param  DnsCacheEntry      Entry Pointer to DNS Cache entry.
 489
 490   @retval EFI_SUCCESS        Update Dns4 cache successfully.
 491   @retval Others             Failed to update Dns4 cache.
 492
 493 **/
 494 EFI_STATUS
 495 EFIAPI
 496 UpdateDns4Cache (
 497   IN LIST_ENTRY             *Dns4CacheList,
 498   IN BOOLEAN                DeleteFlag,
 499   IN BOOLEAN                Override,
 500   IN EFI_DNS4_CACHE_ENTRY   DnsCacheEntry
 501   );
 502
 503 /**
 504   Update Dns6 cache to shared list of caches of all DNSv6 instances.
 505
 506   @param  Dns6CacheList      All Dns6 cache list.
 507   @param  DeleteFlag         If FALSE, this function is to add one entry to the DNS Cache.
 508                              If TRUE, this function will delete matching DNS Cache entry.
 509   @param  Override           If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.
 510                              If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.
 511   @param  DnsCacheEntry      Entry Pointer to DNS Cache entry.
 512
 513   @retval EFI_SUCCESS        Update Dns6 cache successfully.
 514   @retval Others             Failed to update Dns6 cache.
 515 **/
 516 EFI_STATUS
 517 EFIAPI
 518 UpdateDns6Cache (
 519   IN LIST_ENTRY             *Dns6CacheList,
 520   IN BOOLEAN                DeleteFlag,
 521   IN BOOLEAN                Override,
 522   IN EFI_DNS6_CACHE_ENTRY   DnsCacheEntry
 523   );
 524
 525 /**
 526   Add Dns4 ServerIp to common list of addresses of all configured DNSv4 server.
 527
 528   @param  Dns4ServerList    Common list of addresses of all configured DNSv4 server.
 529   @param  ServerIp          DNS server Ip.
 530
 531   @retval EFI_SUCCESS       Add Dns4 ServerIp to common list successfully.
 532   @retval Others            Failed to add Dns4 ServerIp to common list.
 533
 534 **/
 535 EFI_STATUS
 536 EFIAPI
 537 AddDns4ServerIp (
 538   IN LIST_ENTRY                *Dns4ServerList,
 539   IN EFI_IPv4_ADDRESS           ServerIp
 540   );
 541
 542 /**
 543   Add Dns6 ServerIp to common list of addresses of all configured DNSv6 server.
 544
 545   @param  Dns6ServerList    Common list of addresses of all configured DNSv6 server.
 546   @param  ServerIp          DNS server Ip.
 547
 548   @retval EFI_SUCCESS       Add Dns6 ServerIp to common list successfully.
 549   @retval Others            Failed to add Dns6 ServerIp to common list.
 550
 551 **/
 552 EFI_STATUS
 553 EFIAPI
 554 AddDns6ServerIp (
 555   IN LIST_ENTRY                *Dns6ServerList,
 556   IN EFI_IPv6_ADDRESS           ServerIp
 557   );
 558
 559 /**
 560   Find out whether the response is valid or invalid.
 561
 562   @param  TokensMap       All DNS transmittal Tokens entry.
 563   @param  Identification  Identification for queried packet.
 564   @param  Type            Type for queried packet.
 565   @param  Class           Class for queried packet.
 566   @param  Item            Return corresponding Token entry.
 567
 568   @retval TRUE            The response is valid.
 569   @retval FALSE           The response is invalid.
 570
 571 **/
 572 BOOLEAN
 573 IsValidDnsResponse (
 574   IN     NET_MAP      *TokensMap,
 575   IN     UINT16       Identification,
 576   IN     UINT16       Type,
 577   IN     UINT16       Class,
 578      OUT NET_MAP_ITEM **Item
 579   );
 580
 581 /**
 582   Parse Dns Response.
 583
 584   @param  Instance              The DNS instance
 585   @param  RxString              Received buffer.
 586   @param  Length                Received buffer length.
 587   @param  Completed             Flag to indicate that Dns response is valid.
 588
 589   @retval EFI_SUCCESS           Parse Dns Response successfully.
 590   @retval Others                Failed to parse Dns Response.
 591
 592 **/
 593 EFI_STATUS
 594 ParseDnsResponse (
 595   IN OUT DNS_INSTANCE              *Instance,
 596   IN     UINT8                     *RxString,
 597   IN     UINT32                    Length,
 598      OUT BOOLEAN                   *Completed
 599   );
 600
 601 /**
 602   Parse response packet.
 603
 604   @param  Packet                The packets received.
 605   @param  EndPoint              The local/remote UDP access point
 606   @param  IoStatus              The status of the UDP receive
 607   @param  Context               The opaque parameter to the function.
 608
 609 **/
 610 VOID
 611 EFIAPI
 612 DnsOnPacketReceived (
 613   NET_BUF                   *Packet,
 614   UDP_END_POINT             *EndPoint,
 615   EFI_STATUS                IoStatus,
 616   VOID                      *Context
 617   );
 618
 619 /**
 620   Release the net buffer when packet is sent.
 621
 622   @param  Packet                The packets received.
 623   @param  EndPoint              The local/remote UDP access point
 624   @param  IoStatus              The status of the UDP receive
 625   @param  Context               The opaque parameter to the function.
 626
 627 **/
 628 VOID
 629 EFIAPI
 630 DnsOnPacketSent (
 631   NET_BUF                   *Packet,
 632   UDP_END_POINT             *EndPoint,
 633   EFI_STATUS                IoStatus,
 634   VOID                      *Context
 635   );
 636
 637 /**
 638   Query request information.
 639
 640   @param  Instance              The DNS instance
 641   @param  Packet                The packet for querying request information.
 642
 643   @retval EFI_SUCCESS           Query request information successfully.
 644   @retval Others                Failed to query request information.
 645
 646 **/
 647 EFI_STATUS
 648 DoDnsQuery (
 649   IN  DNS_INSTANCE              *Instance,
 650   IN  NET_BUF                   *Packet
 651   );
 652
 653 /**
 654   Construct the Packet according query section.
 655
 656   @param  Instance              The DNS instance
 657   @param  QueryName             Queried Name
 658   @param  Type                  Queried Type
 659   @param  Class                 Queried Class
 660   @param  Packet                The packet for query
 661
 662   @retval EFI_SUCCESS           The packet is constructed.
 663   @retval Others                Failed to construct the Packet.
 664
 665 **/
 666 EFI_STATUS
 667 ConstructDNSQuery (
 668   IN  DNS_INSTANCE              *Instance,
 669   IN  CHAR8                     *QueryName,
 670   IN  UINT16                    Type,
 671   IN  UINT16                    Class,
 672   OUT NET_BUF                   **Packet
 673   );
 674
 675 /**
 676   Retransmit the packet.
 677
 678   @param  Instance              The DNS instance
 679   @param  Packet                Retransmit the packet
 680
 681   @retval EFI_SUCCESS           The packet is retransmitted.
 682   @retval Others                Failed to retransmit.
 683
 684 **/
 685 EFI_STATUS
 686 DnsRetransmit (
 687   IN DNS_INSTANCE        *Instance,
 688   IN NET_BUF             *Packet
 689   );
 690
 691 /**
 692   The timer ticking function for the DNS service.
 693
 694   @param  Event                 The ticking event
 695   @param  Context               The DNS service instance
 696
 697 **/
 698 VOID
 699 EFIAPI
 700 DnsOnTimerRetransmit (
 701   IN EFI_EVENT              Event,
 702   IN VOID                   *Context
 703   );
 704
 705 /**
 706   The timer ticking function for the DNS driver.
 707
 708   @param  Event                 The ticking event
 709   @param  Context               NULL
 710
 711 **/
 712 VOID
 713 EFIAPI
 714 DnsOnTimerUpdate (
 715   IN EFI_EVENT              Event,
 716   IN VOID                   *Context
 717   );
 718
 719
 720 /**
 721   Retrieve mode data of this DNS instance.
 722
 723   This function is used to retrieve DNS mode data for this DNS instance.
 724
 725   @param[in]   This               Pointer to EFI_DNS4_PROTOCOL instance.
 726   @param[out]  DnsModeData        Point to the mode data.
 727
 728   @retval EFI_SUCCESS             The operation completed successfully.
 729   @retval EFI_NOT_STARTED         When DnsConfigData is queried, no configuration data
 730                                   is available because this instance has not been
 731                                   configured.
 732   @retval EFI_INVALID_PARAMETER   This is NULL or DnsModeData is NULL.
 733   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
 734 **/
 735 EFI_STATUS
 736 EFIAPI
 737 Dns4GetModeData (
 738   IN  EFI_DNS4_PROTOCOL          *This,
 739   OUT EFI_DNS4_MODE_DATA         *DnsModeData
 740   );
 741
 742 /**
 743   Configure this DNS instance.
 744
 745   This function is used to configure DNS mode data for this DNS instance.
 746
 747   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 748   @param[in]  DnsConfigData       Point to the Configuration data.
 749
 750   @retval EFI_SUCCESS             The operation completed successfully.
 751   @retval EFI_UNSUPPORTED         The designated protocol is not supported.
 752   @retval EFI_INVALID_PARAMTER    Thisis NULL.
 753                                   The StationIp address provided in DnsConfigData is not a
 754                                   valid unicast.
 755                                   DnsServerList is NULL while DnsServerListCount
 756                                   is not ZERO.
 757                                   DnsServerListCount is ZERO while DnsServerList
 758                                   is not NULL
 759   @retval EFI_OUT_OF_RESOURCES    The DNS instance data or required space could not be
 760                                   allocated.
 761   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. The
 762                                   EFI DNSv4 Protocol instance is not configured.
 763   @retval EFI_ALREADY_STARTED     Second call to Configure() with DnsConfigData. To
 764                                   reconfigure the instance the caller must call Configure()
 765                                   with NULL first to return driver to unconfigured state.
 766 **/
 767 EFI_STATUS
 768 EFIAPI
 769 Dns4Configure (
 770   IN EFI_DNS4_PROTOCOL           *This,
 771   IN EFI_DNS4_CONFIG_DATA        *DnsConfigData
 772   );
 773
 774 /**
 775   Host name to host address translation.
 776
 777   The HostNameToIp () function is used to translate the host name to host IP address. A
 778   type A query is used to get the one or more IP addresses for this host.
 779
 780   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 781   @param[in]  HostName            Host name.
 782   @param[in]  Token               Point to the completion token to translate host name
 783                                   to host address.
 784
 785   @retval EFI_SUCCESS             The operation completed successfully.
 786   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
 787                                   This is NULL.
 788                                   Token is NULL.
 789                                   Token.Event is NULL.
 790                                   HostName is NULL. HostName string is unsupported format.
 791   @retval EFI_NO_MAPPING          There's no source address is available for use.
 792   @retval EFI_NOT_STARTED         This instance has not been started.
 793 **/
 794 EFI_STATUS
 795 EFIAPI
 796 Dns4HostNameToIp (
 797   IN  EFI_DNS4_PROTOCOL          *This,
 798   IN  CHAR16                    *HostName,
 799   IN  EFI_DNS4_COMPLETION_TOKEN  *Token
 800   );
 801
 802 /**
 803   IPv4 address to host name translation also known as Reverse DNS lookup.
 804
 805   The IpToHostName() function is used to translate the host address to host name. A type PTR
 806   query is used to get the primary name of the host. Support of this function is optional.
 807
 808   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 809   @param[in]  IpAddress           Ip Address.
 810   @param[in]  Token               Point to the completion token to translate host
 811                                   address to host name.
 812
 813   @retval EFI_SUCCESS             The operation completed successfully.
 814   @retval EFI_UNSUPPORTED         This function is not supported.
 815   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
 816                                   This is NULL.
 817                                   Token is NULL.
 818                                   Token.Event is NULL.
 819                                   IpAddress is not valid IP address .
 820   @retval EFI_NO_MAPPING          There's no source address is available for use.
 821   @retval EFI_ALREADY_STARTED     This Token is being used in another DNS session.
 822   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
 823 **/
 824 EFI_STATUS
 825 EFIAPI
 826 Dns4IpToHostName (
 827   IN  EFI_DNS4_PROTOCOL             *This,
 828   IN  EFI_IPv4_ADDRESS              IpAddress,
 829   IN  EFI_DNS4_COMPLETION_TOKEN     *Token
 830   );
 831
 832 /**
 833   Retrieve arbitrary information from the DNS server.
 834
 835   This GeneralLookup() function retrieves arbitrary information from the DNS. The caller
 836   supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All
 837   RR content (e.g., TTL) was returned. The caller need parse the returned RR to get
 838   required information. The function is optional.
 839
 840   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 841   @param[in]  QName               Pointer to Query Name.
 842   @param[in]  QType               Query Type.
 843   @param[in]  QClass              Query Name.
 844   @param[in]  Token               Point to the completion token to retrieve arbitrary
 845                                   information.
 846
 847   @retval EFI_SUCCESS             The operation completed successfully.
 848   @retval EFI_UNSUPPORTED         This function is not supported. Or the requested
 849                                   QType is not supported
 850   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
 851                                   This is NULL.
 852                                   Token is NULL.
 853                                   Token.Event is NULL.
 854                                   QName is NULL.
 855   @retval EFI_NO_MAPPING          There's no source address is available for use.
 856   @retval EFI_ALREADY_STARTED     This Token is being used in another DNS session.
 857   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
 858 **/
 859 EFI_STATUS
 860 EFIAPI
 861 Dns4GeneralLookUp (
 862   IN  EFI_DNS4_PROTOCOL                *This,
 863   IN  CHAR8                            *QName,
 864   IN  UINT16                           QType,
 865   IN  UINT16                           QClass,
 866   IN  EFI_DNS4_COMPLETION_TOKEN        *Token
 867   );
 868
 869 /**
 870   This function is to update the DNS Cache.
 871
 872   The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache
 873   can be normally dynamically updated after the DNS resolve succeeds. This function
 874   provided capability to manually add/delete/modify the DNS cache.
 875
 876   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 877   @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the
 878                                   DNS Cahce. If TRUE, this function will delete
 879                                   matching DNS Cache entry.
 880   @param[in]  Override            If TRUE, the maching DNS cache entry will be
 881                                   overwritten with the supplied parameter. If FALSE,
 882                                   EFI_ACCESS_DENIED will be returned if the entry to
 883                                   be added is already existed.
 884   @param[in]  DnsCacheEntry       Pointer to DNS Cache entry.
 885
 886   @retval EFI_SUCCESS             The operation completed successfully.
 887   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
 888                                   This is NULL.
 889                                   DnsCacheEntry.HostName is NULL.
 890                                   DnsCacheEntry.IpAddress is NULL.
 891                                   DnsCacheEntry.Timeout is zero.
 892   @retval EFI_ACCESS_DENIED       The DNS cache entry already exists and Override is
 893                                   not TRUE.
 894 **/
 895 EFI_STATUS
 896 EFIAPI
 897 Dns4UpdateDnsCache (
 898   IN EFI_DNS4_PROTOCOL      *This,
 899   IN BOOLEAN               DeleteFlag,
 900   IN BOOLEAN               Override,
 901   IN EFI_DNS4_CACHE_ENTRY   DnsCacheEntry
 902   );
 903
 904 /**
 905   Polls for incoming data packets and processes outgoing data packets.
 906
 907   The Poll() function can be used by network drivers and applications to increase the
 908   rate that data packets are moved between the communications device and the transmit
 909   and receive queues.
 910   In some systems, the periodic timer event in the managed network driver may not poll
 911   the underlying communications device fast enough to transmit and/or receive all data
 912   packets without missing incoming packets or dropping outgoing packets. Drivers and
 913   applications that are experiencing packet loss should try calling the Poll()
 914   function more often.
 915
 916   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 917
 918   @retval EFI_SUCCESS             Incoming or outgoing data was processed.
 919   @retval EFI_NOT_STARTED         This EFI DNS Protocol instance has not been started.
 920   @retval EFI_INVALID_PARAMETER   This is NULL.
 921   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
 922   @retval EFI_TIMEOUT             Data was dropped out of the transmit and/or receive
 923                                   queue. Consider increasing the polling rate.
 924 **/
 925 EFI_STATUS
 926 EFIAPI
 927 Dns4Poll (
 928   IN EFI_DNS4_PROTOCOL    *This
 929   );
 930
 931 /**
 932   Abort an asynchronous DNS operation, including translation between IP and Host, and
 933   general look up behavior.
 934
 935   The Cancel() function is used to abort a pending resolution request. After calling
 936   this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
 937   signaled. If the token is not in one of the queues, which usually means that the
 938   asynchronous operation has completed, this function will not signal the token and
 939   EFI_NOT_FOUND is returned.
 940
 941   @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.
 942   @param[in]  Token               Pointer to a token that has been issued by
 943                                   EFI_DNS4_PROTOCOL.HostNameToIp (),
 944                                   EFI_DNS4_PROTOCOL.IpToHostName() or
 945                                   EFI_DNS4_PROTOCOL.GeneralLookup().
 946                                   If NULL, all pending tokens are aborted.
 947
 948   @retval EFI_SUCCESS             Incoming or outgoing data was processed.
 949   @retval EFI_NOT_STARTED         This EFI DNS4 Protocol instance has not been started.
 950   @retval EFI_INVALID_PARAMETER   This is NULL.
 951   @retval EFI_NOT_FOUND           When Token is not NULL, and the asynchronous DNS
 952                                   operation was not found in the transmit queue. It
 953                                   was either completed or was not issued by
 954                                   HostNameToIp(), IpToHostName() or GeneralLookup().
 955 **/
 956 EFI_STATUS
 957 EFIAPI
 958 Dns4Cancel (
 959   IN  EFI_DNS4_PROTOCOL          *This,
 960   IN  EFI_DNS4_COMPLETION_TOKEN  *Token
 961   );
 962
 963
 964 /**
 965   Retrieve mode data of this DNS instance.
 966
 967   This function is used to retrieve DNS mode data for this DNS instance.
 968
 969   @param[in]   This                Pointer to EFI_DNS6_PROTOCOL instance.
 970   @param[out]  DnsModeData         Pointer to the caller-allocated storage for the
 971                                    EFI_DNS6_MODE_DATA data.
 972
 973   @retval EFI_SUCCESS             The operation completed successfully.
 974   @retval EFI_NOT_STARTED         When DnsConfigData is queried, no configuration data
 975                                   is available because this instance has not been
 976                                   configured.
 977   @retval EFI_INVALID_PARAMETER   This is NULL or DnsModeData is NULL.
 978   @retval EFI_OUT_OF_RESOURCE     Failed to allocate needed resources.
 979 **/
 980 EFI_STATUS
 981 EFIAPI
 982 Dns6GetModeData (
 983   IN  EFI_DNS6_PROTOCOL          *This,
 984   OUT EFI_DNS6_MODE_DATA         *DnsModeData
 985   );
 986
 987 /**
 988   Configure this DNS instance.
 989
 990   The Configure() function is used to set and change the configuration data for this
 991   EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL.
 992
 993   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
 994   @param[in]  DnsConfigData       Pointer to the configuration data structure. All associated
 995                                   storage to be allocated and released by caller.
 996
 997   @retval EFI_SUCCESS             The operation completed successfully.
 998   @retval EFI_INVALID_PARAMTER    This is NULL.
 999                                   The StationIp address provided in DnsConfigData is not zero and not a valid unicast.
1000                                   DnsServerList is NULL while DnsServerList Count is not ZERO.
1001                                   DnsServerList Count is ZERO while DnsServerList is not NULL.
1002   @retval EFI_OUT_OF_RESOURCES    The DNS instance data or required space could not be allocated.
1003   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. The
1004                                   EFI DNSv6 Protocol instance is not configured.
1005   @retval EFI_UNSUPPORTED         The designated protocol is not supported.
1006   @retval EFI_ALREADY_STARTED     Second call to Configure() with DnsConfigData. To
1007                                   reconfigure the instance the caller must call Configure() with
1008                                   NULL first to return driver to unconfigured state.
1009 **/
1010 EFI_STATUS
1011 EFIAPI
1012 Dns6Configure (
1013   IN EFI_DNS6_PROTOCOL           *This,
1014   IN EFI_DNS6_CONFIG_DATA        *DnsConfigData
1015   );
1016
1017 /**
1018   Host name to host address translation.
1019
1020   The HostNameToIp () function is used to translate the host name to host IP address. A
1021   type AAAA query is used to get the one or more IPv6 addresses for this host.
1022
1023   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
1024   @param[in]  HostName            Host name.
1025   @param[in]  Token               Point to the completion token to translate host name
1026                                   to host address.
1027
1028   @retval EFI_SUCCESS             The operation completed successfully.
1029   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
1030                                   This is NULL.
1031                                   Token is NULL.
1032                                   Token.Event is NULL.
1033                                   HostName is NULL or buffer contained unsupported characters.
1034   @retval EFI_NO_MAPPING          There's no source address is available for use.
1035   @retval EFI_ALREADY_STARTED     This Token is being used in another DNS session.
1036   @retval EFI_NOT_STARTED         This instance has not been started.
1037   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
1038 **/
1039 EFI_STATUS
1040 EFIAPI
1041 Dns6HostNameToIp (
1042   IN  EFI_DNS6_PROTOCOL          *This,
1043   IN  CHAR16                     *HostName,
1044   IN  EFI_DNS6_COMPLETION_TOKEN  *Token
1045   );
1046
1047 /**
1048   Host address to host name translation.
1049
1050   The IpToHostName () function is used to translate the host address to host name. A
1051   type PTR query is used to get the primary name of the host. Implementation can choose
1052   to support this function or not.
1053
1054   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
1055   @param[in]  IpAddress           Ip Address.
1056   @param[in]  Token               Point to the completion token to translate host
1057                                   address to host name.
1058
1059   @retval EFI_SUCCESS             The operation completed successfully.
1060   @retval EFI_UNSUPPORTED         This function is not supported.
1061   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
1062                                   This is NULL.
1063                                   Token is NULL.
1064                                   Token.Event is NULL.
1065                                   IpAddress is not valid IP address.
1066   @retval EFI_NO_MAPPING          There's no source address is available for use.
1067   @retval EFI_NOT_STARTED         This instance has not been started.
1068   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
1069 **/
1070 EFI_STATUS
1071 EFIAPI
1072 Dns6IpToHostName (
1073   IN  EFI_DNS6_PROTOCOL             *This,
1074   IN  EFI_IPv6_ADDRESS              IpAddress,
1075   IN  EFI_DNS6_COMPLETION_TOKEN     *Token
1076   );
1077
1078 /**
1079   This function provides capability to retrieve arbitrary information from the DNS
1080   server.
1081
1082   This GeneralLookup() function retrieves arbitrary information from the DNS. The caller
1083   supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All
1084   RR content (e.g., TTL) was returned. The caller need parse the returned RR to get
1085   required information. The function is optional. Implementation can choose to support
1086   it or not.
1087
1088   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
1089   @param[in]  QName               Pointer to Query Name.
1090   @param[in]  QType               Query Type.
1091   @param[in]  QClass              Query Name.
1092   @param[in]  Token               Point to the completion token to retrieve arbitrary
1093                                   information.
1094
1095   @retval EFI_SUCCESS             The operation completed successfully.
1096   @retval EFI_UNSUPPORTED         This function is not supported. Or the requested
1097                                   QType is not supported
1098   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
1099                                   This is NULL.
1100                                   Token is NULL.
1101                                   Token.Event is NULL.
1102                                   QName is NULL.
1103   @retval EFI_NO_MAPPING          There's no source address is available for use.
1104   @retval EFI_NOT_STARTED         This instance has not been started.
1105   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
1106 **/
1107 EFI_STATUS
1108 EFIAPI
1109 Dns6GeneralLookUp (
1110   IN  EFI_DNS6_PROTOCOL                *This,
1111   IN  CHAR8                            *QName,
1112   IN  UINT16                           QType,
1113   IN  UINT16                           QClass,
1114   IN  EFI_DNS6_COMPLETION_TOKEN        *Token
1115   );
1116
1117 /**
1118   This function is to update the DNS Cache.
1119
1120   The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache
1121   can be normally dynamically updated after the DNS resolve succeeds. This function
1122   provided capability to manually add/delete/modify the DNS cache.
1123
1124   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
1125   @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the
1126                                   DNS Cahce. If TRUE, this function will delete
1127                                   matching DNS Cache entry.
1128   @param[in]  Override            If TRUE, the maching DNS cache entry will be
1129                                   overwritten with the supplied parameter. If FALSE,
1130                                   EFI_ACCESS_DENIED will be returned if the entry to
1131                                   be added is already existed.
1132   @param[in]  DnsCacheEntry       Pointer to DNS Cache entry.
1133
1134   @retval EFI_SUCCESS             The operation completed successfully.
1135   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
1136                                   This is NULL.
1137                                   DnsCacheEntry.HostName is NULL.
1138                                   DnsCacheEntry.IpAddress is NULL.
1139                                   DnsCacheEntry.Timeout is zero.
1140   @retval EFI_ACCESS_DENIED       The DNS cache entry already exists and Override is
1141                                   not TRUE.
1142   @retval EFI_OUT_OF_RESOURCE     Failed to allocate needed resources.
1143 **/
1144 EFI_STATUS
1145 EFIAPI
1146 Dns6UpdateDnsCache (
1147   IN EFI_DNS6_PROTOCOL      *This,
1148   IN BOOLEAN               DeleteFlag,
1149   IN BOOLEAN               Override,
1150   IN EFI_DNS6_CACHE_ENTRY   DnsCacheEntry
1151   );
1152
1153 /**
1154   Polls for incoming data packets and processes outgoing data packets.
1155
1156   The Poll() function can be used by network drivers and applications to increase the
1157   rate that data packets are moved between the communications device and the transmit
1158   and receive queues.
1159
1160   In some systems, the periodic timer event in the managed network driver may not poll
1161   the underlying communications device fast enough to transmit and/or receive all data
1162   packets without missing incoming packets or dropping outgoing packets. Drivers and
1163   applications that are experiencing packet loss should try calling the Poll()
1164   function more often.
1165
1166   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
1167
1168   @retval EFI_SUCCESS             Incoming or outgoing data was processed.
1169   @retval EFI_NOT_STARTED         This EFI DNS Protocol instance has not been started.
1170   @retval EFI_INVALID_PARAMETER   This is NULL.
1171   @retval EFI_NO_MAPPING          There is no source address is available for use.
1172   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
1173   @retval EFI_TIMEOUT             Data was dropped out of the transmit and/or receive
1174                                   queue. Consider increasing the polling rate.
1175 **/
1176 EFI_STATUS
1177 EFIAPI
1178 Dns6Poll (
1179   IN EFI_DNS6_PROTOCOL    *This
1180   );
1181
1182 /**
1183   Abort an asynchronous DNS operation, including translation between IP and Host, and
1184   general look up behavior.
1185
1186   The Cancel() function is used to abort a pending resolution request. After calling
1187   this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
1188   signaled. If the token is not in one of the queues, which usually means that the
1189   asynchronous operation has completed, this function will not signal the token and
1190   EFI_NOT_FOUND is returned.
1191
1192   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.
1193   @param[in]  Token               Pointer to a token that has been issued by
1194                                   EFI_DNS6_PROTOCOL.HostNameToIp (),
1195                                   EFI_DNS6_PROTOCOL.IpToHostName() or
1196                                   EFI_DNS6_PROTOCOL.GeneralLookup().
1197                                   If NULL, all pending tokens are aborted.
1198
1199   @retval EFI_SUCCESS             Incoming or outgoing data was processed.
1200   @retval EFI_NOT_STARTED         This EFI DNS6 Protocol instance has not been started.
1201   @retval EFI_INVALID_PARAMETER   This is NULL.
1202   @retval EFI_NO_MAPPING          There's no source address is available for use.
1203   @retval EFI_NOT_FOUND           When Token is not NULL, and the asynchronous DNS
1204                                   operation was not found in the transmit queue. It
1205                                   was either completed or was not issued by
1206                                   HostNameToIp(), IpToHostName() or GeneralLookup().
1207 **/
1208 EFI_STATUS
1209 EFIAPI
1210 Dns6Cancel (
1211   IN  EFI_DNS6_PROTOCOL          *This,
1212   IN  EFI_DNS6_COMPLETION_TOKEN  *Token
1213   );
1214
1215 #endif