X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FDns4.h;h=42b215b4d07253f3ce1375fe5a11507ed5616b2e;hp=3e7cdaaf2c066414c21d9a815bbbdd715defa7f2;hb=9095d37b8fe5bfc3d02adad6ba7fd7359ebc0107;hpb=cff298f44cbb3d592f7673f420315f0a4499153f
diff --git a/MdePkg/Include/Protocol/Dns4.h b/MdePkg/Include/Protocol/Dns4.h
index 3e7cdaaf2c..42b215b4d0 100644
--- a/MdePkg/Include/Protocol/Dns4.h
+++ b/MdePkg/Include/Protocol/Dns4.h
@@ -4,7 +4,7 @@
DNSv4 Service Binding Protocol (DNSv4SB)
DNSv4 Protocol (DNSv4)
- Copyright (c) 2015, Intel Corporation. All rights reserved.
+ Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -38,23 +38,23 @@ typedef struct _EFI_DNS4_PROTOCOL EFI_DNS4_PROTOCOL;
///
typedef struct {
///
- /// Count of the DNS servers. When used with GetModeData(),
- /// this field is the count of originally configured servers when
- /// Configure() was called for this instance. When used with
- /// Configure() this is the count of caller-supplied servers. If the
- /// DnsServerListCount is zero, the DNS server configuration
+ /// Count of the DNS servers. When used with GetModeData(),
+ /// this field is the count of originally configured servers when
+ /// Configure() was called for this instance. When used with
+ /// Configure() this is the count of caller-supplied servers. If the
+ /// DnsServerListCount is zero, the DNS server configuration
/// will be retrieved from DHCP server automatically.
///
UINTN DnsServerListCount;
///
- /// Pointer to DNS server list containing DnsServerListCount entries or NULL
- /// if DnsServerListCountis 0. For Configure(), this will be NULL when there are
- /// no caller supplied server addresses, and, the DNS instance will retrieve
- /// DNS server from DHCP Server. The provided DNS server list is
- /// recommended to be filled up in the sequence of preference. When
- /// used with GetModeData(), the buffer containing the list will
- /// be allocated by the driver implementing this protocol and must be
- /// freed by the caller. When used with Configure(), the buffer
+ /// Pointer to DNS server list containing DnsServerListCount entries or NULL
+ /// if DnsServerListCountis 0. For Configure(), this will be NULL when there are
+ /// no caller supplied server addresses, and, the DNS instance will retrieve
+ /// DNS server from DHCP Server. The provided DNS server list is
+ /// recommended to be filled up in the sequence of preference. When
+ /// used with GetModeData(), the buffer containing the list will
+ /// be allocated by the driver implementing this protocol and must be
+ /// freed by the caller. When used with Configure(), the buffer
/// containing the list will be allocated and released by the caller.
///
EFI_IPv4_ADDRESS *DnsServerList;
@@ -68,10 +68,10 @@ typedef struct {
///
BOOLEAN EnableDnsCache;
///
- /// Use the protocol number defined in "Links to UEFI-Related
- /// Documents"(http://uefi.org/uefi) under the heading "IANA
- /// Protocol Numbers". Only TCP or UDP are supported, and other
- /// protocol values are invalid. An implementation can choose to
+ /// Use the protocol number defined in "Links to UEFI-Related
+ /// Documents"(http://uefi.org/uefi) under the heading "IANA
+ /// Protocol Numbers". Only TCP or UDP are supported, and other
+ /// protocol values are invalid. An implementation can choose to
/// support only UDP, or both TCP and UDP.
///
UINT8 Protocol;
@@ -135,10 +135,10 @@ typedef struct {
///
UINT32 DnsServerCount;
///
- /// Pointer to common list of addresses of all configured DNS server
- /// used by EFI_DNS4_PROTOCOL instances. List will include
- /// DNS servers configured by this or any other EFI_DNS4_PROTOCOL instance.
- /// The storage for this list is allocated by the driver publishing this
+ /// Pointer to common list of addresses of all configured DNS server
+ /// used by EFI_DNS4_PROTOCOL instances. List will include
+ /// DNS servers configured by this or any other EFI_DNS4_PROTOCOL instance.
+ /// The storage for this list is allocated by the driver publishing this
/// protocol, and must be freed by the caller.
///
EFI_IPv4_ADDRESS *DnsServerList;
@@ -147,8 +147,8 @@ typedef struct {
///
UINT32 DnsCacheCount;
///
- /// Pointer to a buffer containing DnsCacheCount DNS Cache
- /// entry structures. The storage for this list is allocated by the driver
+ /// Pointer to a buffer containing DnsCacheCount DNS Cache
+ /// entry structures. The storage for this list is allocated by the driver
/// publishing this protocol and must be freed by caller.
///
EFI_DNS4_CACHE_ENTRY *DnsCacheList;
@@ -310,8 +310,8 @@ EFI_STATUS
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_UNSUPPORTED The designated protocol is not supported.
- @retval EFI_INVALID_PARAMTER Thisis NULL.
- The StationIp address provided in DnsConfigData is not a
+ @retval EFI_INVALID_PARAMETER This is NULL.
+ The StationIp address provided in DnsConfigData is not a
valid unicast.
DnsServerList is NULL while DnsServerListCount
is not ZERO.
@@ -321,8 +321,8 @@ EFI_STATUS
allocated.
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The
EFI DNSv4 Protocol instance is not configured.
- @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To
- reconfigure the instance the caller must call Configure()
+ @retval EFI_ALREADY_STARTED Second call to Configure() with DnsConfigData. To
+ reconfigure the instance the caller must call Configure()
with NULL first to return driver to unconfigured state.
**/
typedef
@@ -339,7 +339,7 @@ EFI_STATUS
type A query is used to get the one or more IP addresses for this host.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
- @param[in] Hostname Host name.
+ @param[in] HostName Host name.
@param[in] Token Point to the completion token to translate host name
to host address.
@@ -363,7 +363,7 @@ EFI_STATUS
/**
IPv4 address to host name translation also known as Reverse DNS lookup.
- The IpToHostName() function is used to translate the host address to host name. A type PTR
+ The IpToHostName() function is used to translate the host address to host name. A type PTR
query is used to get the primary name of the host. Support of this function is optional.
@param[in] This Pointer to EFI_DNS4_PROTOCOL instance.
@@ -380,7 +380,6 @@ EFI_STATUS
IpAddress is not valid IP address .
@retval EFI_NO_MAPPING There's no source address is available for use.
@retval EFI_ALREADY_STARTED This Token is being used in another DNS session.
- @retval EFI_NOT_STARTED This instance has not been started.
@retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
**/
typedef
@@ -392,7 +391,7 @@ EFI_STATUS
);
/**
- Retrieve arbitrary information from the DNS server.
+ Retrieve arbitrary information from the DNS server.
This GeneralLookup() function retrieves arbitrary information from the DNS. The caller
supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All