/** @file\r
DnsDxe support functions implementation.\r
- \r
-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define DNS_STATE_DESTROY 2\r
\r
#define DNS_DEFAULT_TIMEOUT 2\r
-#define DNS_DEFAULT_RETRY 3\r
-#define DNS_DEFAULT_BLKSIZE 512\r
\r
#define DNS_TIME_TO_GETMAP 5\r
\r
\r
typedef struct {\r
LIST_ENTRY AllCacheLink;\r
- EFI_DNS4_CACHE_ENTRY DnsCache; \r
+ EFI_DNS4_CACHE_ENTRY DnsCache;\r
} DNS4_CACHE;\r
\r
typedef struct {\r
LIST_ENTRY AllCacheLink;\r
- EFI_DNS6_CACHE_ENTRY DnsCache; \r
+ EFI_DNS6_CACHE_ENTRY DnsCache;\r
} DNS6_CACHE;\r
\r
typedef struct {\r
LIST_ENTRY AllServerLink;\r
- EFI_IPv4_ADDRESS Dns4ServerIp; \r
+ EFI_IPv4_ADDRESS Dns4ServerIp;\r
} DNS4_SERVER_IP;\r
\r
typedef struct {\r
LIST_ENTRY AllServerLink;\r
- EFI_IPv6_ADDRESS Dns6ServerIp; \r
+ EFI_IPv6_ADDRESS Dns6ServerIp;\r
} DNS6_SERVER_IP;\r
\r
typedef struct {\r
+ UINT32 RetryCounting;\r
UINT32 PacketToLive;\r
CHAR16 *QueryHostName;\r
EFI_IPv4_ADDRESS QueryIpAddress;\r
} DNS4_TOKEN_ENTRY;\r
\r
typedef struct {\r
+ UINT32 RetryCounting;\r
UINT32 PacketToLive;\r
CHAR16 *QueryHostName;\r
EFI_IPv6_ADDRESS QueryIpAddress;\r
\r
@retval EFI_SUCCESS Remove TokenEntry from TokenMap sucessfully.\r
@retval EFI_NOT_FOUND TokenEntry is not found in TokenMap.\r
- \r
+\r
**/\r
EFI_STATUS\r
Dns6RemoveTokenEntry (\r
EFIAPI\r
GetDns4TokenEntry (\r
IN NET_MAP *TokensMap,\r
- IN EFI_DNS4_COMPLETION_TOKEN *Token, \r
+ IN EFI_DNS4_COMPLETION_TOKEN *Token,\r
OUT DNS4_TOKEN_ENTRY **TokenEntry\r
);\r
\r
EFIAPI\r
GetDns6TokenEntry (\r
IN NET_MAP *TokensMap,\r
- IN EFI_DNS6_COMPLETION_TOKEN *Token, \r
+ IN EFI_DNS6_COMPLETION_TOKEN *Token,\r
OUT DNS6_TOKEN_ENTRY **TokenEntry\r
);\r
\r
\r
/**\r
Poll the UDP to get the IP4 default address, which may be retrieved\r
- by DHCP. \r
- \r
- The default time out value is 5 seconds. If IP has retrieved the default address, \r
+ by DHCP.\r
+\r
+ The default time out value is 5 seconds. If IP has retrieved the default address,\r
the UDP is reconfigured.\r
\r
@param Instance The DNS instance\r
\r
/**\r
Configure the UDP.\r
- \r
+\r
@param Instance The DNS session\r
@param UdpIo The UDP_IO instance\r
- \r
+\r
@retval EFI_SUCCESS The UDP is successfully configured for the\r
session.\r
\r
\r
/**\r
Configure the UDP.\r
- \r
+\r
@param Instance The DNS session\r
@param UdpIo The UDP_IO instance\r
\r
\r
/**\r
Update Dns4 cache to shared list of caches of all DNSv4 instances.\r
- \r
+\r
@param Dns4CacheList All Dns4 cache list.\r
- @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache. \r
- If TRUE, this function will delete matching DNS Cache entry. \r
- @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. \r
+ @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache.\r
+ If TRUE, this function will delete matching DNS Cache entry.\r
+ @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.\r
If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.\r
@param DnsCacheEntry Entry Pointer to DNS Cache entry.\r
\r
@retval EFI_SUCCESS Update Dns4 cache successfully.\r
- @retval Others Failed to update Dns4 cache. \r
- \r
+ @retval Others Failed to update Dns4 cache.\r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- Update Dns6 cache to shared list of caches of all DNSv6 instances. \r
+ Update Dns6 cache to shared list of caches of all DNSv6 instances.\r
\r
@param Dns6CacheList All Dns6 cache list.\r
- @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache. \r
- If TRUE, this function will delete matching DNS Cache entry. \r
- @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. \r
+ @param DeleteFlag If FALSE, this function is to add one entry to the DNS Cache.\r
+ If TRUE, this function will delete matching DNS Cache entry.\r
+ @param Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter.\r
If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.\r
@param DnsCacheEntry Entry Pointer to DNS Cache entry.\r
- \r
+\r
@retval EFI_SUCCESS Update Dns6 cache successfully.\r
@retval Others Failed to update Dns6 cache.\r
-**/ \r
+**/\r
EFI_STATUS\r
EFIAPI\r
UpdateDns6Cache (\r
);\r
\r
/**\r
- Add Dns4 ServerIp to common list of addresses of all configured DNSv4 server. \r
+ Add Dns4 ServerIp to common list of addresses of all configured DNSv4 server.\r
\r
- @param Dns4ServerList Common list of addresses of all configured DNSv4 server. \r
- @param ServerIp DNS server Ip. \r
+ @param Dns4ServerList Common list of addresses of all configured DNSv4 server.\r
+ @param ServerIp DNS server Ip.\r
\r
@retval EFI_SUCCESS Add Dns4 ServerIp to common list successfully.\r
@retval Others Failed to add Dns4 ServerIp to common list.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- Add Dns6 ServerIp to common list of addresses of all configured DNSv6 server. \r
+ Add Dns6 ServerIp to common list of addresses of all configured DNSv6 server.\r
\r
- @param Dns6ServerList Common list of addresses of all configured DNSv6 server. \r
- @param ServerIp DNS server Ip. \r
+ @param Dns6ServerList Common list of addresses of all configured DNSv6 server.\r
+ @param ServerIp DNS server Ip.\r
\r
@retval EFI_SUCCESS Add Dns6 ServerIp to common list successfully.\r
@retval Others Failed to add Dns6 ServerIp to common list.\r
- \r
-**/ \r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
AddDns6ServerIp (\r
IN EFI_IPv6_ADDRESS ServerIp\r
);\r
\r
-/**\r
- Fill QName for IP querying. QName is a domain name represented as \r
- a sequence of labels, where each label consists of a length octet \r
- followed by that number of octets. The domain name terminates with \r
- the zero length octet for the null label of the root.\r
-\r
- @param HostName Queried HostName \r
-\r
- @retval NULL Failed to fill QName.\r
- @return QName filled successfully.\r
- \r
-**/ \r
-CHAR8 *\r
-EFIAPI\r
-DnsFillinQNameForQueryIp (\r
- IN CHAR16 *HostName\r
- );\r
-\r
/**\r
Find out whether the response is valid or invalid.\r
\r
- @param TokensMap All DNS transmittal Tokens entry. \r
- @param Identification Identification for queried packet. \r
+ @param TokensMap All DNS transmittal Tokens entry.\r
+ @param Identification Identification for queried packet.\r
@param Type Type for queried packet.\r
+ @param Class Class for queried packet.\r
@param Item Return corresponding Token entry.\r
\r
@retval TRUE The response is valid.\r
@retval FALSE The response is invalid.\r
- \r
-**/ \r
+\r
+**/\r
BOOLEAN\r
IsValidDnsResponse (\r
IN NET_MAP *TokensMap,\r
IN UINT16 Identification,\r
IN UINT16 Type,\r
+ IN UINT16 Class,\r
OUT NET_MAP_ITEM **Item\r
);\r
\r
\r
@param Instance The DNS instance\r
@param RxString Received buffer.\r
- @param Completed Flag to indicate that Dns response is valid. \r
- \r
+ @param Length Received buffer length.\r
+ @param Completed Flag to indicate that Dns response is valid.\r
+\r
@retval EFI_SUCCESS Parse Dns Response successfully.\r
@retval Others Failed to parse Dns Response.\r
- \r
-**/ \r
+\r
+**/\r
EFI_STATUS\r
ParseDnsResponse (\r
IN OUT DNS_INSTANCE *Instance,\r
IN UINT8 *RxString,\r
+ IN UINT32 Length,\r
OUT BOOLEAN *Completed\r
);\r
\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
-**/ \r
+**/\r
VOID\r
EFIAPI\r
DnsOnPacketReceived (\r
Construct the Packet according query section.\r
\r
@param Instance The DNS instance\r
- @param QueryName Queried Name \r
- @param Type Queried Type \r
- @param Class Queried Class \r
+ @param QueryName Queried Name\r
+ @param Type Queried Type\r
+ @param Class Queried Class\r
@param Packet The packet for query\r
\r
@retval EFI_SUCCESS The packet is constructed.\r
Retransmit the packet.\r
\r
@param Instance The DNS instance\r
- @param Packet Retransmit the packet \r
+ @param Packet Retransmit the packet\r
\r
@retval EFI_SUCCESS The packet is retransmitted.\r
@retval Others Failed to retransmit.\r
\r
\r
/**\r
- This function is used to retrieve DNS mode data for this DNS instance.\r
+ Retrieve mode data of this DNS instance.\r
\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[out] DnsModeData Pointer to the caller-allocated storage for the EFI_DNS4_MODE_DATA structure.\r
+ This function is used to retrieve DNS mode data for this DNS instance.\r
\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data is \r
- available because this instance has not been configured.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[out] DnsModeData Point to the mode data.\r
\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data\r
+ is available because this instance has not been\r
+ configured.\r
+ @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function is used to configure DNS configuration data for this DNS instance.\r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[in] DnsConfigData Pointer to caller-allocated buffer containing EFI_DNS4_CONFIG_DATA structure. \r
- If NULL, the driver will reinitialize the protocol instance to the unconfigured state.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_UNSUPPORTED The designated protocol is not supported.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- The StationIp address provided in DnsConfigData is not a valid unicast.\r
- DnsServerList is NULL while DnsServerListCount is not equal to Zero.\r
- DnsServerListCount is Zero while DnsServerListCount is not equal to NULL.\r
- @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI DNSv4 Protocol instance is not configured.\r
-\r
+ Configure this DNS instance.\r
+\r
+ This function is used to configure DNS mode data for this DNS instance.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[in] DnsConfigData Point to the Configuration data.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_UNSUPPORTED The designated protocol is not supported.\r
+ @retval EFI_INVALID_PARAMTER Thisis NULL.\r
+ The StationIp address provided in DnsConfigData is not a\r
+ valid unicast.\r
+ DnsServerList is NULL while DnsServerListCount\r
+ is not ZERO.\r
+ DnsServerListCount is ZERO while DnsServerList\r
+ is not NULL\r
+ @retval EFI_OUT_OF_RESOURCES The DNS instance data or required space could not be\r
+ allocated.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The\r
+ EFI DNSv4 Protocol instance is not configured.\r
+ @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To\r
+ reconfigure the instance the caller must call Configure()\r
+ with NULL first to return driver to unconfigured state.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- The function is used to translate the host name to host IP address. \r
- A type A query is used to get the one or more IP addresses for this host. \r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[in] HostName Pointer to caller-supplied buffer containing Host name to be translated. \r
- This buffer contains 16 bit characters but these are translated to ASCII for use with \r
- DNSv4 server and there is no requirement for driver to support non-ASCII Unicode characters.\r
- @param[in] Token Pointer to the caller-allocated completion token to return at the completion of the process to translate host name to host address. \r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- Token is NULL.\r
- Token.Event is.NULL\r
- HostName is NULL\r
- @retval EFI_NO_MAPPING There's no source address is available for use.\r
- @retval EFI_NOT_STARTED This instance has not been started.\r
-\r
+ Host name to host address translation.\r
+\r
+ The HostNameToIp () function is used to translate the host name to host IP address. A\r
+ type A query is used to get the one or more IP addresses for this host.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[in] HostName Host name.\r
+ @param[in] Token Point to the completion token to translate host name\r
+ to host address.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ Token is NULL.\r
+ Token.Event is NULL.\r
+ HostName is NULL. HostName string is unsupported format.\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- The function is used to translate the host address to host name. \r
- A type PTR query is used to get the primary name of the host. \r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[in] IpAddress IP address.\r
- @param[in] Token Pointer to the caller-allocated completion used token to translate host address to host name.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- Token is NULL.\r
- Token.Event is NULL.\r
- IpAddress is not valid IP address.\r
- @retval EFI_NO_MAPPING There's no source address is available for use.\r
- @retval EFI_NOT_STARTED This instance has not been started.\r
- @retval EFI_UNSUPPORTED This function is not supported.\r
-\r
+ IPv4 address to host name translation also known as Reverse DNS lookup.\r
+\r
+ The IpToHostName() function is used to translate the host address to host name. A type PTR\r
+ query is used to get the primary name of the host. Support of this function is optional.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[in] IpAddress Ip Address.\r
+ @param[in] Token Point to the completion token to translate host\r
+ address to host name.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_UNSUPPORTED This function is not supported.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ Token is NULL.\r
+ Token.Event is NULL.\r
+ IpAddress is not valid IP address .\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function retrieves arbitrary information from the DNS. \r
- The caller supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. \r
- All RR content (e.g., Ttl) was returned. \r
- The caller need parse the returned RR to get required information. This function is optional.\r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[in] QName Pointer to Query Name.\r
- @param[in] QType Query Type.\r
- @param[in] QClass Query Name.\r
- @param[in] Token Point to the caller-allocated completion token to retrieve arbitrary information.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- Token is NULL.\r
- Token.Event is NULL.\r
- QName is NULL.\r
- @retval EFI_NO_MAPPING There's no source address is available for use.\r
- @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r
- @retval EFI_UNSUPPORTED This function is not supported. Or the requested QType is not supported\r
-\r
+ Retrieve arbitrary information from the DNS server.\r
+\r
+ This GeneralLookup() function retrieves arbitrary information from the DNS. The caller\r
+ supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All\r
+ RR content (e.g., TTL) was returned. The caller need parse the returned RR to get\r
+ required information. The function is optional.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[in] QName Pointer to Query Name.\r
+ @param[in] QType Query Type.\r
+ @param[in] QClass Query Name.\r
+ @param[in] Token Point to the completion token to retrieve arbitrary\r
+ information.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_UNSUPPORTED This function is not supported. Or the requested\r
+ QType is not supported\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ Token is NULL.\r
+ Token.Event is NULL.\r
+ QName is NULL.\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns4GeneralLookUp (\r
IN EFI_DNS4_PROTOCOL *This,\r
IN CHAR8 *QName,\r
- IN UINT16 QType, \r
+ IN UINT16 QType,\r
IN UINT16 QClass,\r
IN EFI_DNS4_COMPLETION_TOKEN *Token\r
);\r
\r
/**\r
- This function is used to add/delete/modify DNS cache entry. \r
- DNS cache can be normally dynamically updated after the DNS resolve succeeds. \r
- This function provided capability to manually add/delete/modify the DNS cache.\r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[in] DeleteFlag If FALSE, this function is to add one entry to the DNS Cache. \r
- If TRUE, this function will delete matching DNS Cache entry. \r
- @param[in] Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. \r
- If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.\r
- @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_INVALID_PARAMETER This is NULL. \r
- DnsCacheEntry.HostName is NULL.\r
- DnsCacheEntry.IpAddress is NULL.\r
- DnsCacheEntry.Timeout is zero.\r
- @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is not TRUE. \r
-\r
+ This function is to update the DNS Cache.\r
+\r
+ The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache\r
+ can be normally dynamically updated after the DNS resolve succeeds. This function\r
+ provided capability to manually add/delete/modify the DNS cache.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[in] DeleteFlag If FALSE, this function is to add one entry to the\r
+ DNS Cahce. If TRUE, this function will delete\r
+ matching DNS Cache entry.\r
+ @param[in] Override If TRUE, the maching DNS cache entry will be\r
+ overwritten with the supplied parameter. If FALSE,\r
+ EFI_ACCESS_DENIED will be returned if the entry to\r
+ be added is already existed.\r
+ @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ DnsCacheEntry.HostName is NULL.\r
+ DnsCacheEntry.IpAddress is NULL.\r
+ DnsCacheEntry.Timeout is zero.\r
+ @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is\r
+ not TRUE.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function can be used by network drivers and applications to increase the rate that data packets are moved between \r
- the communications device and the transmit and receive queues. In some systems, the periodic timer event in the managed \r
- network driver may not poll the underlying communications device fast enough to transmit and/or receive all data packets \r
- without missing incoming packets or dropping outgoing packets.\r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
-\r
- @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
- @retval EFI_INVALID_PARAMETER This is NULL. \r
- @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started. \r
- @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. \r
- @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. \r
- Consider increasing the polling rate.\r
- \r
+ Polls for incoming data packets and processes outgoing data packets.\r
+\r
+ The Poll() function can be used by network drivers and applications to increase the\r
+ rate that data packets are moved between the communications device and the transmit\r
+ and receive queues.\r
+ In some systems, the periodic timer event in the managed network driver may not poll\r
+ the underlying communications device fast enough to transmit and/or receive all data\r
+ packets without missing incoming packets or dropping outgoing packets. Drivers and\r
+ applications that are experiencing packet loss should try calling the Poll()\r
+ function more often.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive\r
+ queue. Consider increasing the polling rate.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function is used to abort a pending resolution request. \r
- After calling this function, Token.Status will be set to EFI_ABORTED and then Token.\r
-\r
- @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
- @param[in] Token Pointer to a token that has been issued by EFI_DNS4_PROTOCOL.HostNameToIp(), \r
- EFI_DNS4_PROTOCOL.IpToHostName() or EFI_DNS4_PROTOCOL.GeneralLookup(). \r
- If NULL, all pending tokens are aborted.\r
-\r
- @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
- @retval EFI_INVALID_PARAMETER This is NULL. \r
- @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started. \r
- @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS operation was not found in the transmit queue. \r
- It was either completed or was not issued by HostNameToIp(), IpToHostName() or GeneralLookup().\r
- \r
+ Abort an asynchronous DNS operation, including translation between IP and Host, and\r
+ general look up behavior.\r
+\r
+ The Cancel() function is used to abort a pending resolution request. After calling\r
+ this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r
+ signaled. If the token is not in one of the queues, which usually means that the\r
+ asynchronous operation has completed, this function will not signal the token and\r
+ EFI_NOT_FOUND is returned.\r
+\r
+ @param[in] This Pointer to EFI_DNS4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_DNS4_PROTOCOL.HostNameToIp (),\r
+ EFI_DNS4_PROTOCOL.IpToHostName() or\r
+ EFI_DNS4_PROTOCOL.GeneralLookup().\r
+ If NULL, all pending tokens are aborted.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_NOT_STARTED This EFI DNS4 Protocol instance has not been started.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS\r
+ operation was not found in the transmit queue. It\r
+ was either completed or was not issued by\r
+ HostNameToIp(), IpToHostName() or GeneralLookup().\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
\r
/**\r
- This function is used to retrieve DNS mode data for this DNS instance.\r
+ Retrieve mode data of this DNS instance.\r
\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[out] DnsModeData Pointer to the caller-allocated storage for the EFI_DNS6_MODE_DATA structure.\r
+ This function is used to retrieve DNS mode data for this DNS instance.\r
\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data is \r
- available because this instance has not been configured.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[out] DnsModeData Pointer to the caller-allocated storage for the\r
+ EFI_DNS6_MODE_DATA data.\r
\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_NOT_STARTED When DnsConfigData is queried, no configuration data\r
+ is available because this instance has not been\r
+ configured.\r
+ @retval EFI_INVALID_PARAMETER This is NULL or DnsModeData is NULL.\r
+ @retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- The function is used to set and change the configuration data for this EFI DNSv6 Protocol driver instance. \r
- Reset the DNS instance if DnsConfigData is NULL.\r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[in] DnsConfigData Pointer to the configuration data structure. \r
- All associated storage to be allocated and released by caller.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_UNSUPPORTED The designated protocol is not supported.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- The StationIp address provided in DnsConfigData is not a valid unicast.\r
- DnsServerList is NULL while DnsServerListCount is not equal to Zero.\r
- DnsServerListCount is Zero while DnsServerList is not equal to NULL.\r
- @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI DNSv6 Protocol instance is not configured.\r
-\r
+ Configure this DNS instance.\r
+\r
+ The Configure() function is used to set and change the configuration data for this\r
+ EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[in] DnsConfigData Pointer to the configuration data structure. All associated\r
+ storage to be allocated and released by caller.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMTER This is NULL.\r
+ The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r
+ DnsServerList is NULL while DnsServerList Count is not ZERO.\r
+ DnsServerList Count is ZERO while DnsServerList is not NULL.\r
+ @retval EFI_OUT_OF_RESOURCES The DNS instance data or required space could not be allocated.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The\r
+ EFI DNSv6 Protocol instance is not configured.\r
+ @retval EFI_UNSUPPORTED The designated protocol is not supported.\r
+ @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To\r
+ reconfigure the instance the caller must call Configure() with\r
+ NULL first to return driver to unconfigured state.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- The function is used to translate the host name to host IP address. \r
- A type AAAA query is used to get the one or more IPv6 addresses for this host. \r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[in] HostName Pointer to caller-supplied buffer containing Host name to be translated. \r
- This buffer contains 16 bit characters but these are translated to ASCII for use with \r
- DNSv4 server and there is no requirement for driver to support non-ASCII Unicode characters.\r
- @param[in] Token Pointer to the caller-allocated completion token to return at the completion of the process to translate host name to host address. \r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- Token is NULL.\r
- Token.Event is.NULL\r
- HostName is NULL\r
- @retval EFI_NO_MAPPING There's no source address is available for use.\r
- @retval EFI_NOT_STARTED This instance has not been started.\r
-\r
+ Host name to host address translation.\r
+\r
+ The HostNameToIp () function is used to translate the host name to host IP address. A\r
+ type AAAA query is used to get the one or more IPv6 addresses for this host.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[in] HostName Host name.\r
+ @param[in] Token Point to the completion token to translate host name\r
+ to host address.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ Token is NULL.\r
+ Token.Event is NULL.\r
+ HostName is NULL or buffer contained unsupported characters.\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_ALREADY_STARTED This Token is being used in another DNS session.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- The function is used to translate the host address to host name. \r
- A type PTR query is used to get the primary name of the host. \r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[in] IpAddress IP address.\r
- @param[in] Token Pointer to the caller-allocated completion used token to translate host address to host name.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- Token is NULL.\r
- Token.Event is NULL.\r
- IpAddress is not valid IP address.\r
- @retval EFI_NO_MAPPING There's no source address is available for use.\r
- @retval EFI_NOT_STARTED This instance has not been started.\r
- @retval EFI_UNSUPPORTED This function is not supported.\r
-\r
+ Host address to host name translation.\r
+\r
+ The IpToHostName () function is used to translate the host address to host name. A\r
+ type PTR query is used to get the primary name of the host. Implementation can choose\r
+ to support this function or not.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[in] IpAddress Ip Address.\r
+ @param[in] Token Point to the completion token to translate host\r
+ address to host name.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_UNSUPPORTED This function is not supported.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ Token is NULL.\r
+ Token.Event is NULL.\r
+ IpAddress is not valid IP address.\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function retrieves arbitrary information from the DNS. \r
- The caller supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. \r
- All RR content (e.g., Ttl) was returned. \r
- The caller need parse the returned RR to get required information. This function is optional.\r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[in] QName Pointer to Query Name.\r
- @param[in] QType Query Type.\r
- @param[in] QClass Query Name.\r
- @param[in] Token Point to the caller-allocated completion token to retrieve arbitrary information.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_INVALID_PARAMETER This is NULL.\r
- Token is NULL.\r
- Token.Event is NULL.\r
- QName is NULL.\r
- @retval EFI_NO_MAPPING There's no source address is available for use.\r
- @retval EFI_NOT_STARTED This instance has not been started.\r
- @retval EFI_UNSUPPORTED This function is not supported. Or the requested QType is not supported\r
-\r
+ This function provides capability to retrieve arbitrary information from the DNS\r
+ server.\r
+\r
+ This GeneralLookup() function retrieves arbitrary information from the DNS. The caller\r
+ supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All\r
+ RR content (e.g., TTL) was returned. The caller need parse the returned RR to get\r
+ required information. The function is optional. Implementation can choose to support\r
+ it or not.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[in] QName Pointer to Query Name.\r
+ @param[in] QType Query Type.\r
+ @param[in] QClass Query Name.\r
+ @param[in] Token Point to the completion token to retrieve arbitrary\r
+ information.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_UNSUPPORTED This function is not supported. Or the requested\r
+ QType is not supported\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ Token is NULL.\r
+ Token.Event is NULL.\r
+ QName is NULL.\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns6GeneralLookUp (\r
IN EFI_DNS6_PROTOCOL *This,\r
IN CHAR8 *QName,\r
- IN UINT16 QType, \r
+ IN UINT16 QType,\r
IN UINT16 QClass,\r
IN EFI_DNS6_COMPLETION_TOKEN *Token\r
);\r
\r
/**\r
- This function is used to add/delete/modify DNS cache entry. \r
- DNS cache can be normally dynamically updated after the DNS resolve succeeds. \r
- This function provided capability to manually add/delete/modify the DNS cache.\r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[in] DeleteFlag If FALSE, this function is to add one entry to the DNS Cache. \r
- If TRUE, this function will delete matching DNS Cache entry. \r
- @param[in] Override If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. \r
- If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists.\r
- @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r
-\r
- @retval EFI_SUCCESS The operation completed successfully.\r
- @retval EFI_INVALID_PARAMETER This is NULL. \r
- DnsCacheEntry.HostName is NULL.\r
- DnsCacheEntry.IpAddress is NULL.\r
- DnsCacheEntry.Timeout is zero.\r
- @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is not TRUE. \r
-\r
+ This function is to update the DNS Cache.\r
+\r
+ The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache\r
+ can be normally dynamically updated after the DNS resolve succeeds. This function\r
+ provided capability to manually add/delete/modify the DNS cache.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[in] DeleteFlag If FALSE, this function is to add one entry to the\r
+ DNS Cahce. If TRUE, this function will delete\r
+ matching DNS Cache entry.\r
+ @param[in] Override If TRUE, the maching DNS cache entry will be\r
+ overwritten with the supplied parameter. If FALSE,\r
+ EFI_ACCESS_DENIED will be returned if the entry to\r
+ be added is already existed.\r
+ @param[in] DnsCacheEntry Pointer to DNS Cache entry.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ DnsCacheEntry.HostName is NULL.\r
+ DnsCacheEntry.IpAddress is NULL.\r
+ DnsCacheEntry.Timeout is zero.\r
+ @retval EFI_ACCESS_DENIED The DNS cache entry already exists and Override is\r
+ not TRUE.\r
+ @retval EFI_OUT_OF_RESOURCE Failed to allocate needed resources.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function can be used by network drivers and applications to increase the rate that data packets are moved between \r
- the communications device and the transmit and receive queues. In some systems, the periodic timer event in the managed \r
- network driver may not poll the underlying communications device fast enough to transmit and/or receive all data packets \r
- without missing incoming packets or dropping outgoing packets.\r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
-\r
- @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
- @retval EFI_INVALID_PARAMETER This is NULL. \r
- @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started. \r
- @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. \r
- @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. \r
- Consider increasing the polling rate.\r
- \r
+ Polls for incoming data packets and processes outgoing data packets.\r
+\r
+ The Poll() function can be used by network drivers and applications to increase the\r
+ rate that data packets are moved between the communications device and the transmit\r
+ and receive queues.\r
+\r
+ In some systems, the periodic timer event in the managed network driver may not poll\r
+ the underlying communications device fast enough to transmit and/or receive all data\r
+ packets without missing incoming packets or dropping outgoing packets. Drivers and\r
+ applications that are experiencing packet loss should try calling the Poll()\r
+ function more often.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NO_MAPPING There is no source address is available for use.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive\r
+ queue. Consider increasing the polling rate.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This function is used to abort a pending resolution request. \r
- After calling this function, Token.Status will be set to EFI_ABORTED and then Token.\r
-\r
- @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
- @param[in] Token Pointer to a token that has been issued by EFI_DNS6_PROTOCOL.HostNameToIp(), \r
- EFI_DNS6_PROTOCOL.IpToHostName() or EFI_DNS6_PROTOCOL.GeneralLookup(). \r
- If NULL, all pending tokens are aborted.\r
-\r
- @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
- @retval EFI_INVALID_PARAMETER This is NULL. \r
- @retval EFI_NOT_STARTED This EFI DNS Protocol instance has not been started. \r
- @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS operation was not found in the transmit queue. \r
- It was either completed or was not issued by HostNameToIp(), IpToHostName() or GeneralLookup().\r
- \r
+ Abort an asynchronous DNS operation, including translation between IP and Host, and\r
+ general look up behavior.\r
+\r
+ The Cancel() function is used to abort a pending resolution request. After calling\r
+ this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r
+ signaled. If the token is not in one of the queues, which usually means that the\r
+ asynchronous operation has completed, this function will not signal the token and\r
+ EFI_NOT_FOUND is returned.\r
+\r
+ @param[in] This Pointer to EFI_DNS6_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_DNS6_PROTOCOL.HostNameToIp (),\r
+ EFI_DNS6_PROTOCOL.IpToHostName() or\r
+ EFI_DNS6_PROTOCOL.GeneralLookup().\r
+ If NULL, all pending tokens are aborted.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_NOT_STARTED This EFI DNS6 Protocol instance has not been started.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NO_MAPPING There's no source address is available for use.\r
+ @retval EFI_NOT_FOUND When Token is not NULL, and the asynchronous DNS\r
+ operation was not found in the transmit queue. It\r
+ was either completed or was not issued by\r
+ HostNameToIp(), IpToHostName() or GeneralLookup().\r
**/\r
EFI_STATUS\r
EFIAPI\r
projects / mirror_edk2.git / blobdiff