mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-12-01 12:53:27 +01:00
412 lines
20 KiB
C
412 lines
20 KiB
C
|
/** @file
|
||
|
|
Header file for EFI_BLOCK_IO_PROTOCOL interface.
|
||
|
|
|
||
|
|
Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved.<BR>
|
||
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef _EFI_NVME_BLOCKIO_H_
|
||
|
|
#define _EFI_NVME_BLOCKIO_H_
|
||
|
|
|
||
|
|
/**
|
||
|
|
Reset the Block Device.
|
||
|
|
|
||
|
|
@param This Indicates a pointer to the calling context.
|
||
|
|
@param ExtendedVerification Driver may perform diagnostics on reset.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The device was reset.
|
||
|
|
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
|
||
|
|
not be reset.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoReset (
|
||
|
|
IN EFI_BLOCK_IO_PROTOCOL *This,
|
||
|
|
IN BOOLEAN ExtendedVerification
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Read BufferSize bytes from Lba into Buffer.
|
||
|
|
|
||
|
|
@param This Indicates a pointer to the calling context.
|
||
|
|
@param MediaId Id of the media, changes every time the media is replaced.
|
||
|
|
@param Lba The starting Logical Block Address to read from
|
||
|
|
@param BufferSize Size of Buffer, must be a multiple of device block size.
|
||
|
|
@param Buffer A pointer to the destination buffer for the data. The caller is
|
||
|
|
responsible for either having implicit or explicit ownership of the buffer.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The data was read correctly from the device.
|
||
|
|
@retval EFI_DEVICE_ERROR The device reported an error while performing the read.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHANGED The MediaId does not matched the current device.
|
||
|
|
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
|
||
|
|
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
|
||
|
|
or the buffer is not on proper alignment.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoReadBlocks (
|
||
|
|
IN EFI_BLOCK_IO_PROTOCOL *This,
|
||
|
|
IN UINT32 MediaId,
|
||
|
|
IN EFI_LBA Lba,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
OUT VOID *Buffer
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Write BufferSize bytes from Lba into Buffer.
|
||
|
|
|
||
|
|
@param This Indicates a pointer to the calling context.
|
||
|
|
@param MediaId The media ID that the write request is for.
|
||
|
|
@param Lba The starting logical block address to be written. The caller is
|
||
|
|
responsible for writing to only legitimate locations.
|
||
|
|
@param BufferSize Size of Buffer, must be a multiple of device block size.
|
||
|
|
@param Buffer A pointer to the source buffer for the data.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The data was written correctly to the device.
|
||
|
|
@retval EFI_WRITE_PROTECTED The device can not be written to.
|
||
|
|
@retval EFI_DEVICE_ERROR The device reported an error while performing the write.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
|
||
|
|
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
|
||
|
|
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
|
||
|
|
or the buffer is not on proper alignment.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoWriteBlocks (
|
||
|
|
IN EFI_BLOCK_IO_PROTOCOL *This,
|
||
|
|
IN UINT32 MediaId,
|
||
|
|
IN EFI_LBA Lba,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN VOID *Buffer
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Flush the Block Device.
|
||
|
|
|
||
|
|
@param This Indicates a pointer to the calling context.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS All outstanding data was written to the device
|
||
|
|
@retval EFI_DEVICE_ERROR The device reported an error while writing back the data
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoFlushBlocks (
|
||
|
|
IN EFI_BLOCK_IO_PROTOCOL *This
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Reset the block device hardware.
|
||
|
|
|
||
|
|
@param[in] This Indicates a pointer to the calling context.
|
||
|
|
@param[in] ExtendedVerification Indicates that the driver may perform a more
|
||
|
|
exhausive verfication operation of the
|
||
|
|
device during reset.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The device was reset.
|
||
|
|
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
|
||
|
|
not be reset.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoResetEx (
|
||
|
|
IN EFI_BLOCK_IO2_PROTOCOL *This,
|
||
|
|
IN BOOLEAN ExtendedVerification
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Read BufferSize bytes from Lba into Buffer.
|
||
|
|
|
||
|
|
This function reads the requested number of blocks from the device. All the
|
||
|
|
blocks are read, or an error is returned.
|
||
|
|
If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and
|
||
|
|
non-blocking I/O is being used, the Event associated with this request will
|
||
|
|
not be signaled.
|
||
|
|
|
||
|
|
@param[in] This Indicates a pointer to the calling context.
|
||
|
|
@param[in] MediaId Id of the media, changes every time the media is
|
||
|
|
replaced.
|
||
|
|
@param[in] Lba The starting Logical Block Address to read from.
|
||
|
|
@param[in, out] Token A pointer to the token associated with the
|
||
|
|
transaction.
|
||
|
|
@param[in] BufferSize Size of Buffer, must be a multiple of device
|
||
|
|
block size.
|
||
|
|
@param[out] Buffer A pointer to the destination buffer for the data.
|
||
|
|
The caller is responsible for either having
|
||
|
|
implicit or explicit ownership of the buffer.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The read request was queued if Token->Event is
|
||
|
|
not NULL.The data was read correctly from the
|
||
|
|
device if the Token->Event is NULL.
|
||
|
|
@retval EFI_DEVICE_ERROR The device reported an error while performing
|
||
|
|
the read.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
|
||
|
|
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
|
||
|
|
the intrinsic block size of the device.
|
||
|
|
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not
|
||
|
|
valid, or the buffer is not on proper
|
||
|
|
alignment.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
|
||
|
|
lack of resources.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoReadBlocksEx (
|
||
|
|
IN EFI_BLOCK_IO2_PROTOCOL *This,
|
||
|
|
IN UINT32 MediaId,
|
||
|
|
IN EFI_LBA Lba,
|
||
|
|
IN OUT EFI_BLOCK_IO2_TOKEN *Token,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
OUT VOID *Buffer
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Write BufferSize bytes from Lba into Buffer.
|
||
|
|
|
||
|
|
This function writes the requested number of blocks to the device. All blocks
|
||
|
|
are written, or an error is returned.If EFI_DEVICE_ERROR, EFI_NO_MEDIA,
|
||
|
|
EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is
|
||
|
|
being used, the Event associated with this request will not be signaled.
|
||
|
|
|
||
|
|
@param[in] This Indicates a pointer to the calling context.
|
||
|
|
@param[in] MediaId The media ID that the write request is for.
|
||
|
|
@param[in] Lba The starting logical block address to be written.
|
||
|
|
The caller is responsible for writing to only
|
||
|
|
legitimate locations.
|
||
|
|
@param[in, out] Token A pointer to the token associated with the
|
||
|
|
transaction.
|
||
|
|
@param[in] BufferSize Size of Buffer, must be a multiple of device
|
||
|
|
block size.
|
||
|
|
@param[in] Buffer A pointer to the source buffer for the data.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The write request was queued if Event is not
|
||
|
|
NULL.
|
||
|
|
The data was written correctly to the device if
|
||
|
|
the Event is NULL.
|
||
|
|
@retval EFI_WRITE_PROTECTED The device can not be written to.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current
|
||
|
|
device.
|
||
|
|
@retval EFI_DEVICE_ERROR The device reported an error while performing
|
||
|
|
the write.
|
||
|
|
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size
|
||
|
|
of the device.
|
||
|
|
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not
|
||
|
|
valid, or the buffer is not on proper
|
||
|
|
alignment.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
|
||
|
|
lack of resources.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoWriteBlocksEx (
|
||
|
|
IN EFI_BLOCK_IO2_PROTOCOL *This,
|
||
|
|
IN UINT32 MediaId,
|
||
|
|
IN EFI_LBA Lba,
|
||
|
|
IN OUT EFI_BLOCK_IO2_TOKEN *Token,
|
||
|
|
IN UINTN BufferSize,
|
||
|
|
IN VOID *Buffer
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Flush the Block Device.
|
||
|
|
|
||
|
|
If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED
|
||
|
|
is returned and non-blocking I/O is being used, the Event associated with
|
||
|
|
this request will not be signaled.
|
||
|
|
|
||
|
|
@param[in] This Indicates a pointer to the calling context.
|
||
|
|
@param[in,out] Token A pointer to the token associated with the
|
||
|
|
transaction.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The flush request was queued if Event is not
|
||
|
|
NULL.
|
||
|
|
All outstanding data was written correctly to
|
||
|
|
the device if the Event is NULL.
|
||
|
|
@retval EFI_DEVICE_ERROR The device reported an error while writting back
|
||
|
|
the data.
|
||
|
|
@retval EFI_WRITE_PROTECTED The device cannot be written to.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
|
||
|
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack
|
||
|
|
of resources.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeBlockIoFlushBlocksEx (
|
||
|
|
IN EFI_BLOCK_IO2_PROTOCOL *This,
|
||
|
|
IN OUT EFI_BLOCK_IO2_TOKEN *Token
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
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.
|
||
|
|
|
||
|
|
@param This Indicates a pointer to the calling context.
|
||
|
|
@param MediaId ID of the medium to receive data from.
|
||
|
|
@param 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.
|
||
|
|
@param SecurityProtocolId The value of the "Security Protocol" parameter of
|
||
|
|
the security protocol command to be sent.
|
||
|
|
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
|
||
|
|
of the security protocol command to be sent.
|
||
|
|
@param PayloadBufferSize Size in bytes of the payload data buffer.
|
||
|
|
@param 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.
|
||
|
|
@param PayloadTransferSize A pointer to a buffer to store the size in bytes of the
|
||
|
|
data written to the payload data buffer.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The security protocol command completed successfully.
|
||
|
|
@retval EFI_WARN_BUFFER_TOO_SMALL The PayloadBufferSize was too small to store the available
|
||
|
|
data from the device. The PayloadBuffer contains the truncated data.
|
||
|
|
@retval EFI_UNSUPPORTED The given MediaId does not support security protocol commands.
|
||
|
|
@retval EFI_DEVICE_ERROR The security protocol command completed with an error.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
|
||
|
|
@retval EFI_INVALID_PARAMETER The PayloadBuffer or PayloadTransferSize is NULL and
|
||
|
|
PayloadBufferSize is non-zero.
|
||
|
|
@retval EFI_TIMEOUT A timeout occurred while waiting for the security
|
||
|
|
protocol command to execute.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeStorageSecurityReceiveData (
|
||
|
|
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.
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
@param This Indicates a pointer to the calling context.
|
||
|
|
@param MediaId ID of the medium to receive data from.
|
||
|
|
@param 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.
|
||
|
|
@param SecurityProtocolId The value of the "Security Protocol" parameter of
|
||
|
|
the security protocol command to be sent.
|
||
|
|
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
|
||
|
|
of the security protocol command to be sent.
|
||
|
|
@param PayloadBufferSize Size in bytes of the payload data buffer.
|
||
|
|
@param PayloadBuffer A pointer to a destination buffer to store the security
|
||
|
|
protocol command specific payload data for the security
|
||
|
|
protocol command.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The security protocol command completed successfully.
|
||
|
|
@retval EFI_UNSUPPORTED The given MediaId does not support security protocol commands.
|
||
|
|
@retval EFI_DEVICE_ERROR The security protocol command completed with an error.
|
||
|
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||
|
|
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
|
||
|
|
@retval EFI_INVALID_PARAMETER The PayloadBuffer is NULL and PayloadBufferSize is non-zero.
|
||
|
|
@retval EFI_TIMEOUT A timeout occurred while waiting for the security
|
||
|
|
protocol command to execute.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
NvmeStorageSecuritySendData (
|
||
|
|
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
|
||
|
|
);
|
||
|
|
|
||
|
|
#endif
|