MdeModulePkg/Include/Guid/S3StorageDeviceInitList.h

   1 /** @file
   2   Define the LockBox GUID for list of storage devices need to be initialized in
   3   S3.
   4
   5   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
   6
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __S3_STORAGE_DEVICE_INIT_LIST_H__
  12 #define __S3_STORAGE_DEVICE_INIT_LIST_H__
  13
  14 #define S3_STORAGE_DEVICE_INIT_LIST \
  15   { \
  16     0x310e9b8c, 0xcf90, 0x421e, { 0x8e, 0x9b, 0x9e, 0xef, 0xb6, 0x17, 0xc8, 0xef } \
  17   }
  18
  19 //
  20 // The LockBox will store a DevicePath structure that contains one or more
  21 // DevicePath instances. Each instance denotes a storage device that needs to
  22 // get initialized during the S3 resume.
  23 //
  24 // For example, if there is only one storage device stored in the list, the
  25 // content of this LockBox will be:
  26 //
  27 // +-------------------------------------------------------+
  28 // |                 DevPath Instance #1                   |
  29 // | (Terminated by an End of Hardware Device Path node    |
  30 // |  with an End Entire Device Path sub-type)             |
  31 // +-------------------------------------------------------+
  32 //
  33 // If there are n (n > 1) storage devices in the list, the content of this
  34 // LockBox will be:
  35 //
  36 // +-------------------------------------------------------+
  37 // |                 DevPath Instance #1                   |
  38 // | (Terminated by an End of Hardware Device Path node    |
  39 // |  with an End This Instance of a Device Path sub-type) |
  40 // +-------------------------------------------------------+
  41 // |                 DevPath Instance #2                   |
  42 // | (Terminated by an End of Hardware Device Path node    |
  43 // |  with an End This Instance of a Device Path sub-type) |
  44 // +-------------------------------------------------------+
  45 // |                        ...                            |
  46 // +-------------------------------------------------------+
  47 // |                 DevPath Instance #n                   |
  48 // | (Terminated by an End of Hardware Device Path node    |
  49 // |  with an End Entire Device Path sub-type)             |
  50 // +-------------------------------------------------------+
  51 //
  52 // The attribute of the LockBox should be set to
  53 // 'LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY'.
  54 //
  55 extern EFI_GUID  gS3StorageDeviceInitListGuid;
  56
  57 #endif  // __S3_STORAGE_DEVICE_INIT_LIST_H__