#include "OpalPasswordPei.h"

Functions
EFI_STATUS EFIAPI	SecurityReceiveData (IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Timeout, IN UINT8 SecurityProtocolId, IN UINT16 SecurityProtocolSpecificData, IN UINTN PayloadBufferSize, OUT VOID PayloadBuffer, OUT UINTN *PayloadTransferSize)

EFI_STATUS EFIAPI	SecuritySendData (IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL This, IN UINT32 MediaId, IN UINT64 Timeout, IN UINT8 SecurityProtocolId, IN UINT16 SecurityProtocolSpecificData, IN UINTN PayloadBufferSize, IN VOID PayloadBuffer)

BOOLEAN	IsOpalDeviceLocked (OPAL_PEI_DEVICE OpalDev, BOOLEAN BlockSidSupported)

VOID	UnlockOpalPassword (IN OPAL_PEI_DEVICE *OpalDev)

VOID	UnlockOpalPasswordDevices (IN EDKII_PEI_STORAGE_SECURITY_CMD_PPI *SscPpi)

EFI_STATUS EFIAPI	OpalPasswordStorageSecurityPpiNotify (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR NotifyDesc, IN VOID *Ppi)

EFI_STATUS EFIAPI	OpalPasswordPeiInit (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Variables
EFI_GUID	mOpalDeviceLockBoxGuid = OPAL_DEVICE_LOCKBOX_GUID

EFI_PEI_NOTIFY_DESCRIPTOR	mOpalPasswordStorageSecurityPpiNotifyDesc

Detailed Description

Opal Password PEI driver which is used to unlock Opal Password for S3.

Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file OpalPasswordPei.c.

Function Documentation

◆ IsOpalDeviceLocked()

BOOLEAN IsOpalDeviceLocked	(	OPAL_PEI_DEVICE *	OpalDev,
		BOOLEAN *	BlockSidSupported
	)

The function returns whether or not the device is Opal Locked. TRUE means that the device is partially or fully locked. This will perform a Level 0 Discovery and parse the locking feature descriptor

Parameters

[in]	OpalDev	Opal object to determine if locked.
[out]	BlockSidSupported	Whether device support BlockSid feature.

Definition at line 223 of file OpalPasswordPei.c.

◆ OpalPasswordPeiInit()

EFI_STATUS EFIAPI OpalPasswordPeiInit	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Main entry for this module.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Pointer to PEI Services table.

Returns: Status from PeiServicesNotifyPpi.

Definition at line 460 of file OpalPasswordPei.c.

◆ OpalPasswordStorageSecurityPpiNotify()

EFI_STATUS EFIAPI OpalPasswordStorageSecurityPpiNotify	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyDesc,
		IN VOID *	Ppi
	)

One notified function at the installation of EDKII_PEI_STORAGE_SECURITY_CMD_PPI. It is to unlock OPAL password for S3.

Parameters

[in]	PeiServices	Indirect reference to the PEI Services Table.
[in]	NotifyDescriptor	Address of the notification descriptor data structure.
[in]	Ppi	Address of the PPI that was installed.

Returns: Status of the notification. The status code returned from this function is ignored.

Definition at line 428 of file OpalPasswordPei.c.

◆ SecurityReceiveData()

EFI_STATUS EFIAPI SecurityReceiveData	(	IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Timeout,
		IN UINT8	SecurityProtocolId,
		IN UINT16	SecurityProtocolSpecificData,
		IN UINTN	PayloadBufferSize,
		OUT VOID *	PayloadBuffer,
		OUT UINTN *	PayloadTransferSize
	)

Send a security protocol command to a device that receives data and/or the result of one or more commands sent by SendData.

The ReceiveData function sends a security protocol command to the given MediaId. The security protocol command sent is defined by SecurityProtocolId and contains the security protocol specific data SecurityProtocolSpecificData. The function returns the data from the security protocol command in PayloadBuffer.

