OpalDriver.h

Go to the documentation of this file.

 
#ifndef _OPAL_DRIVER_H_
#define _OPAL_DRIVER_H_
 
#include <PiDxe.h>
 
#include <IndustryStandard/Pci.h>
 
#include <Protocol/PciIo.h>
#include <Protocol/SmmCommunication.h>
#include <Protocol/BlockIo.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/DevicePath.h>
#include <Protocol/DevicePathToText.h>
#include <Protocol/StorageSecurityCommand.h>
 
#include <Guid/EventGroup.h>
#include <Guid/S3StorageDeviceInitList.h>
#include <Guid/MdeModuleHii.h>
 
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/DxeServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseLib.h>
#include <Library/PrintLib.h>
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/HiiLib.h>
#include <Library/UefiHiiServicesLib.h>
#include <Library/PciLib.h>
#include <Library/LockBoxLib.h>
#include <Library/TcgStorageOpalLib.h>
#include <Library/Tcg2PhysicalPresenceLib.h>
 
#include "OpalPasswordCommon.h"
#include "OpalHiiFormValues.h"
 
#define EFI_DRIVER_NAME_UNICODE  L"1.0 UEFI Opal Driver"
 
// UEFI 2.1
#define LANGUAGE_RFC_3066_ENGLISH  ((CHAR8*)"en")
 
// UEFI/EFI < 2.1
#define LANGUAGE_ISO_639_2_ENGLISH  ((CHAR8*)"eng")
 
#define CONCAT_(x, y)  x ## y
#define CONCAT(x, y)   CONCAT_(x, y)
 
#define UNICODE_STR(x)  CONCAT( L, x )
 
extern EFI_DRIVER_BINDING_PROTOCOL   gOpalDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL   gOpalComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gOpalComponentName2;
 
#define OPAL_MSID_LENGTH  128
 
#define MAX_PASSWORD_TRY_COUNT  5
 
// PSID Length
#define PSID_CHARACTER_LENGTH  0x20
#define MAX_PSID_TRY_COUNT     5
 
//
// The max timeout value assume the user can wait for the revert action. The unit of this macro is second.
// If the revert time value bigger than this one, driver needs to popup a dialog to let user confirm the
// revert action.
//
#define MAX_ACCEPTABLE_REVERTING_TIME  10
 
#pragma pack(1)
 
//
// Structure that is used to represent the available actions for an OpalDisk.
// The data can then be utilized to expose/hide certain actions available to an end user
// by the consumer of this library.
//
typedef struct {
  //
  // Indicates if the disk can support PSID Revert action.  should verify disk supports PSID authority
  //
  UINT16    PsidRevert           : 1;
 
  //
  // Indicates if the disk can support Revert action
  //
  UINT16    Revert               : 1;
 
  //
  // Indicates if the user must keep data for revert action.  It is true if no media encryption is supported.
  //
  UINT16    RevertKeepDataForced : 1;
 
  //
  // Indicates if the disk can support set Admin password
  //
  UINT16    AdminPass            : 1;
 
  //
  // Indicates if the disk can support set User password.  This action requires that a user
  // password is first enabled.
  //
  UINT16    UserPass             : 1;
 
  //
  // Indicates if unlock action is available.  Requires disk to be currently locked.
  //
  UINT16    Unlock               : 1;
 
  //
  // Indicates if Secure Erase action is available.  Action requires admin credentials and media encryption support.
  //
  UINT16    SecureErase          : 1;
 
  //
  // Indicates if Disable User action is available.  Action requires admin credentials.
  //
  UINT16    DisableUser          : 1;
} OPAL_DISK_ACTIONS;
 
//
// Structure that is used to represent an OPAL_DISK.
//
typedef struct {
  UINT32                                   MsidLength;                    // Byte length of MSID Pin for device
  UINT8                                    Msid[OPAL_MSID_LENGTH];        // MSID Pin for device
  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL    *Sscp;
  UINT32                                   MediaId;                       // MediaId is used by Ssc Protocol.
  EFI_DEVICE_PATH_PROTOCOL                 *OpalDevicePath;
  UINT16                                   OpalBaseComId;                 // Opal SSC 1 base com id.
  OPAL_OWNER_SHIP                          Owner;
  OPAL_DISK_SUPPORT_ATTRIBUTE              SupportedAttributes;
  TCG_LOCKING_FEATURE_DESCRIPTOR           LockingFeature;                // Locking Feature Descriptor retrieved from performing a Level 0 Discovery
  UINT8                                    PasswordLength;
  UINT8                                    Password[OPAL_MAX_PASSWORD_SIZE];
 
  UINT32                                   EstimateTimeCost;
  BOOLEAN                                  SentBlockSID;                  // Check whether BlockSid command has been sent.
} OPAL_DISK;
 
