SecurityPkg: Clean up source files

[mirror_edk2.git] / SecurityPkg / Tcg / Opal / OpalPassword / OpalDriver.h

/** @file\r
  Values defined and used by the Opal UEFI Driver.\r
\r
Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _OPAL_DRIVER_H_\r
#define _OPAL_DRIVER_H_\r
\r
#include <PiDxe.h>\r
\r
#include <IndustryStandard/Pci.h>\r
\r
#include <Protocol/PciIo.h>\r
#include <Protocol/SmmCommunication.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/DevicePathToText.h>\r
#include <Protocol/StorageSecurityCommand.h>\r
\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/UefiLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/PciLib.h>\r
#include <Library/S3BootScriptLib.h>\r
#include <Library/LockBoxLib.h>\r
#include <Library/TcgStorageOpalLib.h>\r
#include <Library/Tcg2PhysicalPresenceLib.h>\r
\r
#include "OpalPasswordCommon.h"\r
#include "OpalHiiFormValues.h"\r
\r
#define EFI_DRIVER_NAME_UNICODE L"1.0 UEFI Opal Driver"\r
\r
// UEFI 2.1\r
#define LANGUAGE_RFC_3066_ENGLISH ((CHAR8*)"en")\r
\r
// UEFI/EFI < 2.1\r
#define LANGUAGE_ISO_639_2_ENGLISH ((CHAR8*)"eng")\r
\r
#define CONCAT_(x, y) x ## y\r
#define CONCAT(x, y) CONCAT_(x, y)\r
\r
#define UNICODE_STR(x) CONCAT( L, x )\r
\r
extern EFI_DRIVER_BINDING_PROTOCOL   gOpalDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gOpalComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gOpalComponentName2;\r
\r
#define OPAL_MSID_LENGHT        128\r
\r
#define MAX_PASSWORD_TRY_COUNT  5\r
\r
// PSID Length\r
#define PSID_CHARACTER_LENGTH   0x20\r
#define MAX_PSID_TRY_COUNT      5\r
\r
//\r
// The max timeout value assume the user can wait for the revert action. The unit of this macro is second.\r
// If the revert time value bigger than this one, driver needs to popup a dialog to let user confirm the\r
// revert action.\r
//\r
#define MAX_ACCEPTABLE_REVERTING_TIME    10\r
\r
#pragma pack(1)\r
\r
//\r
// Structure that is used to represent the available actions for an OpalDisk.\r
// The data can then be utilized to expose/hide certain actions available to an end user\r
// by the consumer of this library.\r
//\r
typedef struct {\r
    //\r
    // Indicates if the disk can support PSID Revert action.  should verify disk supports PSID authority\r
    //\r
    UINT16 PsidRevert : 1;\r
\r
    //\r
    // Indicates if the disk can support Revert action\r
    //\r
    UINT16 Revert : 1;\r
\r
    //\r
    // Indicates if the user must keep data for revert action.  It is true if no media encryption is supported.\r
    //\r
    UINT16 RevertKeepDataForced : 1;\r
\r
    //\r
    // Indicates if the disk can support set Admin password\r
    //\r
    UINT16 AdminPass : 1;\r
\r
    //\r
    // Indicates if the disk can support set User password.  This action requires that a user\r
    // password is first enabled.\r
    //\r
    UINT16 UserPass : 1;\r
\r
    //\r
    // Indicates if unlock action is available.  Requires disk to be currently locked.\r
    //\r
    UINT16 Unlock : 1;\r
\r
    //\r
    // Indicates if Secure Erase action is available.  Action requires admin credentials and media encryption support.\r
    //\r
    UINT16 SecureErase : 1;\r
\r
    //\r
    // Indicates if Disable User action is available.  Action requires admin credentials.\r
    //\r
    UINT16 DisableUser : 1;\r
} OPAL_DISK_ACTIONS;\r
\r
//\r
// Structure that is used to represent an OPAL_DISK.\r
//\r
typedef struct {\r
  UINT32                                          MsidLength;             // Byte length of MSID Pin for device\r
  UINT8                                           Msid[OPAL_MSID_LENGHT]; // MSID Pin for device\r
  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL           *Sscp;\r
  UINT32                                          MediaId;                // MediaId is used by Ssc Protocol.\r
  EFI_DEVICE_PATH_PROTOCOL                        *OpalDevicePath;\r
  UINT16                                          OpalBaseComId;          // Opal SSC 1 base com id.\r
  OPAL_OWNER_SHIP                                 Owner;\r
  OPAL_DISK_SUPPORT_ATTRIBUTE                     SupportedAttributes;\r
  TCG_LOCKING_FEATURE_DESCRIPTOR                  LockingFeature;         // Locking Feature Descriptor retrieved from performing a Level 0 Discovery\r
  UINT8                                           PasswordLength;\r
  UINT8                                           Password[OPAL_MAX_PASSWORD_SIZE];\r
\r
  UINT32                                          EstimateTimeCost;\r
} OPAL_DISK;\r
\r
//\r
// Device with block IO protocol\r
//\r
typedef struct _OPAL_DRIVER_DEVICE OPAL_DRIVER_DEVICE;\r
\r
struct _OPAL_DRIVER_DEVICE {\r
  OPAL_DRIVER_DEVICE                              *Next;              ///< Linked list pointer\r
  EFI_HANDLE                                      Handle;             ///< Device handle\r
  OPAL_DISK                                       OpalDisk;           ///< User context\r
  CHAR16                                          *Name16;            ///< Allocated/freed by UEFI Filter Driver at device creation/removal\r
  CHAR8                                           *NameZ;             ///< Allocated/freed by UEFI Filter Driver at device creation/removal\r
  UINT32                                          MediaId;            ///< Required parameter for EFI_STORAGE_SECURITY_COMMAND_PROTOCOL, from BLOCK_IO_MEDIA\r
\r
  EFI_STORAGE_SECURITY_COMMAND_PROTOCOL           *Sscp;              /// Device protocols consumed\r
  EFI_DEVICE_PATH_PROTOCOL                        *OpalDevicePath;\r
};\r
\r
//\r
// Opal Driver UEFI Driver Model\r
//\r
typedef struct {\r
  EFI_HANDLE           Handle;              ///< Driver image handle\r
  OPAL_DRIVER_DEVICE   *DeviceList;         ///< Linked list of controllers owned by this Driver\r
} OPAL_DRIVER;\r
\r
#pragma pack()\r
\r
//\r
// Retrieves a OPAL_DRIVER_DEVICE based on the pointer to its StorageSecurity protocol.\r
//\r
#define DRIVER_DEVICE_FROM_OPALDISK(OpalDiskPointer) (OPAL_DRIVER_DEVICE*)(BASE_CR(OpalDiskPointer, OPAL_DRIVER_DEVICE, OpalDisk))\r
\r
/**\r
  Get devcie list info.\r
\r
  @retval     return the device list pointer.\r
**/\r
OPAL_DRIVER_DEVICE*\r
OpalDriverGetDeviceList(\r
  VOID\r
  );\r
