You've already forked slimbootloader
mirror of
https://github.com/Dasharo/slimbootloader.git
synced 2026-03-06 15:26:20 -08:00
Aiden Park
b24fd2759c
This will fully support PatchCheck.py. - Remove all trailing whitespace - Convert LF to CRLF by default - Update EFI_D_* to DEBUG_* - Re-enable CRLF check in PatchCheck.py Signed-off-by: Aiden Park <aiden.park@intel.com>
151 lines
3.8 KiB
C
151 lines
3.8 KiB
C
/** @file
|
|
|
|
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef _S3_SAVE_RESTORE_LIB_H_
|
|
#define _S3_SAVE_RESTORE_LIB_H_
|
|
|
|
|
|
#define BL_PLD_COMM_SIG SIGNATURE_32('B', 'P', 'C', 'O')
|
|
|
|
#define SMMBASE_INFO_COMM_ID 1
|
|
#define S3_SAVE_REG_COMM_ID 2
|
|
|
|
//
|
|
// Format to share info between bootloader and payload.
|
|
// Structures can be present in any order within the 4KB
|
|
// communication area starting from TSEG. They are
|
|
// identified by their Id.
|
|
//
|
|
|
|
// -------------------------- <----TSEG_BASE------
|
|
// | BL_PLD_COMM_HDR |
|
|
// | (Id:1) |
|
|
// --------------------------
|
|
// | SMMBASE_INFO |
|
|
// --------------------------
|
|
// --------------------------
|
|
// | BL_PLD_COMM_HDR |
|
|
// | (Id:*) |
|
|
// --------------------------
|
|
// | COMM_STRUCT_2 |
|
|
// --------------------------
|
|
// --------------------------
|
|
// | BL_PLD_COMM_HDR |
|
|
// | (Id:*) |
|
|
// --------------------------
|
|
// | COMM_STRUCT_3 |
|
|
// --------------------------
|
|
// --------------------------
|
|
// | BL_PLD_COMM_HDR |
|
|
// | (Id:2) |
|
|
// --------------------------
|
|
// | S3_SAVE_REG |
|
|
// --------------------------
|
|
// --------------------------
|
|
// | BL_PLD_COMM_HDR |
|
|
// | (Id:*) |
|
|
// --------------------------
|
|
// | COMM_STRUCT_5 |
|
|
// --------------------------
|
|
// --------------------------
|
|
// .....
|
|
// .....
|
|
// .....
|
|
|
|
|
|
#pragma pack(1)
|
|
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
UINT8 Id;
|
|
UINT8 Count;
|
|
UINT16 TotalSize;
|
|
} BL_PLD_COMM_HDR;
|
|
|
|
typedef struct {
|
|
UINT8 Type;
|
|
UINT8 Width;
|
|
UINT8 Rsvd[2];
|
|
UINT32 Addr;
|
|
UINT32 Val;
|
|
} REG_INFO;
|
|
|
|
typedef struct {
|
|
BL_PLD_COMM_HDR S3SaveHdr;
|
|
REG_INFO RegInfo[];
|
|
} S3_SAVE_REG;
|
|
|
|
typedef struct {
|
|
UINT32 ApicId;
|
|
UINT32 SmmBase;
|
|
} CPU_SMMBASE;
|
|
|
|
typedef struct {
|
|
BL_PLD_COMM_HDR SmmBaseHdr;
|
|
CPU_SMMBASE SmmBase[];
|
|
} SMMBASE_INFO;
|
|
|
|
#pragma pack()
|
|
|
|
/**
|
|
This function appends information in TSEG area
|
|
designated for S3 save/restore purpose.
|
|
|
|
@param DataPtr Address of the structure to be copied to TSEG
|
|
|
|
@retval EFI_OUT_OF_RESOURCES If SmmSize is exceeding 4KiB
|
|
@retval EFI_OUT_OF_RESOURCES If appeding new struct exceeds SmmSize
|
|
@retval EFI_SUCCESS Append is successful
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
AppendS3Info (
|
|
IN VOID *DataPtr
|
|
);
|
|
|
|
|
|
/**
|
|
Get pointer to a specific struct area in TSEG
|
|
|
|
@param Id Id of the struct to be retreived
|
|
|
|
@retval NULL Struct with signature not found
|
|
@retval Ptr Pointer to struct with signature
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
FindS3Info (
|
|
IN UINT8 Id
|
|
);
|
|
|
|
|
|
/**
|
|
This function restores the states of the registers that were
|
|
set to be saved by the bootloader in the normal boot path.
|
|
After the payload has updated the 'Val' field of the reg info
|
|
in the normal boot path, we simply OR the updated 'Val'
|
|
with the existing vale of the register in the S3 resume boot path.
|
|
This function is only called in the S3 resume path.
|
|
|
|
@param S3SaveReg S3_SAVE_REG info offset
|
|
|
|
@retval EFI_INVALID_PARAMETER Invalid pointer to S3_SAVE_REG in Communicaton region
|
|
@retval EFI_INVALID_PARAMETER Invalid Type and Width
|
|
@retval EFI_SUCCESS Restore successful
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
RestoreS3RegInfo (
|
|
IN S3_SAVE_REG *S3SaveReg
|
|
);
|
|
|
|
|
|
#endif
|