159 lines
5.1 KiB
C
159 lines
5.1 KiB
C
/** @file
|
|
Header file for SMM Control Driver.
|
|
|
|
@copyright
|
|
INTEL CONFIDENTIAL
|
|
Copyright 1999 - 2017 Intel Corporation.
|
|
|
|
The source code contained or described herein and all documents related to the
|
|
source code ("Material") are owned by Intel Corporation or its suppliers or
|
|
licensors. Title to the Material remains with Intel Corporation or its suppliers
|
|
and licensors. The Material may contain trade secrets and proprietary and
|
|
confidential information of Intel Corporation and its suppliers and licensors,
|
|
and is protected by worldwide copyright and trade secret laws and treaty
|
|
provisions. No part of the Material may be used, copied, reproduced, modified,
|
|
published, uploaded, posted, transmitted, distributed, or disclosed in any way
|
|
without Intel's prior express written permission.
|
|
|
|
No license under any patent, copyright, trade secret or other intellectual
|
|
property right is granted to or conferred upon you by disclosure or delivery
|
|
of the Materials, either expressly, by implication, inducement, estoppel or
|
|
otherwise. Any license under such intellectual property rights must be
|
|
express and approved by Intel in writing.
|
|
|
|
Unless otherwise agreed by Intel in writing, you may not remove or alter
|
|
this notice or any other notice embedded in Materials by Intel or
|
|
Intel's suppliers or licensors in any way.
|
|
|
|
This file contains an 'Intel Peripheral Driver' and is uniquely identified as
|
|
"Intel Reference Module" and is licensed for Intel CPUs and chipsets under
|
|
the terms of your license agreement with Intel or your vendor. This file may
|
|
be modified by the user, subject to additional terms of the license agreement.
|
|
|
|
@par Specification Reference:
|
|
**/
|
|
#ifndef _SMM_CONTROL_DRIVER_H_
|
|
#define _SMM_CONTROL_DRIVER_H_
|
|
|
|
#include <Protocol/SmmControl2.h>
|
|
|
|
|
|
#define SMM_CONTROL_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('i', '4', 's', 'c')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
EFI_HANDLE Handle;
|
|
EFI_SMM_CONTROL2_PROTOCOL SmmControl;
|
|
} SMM_CONTROL_PRIVATE_DATA;
|
|
|
|
#define SMM_CONTROL_PRIVATE_DATA_FROM_THIS(a) CR (a, SMM_CONTROL_PRIVATE_DATA, SmmControl, SMM_CONTROL_DEV_SIGNATURE)
|
|
|
|
//
|
|
// Prototypes
|
|
//
|
|
|
|
/**
|
|
<b>SmmControl DXE RUNTIME Module Entry Point</b>\n
|
|
- <b>Introduction</b>\n
|
|
The SmmControl module is a DXE RUNTIME driver that provides a standard way
|
|
for other drivers to trigger software SMIs.
|
|
|
|
- @pre
|
|
- PCH Power Management I/O space base address has already been programmed.
|
|
If SmmControl Runtime DXE driver is run before Status Code Runtime Protocol
|
|
is installed and there is the need to use Status code in the driver, it will
|
|
be necessary to add EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID to the dependency file.
|
|
- EFI_SMM_BASE2_PROTOCOL
|
|
- Documented in the System Management Mode Core Interface Specification.
|
|
|
|
- @result
|
|
The SmmControl driver produces the EFI_SMM_CONTROL_PROTOCOL documented in
|
|
System Management Mode Core Interface Specification.
|
|
|
|
@param[in] ImageHandle Handle for the image of this driver
|
|
@param[in] SystemTable Pointer to the EFI System Table
|
|
|
|
@retval EFI_STATUS Results of the installation of the SMM Control Protocol
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmControlDriverEntryInit (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
);
|
|
|
|
/**
|
|
Trigger the software SMI
|
|
|
|
@param[in] Data The value to be set on the software SMI data port
|
|
|
|
@retval EFI_SUCCESS Function completes successfully
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmTrigger (
|
|
UINT8 Data
|
|
);
|
|
|
|
/**
|
|
Clear the SMI status
|
|
|
|
|
|
@retval EFI_SUCCESS The function completes successfully
|
|
@retval EFI_DEVICE_ERROR Something error occurred
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmClear (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This routine generates an SMI
|
|
|
|
@param[in] This The EFI SMM Control protocol instance
|
|
@param[in, out] ArgumentBuffer The buffer of argument
|
|
@param[in, out] ArgumentBufferSize The size of the argument buffer
|
|
@param[in] Periodic Periodic or not
|
|
@param[in] ActivationInterval Interval of periodic SMI
|
|
|
|
@retval EFI Status Describing the result of the operation
|
|
@retval EFI_INVALID_PARAMETER Some parameter value passed is not supported
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Activate (
|
|
IN CONST EFI_SMM_CONTROL2_PROTOCOL *This,
|
|
IN OUT UINT8 *ArgumentBuffer OPTIONAL,
|
|
IN OUT UINT8 *ArgumentBufferSize OPTIONAL,
|
|
IN BOOLEAN Periodic OPTIONAL,
|
|
IN UINTN ActivationInterval OPTIONAL
|
|
);
|
|
|
|
/**
|
|
This routine clears an SMI
|
|
|
|
@param[in] This The EFI SMM Control protocol instance
|
|
@param[in] Periodic Periodic or not
|
|
|
|
@retval EFI Status Describing the result of the operation
|
|
@retval EFI_INVALID_PARAMETER Some parameter value passed is not supported
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Deactivate (
|
|
IN CONST EFI_SMM_CONTROL2_PROTOCOL *This,
|
|
IN BOOLEAN Periodic OPTIONAL
|
|
);
|
|
/**
|
|
Disable all pending SMIs
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
DisablePendingSmis (
|
|
VOID
|
|
);
|
|
|
|
#endif
|