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