1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/** @file
Header file for PCH S3 Support driver
@copyright
Copyright (c) 1999 - 2015 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains an 'Intel Peripheral Driver' and 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
**/
#ifndef _PCH_S3_SUPPORT_DRIVER_H_
#define _PCH_S3_SUPPORT_DRIVER_H_
//
// External include files do NOT need to be explicitly specified in real EDKII
// environment
//
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#include "EdkIIGlueDxe.h"
#include "EfiScriptLib.h"
//
// Driver Produced Protocol Prototypes
//
#include EFI_PROTOCOL_PRODUCER (PchS3Support)
#include EFI_GUID_DEFINITION (S3SupportHob)
#include EFI_PROTOCOL_CONSUMER (Spi)
#include "PchAccess.h"
#include "PchPlatformLib.h"
#endif
///
/// EDK and EDKII have different GUID formats
///
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#define EFI_PCH_S3_IMAGE_GUID \
{ \
0x271dd6f2, 0x54cb, 0x45e6, 0x85, 0x85, 0x8c, 0x92, 0x3c, 0x1a, 0xc7, 0x6 \
}
#else
#define EFI_PCH_S3_IMAGE_GUID \
{ \
0x271dd6f2, 0x54cb, 0x45e6, \
{ \
0x85, 0x85, 0x8c, 0x92, 0x3c, 0x1a, 0xc7, 0x6 \
} \
}
#endif
extern EFI_GUID gEfiSpiProtocolGuid;
//
// Function prototypes
//
/**
Set an item to be dispatched at S3 resume time. At the same time, the entry point
of the PCH S3 support image is returned to be used in subsequent boot script save
call
@param[in] This Pointer to the protocol instance.
@param[in] InputDispatchItem The item to be dispatched.
@param[out] S3DispatchEntryPoint The entry point of the PCH S3 support image.
@retval EFI_STATUS Successfully completed.
@retval EFI_OUT_OF_RESOURCES Out of resources.
**/
EFI_STATUS
EFIAPI
PchS3SetDispatchItem (
IN EFI_PCH_S3_SUPPORT_PROTOCOL *This,
IN EFI_PCH_S3_DISPATCH_ITEM *InputDispatchItem,
OUT EFI_PHYSICAL_ADDRESS *S3DispatchEntryPoint
);
/**
Perform the EFI_PCH_S3_SUPPORT_SMM_PROTOCOL IO Trap to invoke DispatchArray data copy and
IO Trap Unregister.
@param[in] This Pointer to the protocol instance.
@retval EFI_SUCCESS Successfully completed.
**/
EFI_STATUS
EFIAPI
S3SupportReadyToLock(
IN EFI_PCH_S3_SUPPORT_PROTOCOL *This
);
/**
Initialize the Pch S3 Custom Script memory area. This will later be transferred to SMRAM.
@param[in] VOID
@retval None
**/
EFI_STATUS
InitializePchS3CustomScriptMemory (
VOID
);
/**
Load the entry point address of the PCHS3Peim from the HOB that it generated during the PEI phase of POST
@param[out] ImageEntryPoint The ImageEntryPoint after success loading
@retval EFI_STATUS
**/
EFI_STATUS
LoadPchS3ImageEntryPoint (
OUT UINT32 *ImageEntryPoint
);
#endif
|
