SmMonitorInit.h File Reference

#include <PiSmm.h>
#include <Register/Intel/StmApi.h>

Go to the source code of this file.

Data Structures
struct	_EFI_SM_MONITOR_INIT_PROTOCOL

Macros
#define	EFI_SM_MONITOR_INIT_PROTOCOL_GUID    { 0x228f344d, 0xb3de, 0x43bb, 0xa4, 0xd7, 0xea, 0x20, 0xb, 0x1b, 0x14, 0x82}
#define	EFI_SM_MONITOR_STATE_ENABLED   0x1
#define	EFI_SM_MONITOR_STATE_ACTIVATED   0x2

Typedefs
typedef EFI_STATUS(EFIAPI *	EFI_SM_MONITOR_LOAD_MONITOR) (IN EFI_PHYSICAL_ADDRESS StmImage, IN UINTN StmImageSize)
typedef EFI_STATUS(EFIAPI *	EFI_SM_MONITOR_ADD_PI_RESOURCE) (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)
typedef EFI_STATUS(EFIAPI *	EFI_SM_MONITOR_DELETE_PI_RESOURCE) (IN STM_RSC *ResourceList OPTIONAL, IN UINT32 NumEntries OPTIONAL)
typedef EFI_STATUS(EFIAPI *	EFI_SM_MONITOR_GET_PI_RESOURCE) (OUT STM_RSC *ResourceList, IN OUT UINT32 *ResourceSize)
typedef UINT32	EFI_SM_MONITOR_STATE
typedef EFI_SM_MONITOR_STATE(EFIAPI *	EFI_SM_MONITOR_GET_MONITOR_STATE) (VOID)
typedef struct _EFI_SM_MONITOR_INIT_PROTOCOL	EFI_SM_MONITOR_INIT_PROTOCOL

Variables
EFI_GUID	gEfiSmMonitorInitProtocolGuid

Detailed Description

STM service protocol definition

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

Definition in file SmMonitorInit.h.

Macro Definition Documentation

EFI_SM_MONITOR_INIT_PROTOCOL_GUID

#define EFI_SM_MONITOR_INIT_PROTOCOL_GUID    { 0x228f344d, 0xb3de, 0x43bb, 0xa4, 0xd7, 0xea, 0x20, 0xb, 0x1b, 0x14, 0x82}

Definition at line 15 of file SmMonitorInit.h.

EFI_SM_MONITOR_STATE_ACTIVATED

#define EFI_SM_MONITOR_STATE_ACTIVATED   0x2

Definition at line 104 of file SmMonitorInit.h.

EFI_SM_MONITOR_STATE_ENABLED

#define EFI_SM_MONITOR_STATE_ENABLED   0x1

Definition at line 103 of file SmMonitorInit.h.

Typedef Documentation

EFI_SM_MONITOR_ADD_PI_RESOURCE

typedef EFI_STATUS(EFIAPI * EFI_SM_MONITOR_ADD_PI_RESOURCE) (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)

Add resources in list to database.

Parameters

ResourceList	A pointer to resource list to be added
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Return values

EFI_SUCCESS	If resources are added
EFI_INVALID_PARAMETER	If nested procedure detected resource failer
EFI_OUT_OF_RESOURCES	If nested procedure returned it and we cannot allocate more areas.

Definition at line 56 of file SmMonitorInit.h.

EFI_SM_MONITOR_DELETE_PI_RESOURCE

typedef EFI_STATUS(EFIAPI * EFI_SM_MONITOR_DELETE_PI_RESOURCE) (IN STM_RSC *ResourceList OPTIONAL, IN UINT32 NumEntries OPTIONAL)

Delete resources in list to database.

Parameters

ResourceList	A pointer to resource list to be deleted NULL means delete all resources.
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Return values

EFI_SUCCESS	If resources are deleted
EFI_INVALID_PARAMETER	If nested procedure detected resource failer

Definition at line 76 of file SmMonitorInit.h.

EFI_SM_MONITOR_GET_MONITOR_STATE

typedef EFI_SM_MONITOR_STATE(EFIAPI * EFI_SM_MONITOR_GET_MONITOR_STATE) (VOID)

Get STM state

Returns

STM state

Definition at line 114 of file SmMonitorInit.h.

EFI_SM_MONITOR_GET_PI_RESOURCE

typedef EFI_STATUS(EFIAPI * EFI_SM_MONITOR_GET_PI_RESOURCE) (OUT STM_RSC *ResourceList, IN OUT UINT32 *ResourceSize)

Get BIOS resources.

Parameters

ResourceList	A pointer to resource list to be filled
ResourceSize	On input it means size of resource list input. On output it means size of resource list filled, or the size of resource list to be filled if size of too small.

Return values

EFI_SUCCESS	If resources are returned.
EFI_BUFFER_TOO_SMALL	If resource list buffer is too small to hold the whole resources.

Definition at line 96 of file SmMonitorInit.h.

EFI_SM_MONITOR_LOAD_MONITOR

typedef EFI_STATUS(EFIAPI * EFI_SM_MONITOR_LOAD_MONITOR) (IN EFI_PHYSICAL_ADDRESS StmImage, IN UINTN StmImageSize)

Load STM image to MSEG.

Parameters

StmImage	STM image
StmImageSize	STM image size

Return values

EFI_SUCCESS	Load STM to MSEG successfully
EFI_ALREADY_STARTED	STM image is already loaded to MSEG
EFI_BUFFER_TOO_SMALL	MSEG is smaller than minimal requirement of STM image
EFI_UNSUPPORTED	MSEG is not enabled

Definition at line 36 of file SmMonitorInit.h.

EFI_SM_MONITOR_STATE

typedef UINT32 EFI_SM_MONITOR_STATE

Definition at line 102 of file SmMonitorInit.h.