For devices supporting the SCSI command set, the security protocol command is sent using the SECURITY PROTOCOL IN command defined in SPC-4.

For devices supporting the ATA command set, the security protocol command is sent using one of the TRUSTED RECEIVE commands defined in ATA8-ACS if PayloadBufferSize is non-zero.

If the PayloadBufferSize is zero, the security protocol command is sent using the Trusted Non-Data command defined in ATA8-ACS.

If PayloadBufferSize is too small to store the available data from the security protocol command, the function shall copy PayloadBufferSize bytes into the PayloadBuffer and return EFI_WARN_BUFFER_TOO_SMALL.

If PayloadBuffer or PayloadTransferSize is NULL and PayloadBufferSize is non-zero, the function shall return EFI_INVALID_PARAMETER.

If the given MediaId does not support security protocol commands, the function shall return EFI_UNSUPPORTED. If there is no media in the device, the function returns EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the device, the function returns EFI_MEDIA_CHANGED.

If the security protocol fails to complete within the Timeout period, the function shall return EFI_TIMEOUT.

If the security protocol command completes without an error, the function shall return EFI_SUCCESS. If the security protocol command completes with an error, the function shall return EFI_DEVICE_ERROR.

Parameters

This	Indicates a pointer to the calling context.
MediaId	ID of the medium to receive data from. If there is no block IO protocol supported by the physical device, the value of MediaId is undefined.
Timeout	The timeout, in 100ns units, to use for the execution of the security protocol command. A Timeout value of 0 means that this function will wait indefinitely for the security protocol command to execute. If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the receive data command is greater than Timeout.
SecurityProtocolId	The value of the "Security Protocol" parameter of the security protocol command to be sent.
SecurityProtocolSpecificData	The value of the "Security Protocol Specific" parameter of the security protocol command to be sent.
PayloadBufferSize	Size in bytes of the payload data buffer.
PayloadBuffer	A pointer to a destination buffer to store the security protocol command specific payload data for the security protocol command. The caller is responsible for having either implicit or explicit ownership of the buffer.
PayloadTransferSize	A pointer to a buffer to store the size in bytes of the data written to the payload data buffer.

Return values

EFI_SUCCESS	The security protocol command completed successfully.
EFI_WARN_BUFFER_TOO_SMALL	The PayloadBufferSize was too small to store the available data from the device. The PayloadBuffer contains the truncated data.
EFI_UNSUPPORTED	The given MediaId does not support security protocol commands.
EFI_DEVICE_ERROR	The security protocol command completed with an error.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.
EFI_INVALID_PARAMETER	The PayloadBuffer or PayloadTransferSize is NULL and PayloadBufferSize is non-zero.
EFI_TIMEOUT	A timeout occurred while waiting for the security protocol command to execute.

Definition at line 89 of file OpalPasswordPei.c.

◆ SecuritySendData()

EFI_STATUS EFIAPI SecuritySendData	(	IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN UINT64	Timeout,
		IN UINT8	SecurityProtocolId,
		IN UINT16	SecurityProtocolSpecificData,
		IN UINTN	PayloadBufferSize,
		IN VOID *	PayloadBuffer
	)

Send a security protocol command to a device.

The SendData function sends a security protocol command containing the payload PayloadBuffer to the given MediaId. The security protocol command sent is defined by SecurityProtocolId and contains the security protocol specific data SecurityProtocolSpecificData. If the underlying protocol command requires a specific padding for the command payload, the SendData function shall add padding bytes to the command payload to satisfy the padding requirements.

For devices supporting the SCSI command set, the security protocol command is sent using the SECURITY PROTOCOL OUT command defined in SPC-4.

For devices supporting the ATA command set, the security protocol command is sent using one of the TRUSTED SEND commands defined in ATA8-ACS if PayloadBufferSize is non-zero. If the PayloadBufferSize is zero, the security protocol command is sent using the Trusted Non-Data command defined in ATA8-ACS.

