|
MdeModulePkg[all]
0.98
|
|
MdeModulePkg[all]
0.98
|
Data Structures | |
| struct | _EDKII_PEI_STORAGE_SECURITY_CMD_PPI |
Macros | |
| #define | EDKII_PEI_STORAGE_SECURITY_CMD_PPI_GUID |
| #define | EDKII_STORAGE_SECURITY_PPI_REVISION 0x00010000 |
Typedefs | |
| typedef struct _EDKII_PEI_STORAGE_SECURITY_CMD_PPI | EDKII_PEI_STORAGE_SECURITY_CMD_PPI |
| typedef OUT UINTN * | NumberofDevices |
| typedef IN UINTN | DeviceIndex |
| typedef IN UINTN OUT UINTN * | DevicePathLength |
| typedef IN UINTN OUT UINTN OUT EFI_DEVICE_PATH_PROTOCOL ** | DevicePath |
| typedef IN UINTN IN UINT64 | Timeout |
| typedef IN UINTN IN UINT64 IN UINT8 | SecurityProtocolId |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 | SecurityProtocolSpecificData |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 IN UINTN | PayloadBufferSize |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 IN UINTN OUT VOID * | PayloadBuffer |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 IN UINTN OUT VOID OUT UINTN * | PayloadTransferSize |
Functions | |
| typedef | EFI_STATUS (EFIAPI *EDKII_PEI_STORAGE_SECURITY_GET_NUMBER_DEVICES)(IN EDKII_PEI_STORAGE_SECURITY_CMD_PPI *This |
Variables | |
| EFI_GUID | gEdkiiPeiStorageSecurityCommandPpiGuid |
Copyright (c) 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define EDKII_PEI_STORAGE_SECURITY_CMD_PPI_GUID |
Global ID for the EDKII_PEI_STORAGE_SECURITY_CMD_PPI.
| #define EDKII_STORAGE_SECURITY_PPI_REVISION 0x00010000 |
| typedef IN UINTN DeviceIndex |
| typedef IN UINTN OUT UINTN OUT EFI_DEVICE_PATH_PROTOCOL** DevicePath |
| typedef IN UINTN OUT UINTN* DevicePathLength |
| typedef OUT UINTN* NumberofDevices |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 IN UINTN IN VOID * PayloadBuffer |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 IN UINTN PayloadBufferSize |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 IN UINTN OUT VOID OUT UINTN* PayloadTransferSize |
| typedef IN UINTN IN UINT64 IN UINT8 SecurityProtocolId |
| typedef IN UINTN IN UINT64 IN UINT8 IN UINT16 SecurityProtocolSpecificData |
| typedef EFI_STATUS | ( | EFIAPI * | EDKII_PEI_STORAGE_SECURITY_SEND_DATA | ) |
Gets the count of storage security devices that one specific driver detects.
| [in] | This | The PPI instance pointer. |
| [out] | NumberofDevices | The number of storage security devices discovered. |
| EFI_SUCCESS | The operation performed successfully. |
| EFI_INVALID_PARAMETER | The parameters are invalid. |
Gets the device path of a specific storage security device.
| [in] | This | The PPI instance pointer. |
| [in] | DeviceIndex | Specifies the storage security device to which the function wants to talk. Because the driver that implements Storage Security Command PPIs will manage multiple storage devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberofDevices. |
| [out] | DevicePathLength | The length of the device path in bytes specified by DevicePath. |
| [out] | DevicePath | The device path of storage security device. This field re-uses EFI Device Path Protocol as defined by Section 10.2 EFI Device Path Protocol of UEFI 2.7 Specification. |
| EFI_SUCCESS | The operation succeeds. |
| EFI_INVALID_PARAMETER | DevicePathLength or DevicePath is NULL. |
| EFI_NOT_FOUND | The specified storage security device not found. |
| EFI_OUT_OF_RESOURCES | The operation fails due to lack of resources. |
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 DeviceIndex. 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 DeviceIndex does not support security protocol commands, the function shall return EFI_UNSUPPORTED.
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.
| [in] | This | The PPI instance pointer. |
| [in] | DeviceIndex | Specifies the storage security device to which the function wants to talk. Because the driver that implements Storage Security Command PPIs will manage multiple storage devices, the PPIs that want to talk to a single device must specify the device index that was assigned during the enumeration process. This index is a number from one to NumberofDevices. |
| [in] | 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. |
| [in] | SecurityProtocolId | The value of the "Security Protocol" parameter of the security protocol command to be sent. |
| [in] | SecurityProtocolSpecificData | The value of the "Security Protocol Specific" parameter of the security protocol command to be sent. |
| [in] | PayloadBufferSize | Size in bytes of the payload data buffer. |
| [out] | 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. |
| [out] | PayloadTransferSize | A pointer to a buffer to store the size in bytes of the data written to the payload data buffer. |
| 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 DeviceIndex does not support security protocol commands. |
| EFI_DEVICE_ERROR | The security protocol command completed with an error. |
| 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. |
Send a security protocol command to a device.
The SendData function sends a security protocol command containing the payload PayloadBuffer to the given DeviceIndex. 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 DeviceIndex does not support security protocol commands, the function shall return EFI_UNSUPPORTED.
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 functio shall return EFI_DEVICE_ERROR.
| [in] | This | The PPI instance pointer. |
| [in] | DeviceIndex | The ID of the device. |
| [in] | 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. |
| [in] | SecurityProtocolId | The value of the "Security Protocol" parameter of the security protocol command to be sent. |
| [in] | SecurityProtocolSpecificData | The value of the "Security Protocol Specific" parameter of the security protocol command to be sent. |
| [in] | PayloadBufferSize | Size in bytes of the payload data buffer. |
| [in] | PayloadBuffer | A pointer to a destination buffer to store the security protocol command specific payload data for the security protocol command. |
| EFI_SUCCESS | The security protocol command completed successfully. |
| EFI_UNSUPPORTED | The given DeviceIndex does not support security protocol commands. |
| EFI_DEVICE_ERROR | The security protocol command completed with an error. |
| 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. |
| EFI_GUID gEdkiiPeiStorageSecurityCommandPpiGuid |
1.8.6 
