MdePkg/Include/Protocol/McaInitPmi.h File Reference


Data Structures

struct  SAL_MCA_COUNT_STRUCTURE
struct  _EFI_SAL_MCA_INIT_PMI_PROTOCOL

Defines

#define EFI_SAL_MCA_INIT_PMI_PROTOCOL_GUID   { 0xb60dc6e8, 0x3b6f, 0x11d5, {0xaf, 0x9, 0x0, 0xa0, 0xc9, 0x44, 0xa0, 0x5b} }

Typedefs

typedef struct
_EFI_SAL_MCA_INIT_PMI_PROTOCOL 
EFI_SAL_MCA_INIT_PMI_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SAL_MCA_HANDLER )(IN VOID *ModuleGlobal, IN UINT64 ProcessorStateParameters, IN EFI_PHYSICAL_ADDRESS MinstateBase, IN UINT64 RendezvouseStateInformation, IN UINT64 CpuIndex, IN SAL_MCA_COUNT_STRUCTURE *McaCountStructure, OUT BOOLEAN *CorrectedMachineCheck)
typedef EFI_STATUS(EFIAPI * EFI_SAL_INIT_HANDLER )(IN VOID *ModuleGlobal, IN UINT64 ProcessorStateParameters, IN EFI_PHYSICAL_ADDRESS MinstateBase, IN BOOLEAN McaInProgress, IN UINT64 CpuIndex, IN SAL_MCA_COUNT_STRUCTURE *McaCountStructure, OUT BOOLEAN *DumpSwitchPressed)
typedef EFI_STATUS(EFIAPI * EFI_SAL_PMI_HANDLER )(IN VOID *ModuleGlobal, IN UINT64 CpuIndex, IN UINT64 PmiVector)
typedef EFI_STATUS(EFIAPI * EFI_SAL_REGISTER_MCA_HANDLER )(IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This, IN EFI_SAL_MCA_HANDLER McaHandler, IN VOID *ModuleGlobal, IN BOOLEAN MakeFirst, IN BOOLEAN MakeLast)
typedef EFI_STATUS(EFIAPI * EFI_SAL_REGISTER_INIT_HANDLER )(IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This, IN EFI_SAL_INIT_HANDLER InitHandler, IN VOID *ModuleGlobal, IN BOOLEAN MakeFirst, IN BOOLEAN MakeLast)
typedef EFI_STATUS(EFIAPI * EFI_SAL_REGISTER_PMI_HANDLER )(IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This, IN EFI_SAL_PMI_HANDLER PmiHandler, IN VOID *ModuleGlobal, IN BOOLEAN MakeFirst, IN BOOLEAN MakeLast)

Variables

EFI_GUID gEfiSalMcaInitPmiProtocolGuid

Detailed Description

MCA/PMI/INIT Protocol as defined in PI Specification VOLUME 4.

This protocol provides services to handle Machine Checks (MCA), Initialization (INIT) events, and Platform Management Interrupt (PMI) events on an Intel Itanium Processor Family based system.

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


Define Documentation

#define EFI_SAL_MCA_INIT_PMI_PROTOCOL_GUID   { 0xb60dc6e8, 0x3b6f, 0x11d5, {0xaf, 0x9, 0x0, 0xa0, 0xc9, 0x44, 0xa0, 0x5b} }

Global ID for the MCA/PMI/INIT Protocol.


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SAL_INIT_HANDLER)(IN VOID *ModuleGlobal, IN UINT64 ProcessorStateParameters, IN EFI_PHYSICAL_ADDRESS MinstateBase, IN BOOLEAN McaInProgress, IN UINT64 CpuIndex, IN SAL_MCA_COUNT_STRUCTURE *McaCountStructure, OUT BOOLEAN *DumpSwitchPressed)

Prototype of INIT handler.

Parameters:
ModuleGlobal The context of INIT Handler
ProcessorStateParameters The processor state parameters (PSP)
MinstateBase Base address of the min-state
McaInProgress This flag indicates if an MCA is in progress
CpuIndex Index of the logical processor
McaCountStructure Pointer to the MCA records structure
DumpSwitchPressed This flag indicates the crash dump switch has been pressed
Return values:
EFI_SUCCESS Handler successfully returned

