158 lines
4.1 KiB
C
158 lines
4.1 KiB
C
/** @file
|
|
|
|
@copyright
|
|
INTEL CONFIDENTIAL
|
|
Copyright 2006 - 2016 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 a 'Sample Driver' and is licensed as such under the terms
|
|
of your license agreement with Intel or your vendor. This file may be modified
|
|
by the user, subject to the additional terms of the license agreement.
|
|
|
|
@par Specification Reference:
|
|
**/
|
|
|
|
#ifndef _DXE_SMM_SCRIPT_LIB_H_
|
|
#define _DXE_SMM_SCRIPT_LIB_H_
|
|
|
|
#include "Uefi.h"
|
|
#include <Library/DebugLib.h>
|
|
#include <Protocol/SmmBase2.h>
|
|
#include <Protocol/S3SmmSaveState.h>
|
|
#include <IndustryStandard/SmBus.h>
|
|
#include <Library/SmmServicesTableLib.h>
|
|
|
|
typedef EFI_PHYSICAL_ADDRESS EFI_SMM_SCRIPT_TABLE;
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
InitializeSmmScriptLib (
|
|
IN EFI_SYSTEM_TABLE *SystemTable,
|
|
IN UINTN SmmScriptTablePages,
|
|
OUT EFI_PHYSICAL_ADDRESS *SmmScriptTableBase
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
|
|
Intialize Boot Script table.
|
|
|
|
Arguments:
|
|
|
|
SystemTable - Pointer to the EFI sytem table
|
|
SmmScriptTablePages - The expected ScriptTable page number
|
|
SmmScriptTableBase - The returned ScriptTable base address
|
|
|
|
Returns:
|
|
|
|
EFI_OUT_OF_RESOURCES - No resource to do the initialization.
|
|
EFI_SUCCESS - Function has completed successfully.
|
|
|
|
--*/
|
|
;
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmBootScriptCreateTable (
|
|
IN OUT EFI_SMM_SCRIPT_TABLE *ScriptTable,
|
|
IN UINTN Type
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
|
|
Create Boot Script table.
|
|
|
|
Arguments:
|
|
|
|
ScriptTable - Pointer to the boot script table to create.
|
|
Type - The type of table to creat.
|
|
|
|
|
|
Returns:
|
|
|
|
EFI_INVALID_PARAMETER - Invalid parameter detected.
|
|
EFI_SUCCESS - Function has completed successfully.
|
|
|
|
--*/
|
|
;
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmBootScriptWrite (
|
|
IN OUT EFI_SMM_SCRIPT_TABLE *ScriptTable,
|
|
IN UINTN Type,
|
|
IN UINT16 OpCode,
|
|
...
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
|
|
Write to boot script table. Format is defined in AcpiScritSave Protocol.
|
|
Currently it supports MemWrite, IoWrite, PciCfgWrite.
|
|
|
|
Arguments:
|
|
|
|
ScriptTable - Pointer to the script table to write to.
|
|
Type - Not used.
|
|
OpCode - Table write's Opcode.
|
|
... - Parameter of the OpCode.
|
|
|
|
Returns:
|
|
|
|
EFI_INVALID_PARAMETER - Invalid parameter passed in detected.
|
|
EFI_SUCCESS - Function completed successfully.
|
|
Other - Error occurred during execution.
|
|
|
|
--*/
|
|
;
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SmmBootScriptCloseTable (
|
|
IN EFI_SMM_SCRIPT_TABLE ScriptTableBase,
|
|
IN EFI_SMM_SCRIPT_TABLE ScriptTablePtr,
|
|
IN UINTN Type
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
|
|
Close Boot Script table.
|
|
|
|
Arguments:
|
|
|
|
ScriptTableBase - Pointer to the boot script table to create.
|
|
ScriptTablePtr - Pointer to the script table to write to.
|
|
Type - The type of table to creat.
|
|
|
|
|
|
Returns:
|
|
|
|
EFI_SUCCESS - Function has completed successfully.
|
|
|
|
--*/
|
|
;
|
|
|
|
#endif
|