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