|
iPXE
|
EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. More...
#include <ipxe/efi/Protocol/SimpleNetwork.h>Go to the source code of this file.
Data Structures | |
| struct | EFI_MANAGED_NETWORK_CONFIG_DATA |
| struct | EFI_MANAGED_NETWORK_RECEIVE_DATA |
| struct | EFI_MANAGED_NETWORK_FRAGMENT_DATA |
| struct | EFI_MANAGED_NETWORK_TRANSMIT_DATA |
| struct | EFI_MANAGED_NETWORK_COMPLETION_TOKEN |
| struct | _EFI_MANAGED_NETWORK_PROTOCOL |
| The MNP is used by network applications (and drivers) to perform raw (unformatted) asynchronous network packet I/O. More... | |
Macros | |
| #define | EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL_GUID |
| #define | EFI_MANAGED_NETWORK_PROTOCOL_GUID |
Functions | |
| FILE_LICENCE (BSD2_PATENT) | |
Variables | |
| EFI_GUID | gEfiManagedNetworkServiceBindingProtocolGuid |
| EFI_GUID | gEfiManagedNetworkProtocolGuid |
EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.
EFI_MANAGED_NETWORK_PROTOCOL as defined in UEFI 2.0.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file ManagedNetwork.h.
| #define EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL_GUID |
Definition at line 20 of file ManagedNetwork.h.
| #define EFI_MANAGED_NETWORK_PROTOCOL_GUID |
Definition at line 25 of file ManagedNetwork.h.
| typedef struct _EFI_MANAGED_NETWORK_PROTOCOL EFI_MANAGED_NETWORK_PROTOCOL |
Definition at line 30 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_GET_MODE_DATA) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL) |
Returns the operational parameters for the current MNP child driver.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| MnpConfigData | The pointer to storage for MNP operational parameters. |
| SnpModeData | The pointer to storage for SNP operational parameters. |
| EFI_SUCCESS | The operation completed successfully. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_UNSUPPORTED | The requested feature is unsupported in this MNP implementation. |
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. The default values are returned in MnpConfigData if it is not NULL. |
| Other | The mode data could not be read. |
Definition at line 162 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_CONFIGURE) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, IN EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL) |
Sets or clears the operational parameters for the MNP child driver.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| MnpConfigData | The pointer to configuration data that will be assigned to the MNP child driver instance. If NULL, the MNP child driver instance is reset to startup defaults and all pending transmit and receive requests are flushed. |
| EFI_SUCCESS | The operation completed successfully. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_OUT_OF_RESOURCES | Required system resources (usually memory) could not be allocated. |
| EFI_UNSUPPORTED | The requested feature is unsupported in this [MNP] implementation. |
| EFI_DEVICE_ERROR | An unexpected network or system error occurred. |
| Other | The MNP child driver instance has been reset to startup defaults. |
Definition at line 189 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_MCAST_IP_TO_MAC) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, IN BOOLEAN Ipv6Flag, IN EFI_IP_ADDRESS *IpAddress, OUT EFI_MAC_ADDRESS *MacAddress) |
Translates an IP multicast address to a hardware (MAC) multicast address.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| Ipv6Flag | Set to TRUE to if IpAddress is an IPv6 multicast address. Set to FALSE if IpAddress is an IPv4 multicast address. |
| IpAddress | The pointer to the multicast IP address (in network byte order) to convert. |
| MacAddress | The pointer to the resulting multicast MAC address. |
| EFI_SUCCESS | The operation completed successfully. |
| EFI_INVALID_PARAMETER | One of the following conditions is TRUE:
|
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. |
| EFI_UNSUPPORTED | The requested feature is unsupported in this MNP implementation. |
| EFI_DEVICE_ERROR | An unexpected network or system error occurred. |
| Other | The address could not be converted. |
Definition at line 217 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_GROUPS) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, IN BOOLEAN JoinFlag, IN EFI_MAC_ADDRESS *MacAddress OPTIONAL) |
Enables and disables receive filters for multicast address.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| JoinFlag | Set to TRUE to join this multicast group. Set to FALSE to leave this multicast group. |
| MacAddress | The pointer to the multicast MAC group (address) to join or leave. |
| EFI_SUCCESS | The requested operation completed successfully. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
|
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. |
| EFI_ALREADY_STARTED | The supplied multicast group is already joined. |
| EFI_NOT_FOUND | The supplied multicast group is not joined. |
| EFI_DEVICE_ERROR | An unexpected network or system error occurred. |
| EFI_UNSUPPORTED | The requested feature is unsupported in this MNP implementation. |
| Other | The requested operation could not be completed. |
Definition at line 247 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_TRANSMIT) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token) |
Places asynchronous outgoing data packets into the transmit queue.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| Token | The pointer to a token associated with the transmit data descriptor. |
| EFI_SUCCESS | The transmit completion token was cached. |
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_ACCESS_DENIED | The transmit completion token is already in the transmit queue. |
| EFI_OUT_OF_RESOURCES | The transmit data could not be queued due to a lack of system resources (usually memory). |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| EFI_NOT_READY | The transmit request could not be queued because the transmit queue is full. |
Definition at line 271 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_RECEIVE) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token) |
Places an asynchronous receiving request into the receiving queue.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| Token | The pointer to a token associated with the receive data descriptor. |
| EFI_SUCCESS | The receive completion token was cached. |
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. |
| EFI_INVALID_PARAMETER | One or more of the following conditions is TRUE:
|
| EFI_OUT_OF_RESOURCES | The transmit data could not be queued due to a lack of system resources (usually memory). |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| EFI_ACCESS_DENIED | The receive completion token was already in the receive queue. |
| EFI_NOT_READY | The receive request could not be queued because the receive queue is full. |
Definition at line 297 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_CANCEL) (IN EFI_MANAGED_NETWORK_PROTOCOL *This, IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token OPTIONAL) |
Aborts an asynchronous transmit or receive request.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| Token | The pointer to a token that has been issued by EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending tokens are aborted. |
| EFI_SUCCESS | The asynchronous I/O request was aborted and Token.Event was signaled. When Token is NULL, all pending requests were aborted and their events were signaled. |
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_NOT_FOUND | When Token is not NULL, the asynchronous I/O request was not found in the transmit or receive queue. It has either completed or was not issued by Transmit() and Receive(). |
Definition at line 323 of file ManagedNetwork.h.
| typedef EFI_STATUS(EFIAPI * EFI_MANAGED_NETWORK_POLL) (IN EFI_MANAGED_NETWORK_PROTOCOL *This) |
Polls for incoming data packets and processes outgoing data packets.
| This | The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. |
| EFI_SUCCESS | Incoming or outgoing data was processed. |
| EFI_NOT_STARTED | This MNP child driver instance has not been configured. |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| EFI_NOT_READY | No incoming or outgoing data was processed. Consider increasing the polling rate. |
| EFI_TIMEOUT | Data was dropped out of the transmit and/or receive queue. Consider increasing the polling rate. |
Definition at line 344 of file ManagedNetwork.h.
| FILE_LICENCE | ( | BSD2_PATENT | ) |
| EFI_GUID gEfiManagedNetworkServiceBindingProtocolGuid |
| EFI_GUID gEfiManagedNetworkProtocolGuid |
1.8.15