TcgStorageOpalLib.h

Go to the documentation of this file.

 
#ifndef _OPAL_CORE_H_
#define _OPAL_CORE_H_
 
#include <IndustryStandard/TcgStorageOpal.h>
 
#include <Library/TcgStorageCoreLib.h>
#include <Protocol/StorageSecurityCommand.h>
 
#pragma pack(1)
 
typedef struct {
  //
  // Opal SSC 1 support  (0 - not supported, 1 - supported)
  //
  UINT32    OpalSsc1          : 1;
 
  //
  // Opal SSC 2support  (0 - not supported, 1 - supported)
  //
  UINT32    OpalSsc2          : 1;
 
  //
  // Opal SSC Lite support  (0 - not supported, 1 - supported)
  //
  UINT32    OpalSscLite       : 1;
 
  //
  // Pyrite SSC support  (0 - not supported, 1 - supported)
  //
  UINT32    PyriteSsc         : 1;
 
  //
  // Security protocol 1 support  (0 - not supported, 1 - supported)
  //
  UINT32    Sp1               : 1;
 
  //
  // Security protocol 2 support  (0 - not supported, 1 - supported)
  //
  UINT32    Sp2               : 1;
 
  //
  // Security protocol IEEE1667 support  (0 - not supported, 1 - supported)
  //
  UINT32    SpIeee1667        : 1;
 
  //
  // Media encryption supported (0 - not supported, 1 - supported)
  //
  UINT32    MediaEncryption   : 1;
 
  //
  // Initial C_PIN_SID PIN Indicator
  //  0 - The initial C_PIN_SID PIN value is NOT equal to the C_PIN_MSID PIN value
  //  1 - The initial C_PIN_SID PIN value is equal to the C_PIN_MSID PIN value
  //
  UINT32    InitCpinIndicator : 1;
 
  //
  // Behavior of C_PIN_SID PIN upon TPer Revert
  //  0 - The initial C_PIN_SID PIN value is NOT equal to the C_PIN_MSID PIN value
  //  1 - The initial C_PIN_SID PIN value is equal to the C_PIN_MSID PIN value
  //
  UINT32    CpinUponRevert    : 1;
 
  //
  // Media encryption supported (0 - not supported, 1 - supported)
  //
  UINT32    BlockSid          : 1;
 
  //
  // Pyrite SSC V2 support  (0 - not supported, 1 - supported)
  //
  UINT32    PyriteSscV2       : 1;
 
  //
  // Supported Data Removal Mechanism support  (0 - not supported, 1 - supported)
  //
  UINT32    DataRemoval       : 1;
} OPAL_DISK_SUPPORT_ATTRIBUTE;
 
//
// Opal device ownership type
// The type indicates who was the determined owner of the device.
//
typedef enum {
  //
  // Represents the device ownership is unknown because starting a session as the SID authority with the ADMIN SP
  // was unsuccessful with the provided PIN
  //
  OpalOwnershipUnknown,
 
  //
  // Represents that the ADMIN SP SID authority contains the same PIN as the MSID PIN
  //
  OpalOwnershipNobody,
} OPAL_OWNER_SHIP;
 
//
// Structure that is used to represent an Opal session.
// The structure must be initialized by calling OpalStartSession before being used as a parameter
// for any other Opal function.
// This structure should NOT be directly modified by the client of this library.
//
//
typedef struct  {
  UINT32                                   HostSessionId;
  UINT32                                   TperSessionId;
  UINT16                                   ComIdExtension;
 
  UINT16                                   OpalBaseComId;
 
  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL    *Sscp;
  UINT32                                   MediaId;
} OPAL_SESSION;
#pragma pack()
 
TCG_RESULT
EFIAPI
OpalRetrieveSupportedProtocolList (
  OPAL_SESSION  *Session,
  UINTN         BufferSize,
  VOID          *BuffAddress
  );
 
TCG_RESULT
EFIAPI
OpalRetrieveLevel0DiscoveryHeader (
  OPAL_SESSION  *Session,
  UINTN         BufferSize,
  VOID          *BuffAddress
  );
 