\r
/**\r
  Get devcie name through the component name protocol.\r
\r
  @param[in]       Dev                The device which need to get name.\r
\r
  @retval     TRUE        Find the name for this device.\r
  @retval     FALSE       Not found the name for this device.\r
**/\r
BOOLEAN\r
OpalDriverGetDriverDeviceName(\r
  OPAL_DRIVER_DEVICE          *Dev\r
  );\r
\r
/**\r
  Get current device count.\r
\r
  @retval  return the current created device count.\r
\r
**/\r
UINT8\r
GetDeviceCount (\r
  VOID\r
  );\r
\r
/**\r
  Update password for the Opal disk.\r
\r
  @param[in, out] OpalDisk          The disk to update password.\r
  @param[in]      Password          The input password.\r
  @param[in]      PasswordLength    The input password length.\r
\r
**/\r
VOID\r
OpalSupportUpdatePassword (\r
  IN OUT OPAL_DISK      *OpalDisk,\r
  IN VOID               *Password,\r
  IN UINT32             PasswordLength\r
  );\r
\r
/**\r
\r
  The function performs determines the available actions for the OPAL_DISK provided.\r
\r
  @param[in]   SupportedAttributes   The support attribute for the device.\r
  @param[in]   LockingFeature        The locking status for the device.\r
  @param[in]   OwnerShip             The ownership for the device.\r
  @param[out]  AvalDiskActions       Pointer to fill-out with appropriate disk actions.\r
\r
**/\r
TCG_RESULT\r
EFIAPI\r
OpalSupportGetAvailableActions(\r
  IN  OPAL_DISK_SUPPORT_ATTRIBUTE      *SupportedAttributes,\r
  IN  TCG_LOCKING_FEATURE_DESCRIPTOR   *LockingFeature,\r
  IN  UINT16                           OwnerShip,\r
  OUT OPAL_DISK_ACTIONS                *AvalDiskActions\r
  );\r
\r
/**\r
  Enable Opal Feature for the input device.\r
\r
  @param[in]      Session            The opal session for the opal device.\r
  @param[in]      Msid               Msid\r
  @param[in]      MsidLength         Msid Length\r
  @param[in]      Password           Admin password\r
  @param[in]      PassLength         Length of password in bytes\r
\r
**/\r
TCG_RESULT\r
EFIAPI\r
OpalSupportEnableOpalFeature (\r
  IN OPAL_SESSION              *Session,\r
  IN VOID                      *Msid,\r
  IN UINT32                    MsidLength,\r
  IN VOID                      *Password,\r
  IN UINT32                    PassLength\r
  );\r
