HstiAip.c File Reference

#include "HstiDxe.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	HstiAipGetInfo (IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, IN EFI_GUID *InformationType, OUT VOID **InformationBlock, OUT UINTN *InformationBlockSize)
EFI_STATUS EFIAPI	HstiAipSetInfo (IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, IN EFI_GUID *InformationType, IN VOID *InformationBlock, IN UINTN InformationBlockSize)
EFI_STATUS EFIAPI	HstiAipGetSupportedTypes (IN EFI_ADAPTER_INFORMATION_PROTOCOL *This, OUT EFI_GUID **InfoTypesBuffer, OUT UINTN *InfoTypesBufferCount)

Variables
EFI_ADAPTER_INFORMATION_PROTOCOL	mAdapterInformationProtocol

Detailed Description

Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HstiAip.c.

Function Documentation

HstiAipGetInfo()

EFI_STATUS EFIAPI HstiAipGetInfo	(	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. If an adapter does not contain Information for the requested InformationType, it fills InformationBlockSize with 0 and returns EFI_NOT_FOUND.

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]	InformationBlock	The service returns a pointer to the buffer with the InformationBlock structure which contains details about the data specific to InformationType.
[out]	InformationBlockSize	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_NOT_FOUND	Information is not available for the requested information type.
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.

Definition at line 37 of file HstiAip.c.

HstiAipGetSupportedTypes()

EFI_STATUS EFIAPI HstiAipGetSupportedTypes	(	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.

Definition at line 153 of file HstiAip.c.

HstiAipSetInfo()

EFI_STATUS EFIAPI HstiAipSetInfo	(	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]	InformationBlock	A pointer to the InformationBlock structure which contains details about the data specific to InformationType.
[in]	InformationBlockSize	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().

Definition at line 88 of file HstiAip.c.

Variable Documentation

mAdapterInformationProtocol

EFI_ADAPTER_INFORMATION_PROTOCOL mAdapterInformationProtocol

Initial value:

= {
  HstiAipGetInfo,
  HstiAipSetInfo,
  HstiAipGetSupportedTypes,
}

Definition at line 173 of file HstiAip.c.