diff options
Diffstat (limited to 'MdePkg/Include/Protocol/SimpleNetwork.h')
-rw-r--r-- | MdePkg/Include/Protocol/SimpleNetwork.h | 46 |
1 files changed, 20 insertions, 26 deletions
diff --git a/MdePkg/Include/Protocol/SimpleNetwork.h b/MdePkg/Include/Protocol/SimpleNetwork.h index 0dda83aaafd9..a367fa2e3111 100644 --- a/MdePkg/Include/Protocol/SimpleNetwork.h +++ b/MdePkg/Include/Protocol/SimpleNetwork.h @@ -1,5 +1,5 @@ /** @file - The EFI_SIMPLE_NETWORK_PROTOCOL provides services to initialize a network interface, + The EFI_SIMPLE_NETWORK_PROTOCOL provides services to initialize a network interface, transmit packets, receive packets, and close a network interface. Basic network device abstraction. @@ -9,17 +9,11 @@ MCast - MultiCast ... -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR> -This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. -The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent - @par Revision Reference: - This Protocol is introduced in EFI Specification 1.10. + @par Revision Reference: + This Protocol is introduced in EFI Specification 1.10. **/ @@ -36,7 +30,7 @@ typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK_PROTOCOL; /// /// Protocol defined in EFI1.1. -/// +/// typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK; /// @@ -288,8 +282,8 @@ EFI_STATUS ); /** - Resets a network adapter and allocates the transmit and receive buffers - required by the network interface; optionally, also requests allocation + Resets a network adapter and allocates the transmit and receive buffers + required by the network interface; optionally, also requests allocation of additional transmit and receive buffers. @param This The protocol instance pointer. @@ -322,8 +316,8 @@ EFI_STATUS ); /** - Resets a network adapter and re-initializes it with the parameters that were - provided in the previous call to Initialize(). + Resets a network adapter and re-initializes it with the parameters that were + provided in the previous call to Initialize(). @param This The protocol instance pointer. @param ExtendedVerification Indicates that the driver may perform a more @@ -345,7 +339,7 @@ EFI_STATUS ); /** - Resets a network adapter and leaves it in a state that is safe for + Resets a network adapter and leaves it in a state that is safe for another driver to initialize. @param This Protocol instance pointer. @@ -482,7 +476,7 @@ EFI_STATUS ); /** - Performs read and write operations on the NVRAM device attached to a + Performs read and write operations on the NVRAM device attached to a network interface. @param This The protocol instance pointer. @@ -512,7 +506,7 @@ EFI_STATUS ); /** - Reads the current interrupt status and recycled transmit buffer status from + Reads the current interrupt status and recycled transmit buffer status from a network interface. @param This The protocol instance pointer. @@ -570,7 +564,7 @@ EFI_STATUS @retval EFI_SUCCESS The packet was placed on the transmit queue. @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_NOT_READY The network interface is too busy to accept this transmit request. + @retval EFI_NOT_READY The network interface is too busy to accept this transmit request. @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small. @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value. @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. @@ -637,19 +631,19 @@ EFI_STATUS // // Revision defined in EFI1.1 -// +// #define EFI_SIMPLE_NETWORK_INTERFACE_REVISION EFI_SIMPLE_NETWORK_PROTOCOL_REVISION /// -/// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access -/// to a network adapter. Once the network adapter initializes, -/// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that +/// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access +/// to a network adapter. Once the network adapter initializes, +/// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that /// allow packets to be transmitted and received. /// struct _EFI_SIMPLE_NETWORK_PROTOCOL { /// - /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must - /// be backwards compatible. If a future version is not backwards compatible + /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must + /// be backwards compatible. If a future version is not backwards compatible /// it is not the same GUID. /// UINT64 Revision; |