TCG_RESULT
EFIAPI
OpalStartSession (
  OPAL_SESSION  *Session,
  TCG_UID       SpId,
  BOOLEAN       Write,
  UINT32        HostChallengeLength,
  const VOID    *HostChallenge,
  TCG_UID       HostSigningAuthority,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalEndSession (
  OPAL_SESSION  *Session
  );
 
TCG_RESULT
EFIAPI
OpalPsidRevert (
  OPAL_SESSION  *AdminSpSession
  );
 
TCG_RESULT
EFIAPI
OpalGetMsid (
  OPAL_SESSION  *AdminSpSession,
  UINT32        MsidBufferSize,
  UINT8         *Msid,
  UINT32        *MsidLength
  );
 
TCG_RESULT
EFIAPI
OpalActivateLockingSp (
  OPAL_SESSION  *AdminSpSession,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalSetPassword (
  OPAL_SESSION  *Session,
  TCG_UID       CpinRowUid,
  const VOID    *NewPin,
  UINT32        NewPinLength,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalGlobalLockingRangeGenKey (
  OPAL_SESSION  *LockingSpSession,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalUpdateGlobalLockingRange (
  OPAL_SESSION  *LockingSpSession,
  BOOLEAN       ReadLocked,
  BOOLEAN       WriteLocked,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalSetLockingRange (
  OPAL_SESSION  *LockingSpSession,
  TCG_UID       LockingRangeUid,
  UINT64        RangeStart,
  UINT64        RangeLength,
  BOOLEAN       ReadLockEnabled,
  BOOLEAN       WriteLockEnabled,
  BOOLEAN       ReadLocked,
  BOOLEAN       WriteLocked,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalSetLockingSpAuthorityEnabledAndPin (
  OPAL_SESSION  *LockingSpSession,
  TCG_UID       CpinRowUid,
  TCG_UID       AuthorityUid,
  const VOID    *NewPin,
  UINT32        NewPinLength,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalDisableUser (
  OPAL_SESSION  *LockingSpSession,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalAdminRevert (
  OPAL_SESSION  *LockingSpSession,
  BOOLEAN       KeepUserData,
  UINT8         *MethodStatus
  );
 
TCG_RESULT
EFIAPI
OpalGetTryLimit (
  OPAL_SESSION  *LockingSpSession,
  TCG_UID       RowUid,
  UINT32        *TryLimit
  );
 
TCG_RESULT
EFIAPI
OpalCreateRetrieveGlobalLockingRangeActiveKey (
  const OPAL_SESSION  *Session,
  TCG_CREATE_STRUCT   *CreateStruct,
  UINT32              *Size
  );
 
TCG_RESULT
EFIAPI
OpalParseRetrieveGlobalLockingRangeActiveKey (
  TCG_PARSE_STRUCT  *ParseStruct,
  TCG_UID           *ActiveKey
  );
 
TCG_RESULT
EFIAPI
OpalGetLockingInfo (
  OPAL_SESSION                    *Session,
  TCG_LOCKING_FEATURE_DESCRIPTOR  *LockingFeature
  );
 
BOOLEAN
EFIAPI
OpalFeatureSupported (
  OPAL_DISK_SUPPORT_ATTRIBUTE  *SupportedAttributes
  );
 
BOOLEAN
EFIAPI
OpalFeatureEnabled (
  OPAL_DISK_SUPPORT_ATTRIBUTE     *SupportedAttributes,
  TCG_LOCKING_FEATURE_DESCRIPTOR  *LockingFeature
  );
 
BOOLEAN
OpalDeviceLocked (
  OPAL_DISK_SUPPORT_ATTRIBUTE     *SupportedAttributes,
  TCG_LOCKING_FEATURE_DESCRIPTOR  *LockingFeature
  );
 
TCG_RESULT
EFIAPI
OpalBlockSid (
  OPAL_SESSION  *Session,
  BOOLEAN       HardwareReset
  );
 
TCG_RESULT
EFIAPI
OpalGetSupportedAttributesInfo (
  OPAL_SESSION                 *Session,
  OPAL_DISK_SUPPORT_ATTRIBUTE  *SupportedAttributes,
  UINT16                       *OpalBaseComId
  );
 
TCG_RESULT
EFIAPI
OpalUtilPsidRevert (
  OPAL_SESSION  *AdminSpSession,
  const VOID    *Psid,
  UINT32        PsidLength
  );
 
TCG_RESULT
EFIAPI
OpalUtilSetAdminPasswordAsSid (
  OPAL_SESSION  *AdminSpSession,
  const VOID    *GeneratedSid,
  UINT32        SidLength,
  const VOID    *Password,
  UINT32        PassLength
  );
 
TCG_RESULT
EFIAPI
OpalUtilSetOpalLockingRange (
  OPAL_SESSION  *LockingSpSession,
  const VOID    *Password,
  UINT32        PassLength,
  TCG_UID       LockingRangeUid,
  UINT64        RangeStart,
  UINT64        RangeLength,
  BOOLEAN       ReadLockEnabled,
  BOOLEAN       WriteLockEnabled,
  BOOLEAN       ReadLocked,
  BOOLEAN       WriteLocked
  );
 
TCG_RESULT
EFIAPI
OpalUtilSetAdminPassword (
  OPAL_SESSION  *AdminSpSession,
  const VOID    *OldPassword,
  UINT32        OldPasswordLength,
  const VOID    *NewPassword,
  UINT32        NewPasswordLength
  );
 
TCG_RESULT
EFIAPI
OpalUtilSetUserPassword (
  OPAL_SESSION  *LockingSpSession,
  const VOID    *OldPassword,
  UINT32        OldPasswordLength,
  const VOID    *NewPassword,
  UINT32        NewPasswordLength
  );
 
TCG_RESULT
EFIAPI
OpalUtilVerifyPassword (
  OPAL_SESSION  *LockingSpSession,
  const VOID    *Password,
  UINT32        PasswordLength,
  TCG_UID       HostSigningAuthority
  );
 
TCG_RESULT
EFIAPI
OpalUtilSecureErase (
  OPAL_SESSION  *LockingSpSession,
  const VOID    *Password,
  UINT32        PasswordLength,
  BOOLEAN       *PasswordFailed
  );
 
TCG_RESULT
EFIAPI
OpalUtilDisableUser (
  OPAL_SESSION  *LockingSpSession,
  const VOID    *Password,
  UINT32        PasswordLength,
  BOOLEAN       *PasswordFailed
  );
 
TCG_RESULT
EFIAPI
OpalUtilRevert (
  OPAL_SESSION  *LockingSpSession,
  BOOLEAN       KeepUserData,
  const VOID    *Password,
  UINT32        PasswordLength,
  BOOLEAN       *PasswordFailed,
  UINT8         *Msid,
  UINT32        MsidLength
  );
 
TCG_RESULT
EFIAPI
OpalUtilSetSIDtoMSID (
  OPAL_SESSION  *AdminSpSession,
  const VOID    *Password,
  UINT32        PasswordLength,
  UINT8         *Msid,
  UINT32        MsidLength
  );
 
TCG_RESULT
EFIAPI
OpalUtilUpdateGlobalLockingRange (
  OPAL_SESSION  *LockingSpSession,
  const VOID    *Password,
  UINT32        PasswordLength,
  BOOLEAN       ReadLocked,
  BOOLEAN       WriteLocked
  );
 
TCG_RESULT
EFIAPI
OpalUtilGetMsid (
  OPAL_SESSION  *Session,
  UINT8         *Msid,
  UINT32        MsidBufferLength,
  UINT32        *MsidLength
  );
 
OPAL_OWNER_SHIP
EFIAPI
OpalUtilDetermineOwnership (
  OPAL_SESSION  *Session,
  UINT8         *Msid,
  UINT32        MsidLength
  );
 
BOOLEAN
EFIAPI
OpalUtilAdminPasswordExists (
  IN  UINT16                          OwnerShip,
  IN  TCG_LOCKING_FEATURE_DESCRIPTOR  *LockingFeature
  );
 
TCG_RESULT
EFIAPI
OpalUtilGetActiveDataRemovalMechanism (
  OPAL_SESSION  *Session,
  const VOID    *GeneratedSid,
  UINT32        SidLength,
  UINT8         *ActiveDataRemovalMechanism
  );
 
TCG_RESULT
EFIAPI
OpalUtilGetDataRemovalMechanismLists (
  IN  OPAL_SESSION  *Session,
  OUT UINT32        *RemovalMechanismLists
  );
 
#endif // _OPAL_CORE_H_