]> git.proxmox.com Git - mirror_edk2.git/commit - MdeModulePkg/MdeModulePkg.dec
MdeModulePkg: Add GUID for LockBox to save storage dev to init in S3
authorHao Wu <hao.a.wu@intel.com>
Fri, 14 Dec 2018 06:39:45 +0000 (14:39 +0800)
committerHao Wu <hao.a.wu@intel.com>
Fri, 22 Feb 2019 00:20:07 +0000 (08:20 +0800)
commit112dcbd9c26800c6820020dfa02341fbb75439a7
treeb0a961f9737c25bec0b5c3f48e1b37b143650948
parent110dfcd9285fa01a73b2e59bc01f9e9ebd53adbe
MdeModulePkg: Add GUID for LockBox to save storage dev to init in S3

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1409

This commit will add the GUID definitions for LockBox which is used to
save a list of storage devices that need to get initialized during the S3
resume.

The content of the LockBox will be a DevicePath structure that contains
zero or more DevicePath instances. Each instance denotes a storage device
that needs to get initialized during the S3 resume.

The producers of the content of this LockBox will be drivers like
OpalPassword DXE driver. This kind of drivers requires some specific
storage devices to be initialized during the PEI phase of in S3 resume.
(For the OpalPassword case, it requires the managing devices to be
automatically unlocked during the S3 resume).

The attribute of the LockBox should be set to
LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY.

The consumers of the content of this LockBox will be PEI storage device
controller/bus drivers (e.g. NvmExpressPei) during S3 resume. This kind of
drivers can use the DevicePath instances stored in the LockBox to get a
list of devices that need to get initialized. In such way, an on-demand
(partial) device enumeration/initialization can be performed to benefit
the S3 resume performance.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Ray Ni <ray.ni@Intel.com>
Reviewed-by: Eric Dong <eric.dong@intel.com>
MdeModulePkg/Include/Guid/S3StorageDeviceInitList.h [new file with mode: 0644]
MdeModulePkg/MdeModulePkg.dec