MdePkg/Include/Protocol/AdapterInformation.h File Reference


Data Structures

struct  EFI_ADAPTER_INFO_MEDIA_STATE
struct  EFI_ADAPTER_INFO_NETWORK_BOOT
struct  EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
struct  EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT
struct  _EFI_ADAPTER_INFORMATION_PROTOCOL

Defines

#define EFI_ADAPTER_INFORMATION_PROTOCOL_GUID
#define EFI_ADAPTER_INFO_MEDIA_STATE_GUID
#define EFI_ADAPTER_INFO_NETWORK_BOOT_GUID
#define EFI_ADAPTER_INFO_SAN_MAC_ADDRESS_GUID
#define EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT_GUID

Typedefs

typedef struct
_EFI_ADAPTER_INFORMATION_PROTOCOL 
EFI_ADAPTER_INFORMATION_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_ADAPTER_INFO_GET_INFO )(IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, IN EFI_GUID *InformationType, OUT VOID **InformationBlock, OUT UINTN *InformationBlockSize)
typedef EFI_STATUS(EFIAPI * EFI_ADAPTER_INFO_SET_INFO )(IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, IN EFI_GUID *InformationType, IN VOID *InformationBlock, IN UINTN InformationBlockSize)
typedef EFI_STATUS(EFIAPI * EFI_ADAPTER_INFO_GET_SUPPORTED_TYPES )(IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, OUT EFI_GUID **InfoTypesBuffer, OUT UINTN *InfoTypesBufferCount)

Variables

EFI_GUID gEfiAdapterInformationProtocolGuid
EFI_GUID gEfiAdapterInfoMediaStateGuid
EFI_GUID gEfiAdapterInfoNetworkBootGuid
EFI_GUID gEfiAdapterInfoSanMacAddressGuid
EFI_GUID gEfiAdapterInfoUndiIpv6SupportGuid

Detailed Description

EFI Adapter Information Protocol definition. The EFI Adapter Information Protocol is used to dynamically and quickly discover or set device information for an adapter.

Copyright (c) 2014 - 2015, 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 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.

Revision Reference:
This Protocol is introduced in UEFI Specification 2.4

Define Documentation

#define EFI_ADAPTER_INFO_MEDIA_STATE_GUID

Value:

{ \
    0xD7C74207, 0xA831, 0x4A26, {0xB1, 0xF5, 0xD1, 0x93, 0x06, 0x5C, 0xE8, 0xB6 } \
  }

#define EFI_ADAPTER_INFO_NETWORK_BOOT_GUID

Value:

{ \
    0x1FBD2960, 0x4130, 0x41E5, {0x94, 0xAC, 0xD2, 0xCF, 0x03, 0x7F, 0xB3, 0x7C } \
  }

#define EFI_ADAPTER_INFO_SAN_MAC_ADDRESS_GUID

Value:

{ \
    0x114da5ef, 0x2cf1, 0x4e12, {0x9b, 0xbb, 0xc4, 0x70, 0xb5, 0x52, 0x5, 0xd9 } \
  }

#define EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT_GUID

Value:

{ \
    0x4bd56be3, 0x4975, 0x4d8a, {0xa0, 0xad, 0xc4, 0x91, 0x20, 0x4b, 0x5d, 0x4d} \
  }

#define EFI_ADAPTER_INFORMATION_PROTOCOL_GUID

Value:

{ \
    0xE5DD1403, 0xD622, 0xC24E, {0x84, 0x88, 0xC7, 0x1B, 0x17, 0xF5, 0xE8, 0x02 } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_ADAPTER_INFO_GET_INFO)(IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, IN EFI_GUID *InformationType, OUT VOID **InformationBlock, OUT UINTN *InformationBlockSize)

Returns the current state information for the adapter.

This function returns information of type InformationType from the adapter. If an adapter does not support the requested informational type, then EFI_UNSUPPORTED is returned.

Parameters:
[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock.
[out] InforamtionBlock The service returns a pointer to the buffer with the InformationBlock structure which contains details about the data specific to InformationType.
[out] InforamtionBlockSize The driver returns the size of the InformationBlock in bytes.
Return values:
EFI_SUCCESS The InformationType information was retrieved.
EFI_UNSUPPORTED The InformationType is not known.
EFI_DEVICE_ERROR The device reported an error.
EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
EFI_INVALID_PARAMETER This is NULL.
EFI_INVALID_PARAMETER InformationBlock is NULL.
EFI_INVALID_PARAMETER InformationBlockSize is NULL.

typedef EFI_STATUS(EFIAPI * EFI_ADAPTER_INFO_GET_SUPPORTED_TYPES)(IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, OUT EFI_GUID **InfoTypesBuffer, OUT UINTN *InfoTypesBufferCount)

Get a list of supported information types for this instance of the protocol.

This function returns a list of InformationType GUIDs that are supported on an adapter with this instance of EFI_ADAPTER_INFORMATION_PROTOCOL. The list is returned in InfoTypesBuffer, and the number of GUID pointers in InfoTypesBuffer is returned in InfoTypesBufferCount.

Parameters:
[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
[out] InfoTypesBuffer A pointer to the array of InformationType GUIDs that are supported by This.
[out] InfoTypesBufferCount A pointer to the number of GUIDs present in InfoTypesBuffer.
Return values:
EFI_SUCCESS The list of information type GUIDs that are supported on this adapter was returned in InfoTypesBuffer. The number of information type GUIDs was returned in InfoTypesBufferCount.
EFI_INVALID_PARAMETER This is NULL.
EFI_INVALID_PARAMETER InfoTypesBuffer is NULL.
EFI_INVALID_PARAMETER InfoTypesBufferCount is NULL.
EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.

typedef EFI_STATUS(EFIAPI * EFI_ADAPTER_INFO_SET_INFO)(IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, IN EFI_GUID *InformationType, IN VOID *InformationBlock, IN UINTN InformationBlockSize)

Sets state information for an adapter.

This function sends information of type InformationType for an adapter. If an adapter does not support the requested information type, then EFI_UNSUPPORTED is returned.

Parameters:
[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock.
[in] InforamtionBlock A pointer to the InformationBlock structure which contains details about the data specific to InformationType.
[in] InforamtionBlockSize The size of the InformationBlock in bytes.
Return values:
EFI_SUCCESS The information was received and interpreted successfully.
EFI_UNSUPPORTED The InformationType is not known.
EFI_DEVICE_ERROR The device reported an error.
EFI_INVALID_PARAMETER This is NULL.
EFI_INVALID_PARAMETER InformationBlock is NULL.
EFI_WRITE_PROTECTED The InformationType cannot be modified using EFI_ADAPTER_INFO_SET_INFO().


Variable Documentation


Generated on Wed Sep 23 16:24:22 2015 for MdePkg[ALL] by  doxygen 1.5.7.1