]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Guid/S3StorageDeviceInitList.h
MdeModulePkg: Add GUID for LockBox to save storage dev to init in S3
[mirror_edk2.git] / MdeModulePkg / Include / Guid / S3StorageDeviceInitList.h
CommitLineData
112dcbd9
HW
1/** @file\r
2 Define the LockBox GUID for list of storage devices need to be initialized in\r
3 S3.\r
4\r
5 Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
6\r
7 This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions\r
9 of the BSD License which accompanies this distribution. The\r
10 full text of the license may be found at\r
11 http://opensource.org/licenses/bsd-license.php\r
12\r
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15\r
16**/\r
17\r
18#ifndef __S3_STORAGE_DEVICE_INIT_LIST_H__\r
19#define __S3_STORAGE_DEVICE_INIT_LIST_H__\r
20\r
21#define S3_STORAGE_DEVICE_INIT_LIST \\r
22 { \\r
23 0x310e9b8c, 0xcf90, 0x421e, { 0x8e, 0x9b, 0x9e, 0xef, 0xb6, 0x17, 0xc8, 0xef } \\r
24 }\r
25\r
26//\r
27// The LockBox will store a DevicePath structure that contains one or more\r
28// DevicePath instances. Each instance denotes a storage device that needs to\r
29// get initialized during the S3 resume.\r
30//\r
31// For example, if there is only one storage device stored in the list, the\r
32// content of this LockBox will be:\r
33//\r
34// +-------------------------------------------------------+\r
35// | DevPath Instance #1 |\r
36// | (Terminated by an End of Hardware Device Path node |\r
37// | with an End Entire Device Path sub-type) |\r
38// +-------------------------------------------------------+\r
39//\r
40// If there are n (n > 1) storage devices in the list, the content of this\r
41// LockBox will be:\r
42//\r
43// +-------------------------------------------------------+\r
44// | DevPath Instance #1 |\r
45// | (Terminated by an End of Hardware Device Path node |\r
46// | with an End This Instance of a Device Path sub-type) |\r
47// +-------------------------------------------------------+\r
48// | DevPath Instance #2 |\r
49// | (Terminated by an End of Hardware Device Path node |\r
50// | with an End This Instance of a Device Path sub-type) |\r
51// +-------------------------------------------------------+\r
52// | ... |\r
53// +-------------------------------------------------------+\r
54// | DevPath Instance #n |\r
55// | (Terminated by an End of Hardware Device Path node |\r
56// | with an End Entire Device Path sub-type) |\r
57// +-------------------------------------------------------+\r
58//\r
59// The attribute of the LockBox should be set to\r
60// 'LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY'.\r
61//\r
62extern EFI_GUID gS3StorageDeviceInitListGuid;\r
63\r
64#endif // __S3_STORAGE_DEVICE_INIT_LIST_H__\r