mirror of https://github.com/acidanthera/audk.git
Add some comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9280 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
abbfadd791
commit
3a7afaf648
|
@ -44,6 +44,7 @@ typedef struct _EFI_IP6_PROTOCOL EFI_IP6_PROTOCOL;
|
||||||
|
|
||||||
///
|
///
|
||||||
/// EFI_IP6_ADDRESS_PAIR
|
/// EFI_IP6_ADDRESS_PAIR
|
||||||
|
/// which is not defined in the UEFI 2.3 Specification.
|
||||||
///
|
///
|
||||||
typedef struct{
|
typedef struct{
|
||||||
///
|
///
|
||||||
|
@ -62,6 +63,7 @@ typedef struct{
|
||||||
|
|
||||||
///
|
///
|
||||||
/// EFI_IP6_VARIABLE_DATA
|
/// EFI_IP6_VARIABLE_DATA
|
||||||
|
/// which is not defined in the UEFI 2.3 Specification.
|
||||||
///
|
///
|
||||||
typedef struct {
|
typedef struct {
|
||||||
///
|
///
|
||||||
|
|
|
@ -323,6 +323,7 @@ EFI_STATUS
|
||||||
the caller.
|
the caller.
|
||||||
|
|
||||||
@retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in the Packet.
|
@retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in the Packet.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
||||||
- This is NULL.
|
- This is NULL.
|
||||||
- Filename is NULL.
|
- Filename is NULL.
|
||||||
|
@ -340,11 +341,17 @@ EFI_STATUS
|
||||||
@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_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in the Packet.
|
@retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in the Packet.
|
||||||
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and is in the Buffer.
|
@retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and is in the Buffer.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is in the Packet.
|
@retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is in the Packet.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
|
@retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
|
||||||
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
|
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
|
||||||
|
|
||||||
|
@ -406,12 +413,18 @@ EFI_STATUS
|
||||||
@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_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
|
@retval EFI_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
|
||||||
downloaded data in downloading process.
|
downloaded data in downloading process.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_ABORTED Current operation is aborted by user.
|
@retval EFI_ABORTED Current operation is aborted by user.
|
||||||
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
|
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
|
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
|
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
|
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received.
|
@retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
|
@retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
|
||||||
@retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.
|
@retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.
|
||||||
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
|
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
|
||||||
|
|
|
@ -503,15 +503,19 @@ EFI_STATUS
|
||||||
- MtftpConfigData.StationIp is neither zero nor one
|
- MtftpConfigData.StationIp is neither zero nor one
|
||||||
of the configured IP addresses in the underlying IPv6 driver.
|
of the configured IP addresses in the underlying IPv6 driver.
|
||||||
- MtftpCofigData.ServerIp is not a valid IPv6 unicast address.
|
- MtftpCofigData.ServerIp is not a valid IPv6 unicast address.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_ACCESS_DENIED - The configuration could not be changed at this time because there
|
@retval EFI_ACCESS_DENIED - The configuration could not be changed at this time because there
|
||||||
is some MTFTP background operation in progress.
|
is some MTFTP background operation in progress.
|
||||||
- MtftpCofigData.LocalPort is already in use.
|
- MtftpCofigData.LocalPort is already in use.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
|
@retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
|
||||||
address for this instance, but no source address was available for use.
|
address for this instance, but no source address was available for use.
|
||||||
@retval EFI_OUT_OF_RESOURCES The EFI MTFTPv6 Protocol driver instance data could not be
|
@retval EFI_OUT_OF_RESOURCES The EFI MTFTPv6 Protocol driver instance data could not be
|
||||||
allocated.
|
allocated.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI
|
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI
|
||||||
MTFTPv6 Protocol driver instance is not configured.
|
MTFTPv6 Protocol driver instance is not configured.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
|
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
@ -544,6 +548,7 @@ EFI_STATUS
|
||||||
the caller.
|
the caller.
|
||||||
|
|
||||||
@retval EFI_SUCCESS An MTFTPv6 OACK packet was received and is in the Packet.
|
@retval EFI_SUCCESS An MTFTPv6 OACK packet was received and is in the Packet.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
||||||
- This is NULL.
|
- This is NULL.
|
||||||
- Filename is NULL
|
- Filename is NULL
|
||||||
|
@ -560,10 +565,14 @@ EFI_STATUS
|
||||||
@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_TFTP_ERROR An MTFTPv6 ERROR packet was received and is in the Packet.
|
@retval EFI_TFTP_ERROR An MTFTPv6 ERROR packet was received and is in the Packet.
|
||||||
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
|
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
|
||||||
@retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and the Packet is set to NULL.
|
@retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and the Packet is set to NULL.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_PROTOCOL_ERROR An unexpected MTFTPv6 packet was received and is in the Packet.
|
@retval EFI_PROTOCOL_ERROR An unexpected MTFTPv6 packet was received and is in the Packet.
|
||||||
@retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.
|
@retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.
|
||||||
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
|
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
|
||||||
|
@ -645,11 +654,16 @@ EFI_STATUS
|
||||||
@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_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
|
@retval EFI_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
|
||||||
downloaded data in downloading process.
|
downloaded data in downloading process.
|
||||||
|
Note: It does not match UEFI 2.3 Specification.
|
||||||
@retval EFI_ABORTED Current operation is aborted by user.
|
@retval EFI_ABORTED Current operation is aborted by user.
|
||||||
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
|
@retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
|
@retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
|
@retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
|
@retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
@retval EFI_ICMP_ERROR An ICMP ERROR packet was received.
|
@retval EFI_ICMP_ERROR An ICMP ERROR packet was received.
|
||||||
@retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.
|
@retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.
|
||||||
@retval EFI_TFTP_ERROR An MTFTPv6 ERROR packet was received.
|
@retval EFI_TFTP_ERROR An MTFTPv6 ERROR packet was received.
|
||||||
|
|
|
@ -128,6 +128,7 @@ typedef struct {
|
||||||
/// either by instance itself or the communication peer.
|
/// either by instance itself or the communication peer.
|
||||||
/// EFI_CONNECTION_REFUSED: The connect fails because this connection is initiated with
|
/// EFI_CONNECTION_REFUSED: The connect fails because this connection is initiated with
|
||||||
/// an active open and the connection is refused.
|
/// an active open and the connection is refused.
|
||||||
|
/// Note: It is not defined in UEFI 2.3 Specification.
|
||||||
/// EFI_ABORTED: The active open is aborted.
|
/// EFI_ABORTED: The active open is aborted.
|
||||||
/// EFI_TIMEOUT: The connection establishment timer expires and
|
/// EFI_TIMEOUT: The connection establishment timer expires and
|
||||||
/// no more specific information is available.
|
/// no more specific information is available.
|
||||||
|
@ -180,6 +181,7 @@ typedef struct {
|
||||||
/// EFI_CONNECTION_FIN: The receiving operation fails because the communication peer
|
/// EFI_CONNECTION_FIN: The receiving operation fails because the communication peer
|
||||||
/// has closed the connection and there is no more data in the
|
/// has closed the connection and there is no more data in the
|
||||||
/// receive buffer of the instance.
|
/// receive buffer of the instance.
|
||||||
|
/// Note: It is not defined in UEFI 2.3 Specification.
|
||||||
/// EFI_CONNECTION_RESET: The receiving or transmission operation fails
|
/// EFI_CONNECTION_RESET: The receiving or transmission operation fails
|
||||||
/// because this connection is reset either by instance
|
/// because this connection is reset either by instance
|
||||||
/// itself or the communication peer.
|
/// itself or the communication peer.
|
||||||
|
@ -513,6 +515,7 @@ EFI_STATUS
|
||||||
transmission or receive queue. It has either
|
transmission or receive queue. It has either
|
||||||
completed or wasn't issued by Transmit() and Receive().
|
completed or wasn't issued by Transmit() and Receive().
|
||||||
@retval EFI_UNSUPPORTED The implementation does not support this function.
|
@retval EFI_UNSUPPORTED The implementation does not support this function.
|
||||||
|
Note: It is not defined in UEFI 2.3 Specification.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
|
|
|
@ -291,6 +291,7 @@ typedef struct {
|
||||||
/// either by instance itself or the communication peer.
|
/// either by instance itself or the communication peer.
|
||||||
/// EFI_CONNECTION_REFUSED: The receiving or transmission operation fails because this
|
/// EFI_CONNECTION_REFUSED: The receiving or transmission operation fails because this
|
||||||
/// connection is refused.
|
/// connection is refused.
|
||||||
|
/// Note: It is not defined in UEFI 2.3 Specification.
|
||||||
/// EFI_ABORTED: The active open is aborted.
|
/// EFI_ABORTED: The active open is aborted.
|
||||||
/// EFI_TIMEOUT: The connection establishment timer expires and
|
/// EFI_TIMEOUT: The connection establishment timer expires and
|
||||||
/// no more specific information is available.
|
/// no more specific information is available.
|
||||||
|
@ -414,6 +415,7 @@ typedef struct {
|
||||||
/// EFI_CONNECTION_FIN: The receiving operation fails because the communication peer
|
/// EFI_CONNECTION_FIN: The receiving operation fails because the communication peer
|
||||||
/// has closed the connection and there is no more data in the
|
/// has closed the connection and there is no more data in the
|
||||||
/// receive buffer of the instance.
|
/// receive buffer of the instance.
|
||||||
|
/// Note: It is not defined in UEFI 2.3 Specification.
|
||||||
/// EFI_CONNECTION_RESET: The receiving or transmission operation fails
|
/// EFI_CONNECTION_RESET: The receiving or transmission operation fails
|
||||||
/// because this connection is reset either by instance
|
/// because this connection is reset either by instance
|
||||||
/// itself or the communication peer.
|
/// itself or the communication peer.
|
||||||
|
|
Loading…
Reference in New Issue