mirror of https://github.com/acidanthera/audk.git
Remove some non-ascii code in header file and fix some minor typos in comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9129 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
2832b22816
commit
176648481e
|
@ -405,7 +405,7 @@ typedef struct {
|
||||||
///
|
///
|
||||||
/// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
|
/// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
|
||||||
/// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
|
/// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
|
||||||
/// CapsuleImageSize-based payloads. These HOB’s shall be created by the PEI PI firmware
|
/// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
|
||||||
/// sometime after the UEFI UpdateCapsule service invocation with the
|
/// sometime after the UEFI UpdateCapsule service invocation with the
|
||||||
/// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
|
/// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
|
||||||
///
|
///
|
||||||
|
|
|
@ -45,7 +45,7 @@ EFI_STATUS
|
||||||
@retval EFI_INVALID_PARAMETER The callback function was NULL.
|
@retval EFI_INVALID_PARAMETER The callback function was NULL.
|
||||||
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
|
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
|
||||||
registered.
|
registered.
|
||||||
@retval EFI_ALREADY_STARTED The function was already registered. It can’t be registered again.
|
@retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
|
|
|
@ -208,19 +208,19 @@ typedef struct {
|
||||||
///
|
///
|
||||||
UINT32 Irt;
|
UINT32 Irt;
|
||||||
///
|
///
|
||||||
/// Maximum retransmission count for one packet. If Mrc is zero, there¡¯s no upper limit
|
/// Maximum retransmission count for one packet. If Mrc is zero, there's no upper limit
|
||||||
/// for retransmission count.
|
/// for retransmission count.
|
||||||
///
|
///
|
||||||
UINT32 Mrc;
|
UINT32 Mrc;
|
||||||
///
|
///
|
||||||
/// Maximum retransmission timeout for each retry. It¡¯s the upper bound of the number of
|
/// Maximum retransmission timeout for each retry. It's the upper bound of the number of
|
||||||
/// retransmission timeout. If Mrt is zero, there is no upper limit for retransmission
|
/// retransmission timeout. If Mrt is zero, there is no upper limit for retransmission
|
||||||
/// timeout.
|
/// timeout.
|
||||||
///
|
///
|
||||||
UINT32 Mrt;
|
UINT32 Mrt;
|
||||||
///
|
///
|
||||||
/// Maximum retransmission duration for one packet. It¡¯s the upper bound of the numbers
|
/// Maximum retransmission duration for one packet. It's the upper bound of the numbers
|
||||||
/// the client may retransmit a message. If Mrd is zero, there¡¯s no upper limit for
|
/// the client may retransmit a message. If Mrd is zero, there's no upper limit for
|
||||||
/// retransmission duration.
|
/// retransmission duration.
|
||||||
///
|
///
|
||||||
UINT32 Mrd;
|
UINT32 Mrd;
|
||||||
|
@ -478,7 +478,7 @@ EFI_STATUS
|
||||||
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.
|
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.
|
||||||
The DHCPv6 S.A.R.R process is started when
|
The DHCPv6 S.A.R.R process is started when
|
||||||
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
|
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
|
||||||
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn¡¯t been configured.
|
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured.
|
||||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||||
@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
|
@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
|
||||||
@retval EFI_ALREADY_STARTED The DHCPv6 S.A.R.R process has already started.
|
@retval EFI_ALREADY_STARTED The DHCPv6 S.A.R.R process has already started.
|
||||||
|
@ -580,7 +580,7 @@ EFI_STATUS
|
||||||
timer continues.
|
timer continues.
|
||||||
- When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound, it will
|
- When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound, it will
|
||||||
send Rebind packet. If valid Reply packet received, the state transfers to Dhcp6Bound and the
|
send Rebind packet. If valid Reply packet received, the state transfers to Dhcp6Bound and the
|
||||||
valid and preferred timer restarts. If fails, the state transfers to Dhcp6Init and the IA can¡¯t
|
valid and preferred timer restarts. If fails, the state transfers to Dhcp6Init and the IA can't
|
||||||
be used.
|
be used.
|
||||||
|
|
||||||
@param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
|
@param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
|
||||||
|
@ -592,7 +592,7 @@ EFI_STATUS
|
||||||
when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.
|
when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.
|
||||||
The EFI DHCPv6 Protocol instance has sent Renew or Rebind packet
|
The EFI DHCPv6 Protocol instance has sent Renew or Rebind packet
|
||||||
when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
|
when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
|
||||||
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn¡¯t been configured, or the state
|
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the state
|
||||||
of the configured IA is not in Dhcp6Bound.
|
of the configured IA is not in Dhcp6Bound.
|
||||||
@retval EFI_ALREADY_STARTED The state of the configured IA has already entered Dhcp6Renewing
|
@retval EFI_ALREADY_STARTED The state of the configured IA has already entered Dhcp6Renewing
|
||||||
when RebindRequest is FALSE.
|
when RebindRequest is FALSE.
|
||||||
|
@ -638,7 +638,7 @@ EFI_STATUS
|
||||||
- AddressCount is zero or Addresses is NULL.
|
- AddressCount is zero or Addresses is NULL.
|
||||||
@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA
|
@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA
|
||||||
for this instance.
|
for this instance.
|
||||||
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn¡¯t been configured, or the
|
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the
|
||||||
state of the configured IA is not in Dhcp6Bound.
|
state of the configured IA is not in Dhcp6Bound.
|
||||||
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
|
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
|
||||||
@retval EFI_ABORTED The DHCPv6 decline exchange process aborted by user.
|
@retval EFI_ABORTED The DHCPv6 decline exchange process aborted by user.
|
||||||
|
@ -676,7 +676,7 @@ EFI_STATUS
|
||||||
- AddressCount is not zero or Addresses is NULL.
|
- AddressCount is not zero or Addresses is NULL.
|
||||||
@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured
|
@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured
|
||||||
IA for this instance.
|
IA for this instance.
|
||||||
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn¡¯t been configured, or the
|
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the
|
||||||
state of the configured IA is not in Dhcp6Bound.
|
state of the configured IA is not in Dhcp6Bound.
|
||||||
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
|
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
|
||||||
@retval EFI_ABORTED The DHCPv6 release exchange process aborted by user.
|
@retval EFI_ABORTED The DHCPv6 release exchange process aborted by user.
|
||||||
|
@ -702,7 +702,7 @@ EFI_STATUS
|
||||||
@retval EFI_SUCCESS The DHCPv6 S.A.R.R process has been stopped when
|
@retval EFI_SUCCESS The DHCPv6 S.A.R.R process has been stopped when
|
||||||
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.
|
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.
|
||||||
The EFI DHCPv6 Protocol instance has sent Release packet if
|
The EFI DHCPv6 Protocol instance has sent Release packet if
|
||||||
need release or has been stopped if needn¡¯t, when
|
need release or has been stopped if needn't, when
|
||||||
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
|
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
|
||||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
/** @file
|
/** @file
|
||||||
UEFI Driver Family Protocol
|
UEFI Driver Family Protocol
|
||||||
|
|
||||||
Copyright (c) 2007 - 2008, Intel Corporation
|
Copyright (c) 2007 - 2009, Intel Corporation
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
@ -47,12 +47,12 @@ UINT32
|
||||||
);
|
);
|
||||||
|
|
||||||
///
|
///
|
||||||
/// When installed, the Driver Family Override Protocol produces a GUID that represets
|
/// When installed, the Driver Family Override Protocol produces a GUID that represents
|
||||||
/// a family of drivers. Drivers with the same GUID are members of the same family
|
/// a family of drivers. Drivers with the same GUID are members of the same family
|
||||||
/// When drivers are connected to controllers, drivers with a higher revision value
|
/// When drivers are connected to controllers, drivers with a higher revision value
|
||||||
/// in the same driver family are connected with a higher priority than drivers
|
/// in the same driver family are connected with a higher priority than drivers
|
||||||
/// with a lower revision value in the same driver family. The EFI Boot Service
|
/// with a lower revision value in the same driver family. The EFI Boot Service
|
||||||
/// Connect Controller uses five rules to build a prioritied list of drivers when
|
/// Connect Controller uses five rules to build a prioritized list of drivers when
|
||||||
/// a request is made to connect a driver to a controller. The Driver Family Protocol
|
/// a request is made to connect a driver to a controller. The Driver Family Protocol
|
||||||
/// rule is between the Platform Specific Driver Override Protocol and above the
|
/// rule is between the Platform Specific Driver Override Protocol and above the
|
||||||
/// Bus Specific Driver Override Protocol.
|
/// Bus Specific Driver Override Protocol.
|
||||||
|
|
|
@ -57,7 +57,7 @@ EFI_STATUS
|
||||||
@retval EFI_INVALID_PARAMETER The callback function was NULL.
|
@retval EFI_INVALID_PARAMETER The callback function was NULL.
|
||||||
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
|
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
|
||||||
registered.
|
registered.
|
||||||
@retval EFI_ALREADY_STARTED The function was already registered. It can’t be registered again.
|
@retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
|
@ -83,7 +83,7 @@
|
||||||
/// the formatted portion of the structure. This method of returning string information eliminates the need for
|
/// the formatted portion of the structure. This method of returning string information eliminates the need for
|
||||||
/// application software to deal with pointers embedded in the SMBIOS structure. Each string is terminated with a null
|
/// application software to deal with pointers embedded in the SMBIOS structure. Each string is terminated with a null
|
||||||
/// (00h) BYTE and the set of strings is terminated with an additional null (00h) BYTE. When the formatted portion of
|
/// (00h) BYTE and the set of strings is terminated with an additional null (00h) BYTE. When the formatted portion of
|
||||||
/// a SMBIOS structure references a string, it does so by specifying a non-zero string number within the structure’s
|
/// a SMBIOS structure references a string, it does so by specifying a non-zero string number within the structure's
|
||||||
/// string-set. For example, if a string field contains 02h, it references the second string following the formatted portion
|
/// string-set. For example, if a string field contains 02h, it references the second string following the formatted portion
|
||||||
/// of the SMBIOS structure. If a string field references no string, a null (0) is placed in that string field. If the
|
/// of the SMBIOS structure. If a string field references no string, a null (0) is placed in that string field. If the
|
||||||
/// formatted portion of the structure contains string-reference fields and all the string fields are set to 0 (no string
|
/// formatted portion of the structure contains string-reference fields and all the string fields are set to 0 (no string
|
||||||
|
@ -98,7 +98,7 @@ typedef UINT8 EFI_SMBIOS_STRING;
|
||||||
typedef UINT8 EFI_SMBIOS_TYPE;
|
typedef UINT8 EFI_SMBIOS_TYPE;
|
||||||
|
|
||||||
///
|
///
|
||||||
/// Specifies the structure’s handle, a unique 16-bit number in the range 0 to 0FFFEh (for version
|
/// Specifies the structure's handle, a unique 16-bit number in the range 0 to 0FFFEh (for version
|
||||||
/// 2.0) or 0 to 0FEFFh (for version 2.1 and later). The handle can be used with the Get SMBIOS
|
/// 2.0) or 0 to 0FEFFh (for version 2.1 and later). The handle can be used with the Get SMBIOS
|
||||||
/// Structure function to retrieve a specific structure; the handle numbers are not required to be
|
/// Structure function to retrieve a specific structure; the handle numbers are not required to be
|
||||||
/// contiguous. For v2.1 and later, handle values in the range 0FF00h to 0FFFFh are reserved for
|
/// contiguous. For v2.1 and later, handle values in the range 0FF00h to 0FFFFh are reserved for
|
||||||
|
|
|
@ -44,7 +44,7 @@ EFI_STATUS
|
||||||
@retval EFI_INVALID_PARAMETER The callback function was NULL.
|
@retval EFI_INVALID_PARAMETER The callback function was NULL.
|
||||||
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
|
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
|
||||||
registered.
|
registered.
|
||||||
@retval EFI_ALREADY_STARTED The function was already registered. It can’t be registered again.
|
@retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
|
@ -99,12 +99,12 @@ typedef struct {
|
||||||
///
|
///
|
||||||
UINT16 SourcePort;
|
UINT16 SourcePort;
|
||||||
///
|
///
|
||||||
/// Address to which this packet is sent. When sending packet, it¡¯ll be ignored
|
/// Address to which this packet is sent. When sending packet, it'll be ignored
|
||||||
/// if it is zero.
|
/// if it is zero.
|
||||||
///
|
///
|
||||||
EFI_IPv6_ADDRESS DestinationAddress;
|
EFI_IPv6_ADDRESS DestinationAddress;
|
||||||
///
|
///
|
||||||
/// Port to which this packet is sent. When sending packet, it¡¯ll be
|
/// Port to which this packet is sent. When sending packet, it'll be
|
||||||
/// ignored if it is zero.
|
/// ignored if it is zero.
|
||||||
///
|
///
|
||||||
UINT16 DestinationPort;
|
UINT16 DestinationPort;
|
||||||
|
@ -428,7 +428,7 @@ EFI_STATUS
|
||||||
fields is NULL.
|
fields is NULL.
|
||||||
- Token.Packet.TxData.UdpSessionData.DestinationAddress is not zero
|
- Token.Packet.TxData.UdpSessionData.DestinationAddress is not zero
|
||||||
and is not valid unicast Ipv6 address if UdpSessionData is not NULL.
|
and is not valid unicast Ipv6 address if UdpSessionData is not NULL.
|
||||||
- Token.Packet.TxData.UdpSessionData is NULL and this instance¡¯s
|
- Token.Packet.TxData.UdpSessionData is NULL and this instance's
|
||||||
UdpConfigData.RemoteAddress is unspecified.
|
UdpConfigData.RemoteAddress is unspecified.
|
||||||
- Token.Packet.TxData.UdpSessionData.DestinationAddress is non-zero
|
- Token.Packet.TxData.UdpSessionData.DestinationAddress is non-zero
|
||||||
when DestinationAddress is configured as non-zero when doing Configure()
|
when DestinationAddress is configured as non-zero when doing Configure()
|
||||||
|
|
Loading…
Reference in New Issue