typedef EFI_STATUS(EFIAPI * EFI_SAL_MCA_HANDLER)(IN VOID *ModuleGlobal, IN UINT64 ProcessorStateParameters, IN EFI_PHYSICAL_ADDRESS MinstateBase, IN UINT64 RendezvouseStateInformation, IN UINT64 CpuIndex, IN SAL_MCA_COUNT_STRUCTURE *McaCountStructure, OUT BOOLEAN *CorrectedMachineCheck)

Prototype of MCA handler.

Parameters:
ModuleGlobal The context of MCA Handler
ProcessorStateParameters The processor state parameters (PSP)
MinstateBase Base address of the min-state
RendezvouseStateInformation Rendezvous state information to be passed to the OS on OS MCA entry
CpuIndex Index of the logical processor
McaCountStructure Pointer to the MCA records structure
CorrectedMachineCheck This flag is set to TRUE is the MCA has been corrected by the handler or by a previous handler
Return values:
EFI_SUCCESS Handler successfully returned

Declare forward reference for the Timer Architectural Protocol

typedef EFI_STATUS(EFIAPI * EFI_SAL_PMI_HANDLER)(IN VOID *ModuleGlobal, IN UINT64 CpuIndex, IN UINT64 PmiVector)

Prototype of PMI handler

Parameters:
ModuleGlobal The context of PMI Handler
CpuIndex Index of the logical processor
PmiVector The PMI vector number as received from the PALE_PMI exit state (GR24)
Return values:
EFI_SUCCESS Handler successfully returned

typedef EFI_STATUS(EFIAPI * EFI_SAL_REGISTER_INIT_HANDLER)(IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This, IN EFI_SAL_INIT_HANDLER InitHandler, IN VOID *ModuleGlobal, IN BOOLEAN MakeFirst, IN BOOLEAN MakeLast)

Register an INIT handler with the INIT dispatcher.

Parameters:
This The EFI_SAL_MCA_INIT_PMI_PROTOCOL instance
InitHandler The INIT handler to register
ModuleGlobal The context of INIT Handler
MakeFirst This flag specifies the handler should be made first in the list
MakeLast This flag specifies the handler should be made last in the list
Return values:
EFI_SUCCESS INIT Handle was registered
EFI_OUT_OF_RESOURCES No more resources to register an INIT handler
EFI_INVALID_PARAMETER Invalid parameters were passed

typedef EFI_STATUS(EFIAPI * EFI_SAL_REGISTER_MCA_HANDLER)(IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This, IN EFI_SAL_MCA_HANDLER McaHandler, IN VOID *ModuleGlobal, IN BOOLEAN MakeFirst, IN BOOLEAN MakeLast)

Register a MCA handler with the MCA dispatcher.

Parameters:
This The EFI_SAL_MCA_INIT_PMI_PROTOCOL instance
McaHandler The MCA handler to register
ModuleGlobal The context of MCA Handler
MakeFirst This flag specifies the handler should be made first in the list
MakeLast This flag specifies the handler should be made last in the list
Return values:
EFI_SUCCESS MCA Handle was registered
EFI_OUT_OF_RESOURCES No more resources to register an MCA handler
EFI_INVALID_PARAMETER Invalid parameters were passed

typedef EFI_STATUS(EFIAPI * EFI_SAL_REGISTER_PMI_HANDLER)(IN EFI_SAL_MCA_INIT_PMI_PROTOCOL *This, IN EFI_SAL_PMI_HANDLER PmiHandler, IN VOID *ModuleGlobal, IN BOOLEAN MakeFirst, IN BOOLEAN MakeLast)

Register a PMI handler with the PMI dispatcher.

Parameters:
This The EFI_SAL_MCA_INIT_PMI_PROTOCOL instance
PmiHandler The PMI handler to register
ModuleGlobal The context of PMI Handler
MakeFirst This flag specifies the handler should be made first in the list
MakeLast This flag specifies the handler should be made last in the list
Return values:
EFI_SUCCESS PMI Handle was registered
EFI_OUT_OF_RESOURCES No more resources to register an PMI handler
EFI_INVALID_PARAMETER Invalid parameters were passed


Variable Documentation


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