//
// Device with block IO protocol
//
typedef struct _OPAL_DRIVER_DEVICE OPAL_DRIVER_DEVICE;
 
struct _OPAL_DRIVER_DEVICE {
  OPAL_DRIVER_DEVICE                       *Next;                     
  EFI_HANDLE                               Handle;                    
  OPAL_DISK                                OpalDisk;                  
  CHAR16                                   *Name16;                   
  CHAR8                                    *NameZ;                    
  UINT32                                   MediaId;                   
 
  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL    *Sscp;                     
  EFI_DEVICE_PATH_PROTOCOL                 *OpalDevicePath;
};
 
//
// Opal Driver UEFI Driver Model
//
typedef struct {
  EFI_HANDLE            Handle;             
  OPAL_DRIVER_DEVICE    *DeviceList;        
} OPAL_DRIVER;
 
#pragma pack()
 
//
// Retrieves a OPAL_DRIVER_DEVICE based on the pointer to its StorageSecurity protocol.
//
#define DRIVER_DEVICE_FROM_OPALDISK(OpalDiskPointer)  (OPAL_DRIVER_DEVICE*)(BASE_CR(OpalDiskPointer, OPAL_DRIVER_DEVICE, OpalDisk))
 
OPAL_DRIVER_DEVICE *
OpalDriverGetDeviceList (
  VOID
  );
 
BOOLEAN
OpalDriverGetDriverDeviceName (
  OPAL_DRIVER_DEVICE  *Dev
  );
 
UINT8
GetDeviceCount (
  VOID
  );
 
VOID
OpalSupportUpdatePassword (
  IN OUT OPAL_DISK  *OpalDisk,
  IN VOID           *Password,
  IN UINT32         PasswordLength
  );
 
TCG_RESULT
EFIAPI
OpalSupportGetAvailableActions (
  IN  OPAL_DISK_SUPPORT_ATTRIBUTE     *SupportedAttributes,
  IN  TCG_LOCKING_FEATURE_DESCRIPTOR  *LockingFeature,
  IN  UINT16                          OwnerShip,
  OUT OPAL_DISK_ACTIONS               *AvalDiskActions
  );
 
TCG_RESULT
EFIAPI
OpalSupportEnableOpalFeature (
  IN OPAL_SESSION  *Session,
  IN VOID          *Msid,
  IN UINT32        MsidLength,
  IN VOID          *Password,
  IN UINT32        PassLength
  );
 
EFI_STATUS
EFIAPI
EfiDriverUnload (
  EFI_HANDLE  ImageHandle
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverBindingSupported (
  EFI_DRIVER_BINDING_PROTOCOL  *This,
  EFI_HANDLE                   Controller,
  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverBindingStart (
  EFI_DRIVER_BINDING_PROTOCOL  *This,
  EFI_HANDLE                   Controller,
  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverBindingStop (
  EFI_DRIVER_BINDING_PROTOCOL  *This,
  EFI_HANDLE                   Controller,
  UINTN                        NumberOfChildren,
  EFI_HANDLE                   *ChildHandleBuffer
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverComponentNameGetDriverName (
  EFI_COMPONENT_NAME_PROTOCOL  *This,
  CHAR8                        *Language,
  CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverComponentNameGetControllerName (
  EFI_COMPONENT_NAME_PROTOCOL  *This,
  EFI_HANDLE                   ControllerHandle,
  EFI_HANDLE                   ChildHandle,
  CHAR8                        *Language,
  CHAR16                       **ControllerName
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverComponentName2GetDriverName (
  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  CHAR8                         *Language,
  CHAR16                        **DriverName
  );
 
EFI_STATUS
EFIAPI
OpalEfiDriverComponentName2GetControllerName (
  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  EFI_HANDLE                    ControllerHandle,
  EFI_HANDLE                    ChildHandle,
  CHAR8                         *Language,
  CHAR16                        **ControllerName
  );
 
#endif //_OPAL_DRIVER_H_