\r
/**\r
  Unloads UEFI Driver.  Very useful for debugging and testing.\r
\r
  @param ImageHandle            Image handle this driver.\r
\r
  @retval EFI_SUCCESS           This function always complete successfully.\r
  @retval EFI_INVALID_PARAMETER The input ImageHandle is not valid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDriverUnload(\r
  EFI_HANDLE ImageHandle\r
  );\r
\r
\r
/**\r
  Test to see if this driver supports Controller.\r
\r
  @param  This                Protocol instance pointer.\r
  @param  ControllerHandle    Handle of device to test\r
  @param  RemainingDevicePath Optional parameter use to pick a specific child\r
                              device to start.\r
\r
  @retval EFI_SUCCESS         This driver supports this device.\r
  @retval EFI_ALREADY_STARTED This driver is already running on this device.\r
  @retval other               This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverBindingSupported(\r
  EFI_DRIVER_BINDING_PROTOCOL*    This,\r
  EFI_HANDLE                      Controller,\r
  EFI_DEVICE_PATH_PROTOCOL*       RemainingDevicePath\r
  );\r
\r
/**\r
  Enables Opal Management on a supported device if available.\r
\r
  The start function is designed to be called after the Opal UEFI Driver has confirmed the\r
  "controller", which is a child handle, contains the EF_STORAGE_SECURITY_COMMAND protocols.\r
  This function will complete the other necessary checks, such as verifying the device supports\r
  the correct version of Opal.  Upon verification, it will add the device to the\r
  Opal HII list in order to expose Opal managmeent options.\r
\r
  @param[in]  This                  A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle      The handle of the controller to start. This handle\r
                                    must support a protocol interface that supplies\r
                                    an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath   A pointer to the remaining portion of a device path.  This\r
                                    parameter is ignored by device drivers, and is optional for bus\r
                                    drivers. For a bus driver, if this parameter is NULL, then handles\r
                                    for all the children of Controller are created by this driver.\r
                                    If this parameter is not NULL and the first Device Path Node is\r
                                    not the End of Device Path Node, then only the handle for the\r
                                    child device specified by the first Device Path Node of\r
                                    RemainingDevicePath is created by this driver.\r
                                    If the first Device Path Node of RemainingDevicePath is\r
                                    the End of Device Path Node, no child handle is created by this\r
                                    driver.\r
\r
  @retval EFI_SUCCESS               Opal management was enabled.\r
  @retval EFI_DEVICE_ERROR          The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES      The request could not be completed due to a lack of resources.\r
  @retval Others                    The driver failed to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverBindingStart(\r
  EFI_DRIVER_BINDING_PROTOCOL*    This,\r
  EFI_HANDLE                      Controller,\r
  EFI_DEVICE_PATH_PROTOCOL*       RemainingDevicePath\r
  );\r
\r
/**\r
  Stop this driver on Controller.\r
\r
  @param  This              Protocol instance pointer.\r
  @param  Controller        Handle of device to stop driver on\r
  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                            children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS       This driver is removed Controller.\r
  @retval other             This driver could not be removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverBindingStop(\r
  EFI_DRIVER_BINDING_PROTOCOL*    This,\r
  EFI_HANDLE                      Controller,\r
  UINTN                           NumberOfChildren,\r
  EFI_HANDLE*                     ChildHandleBuffer\r
  );\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverComponentNameGetDriverName(\r
  EFI_COMPONENT_NAME_PROTOCOL*    This,\r
  CHAR8*                          Language,\r
  CHAR16**                        DriverName\r
  );\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverComponentNameGetControllerName(\r
  EFI_COMPONENT_NAME_PROTOCOL*    This,\r
  EFI_HANDLE                      ControllerHandle,\r
  EFI_HANDLE                      ChildHandle,\r
  CHAR8*                          Language,\r
  CHAR16**                        ControllerName\r
  );\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverComponentName2GetDriverName(\r
  EFI_COMPONENT_NAME2_PROTOCOL*   This,\r
  CHAR8*                          Language,\r
  CHAR16**                        DriverName\r
  );\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OpalEfiDriverComponentName2GetControllerName(\r
  EFI_COMPONENT_NAME2_PROTOCOL*   This,\r
  EFI_HANDLE                      ControllerHandle,\r
  EFI_HANDLE                      ChildHandle,\r
  CHAR8*                          Language,\r
  CHAR16**                        ControllerName\r
  );\r
\r
#endif //_OPAL_DRIVER_H_\r