MdeModulePkg/Include/Guid/DebugMask.h File Reference


Data Structures

struct  _EFI_DEBUG_MASK_PROTOCOL

Defines

#define EFI_DEBUG_MASK_PROTOCOL_GUID   { 0x4c8a2451, 0xc207, 0x405b, {0x96, 0x94, 0x99, 0xea, 0x13, 0x25, 0x13, 0x41} }
#define EFI_DEBUG_MASK_REVISION   0x00010000
#define EFI_GENERIC_VARIABLE_GUID   { 0x59d1c24f, 0x50f1, 0x401a, {0xb1, 0x01, 0xf3, 0x3e, 0x0d, 0xae, 0xd4, 0x43} }
#define DEBUG_MASK_VARIABLE_NAME   L"EFIDebug"

Typedefs

typedef struct
_EFI_DEBUG_MASK_PROTOCOL 
EFI_DEBUG_MASK_PROTOCOL
typedef IN OUT UINTN * CurrentDebugMask
typedef IN UINTN NewDebugMask

Functions

typedef EFI_STATUS (EFIAPI *EFI_GET_DEBUG_MASK)(IN EFI_DEBUG_MASK_PROTOCOL *This

Variables

EFI_GUID gEfiDebugMaskProtocolGuid
EFI_GUID gEfiGenericVariableGuid

Detailed Description

Debug Mask Protocol.

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


Define Documentation

#define DEBUG_MASK_VARIABLE_NAME   L"EFIDebug"

#define EFI_DEBUG_MASK_PROTOCOL_GUID   { 0x4c8a2451, 0xc207, 0x405b, {0x96, 0x94, 0x99, 0xea, 0x13, 0x25, 0x13, 0x41} }

Protocol GUID for DXE Phase Debug Mask support

#define EFI_DEBUG_MASK_REVISION   0x00010000

#define EFI_GENERIC_VARIABLE_GUID   { 0x59d1c24f, 0x50f1, 0x401a, {0xb1, 0x01, 0xf3, 0x3e, 0x0d, 0xae, 0xd4, 0x43} }

GUID used to store the global debug mask in an the "EFIDebug" EFI Variabe Also used as a GUIDed HOB that contains a UINT32 debug mask default value


Typedef Documentation

typedef IN OUT UINTN* CurrentDebugMask

Forward reference for pure ANSI compatability

typedef IN UINTN NewDebugMask


Function Documentation

typedef EFI_STATUS ( EFIAPI *  EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET  ) 

Finds next variable in storage blocks of volatile and non-volatile storage areas.

This code finds next variable in storage blocks of volatile and non-volatile storage areas. If VariableName is an empty string, then we just return the first qualified variable without comparing VariableName and VendorGuid.

Parameters:
[in] VariableName Name of the variable to be found.
[in] VendorGuid Variable vendor GUID to be found.
[out] AuthVariableInfo Pointer to AUTH_VARIABLE_INFO structure for output of the next variable.
Return values:
EFI_INVALID_PARAMETER If VariableName is not an empty string, while VendorGuid is NULL.
EFI_SUCCESS Variable successfully found.
EFI_NOT_FOUND Variable not found
Update the variable region with Variable information.

Parameters:
[in] AuthVariableInfo Pointer AUTH_VARIABLE_INFO structure for input of the variable.
Return values:
EFI_SUCCESS The update operation is success.
EFI_INVALID_PARAMETER Invalid parameter.
EFI_WRITE_PROTECTED Variable is write-protected.
EFI_OUT_OF_RESOURCES There is not enough resource.
Get scratch buffer.

Parameters:
[in,out] ScratchBufferSize Scratch buffer size. If input size is greater than the maximum supported buffer size, this value contains the maximum supported buffer size as output.
[out] ScratchBuffer Pointer to scratch buffer address.
Return values:
EFI_SUCCESS Get scratch buffer successfully.
EFI_UNSUPPORTED If input size is greater than the maximum supported buffer size.
Clears any system state that was created in response to the Active call.

Parameters:
PeiServices General purpose services available to every PEIM.
This The PEI_SMM_CONTROL_PPI instance.
Periodic Optional parameter to repeat at this period one time or, if the Periodic Boolean is set, periodically.
Return values:
EFI_SUCCESS The SMI/PMI has been engendered.
EFI_DEVICE_ERROR The source could not be cleared.
EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
Display one form, and return user input.

Parameters:
FormData Form Data to be shown.
UserInputData User input data.
Return values:
EFI_SUCCESS Form Data is shown, and user input is got.
This interface allows you to configure the EBC debug support driver. For example, turn on or off saving and printing of delta VM even if called. Or to even disable the entire interface, in which case all functions become no-ops.

Parameters:
[in] This A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in] ConfigId ID to be configured.
[in] ConfigValue Value to be set.
Return values:
EFI_UNSUPPORTED No support for it.
EFI_SUCCESS Configure EBC debug.
Convert AsmText to the instruction. This function is only used for test purposes.

Parameters:
[in] This A pointer to the EFI_EBC_VM_TEST_PROTOCOL structure.
[in] AsmText A pointer to EBC ASM text code.
[out] Buffer Buffer to store the instruction.
[out] BufferLen Size of buffer that is requried to store data.
Return values:
EFI_UNSUPPORTED This functionality is unsupported.
EFI_SUCCESS Successfully convert AsmText to the instruction.
Dump the executed instruction. This function is only used for test purposes.

Parameters:
[in] This A pointer to the EFI_EBC_VM_TEST_PROTOCOL structure.
[out] AsmText Contain the disasm text.
[out] Buffer Buffer to store the instruction.
[out] BufferLen Size of buffer that is requried to store data.
Return values:
EFI_UNSUPPORTED This functionality is unsupported.
EFI_SUCCESS Successfully dump the executed instruction.
Register the hot key with its browser action, or unregistered the hot key. If the action value is zero, the hot key will be unregistered if it has been registered. If the same hot key has been registered, the new action and help string will override the previous ones.

Parameters:
[in] KeyData A pointer to a buffer that describes the keystroke information for the hot key. Its type is EFI_INPUT_KEY to be supported by all ConsoleIn devices.
[in] Action Action value that describes what action will be trigged when the hot key is pressed.
[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
[in] HelpString Help string that describes the hot key information. Its value may be NULL for the unregistered hot key.
Return values:
EFI_SUCCESS Hot key is registered or unregistered.
EFI_INVALID_PARAMETER KeyData is NULL.
Variable property set. Variable driver will do check according to the VariableProperty before really setting the variable into variable storage.

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.
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.


Variable Documentation


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