#include "AtaBus.h"

Functions
VOID *	AllocateAlignedBuffer (IN ATA_DEVICE *AtaDevice, IN UINTN BufferSize)

VOID	FreeAlignedBuffer (IN VOID *Buffer, IN UINTN BufferSize)

VOID	ReleaseAtaResources (IN ATA_DEVICE *AtaDevice)

EFI_STATUS	RegisterAtaDevice (IN OUT ATA_BUS_DRIVER_DATA *AtaBusDriverData, IN UINT16 Port, IN UINT16 PortMultiplierPort)

EFI_STATUS	UnregisterAtaDevice (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_HANDLE Handle)

EFI_STATUS EFIAPI	AtaBusDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	AtaBusDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	AtaBusDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

EFI_STATUS EFIAPI	AtaBlockIoReset (IN EFI_BLOCK_IO_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS	BlockIoReadWrite (IN VOID This, IN UINT32 MediaId, IN EFI_LBA Lba, IN OUT EFI_BLOCK_IO2_TOKEN Token, IN UINTN BufferSize, OUT VOID *Buffer, IN BOOLEAN IsBlockIo2, IN BOOLEAN IsWrite)

EFI_STATUS EFIAPI	AtaBlockIoReadBlocks (IN EFI_BLOCK_IO_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, OUT VOID Buffer)

EFI_STATUS EFIAPI	AtaBlockIoWriteBlocks (IN EFI_BLOCK_IO_PROTOCOL This, IN UINT32 MediaId, IN EFI_LBA Lba, IN UINTN BufferSize, IN VOID Buffer)

EFI_STATUS EFIAPI	AtaBlockIoFlushBlocks (IN EFI_BLOCK_IO_PROTOCOL *This)

EFI_STATUS EFIAPI	AtaBlockIoResetEx (IN EFI_BLOCK_IO2_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS EFIAPI	AtaBlockIoReadBlocksEx (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)

EFI_STATUS EFIAPI	AtaBlockIoWriteBlocksEx (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)

EFI_STATUS EFIAPI	AtaBlockIoFlushBlocksEx (IN EFI_BLOCK_IO2_PROTOCOL This, IN OUT EFI_BLOCK_IO2_TOKEN Token)

EFI_STATUS EFIAPI	AtaDiskInfoInquiry (IN EFI_DISK_INFO_PROTOCOL This, IN OUT VOID InquiryData, IN OUT UINT32 *InquiryDataSize)

EFI_STATUS EFIAPI	AtaDiskInfoIdentify (IN EFI_DISK_INFO_PROTOCOL This, IN OUT VOID IdentifyData, IN OUT UINT32 *IdentifyDataSize)

EFI_STATUS EFIAPI	AtaDiskInfoSenseData (IN EFI_DISK_INFO_PROTOCOL This, IN OUT VOID SenseData, IN OUT UINT32 SenseDataSize, OUT UINT8 SenseDataNumber)

EFI_STATUS EFIAPI	AtaDiskInfoWhichIde (IN EFI_DISK_INFO_PROTOCOL This, OUT UINT32 IdeChannel, OUT UINT32 *IdeDevice)

EFI_STATUS EFIAPI	AtaStorageSecurityReceiveData (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	AtaStorageSecuritySendData (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)

EFI_STATUS EFIAPI	InitializeAtaBus (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gAtaBusDriverBinding

ATA_DEVICE	gAtaDeviceTemplate

Detailed Description

This file implements protocol interfaces for ATA bus driver.

This file implements protocol interfaces: Driver Binding protocol, Block IO protocol and DiskInfo protocol.

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

Definition in file AtaBus.c.

Function Documentation

◆ AllocateAlignedBuffer()

VOID * AllocateAlignedBuffer	(	IN ATA_DEVICE *	AtaDevice,
		IN UINTN	BufferSize
	)

Allocates an aligned buffer for ATA device.

This function allocates an aligned buffer for the ATA device to perform ATA pass through operations. The alignment requirement is from ATA pass through interface.

Parameters

AtaDevice	The ATA child device involved for the operation.
BufferSize	The request buffer size.

Returns: A pointer to the aligned buffer or NULL if the allocation fails.

Definition at line 105 of file AtaBus.c.

◆ AtaBlockIoFlushBlocks()

EFI_STATUS EFIAPI AtaBlockIoFlushBlocks ( IN EFI_BLOCK_IO_PROTOCOL * This )

Flush the Block Device.

Parameters

This	Indicates a pointer to the calling context.

Return values

EFI_SUCCESS	All outstanding data was written to the device
EFI_DEVICE_ERROR	The device reported an error while writing back the data
EFI_NO_MEDIA	There is no media in the device.

Definition at line 1168 of file AtaBus.c.

◆ AtaBlockIoFlushBlocksEx()

EFI_STATUS EFIAPI AtaBlockIoFlushBlocksEx	(	IN EFI_BLOCK_IO2_PROTOCOL *	This,
		IN OUT EFI_BLOCK_IO2_TOKEN *	Token
	)

Flush the Block Device.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in,out]	Token	A pointer to the token associated with the transaction.

Return values

EFI_SUCCESS	All outstanding data was written to the device
EFI_DEVICE_ERROR	The device reported an error while writing back the data
EFI_NO_MEDIA	There is no media in the device.

Definition at line 1305 of file AtaBus.c.

◆ AtaBlockIoReadBlocks()

EFI_STATUS EFIAPI AtaBlockIoReadBlocks	(	IN EFI_BLOCK_IO_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN EFI_LBA	Lba,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer
	)

Read BufferSize bytes from Lba into Buffer.

Parameters

This	Indicates a pointer to the calling context.
MediaId	Id of the media, changes every time the media is replaced.
Lba	The starting Logical Block Address to read from
BufferSize	Size of Buffer, must be a multiple of device block size.
Buffer	A pointer to the destination buffer for the data. The caller is responsible for either having implicit or explicit ownership of the buffer.

Return values

EFI_SUCCESS	The data was read correctly from the device.
EFI_DEVICE_ERROR	The device reported an error while performing the read.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId does not match the current device.
EFI_BAD_BUFFER_SIZE	The Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETER	The read request contains LBAs that are not valid, or the buffer is not on proper alignment.

Definition at line 1112 of file AtaBus.c.

◆ AtaBlockIoReadBlocksEx()

EFI_STATUS EFIAPI AtaBlockIoReadBlocksEx	(	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
	)

Read BufferSize bytes from Lba into Buffer.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	MediaId	Id of the media, changes every time the media is replaced.
[in]	Lba	The starting Logical Block Address to read from.
[in,out]	Token	A pointer to the token associated with the transaction.
[in]	BufferSize	Size of Buffer, must be a multiple of device block size.
[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.

Return values

EFI_SUCCESS	The read request was queued if Event is not NULL. The data was read correctly from the device if the Event is NULL.
EFI_DEVICE_ERROR	The device reported an error while performing the read.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId is not for the current media.
EFI_BAD_BUFFER_SIZE	The BufferSize parameter is not a multiple of the intrinsic block size of the device.
EFI_INVALID_PARAMETER	The read request contains LBAs that are not valid, or the buffer is not on proper alignment.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Definition at line 1244 of file AtaBus.c.

◆ AtaBlockIoReset()

EFI_STATUS EFIAPI AtaBlockIoReset	(	IN EFI_BLOCK_IO_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Reset the Block Device.

Parameters

This	Indicates a pointer to the calling context.
ExtendedVerification	Driver may perform diagnostics on reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning properly and could not be reset.

Definition at line 967 of file AtaBus.c.

◆ AtaBlockIoResetEx()

EFI_STATUS EFIAPI AtaBlockIoResetEx	(	IN EFI_BLOCK_IO2_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Reset the Block Device.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	ExtendedVerification	Driver may perform diagnostics on reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning properly and could not be reset.

Definition at line 1191 of file AtaBus.c.

◆ AtaBlockIoWriteBlocks()

EFI_STATUS EFIAPI AtaBlockIoWriteBlocks	(	IN EFI_BLOCK_IO_PROTOCOL *	This,
		IN UINT32	MediaId,
		IN EFI_LBA	Lba,
		IN UINTN	BufferSize,
		IN VOID *	Buffer
	)

Write BufferSize bytes from Lba into Buffer.

Parameters

This	Indicates a pointer to the calling context.
MediaId	The media ID that the write request is for.
Lba	The starting logical block address to be written. The caller is responsible for writing to only legitimate locations.
BufferSize	Size of Buffer, must be a multiple of device block size.
Buffer	A pointer to the source buffer for the data.

Return values

EFI_SUCCESS	The data was written correctly to the device.
EFI_WRITE_PROTECTED	The device can not be written to.
EFI_DEVICE_ERROR	The device reported an error while performing the write.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId does not match the current device.
EFI_BAD_BUFFER_SIZE	The Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETER	The write request contains LBAs that are not valid, or the buffer is not on proper alignment.

Definition at line 1145 of file AtaBus.c.

◆ AtaBlockIoWriteBlocksEx()

EFI_STATUS EFIAPI AtaBlockIoWriteBlocksEx	(	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
	)

Write BufferSize bytes from Lba into Buffer.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	MediaId	The media ID that the write request is for.
[in]	Lba	The starting logical block address to be written. The caller is responsible for writing to only legitimate locations.
[in,out]	Token	A pointer to the token associated with the transaction.
[in]	BufferSize	Size of Buffer, must be a multiple of device block size.
[in]	Buffer	A pointer to the source buffer for the data.

Return values

EFI_SUCCESS	The data was written correctly to the device.
EFI_WRITE_PROTECTED	The device can not be written to.
EFI_DEVICE_ERROR	The device reported an error while performing the write.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId does not match the current device.
EFI_BAD_BUFFER_SIZE	The Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETER	The write request contains LBAs that are not valid, or the buffer is not on proper alignment.

Definition at line 1280 of file AtaBus.c.

◆ AtaBusDriverBindingStart()

EFI_STATUS EFIAPI AtaBusDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Starts a device controller or a bus controller.

The Start() function is designed to be invoked from the EFI boot service ConnectController(). As a result, much of the error checking on the parameters to Start() has been moved into this common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE.
If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL.
Prior to calling Start(), the Supported() function for the driver specified by This must have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver.

Return values

EFI_SUCCESS	The device was started.
EFI_DEVICE_ERROR	The device could not be started due to a device error.Currently not implemented.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
Others	The driver failed to start the device.

Definition at line 715 of file AtaBus.c.

◆ AtaBusDriverBindingStop()

EFI_STATUS EFIAPI AtaBusDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stops a device controller or a bus controller.

The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic.

ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function.
The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 897 of file AtaBus.c.

◆ AtaBusDriverBindingSupported()

EFI_STATUS EFIAPI AtaBusDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device.

This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers will typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small, and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Since ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[in]	RemainingDevicePath	A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this bus driver.

Return values

EFI_SUCCESS	The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
EFI_ACCESS_DENIED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 587 of file AtaBus.c.

◆ AtaDiskInfoIdentify()

EFI_STATUS EFIAPI AtaDiskInfoIdentify	(	IN EFI_DISK_INFO_PROTOCOL *	This,
		IN OUT VOID *	IdentifyData,
		IN OUT UINT32 *	IdentifyDataSize
	)

Provides identify information for the controller type.

This function is used by the IDE bus driver to get identify data. Data format of Identify data is defined by the Interface GUID.

Parameters

[in]	This	Pointer to the EFI_DISK_INFO_PROTOCOL instance.
[in,out]	IdentifyData	Pointer to a buffer for the identify data.
[in,out]	IdentifyDataSize	Pointer to the value for the identify data size.

Return values

EFI_SUCCESS	The command was accepted without any errors.
EFI_NOT_FOUND	Device does not support this data class
EFI_DEVICE_ERROR	Error reading IdentifyData from device
EFI_BUFFER_TOO_SMALL	IdentifyDataSize not big enough

Definition at line 1368 of file AtaBus.c.

◆ AtaDiskInfoInquiry()

EFI_STATUS EFIAPI AtaDiskInfoInquiry	(	IN EFI_DISK_INFO_PROTOCOL *	This,
		IN OUT VOID *	InquiryData,
		IN OUT UINT32 *	InquiryDataSize
	)

Provides inquiry information for the controller type.

This function is used by the IDE bus driver to get inquiry data. Data format of Identify data is defined by the Interface GUID.

Parameters

[in]	This	Pointer to the EFI_DISK_INFO_PROTOCOL instance.
[in,out]	InquiryData	Pointer to a buffer for the inquiry data.
[in,out]	InquiryDataSize	Pointer to the value for the inquiry data size.

Return values

EFI_SUCCESS	The command was accepted without any errors.
EFI_NOT_FOUND	Device does not support this data class
EFI_DEVICE_ERROR	Error reading InquiryData from device
EFI_BUFFER_TOO_SMALL	InquiryDataSize not big enough

Definition at line 1339 of file AtaBus.c.

◆ AtaDiskInfoSenseData()

EFI_STATUS EFIAPI AtaDiskInfoSenseData	(	IN EFI_DISK_INFO_PROTOCOL *	This,
		IN OUT VOID *	SenseData,
		IN OUT UINT32 *	SenseDataSize,
		OUT UINT8 *	SenseDataNumber
	)

Provides sense data information for the controller type.

This function is used by the IDE bus driver to get sense data. Data format of Sense data is defined by the Interface GUID.

Parameters

[in]	This	Pointer to the EFI_DISK_INFO_PROTOCOL instance.
[in,out]	SenseData	Pointer to the SenseData.
[in,out]	SenseDataSize	Size of SenseData in bytes.
[out]	SenseDataNumber	Pointer to the value for the sense data size.

Return values

EFI_SUCCESS	The command was accepted without any errors.
EFI_NOT_FOUND	Device does not support this data class.
EFI_DEVICE_ERROR	Error reading SenseData from device.
EFI_BUFFER_TOO_SMALL	SenseDataSize not big enough.

Definition at line 1409 of file AtaBus.c.

◆ AtaDiskInfoWhichIde()

EFI_STATUS EFIAPI AtaDiskInfoWhichIde	(	IN EFI_DISK_INFO_PROTOCOL *	This,
		OUT UINT32 *	IdeChannel,
		OUT UINT32 *	IdeDevice
	)

This function is used by the IDE bus driver to get controller information.

Parameters

[in]	This	Pointer to the EFI_DISK_INFO_PROTOCOL instance.
[out]	IdeChannel	Pointer to the Ide Channel number. Primary or secondary.
[out]	IdeDevice	Pointer to the Ide Device number. Master or slave.

Return values

EFI_SUCCESS	IdeChannel and IdeDevice are valid.
EFI_UNSUPPORTED	This is not an IDE device.

Definition at line 1432 of file AtaBus.c.

◆ AtaStorageSecurityReceiveData()

EFI_STATUS EFIAPI AtaStorageSecurityReceiveData	(	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 1523 of file AtaBus.c.

◆ AtaStorageSecuritySendData()

EFI_STATUS EFIAPI AtaStorageSecuritySendData	(	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 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.

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 1636 of file AtaBus.c.

◆ BlockIoReadWrite()

EFI_STATUS BlockIoReadWrite	(	IN VOID *	This,
		IN UINT32	MediaId,
		IN EFI_LBA	Lba,
		IN OUT EFI_BLOCK_IO2_TOKEN *	Token,
		IN UINTN	BufferSize,
		OUT VOID *	Buffer,
		IN BOOLEAN	IsBlockIo2,
		IN BOOLEAN	IsWrite
	)

Read/Write BufferSize bytes from Lba from/into Buffer.

Parameters

[in]	This	Indicates a pointer to the calling context. Either be block I/O or block I/O2.
[in]	MediaId	The media ID that the read/write request is for.
[in]	Lba	The starting logical block address to be read/written. The caller is responsible for reading/writing to only legitimate locations.
[in,out]	Token	A pointer to the token associated with the transaction.
[in]	BufferSize	Size of Buffer, must be a multiple of device block size.
[out]	Buffer	A pointer to the destination/source buffer for the data.
[in]	IsBlockIo2	Indicate the calling is from BlockIO or BlockIO2. TRUE is from BlockIO2, FALSE is for BlockIO.
[in]	IsWrite	Indicates whether it is a write operation.

Return values

EFI_SUCCESS	The data was read/written correctly to the device.
EFI_WRITE_PROTECTED	The device can not be read/written to.
EFI_DEVICE_ERROR	The device reported an error while performing the read/write.
EFI_NO_MEDIA	There is no media in the device.
EFI_MEDIA_CHANGED	The MediaId does not match the current device.
EFI_BAD_BUFFER_SIZE	The Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETER	The read/write request contains LBAs that are not valid, or the buffer is not on proper alignment.

Definition at line 1017 of file AtaBus.c.

◆ FreeAlignedBuffer()

VOID FreeAlignedBuffer	(	IN VOID *	Buffer,
		IN UINTN	BufferSize
	)

Frees an aligned buffer for ATA device.

This function frees an aligned buffer for the ATA device to perform ATA pass through operations.

Parameters

Buffer	The aligned buffer to be freed.
BufferSize	The request buffer size.

Definition at line 124 of file AtaBus.c.

◆ InitializeAtaBus()

EFI_STATUS EFIAPI InitializeAtaBus	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The user Entry Point for module AtaBus. The user code starts with this function.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some error occurs when executing this entry point.

Definition at line 1690 of file AtaBus.c.

◆ RegisterAtaDevice()

EFI_STATUS RegisterAtaDevice	(	IN OUT ATA_BUS_DRIVER_DATA *	AtaBusDriverData,
		IN UINT16	Port,
		IN UINT16	PortMultiplierPort
	)

Registers an ATA device.

This function allocates an ATA device structure for the ATA device specified by Port and PortMultiplierPort if the ATA device is identified as a valid one. Then it will create child handle and install Block IO and Disk Info protocol on it.

Parameters

AtaBusDriverData	The parent ATA bus driver data structure.
Port	The port number of the ATA device.
PortMultiplierPort	The port multiplier port number of the ATA device.

Return values

EFI_SUCCESS	The ATA device is successfully registered.
EFI_OUT_OF_RESOURCES	There is not enough memory to allocate the ATA device and related data structures.

Returns: Others Some error occurs when registering the ATA device.

Definition at line 217 of file AtaBus.c.

◆ ReleaseAtaResources()

VOID ReleaseAtaResources ( IN ATA_DEVICE * AtaDevice )

Release all the resources allocated for the ATA device.

This function releases all the resources allocated for the ATA device.

Parameters

AtaDevice The ATA child device involved for the operation.

Definition at line 143 of file AtaBus.c.

◆ UnregisterAtaDevice()

EFI_STATUS UnregisterAtaDevice	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Handle
	)

Unregisters an ATA device.

This function removes the protocols installed on the controller handle and frees the resources allocated for the ATA device.

Parameters

This	The pointer to EFI_DRIVER_BINDING_PROTOCOL instance.
Controller	The controller handle of the ATA device.
Handle	The child handle.

Return values

EFI_SUCCESS The ATA device is successfully unregistered.

Returns: Others Some error occurs when unregistering the ATA device.

Definition at line 418 of file AtaBus.c.

Variable Documentation

◆ gAtaBusDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gAtaBusDriverBinding

Initial value:

= {
  AtaBusDriverBindingSupported,
  AtaBusDriverBindingStart,
  AtaBusDriverBindingStop,
  0x10,
  NULL,
  NULL
}

Definition at line 18 of file AtaBus.c.

◆ gAtaDeviceTemplate

ATA_DEVICE gAtaDeviceTemplate

Definition at line 30 of file AtaBus.c.

Functions

Variables

Detailed Description

Function Documentation

◆ AllocateAlignedBuffer()

◆ AtaBlockIoFlushBlocks()

◆ AtaBlockIoFlushBlocksEx()

◆ AtaBlockIoReadBlocks()

◆ AtaBlockIoReadBlocksEx()

◆ AtaBlockIoReset()

◆ AtaBlockIoResetEx()

◆ AtaBlockIoWriteBlocks()

◆ AtaBlockIoWriteBlocksEx()

◆ AtaBusDriverBindingStart()

◆ AtaBusDriverBindingStop()

◆ AtaBusDriverBindingSupported()

◆ AtaDiskInfoIdentify()

◆ AtaDiskInfoInquiry()

◆ AtaDiskInfoSenseData()

◆ AtaDiskInfoWhichIde()

◆ AtaStorageSecurityReceiveData()

◆ AtaStorageSecuritySendData()

◆ BlockIoReadWrite()

◆ FreeAlignedBuffer()

◆ InitializeAtaBus()

◆ RegisterAtaDevice()

◆ ReleaseAtaResources()

◆ UnregisterAtaDevice()

Variable Documentation

◆ gAtaBusDriverBinding

◆ gAtaDeviceTemplate