If PayloadBuffer is NULL and PayloadBufferSize is non-zero, the function shall return EFI_INVALID_PARAMETER.

If the given MediaId does not support security protocol commands, the function shall return EFI_UNSUPPORTED. If there is no media in the device, the function returns EFI_NO_MEDIA. If the MediaId is not the ID for the current media in the device, the function returns EFI_MEDIA_CHANGED.

If the security protocol fails to complete within the Timeout period, the function shall return EFI_TIMEOUT.

If the security protocol command completes without an error, the function shall return EFI_SUCCESS. If the security protocol command completes with an error, the function shall return EFI_DEVICE_ERROR.

Parameters

This	Indicates a pointer to the calling context.
MediaId	ID of the medium to receive data from. If there is no block IO protocol supported by the physical device, the value of MediaId is undefined.
Timeout	The timeout, in 100ns units, to use for the execution of the security protocol command. A Timeout value of 0 means that this function will wait indefinitely for the security protocol command to execute. If Timeout is greater than zero, then this function will return EFI_TIMEOUT if the time required to execute the send data command is greater than Timeout.
SecurityProtocolId	The value of the "Security Protocol" parameter of the security protocol command to be sent.
SecurityProtocolSpecificData	The value of the "Security Protocol Specific" parameter of the security protocol command to be sent.
PayloadBufferSize	Size in bytes of the payload data buffer.
PayloadBuffer	A pointer to a destination buffer to store the security protocol command specific payload data for the security protocol command.

Return values

EFI_SUCCESS	The security protocol command completed successfully.
EFI_UNSUPPORTED	The given MediaId does not support security protocol commands.
EFI_DEVICE_ERROR	The security protocol command completed with an error.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.
EFI_INVALID_PARAMETER	The PayloadBuffer is NULL and PayloadBufferSize is non-zero.
EFI_TIMEOUT	A timeout occurred while waiting for the security protocol command to execute.

Definition at line 184 of file OpalPasswordPei.c.

◆ UnlockOpalPassword()

VOID UnlockOpalPassword ( IN OPAL_PEI_DEVICE * OpalDev )

Unlock OPAL password for S3.

Parameters

[in] OpalDev Opal object to unlock.

Definition at line 260 of file OpalPasswordPei.c.

◆ UnlockOpalPasswordDevices()

VOID UnlockOpalPasswordDevices ( IN EDKII_PEI_STORAGE_SECURITY_CMD_PPI * SscPpi )

Unlock the OPAL NVM Express and ATA devices for S3.

Parameters

[in] SscPpi Pointer to the EDKII_PEI_STORAGE_SECURITY_CMD_PPI instance.

Definition at line 322 of file OpalPasswordPei.c.

Variable Documentation

◆ mOpalDeviceLockBoxGuid

EFI_GUID mOpalDeviceLockBoxGuid = OPAL_DEVICE_LOCKBOX_GUID

Definition at line 11 of file OpalPasswordPei.c.

◆ mOpalPasswordStorageSecurityPpiNotifyDesc

EFI_PEI_NOTIFY_DESCRIPTOR mOpalPasswordStorageSecurityPpiNotifyDesc

Initial value:

= {
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  &gEdkiiPeiStorageSecurityCommandPpiGuid,
  OpalPasswordStorageSecurityPpiNotify
}

Definition at line 443 of file OpalPasswordPei.c.

Functions

Variables

Detailed Description

Function Documentation

◆ IsOpalDeviceLocked()

◆ OpalPasswordPeiInit()

◆ OpalPasswordStorageSecurityPpiNotify()

◆ SecurityReceiveData()

◆ SecuritySendData()

◆ UnlockOpalPassword()

◆ UnlockOpalPasswordDevices()

Variable Documentation

◆ mOpalDeviceLockBoxGuid

◆ mOpalPasswordStorageSecurityPpiNotifyDesc