MdeModulePkg/Include/Library/VarCheckLib.h File Reference


Enumerations

enum  VAR_CHECK_REQUEST_SOURCE { VarCheckRequestReserved0 = 0, VarCheckRequestReserved1 = 1, VarCheckFromTrusted = 2, VarCheckFromUntrusted = 3 }

Functions

typedef VOID (EFIAPI *VAR_CHECK_END_OF_DXE_CALLBACK)(VOID)
EFI_STATUS EFIAPI VarCheckLibRegisterEndOfDxeCallback (IN VAR_CHECK_END_OF_DXE_CALLBACK Callback)
VOID ***EFIAPI VarCheckLibInitializeAtEndOfDxe (IN OUT UINTN *AddressPointerCount)
EFI_STATUS EFIAPI VarCheckLibRegisterAddressPointer (IN VOID **AddressPointer)
EFI_STATUS EFIAPI VarCheckLibRegisterSetVariableCheckHandler (IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler)
EFI_STATUS EFIAPI VarCheckLibVariablePropertySet (IN CHAR16 *Name, IN EFI_GUID *Guid, IN VAR_CHECK_VARIABLE_PROPERTY *VariableProperty)
EFI_STATUS EFIAPI VarCheckLibVariablePropertyGet (IN CHAR16 *Name, IN EFI_GUID *Guid, OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty)
EFI_STATUS EFIAPI VarCheckLibSetVariableCheck (IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data, IN VAR_CHECK_REQUEST_SOURCE RequestSource)

Detailed Description

Provides variable check services and database management.

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


Enumeration Type Documentation

Enumerator:
VarCheckRequestReserved0 
VarCheckRequestReserved1 
VarCheckFromTrusted 
VarCheckFromUntrusted 


Function Documentation

VOID*** EFIAPI VarCheckLibInitializeAtEndOfDxe ( IN OUT UINTN *  AddressPointerCount  ) 

Var check initialize at END_OF_DXE.

This function needs to be called at END_OF_DXE. Address pointers may be returned, and caller needs to ConvertPointer() for the pointers.

Parameters:
[in,out] AddressPointerCount Output pointer to address pointer count.
Returns:
Address pointer buffer, NULL if input AddressPointerCount is NULL.

EFI_STATUS EFIAPI VarCheckLibRegisterAddressPointer ( IN VOID **  AddressPointer  ) 

Register address pointer. The AddressPointer may be returned by VarCheckLibInitializeAtEndOfDxe().

Parameters:
[in] AddressPointer Address pointer.
Return values:
EFI_SUCCESS The address pointer was registered successfully.
EFI_INVALID_PARAMETER AddressPointer is NULL.
EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.
EFI_OUT_OF_RESOURCES There is not enough resource for the address pointer register request.

EFI_STATUS EFIAPI VarCheckLibRegisterEndOfDxeCallback ( IN VAR_CHECK_END_OF_DXE_CALLBACK  Callback  ) 

Register END_OF_DXE callback. The callback will be invoked by VarCheckLibInitializeAtEndOfDxe().

Parameters:
[in] Callback END_OF_DXE callback.
Return values:
EFI_SUCCESS The callback was registered successfully.
EFI_INVALID_PARAMETER Callback is NULL.
EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.
EFI_OUT_OF_RESOURCES There is not enough resource for the callback register request.

EFI_STATUS EFIAPI VarCheckLibRegisterSetVariableCheckHandler ( IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER  Handler  ) 

Register SetVariable check handler.

Parameters:
[in] Handler Pointer to check handler.
Return values:
EFI_SUCCESS The SetVariable check handler was registered successfully.
EFI_INVALID_PARAMETER Handler is NULL.
EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.
EFI_OUT_OF_RESOURCES There is not enough resource for the SetVariable check handler register request.
EFI_UNSUPPORTED This interface is not implemented. For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.

EFI_STATUS EFIAPI VarCheckLibSetVariableCheck ( IN CHAR16 *  VariableName,
IN EFI_GUID *  VendorGuid,
IN UINT32  Attributes,
IN UINTN  DataSize,
IN VOID *  Data,
IN VAR_CHECK_REQUEST_SOURCE  RequestSource 
)

SetVariable check.

Parameters:
[in] VariableName Name of Variable to set.
[in] VendorGuid Variable vendor GUID.
[in] Attributes Attribute value of the variable.
[in] DataSize Size of Data to set.
[in] Data Data pointer.
[in] RequestSource Request source.
Return values:
EFI_SUCCESS The SetVariable check result was success.
EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, GUID, DataSize and Data value was supplied.
EFI_WRITE_PROTECTED The variable in question is read-only.
Others The other return status from check handler.

EFI_STATUS EFIAPI VarCheckLibVariablePropertyGet ( IN CHAR16 *  Name,
IN EFI_GUID *  Guid,
OUT VAR_CHECK_VARIABLE_PROPERTY VariableProperty 
)

Variable property get.

Parameters:
[in] Name Pointer to the variable name.
[in] Guid Pointer to the vendor GUID.
[out] VariableProperty Pointer to the output variable property.
Return values:
EFI_SUCCESS The property of variable specified by the Name and Guid was got successfully.
EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.
EFI_NOT_FOUND The property of variable specified by the Name and Guid was not found.

EFI_STATUS EFIAPI VarCheckLibVariablePropertySet ( IN CHAR16 *  Name,
IN EFI_GUID *  Guid,
IN VAR_CHECK_VARIABLE_PROPERTY VariableProperty 
)

Variable property set.

Parameters:
[in] Name Pointer to the variable name.
[in] Guid Pointer to the vendor GUID.
[in] VariableProperty Pointer to the input variable property.
Return values:
EFI_SUCCESS The property of variable specified by the Name and Guid was set successfully.
EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string, or the fields of VariableProperty are not valid.
EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.
EFI_OUT_OF_RESOURCES There is not enough resource for the variable property set request.

typedef VOID ( EFIAPI *  EBC_DEBUGGER_DEBUG  ) 

The prototype is called back when an IP packet is received.

Parameters:
[in] Status The result of the receive request.
[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.
[in] NetSession The IP session for the received packet.
[in] Pkt The packet received.
[in] Context The data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
The prototype is called back when an IP packet is sent.

Parameters:
[in] Status Result of the IP packet being sent.
[in] Context The data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext.
[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
[in] NotifyData The Context data specified when calling IpIoSend()
The function boots a legacy boot option.

Register Exit handler function. When more than one handler function is registered, the latter one will override the previous one. When NULL handler is specified, the previous Exit handler will be unregistered.

Parameters:
[in] Handler Pointer to handler function.
Prototype called when receiving or sending packets to or from a UDP point.

This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.

Parameters:
[in] Packet The packet received or sent.
[in] EndPoint The UDP address pair corresponds to the UDP IO.
[in] IoStatus The packet receiving or sending status.
[in] Context The user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram().
Given a pointer to a new VM context, debug one or more instructions.

Parameters:
[in] This A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in] VmPtr A pointer to a VM context.
Return values:
EFI_UNSUPPORTED No support for it.
EFI_SUCCESS Debug one or more instructions.


Generated on Thu Sep 24 23:30:15 2015 for MdeModulePkg[ALL] by  doxygen 1.5.7.1