#include <Uefi.h>
#include <IndustryStandard/Pci.h>
#include <IndustryStandard/Atapi.h>
#include <IndustryStandard/Scsi.h>
#include <Protocol/PciIo.h>
#include <Protocol/IdeControllerInit.h>
#include <Protocol/AtaPassThru.h>
#include <Protocol/ScsiPassThruExt.h>
#include <Protocol/AtaAtapiPolicy.h>
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/PciLib.h>
#include <Library/PcdLib.h>
#include <Library/TimerLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/DevicePathLib.h>
#include "IdeMode.h"
#include "AhciMode.h"

Data Structures
struct	EFI_ATA_DEVICE_INFO

struct	ATA_ATAPI_PASS_THRU_INSTANCE

struct	_ATA_NONBLOCK_TASK

Macros
#define	ATA_ATAPI_PASS_THRU_SIGNATURE SIGNATURE_32 ('a', 'a', 'p', 't')

#define	ATA_ATAPI_DEVICE_SIGNATURE SIGNATURE_32 ('a', 'd', 'e', 'v')

#define	ATA_NONBLOCKING_TASK_SIGNATURE SIGNATURE_32 ('a', 't', 's', 'k')

#define	ATA_ATAPI_TIMEOUT EFI_TIMER_PERIOD_SECONDS(3)

#define	ATA_SPINUP_TIMEOUT EFI_TIMER_PERIOD_SECONDS(10)

#define	ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS(a)

#define	EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS(a)

#define	ATA_ATAPI_DEVICE_INFO_FROM_THIS(a)

#define	ATA_NON_BLOCK_TASK_FROM_ENTRY(a)

Typedefs
typedef struct _ATA_NONBLOCK_TASK	ATA_NONBLOCK_TASK

Enumerations
enum	EFI_ATA_HC_WORK_MODE { EfiAtaIdeMode , EfiAtaAhciMode , EfiAtaRaidMode , EfiAtaUnknownMode }

enum	EFI_ATA_DEVICE_TYPE { EfiIdeCdrom , EfiIdeHarddisk , EfiPortMultiplier , EfiIdeUnknown }

Functions
EFI_STATUS EFIAPI	AtaAtapiPassThruComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN CHAR8 Language, OUT CHAR16 **DriverName)

EFI_STATUS EFIAPI	AtaAtapiPassThruComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 Language, OUT CHAR16 **ControllerName)

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

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

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

LIST_ENTRY *EFIAPI	SearchDeviceInfoList (IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, IN UINT16 Port, IN UINT16 PortMultiplier, IN EFI_ATA_DEVICE_TYPE DeviceType)

EFI_STATUS EFIAPI	CreateNewDeviceInfo (IN ATA_ATAPI_PASS_THRU_INSTANCE Instance, IN UINT16 Port, IN UINT16 PortMultiplier, IN EFI_ATA_DEVICE_TYPE DeviceType, IN EFI_IDENTIFY_DATA IdentifyData)

VOID EFIAPI	DestroyDeviceInfoList (IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance)

VOID EFIAPI	DestroyAsynTaskList (IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance, IN BOOLEAN IsSigEvent)

EFI_STATUS EFIAPI	EnumerateAttachedDevice (IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance)

VOID EFIAPI	AsyncNonBlockingTransferRoutine (EFI_EVENT Event, VOID *Context)

EFI_STATUS EFIAPI	AtaPassThruPassThru (IN EFI_ATA_PASS_THRU_PROTOCOL This, IN UINT16 Port, IN UINT16 PortMultiplierPort, IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET Packet, IN EFI_EVENT Event OPTIONAL)

EFI_STATUS EFIAPI	AtaPassThruGetNextPort (IN EFI_ATA_PASS_THRU_PROTOCOL This, IN OUT UINT16 Port)

EFI_STATUS EFIAPI	AtaPassThruGetNextDevice (IN EFI_ATA_PASS_THRU_PROTOCOL This, IN UINT16 Port, IN OUT UINT16 PortMultiplierPort)

EFI_STATUS EFIAPI	AtaPassThruBuildDevicePath (IN EFI_ATA_PASS_THRU_PROTOCOL This, IN UINT16 Port, IN UINT16 PortMultiplierPort, IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath)

EFI_STATUS EFIAPI	AtaPassThruGetDevice (IN EFI_ATA_PASS_THRU_PROTOCOL This, IN EFI_DEVICE_PATH_PROTOCOL DevicePath, OUT UINT16 Port, OUT UINT16 PortMultiplierPort)

EFI_STATUS EFIAPI	AtaPassThruResetPort (IN EFI_ATA_PASS_THRU_PROTOCOL *This, IN UINT16 Port)

EFI_STATUS EFIAPI	AtaPassThruResetDevice (IN EFI_ATA_PASS_THRU_PROTOCOL *This, IN UINT16 Port, IN UINT16 PortMultiplierPort)

EFI_STATUS EFIAPI	ExtScsiPassThruPassThru (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN UINT8 Target, IN UINT64 Lun, IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, IN EFI_EVENT Event OPTIONAL)

EFI_STATUS EFIAPI	ExtScsiPassThruGetNextTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN OUT UINT8 Target, IN OUT UINT64 Lun)

EFI_STATUS EFIAPI	ExtScsiPassThruBuildDevicePath (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN UINT8 Target, IN UINT64 Lun, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)

EFI_STATUS EFIAPI	ExtScsiPassThruGetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN EFI_DEVICE_PATH_PROTOCOL DevicePath, OUT UINT8 *Target, OUT UINT64 Lun)

EFI_STATUS EFIAPI	ExtScsiPassThruResetChannel (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This)

EFI_STATUS EFIAPI	ExtScsiPassThruResetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN UINT8 Target, IN UINT64 Lun)

EFI_STATUS EFIAPI	ExtScsiPassThruGetNextTarget (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL This, IN OUT UINT8 *Target)

EFI_STATUS EFIAPI	IdeModeInitialization (IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance)

EFI_STATUS EFIAPI	AhciModeInitialization (IN ATA_ATAPI_PASS_THRU_INSTANCE *Instance)

EFI_STATUS EFIAPI	AhciNonDataTransfer (IN EFI_PCI_IO_PROTOCOL PciIo, IN EFI_AHCI_REGISTERS AhciRegisters, IN UINT8 Port, IN UINT8 PortMultiplier, IN EFI_AHCI_ATAPI_COMMAND AtapiCommand OPTIONAL, IN UINT8 AtapiCommandLength, IN EFI_ATA_COMMAND_BLOCK AtaCommandBlock, IN OUT EFI_ATA_STATUS_BLOCK AtaStatusBlock, IN UINT64 Timeout, IN ATA_NONBLOCK_TASK Task)

EFI_STATUS EFIAPI	AhciDmaTransfer (IN ATA_ATAPI_PASS_THRU_INSTANCE Instance, IN EFI_AHCI_REGISTERS AhciRegisters, IN UINT8 Port, IN UINT8 PortMultiplier, IN EFI_AHCI_ATAPI_COMMAND AtapiCommand OPTIONAL, IN UINT8 AtapiCommandLength, IN BOOLEAN Read, IN EFI_ATA_COMMAND_BLOCK AtaCommandBlock, IN OUT EFI_ATA_STATUS_BLOCK AtaStatusBlock, IN OUT VOID MemoryAddr, IN UINT32 DataCount, IN UINT64 Timeout, IN ATA_NONBLOCK_TASK *Task)

EFI_STATUS EFIAPI	AhciPioTransfer (IN EFI_PCI_IO_PROTOCOL PciIo, IN EFI_AHCI_REGISTERS AhciRegisters, IN UINT8 Port, IN UINT8 PortMultiplier, IN EFI_AHCI_ATAPI_COMMAND AtapiCommand OPTIONAL, IN UINT8 AtapiCommandLength, IN BOOLEAN Read, IN EFI_ATA_COMMAND_BLOCK AtaCommandBlock, IN OUT EFI_ATA_STATUS_BLOCK AtaStatusBlock, IN OUT VOID MemoryAddr, IN UINT32 DataCount, IN UINT64 Timeout, IN ATA_NONBLOCK_TASK *Task)

EFI_STATUS EFIAPI	AtaNonDataCommandIn (IN EFI_PCI_IO_PROTOCOL PciIo, IN EFI_IDE_REGISTERS IdeRegisters, IN EFI_ATA_COMMAND_BLOCK AtaCommandBlock, IN OUT EFI_ATA_STATUS_BLOCK AtaStatusBlock, IN UINT64 Timeout, IN ATA_NONBLOCK_TASK *Task)

EFI_STATUS EFIAPI	AtaUdmaInOut (IN ATA_ATAPI_PASS_THRU_INSTANCE Instance, IN EFI_IDE_REGISTERS IdeRegisters, IN BOOLEAN Read, IN VOID DataBuffer, IN UINT64 DataLength, IN EFI_ATA_COMMAND_BLOCK AtaCommandBlock, IN OUT EFI_ATA_STATUS_BLOCK AtaStatusBlock, IN UINT64 Timeout, IN ATA_NONBLOCK_TASK Task)

EFI_STATUS EFIAPI	AtaPioDataInOut (IN EFI_PCI_IO_PROTOCOL PciIo, IN EFI_IDE_REGISTERS IdeRegisters, IN OUT VOID Buffer, IN UINT64 ByteCount, IN BOOLEAN Read, IN EFI_ATA_COMMAND_BLOCK AtaCommandBlock, IN OUT EFI_ATA_STATUS_BLOCK AtaStatusBlock, IN UINT64 Timeout, IN ATA_NONBLOCK_TASK Task)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gAtaAtapiPassThruDriverBinding

EFI_COMPONENT_NAME_PROTOCOL	gAtaAtapiPassThruComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gAtaAtapiPassThruComponentName2

EDKII_ATA_ATAPI_POLICY_PROTOCOL *	mAtaAtapiPolicy

Detailed Description

Header file for ATA/ATAPI PASS THRU driver.

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

Definition in file AtaAtapiPassThru.h.

Macro Definition Documentation

◆ ATA_ATAPI_DEVICE_INFO_FROM_THIS

#define ATA_ATAPI_DEVICE_INFO_FROM_THIS ( a )

Value:

  CR (a, \
      EFI_ATA_DEVICE_INFO, \
      Link, \
      ATA_ATAPI_DEVICE_SIGNATURE \
      );

Definition at line 165 of file AtaAtapiPassThru.h.

◆ ATA_ATAPI_DEVICE_SIGNATURE

#define ATA_ATAPI_DEVICE_SIGNATURE SIGNATURE_32 ('a', 'd', 'e', 'v')

Definition at line 47 of file AtaAtapiPassThru.h.

◆ ATA_ATAPI_PASS_THRU_SIGNATURE

#define ATA_ATAPI_PASS_THRU_SIGNATURE SIGNATURE_32 ('a', 'a', 'p', 't')

Definition at line 46 of file AtaAtapiPassThru.h.

◆ ATA_ATAPI_TIMEOUT

#define ATA_ATAPI_TIMEOUT EFI_TIMER_PERIOD_SECONDS(3)

Definition at line 148 of file AtaAtapiPassThru.h.

◆ ATA_NON_BLOCK_TASK_FROM_ENTRY

#define ATA_NON_BLOCK_TASK_FROM_ENTRY ( a )

Value:

  CR (a, \
      ATA_NONBLOCK_TASK, \
      Link, \
      ATA_NONBLOCKING_TASK_SIGNATURE \
      );

Definition at line 172 of file AtaAtapiPassThru.h.

◆ ATA_NONBLOCKING_TASK_SIGNATURE

#define ATA_NONBLOCKING_TASK_SIGNATURE SIGNATURE_32 ('a', 't', 's', 'k')

Definition at line 48 of file AtaAtapiPassThru.h.

◆ ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS

#define ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS ( a )

Value:

  CR (a, \
      ATA_ATAPI_PASS_THRU_INSTANCE, \
      AtaPassThru, \
      ATA_ATAPI_PASS_THRU_SIGNATURE \
      )

Definition at line 151 of file AtaAtapiPassThru.h.

◆ ATA_SPINUP_TIMEOUT

#define ATA_SPINUP_TIMEOUT EFI_TIMER_PERIOD_SECONDS(10)

Definition at line 149 of file AtaAtapiPassThru.h.

◆ EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS

#define EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS ( a )

Value:

  CR (a, \
      ATA_ATAPI_PASS_THRU_INSTANCE, \
      ExtScsiPassThru, \
      ATA_ATAPI_PASS_THRU_SIGNATURE \
      )

Definition at line 158 of file AtaAtapiPassThru.h.

Typedef Documentation

◆ ATA_NONBLOCK_TASK

typedef struct _ATA_NONBLOCK_TASK ATA_NONBLOCK_TASK

Definition at line 50 of file AtaAtapiPassThru.h.

Enumeration Type Documentation

◆ EFI_ATA_DEVICE_TYPE

enum EFI_ATA_DEVICE_TYPE

Definition at line 59 of file AtaAtapiPassThru.h.

◆ EFI_ATA_HC_WORK_MODE

enum EFI_ATA_HC_WORK_MODE

Definition at line 52 of file AtaAtapiPassThru.h.

Function Documentation

◆ AhciDmaTransfer()

EFI_STATUS EFIAPI AhciDmaTransfer	(	IN ATA_ATAPI_PASS_THRU_INSTANCE *	Instance,
		IN EFI_AHCI_REGISTERS *	AhciRegisters,
		IN UINT8	Port,
		IN UINT8	PortMultiplier,
		IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand	OPTIONAL,
		IN UINT8	AtapiCommandLength,
		IN BOOLEAN	Read,
		IN EFI_ATA_COMMAND_BLOCK *	AtaCommandBlock,
		IN OUT EFI_ATA_STATUS_BLOCK *	AtaStatusBlock,
		IN OUT VOID *	MemoryAddr,
		IN UINT32	DataCount,
		IN UINT64	Timeout,
		IN ATA_NONBLOCK_TASK *	Task
	)

Start a DMA data transfer on specific port

Parameters

[in]	Instance	The ATA_ATAPI_PASS_THRU_INSTANCE protocol instance.
[in]	AhciRegisters	The pointer to the EFI_AHCI_REGISTERS.
[in]	Port	The number of port.
[in]	PortMultiplier	The timeout value of stop.
[in]	AtapiCommand	The atapi command will be used for the transfer.
[in]	AtapiCommandLength	The length of the atapi command.
[in]	Read	The transfer direction.
[in]	AtaCommandBlock	The EFI_ATA_COMMAND_BLOCK data.
[in,out]	AtaStatusBlock	The EFI_ATA_STATUS_BLOCK data.
[in,out]	MemoryAddr	The pointer to the data buffer.
[in]	DataCount	The data count to be transferred.
[in]	Timeout	The timeout value of non data transfer, uses 100ns as a unit.
[in]	Task	Optional. Pointer to the ATA_NONBLOCK_TASK used by non-blocking mode.

Return values

EFI_DEVICE_ERROR	The DMA data transfer abort with error occurs.
EFI_TIMEOUT	The operation is time out.
EFI_UNSUPPORTED	The device is not ready for transfer.
EFI_SUCCESS	The DMA data transfer executes successfully.

Definition at line 1158 of file AhciMode.c.

◆ AhciModeInitialization()

EFI_STATUS EFIAPI AhciModeInitialization ( IN ATA_ATAPI_PASS_THRU_INSTANCE * Instance )

Initialize ATA host controller at AHCI mode.

The function is designed to initialize ATA host controller.

Parameters

[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.

Definition at line 2863 of file AhciMode.c.

◆ AhciNonDataTransfer()

EFI_STATUS EFIAPI AhciNonDataTransfer	(	IN EFI_PCI_IO_PROTOCOL *	PciIo,
		IN EFI_AHCI_REGISTERS *	AhciRegisters,
		IN UINT8	Port,
		IN UINT8	PortMultiplier,
		IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand	OPTIONAL,
		IN UINT8	AtapiCommandLength,
		IN EFI_ATA_COMMAND_BLOCK *	AtaCommandBlock,
		IN OUT EFI_ATA_STATUS_BLOCK *	AtaStatusBlock,
		IN UINT64	Timeout,
		IN ATA_NONBLOCK_TASK *	Task
	)

Start a non data transfer on specific port.

Parameters

[in]	PciIo	The PCI IO protocol instance.
[in]	AhciRegisters	The pointer to the EFI_AHCI_REGISTERS.
[in]	Port	The number of port.
[in]	PortMultiplier	The timeout value of stop.
[in]	AtapiCommand	The atapi command will be used for the transfer.
[in]	AtapiCommandLength	The length of the atapi command.
[in]	AtaCommandBlock	The EFI_ATA_COMMAND_BLOCK data.
[in,out]	AtaStatusBlock	The EFI_ATA_STATUS_BLOCK data.
[in]	Timeout	The timeout value of non data transfer, uses 100ns as a unit.
[in]	Task	Optional. Pointer to the ATA_NONBLOCK_TASK used by non-blocking mode.

Return values

EFI_DEVICE_ERROR	The non data transfer abort with error occurs.
EFI_TIMEOUT	The operation is time out.
EFI_UNSUPPORTED	The device is not ready for transfer.
EFI_SUCCESS	The non data transfer executes successfully.

Definition at line 1424 of file AhciMode.c.

◆ AhciPioTransfer()

EFI_STATUS EFIAPI AhciPioTransfer	(	IN EFI_PCI_IO_PROTOCOL *	PciIo,
		IN EFI_AHCI_REGISTERS *	AhciRegisters,
		IN UINT8	Port,
		IN UINT8	PortMultiplier,
		IN EFI_AHCI_ATAPI_COMMAND *AtapiCommand	OPTIONAL,
		IN UINT8	AtapiCommandLength,
		IN BOOLEAN	Read,
		IN EFI_ATA_COMMAND_BLOCK *	AtaCommandBlock,
		IN OUT EFI_ATA_STATUS_BLOCK *	AtaStatusBlock,
		IN OUT VOID *	MemoryAddr,
		IN UINT32	DataCount,
		IN UINT64	Timeout,
		IN ATA_NONBLOCK_TASK *	Task
	)

Start a PIO data transfer on specific port.

Parameters

[in]	PciIo	The PCI IO protocol instance.
[in]	AhciRegisters	The pointer to the EFI_AHCI_REGISTERS.
[in]	Port	The number of port.
[in]	PortMultiplier	The timeout value of stop.
[in]	AtapiCommand	The atapi command will be used for the transfer.
[in]	AtapiCommandLength	The length of the atapi command.
[in]	Read	The transfer direction.
[in]	AtaCommandBlock	The EFI_ATA_COMMAND_BLOCK data.
[in,out]	AtaStatusBlock	The EFI_ATA_STATUS_BLOCK data.
[in,out]	MemoryAddr	The pointer to the data buffer.
[in]	DataCount	The data count to be transferred.
[in]	Timeout	The timeout value of non data transfer, uses 100ns as a unit.
[in]	Task	Optional. Pointer to the ATA_NONBLOCK_TASK used by non-blocking mode.

Return values

EFI_DEVICE_ERROR	The PIO data transfer abort with error occurs.
EFI_TIMEOUT	The operation is time out.
EFI_UNSUPPORTED	The device is not ready for transfer.
EFI_SUCCESS	The PIO data transfer executes successfully.

Definition at line 983 of file AhciMode.c.

◆ AsyncNonBlockingTransferRoutine()

VOID EFIAPI AsyncNonBlockingTransferRoutine	(	EFI_EVENT	Event,
		VOID *	Context
	)

Call back function when the timer event is signaled.

Parameters

[in]	Event	The Event this notify function registered to.
[in]	Context	Pointer to the context data registered to the Event.

Definition at line 396 of file AtaAtapiPassThru.c.

◆ AtaAtapiPassThruComponentNameGetControllerName()

EFI_STATUS EFIAPI AtaAtapiPassThruComponentNameGetControllerName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE ChildHandle	OPTIONAL,
		IN CHAR8 *	Language,
		OUT CHAR16 **	ControllerName
	)

Retrieves a Unicode string that is the user readable name of the controller that is being managed by a driver.

This function retrieves the user readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandle[in]	The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned.
ChildHandle[in]	The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a child controller.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
ControllerName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language from the point of view of the driver specified by This.

Return values

EFI_SUCCESS	The Unicode string for the user readable name in the language specified by Language for the driver specified by This was returned in DriverName.
EFI_INVALID_PARAMETER	ControllerHandle is NULL.
EFI_INVALID_PARAMETER	ChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	ControllerName is NULL.
EFI_UNSUPPORTED	The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 176 of file ComponentName.c.

◆ AtaAtapiPassThruComponentNameGetDriverName()

EFI_STATUS EFIAPI AtaAtapiPassThruComponentNameGetDriverName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN CHAR8 *	Language,
		OUT CHAR16 **	DriverName
	)

Retrieves a Unicode string that is the user readable name of the driver.

This function retrieves the user readable name of a driver in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the driver name is returned in DriverName, and EFI_SUCCESS is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
DriverName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language specified by Language.

Return values

EFI_SUCCESS	The Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	DriverName is NULL.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 91 of file ComponentName.c.

◆ AtaAtapiPassThruStart()

EFI_STATUS EFIAPI AtaAtapiPassThruStart	(	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 672 of file AtaAtapiPassThru.c.

◆ AtaAtapiPassThruStop()

EFI_STATUS EFIAPI AtaAtapiPassThruStop	(	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 870 of file AtaAtapiPassThru.c.

◆ AtaAtapiPassThruSupported()

EFI_STATUS EFIAPI AtaAtapiPassThruSupported	(	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(). Because 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 531 of file AtaAtapiPassThru.c.

◆ AtaNonDataCommandIn()

EFI_STATUS EFIAPI AtaNonDataCommandIn	(	IN EFI_PCI_IO_PROTOCOL *	PciIo,
		IN EFI_IDE_REGISTERS *	IdeRegisters,
		IN EFI_ATA_COMMAND_BLOCK *	AtaCommandBlock,
		IN OUT EFI_ATA_STATUS_BLOCK *	AtaStatusBlock,
		IN UINT64	Timeout,
		IN ATA_NONBLOCK_TASK *	Task
	)

Send ATA command into device with NON_DATA protocol

Parameters

[in]	PciIo	A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data structure.
[in]	IdeRegisters	A pointer to EFI_IDE_REGISTERS data structure.
[in]	AtaCommandBlock	A pointer to EFI_ATA_COMMAND_BLOCK data structure.
[in,out]	AtaStatusBlock	A pointer to EFI_ATA_STATUS_BLOCK data structure.
[in]	Timeout	The time to complete the command, uses 100ns as a unit.
[in]	Task	Optional. Pointer to the ATA_NONBLOCK_TASK used by non-blocking mode.

Return values

EFI_SUCCESS	Reading succeed
EFI_ABORTED	Command failed
EFI_DEVICE_ERROR	Device status error.

Definition at line 1069 of file IdeMode.c.

◆ AtaPassThruBuildDevicePath()

EFI_STATUS EFIAPI AtaPassThruBuildDevicePath	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN UINT16	Port,
		IN UINT16	PortMultiplierPort,
		IN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath
	)

Used to allocate and build a device path node for an ATA device on an ATA controller.

The BuildDevicePath() function allocates and builds a single device node for the ATA device specified by Port and PortMultiplierPort. If the ATA device specified by Port and PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned. If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.

Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort, and EFI_SUCCESS is returned.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in]	Port	Port specifies the port number of the ATA device for which a device path node is to be allocated and built.
[in]	PortMultiplierPort	The port multiplier port number of the ATA device for which a device path node is to be allocated and built. If there is no port multiplier, then specify 0xFFFF.
[in,out]	DevicePath	A pointer to a single device path node that describes the ATA device specified by Port and PortMultiplierPort. This function is responsible for allocating the buffer DevicePath with the boot service AllocatePool(). It is the caller's responsibility to free DevicePath when the caller is finished with DevicePath.

Return values

EFI_SUCCESS	The device path node that describes the ATA device specified by Port and PortMultiplierPort was allocated and returned in DevicePath.
EFI_NOT_FOUND	The ATA device specified by Port and PortMultiplierPort does not exist on the ATA controller.
EFI_INVALID_PARAMETER	DevicePath is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate DevicePath.

Definition at line 1676 of file AtaAtapiPassThru.c.

◆ AtaPassThruGetDevice()

EFI_STATUS EFIAPI AtaPassThruGetDevice	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		OUT UINT16 *	Port,
		OUT UINT16 *	PortMultiplierPort
	)

Used to translate a device path node to a port number and port multiplier port number.

The GetDevice() function determines the port and port multiplier port number associated with the ATA device described by DevicePath. If DevicePath is a device path node type that the ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents DevicePath into a port number and port multiplier port number.

If this translation is successful, then that port number and port multiplier port number are returned in Port and PortMultiplierPort, and EFI_SUCCESS is returned.

If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.

If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then EFI_UNSUPPORTED is returned.

If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not a valid translation from DevicePath to a port number and port multiplier port number, then EFI_NOT_FOUND is returned.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in]	DevicePath	A pointer to the device path node that describes an ATA device on the ATA controller.
[out]	Port	On return, points to the port number of an ATA device on the ATA controller.
[out]	PortMultiplierPort	On return, points to the port multiplier port number of an ATA device on the ATA controller.

Return values

EFI_SUCCESS	DevicePath was successfully translated to a port number and port multiplier port number, and they were returned in Port and PortMultiplierPort.
EFI_INVALID_PARAMETER	DevicePath is NULL.
EFI_INVALID_PARAMETER	Port is NULL.
EFI_INVALID_PARAMETER	PortMultiplierPort is NULL.
EFI_UNSUPPORTED	This driver does not support the device path node type in DevicePath.
EFI_NOT_FOUND	A valid translation from DevicePath to a port number and port multiplier port number does not exist.

Definition at line 1764 of file AtaAtapiPassThru.c.

◆ AtaPassThruGetNextDevice()

EFI_STATUS EFIAPI AtaPassThruGetNextDevice	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN UINT16	Port,
		IN OUT UINT16 *	PortMultiplierPort
	)

Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA controller. These can either be the list of port multiplier ports where ATA devices are actually present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this function must probe the port number and port multiplier port number returned to see if an ATA device is actually present.

The GetNextDevice() function retrieves the port multiplier port number of an ATA device present on a port of an ATA controller.

If PortMultiplierPort points to a port multiplier port number value that was returned on a previous call to GetNextDevice(), then the port multiplier port number of the next ATA device on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is returned.

If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first ATA device on port of the ATA controller is returned in PortMultiplierPort and EFI_SUCCESS is returned.

If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER is returned.

If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of the ATA controller, then EFI_NOT_FOUND is returned.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in]	Port	The port number present on the ATA controller.
[in,out]	PortMultiplierPort	On input, a pointer to the port multiplier port number of an ATA device present on the ATA controller. If on input a PortMultiplierPort of 0xFFFF is specified, then the port multiplier port number of the first ATA device is returned. On output, a pointer to the port multiplier port number of the next ATA device present on an ATA controller.

Return values

EFI_SUCCESS	The port multiplier port number of the next ATA device on the port of the ATA controller was returned in PortMultiplierPort.
EFI_NOT_FOUND	There are no more ATA devices on this port of the ATA controller.
EFI_INVALID_PARAMETER	PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not returned on a previous call to GetNextDevice().

Definition at line 1562 of file AtaAtapiPassThru.c.

◆ AtaPassThruGetNextPort()

EFI_STATUS EFIAPI AtaPassThruGetNextPort	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT16 *	Port
	)

Used to retrieve the list of legal port numbers for ATA devices on an ATA controller. These can either be the list of ports where ATA devices are actually present or the list of legal port numbers for the ATA controller. Regardless, the caller of this function must probe the port number returned to see if an ATA device is actually present at that location on the ATA controller.

The GetNextPort() function retrieves the port number on an ATA controller. If on input Port is 0xFFFF, then the port number of the first port on the ATA controller is returned in Port and EFI_SUCCESS is returned.

If Port is a port number that was returned on a previous call to GetNextPort(), then the port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS is returned. If Port is not 0xFFFF and Port was not returned on a previous call to GetNextPort(), then EFI_INVALID_PARAMETER is returned.

If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is returned.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in,out]	Port	On input, a pointer to the port number on the ATA controller. On output, a pointer to the next port number on the ATA controller. An input value of 0xFFFF retrieves the first port number on the ATA controller.

Return values

EFI_SUCCESS	The next port number on the ATA controller was returned in Port.
EFI_NOT_FOUND	There are no more ports on this ATA controller.
EFI_INVALID_PARAMETER	Port is not 0xFFFF and Port was not returned on a previous call to GetNextPort().

Definition at line 1452 of file AtaAtapiPassThru.c.

◆ AtaPassThruPassThru()

EFI_STATUS EFIAPI AtaPassThruPassThru	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN UINT16	Port,
		IN UINT16	PortMultiplierPort,
		IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *	Packet,
		IN EFI_EVENT Event	OPTIONAL
	)

Sends an ATA command to an ATA device that is attached to the ATA controller. This function supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required, and the non-blocking I/O functionality is optional.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in]	Port	The port number of the ATA device to send the command.
[in]	PortMultiplierPort	The port multiplier port number of the ATA device to send the command. If there is no port multiplier, then specify 0xFFFF.
[in,out]	Packet	A pointer to the ATA command to send to the ATA device specified by Port and PortMultiplierPort.
[in]	Event	If non-blocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then non-blocking I/O is performed, and Event will be signaled when the ATA command completes.

Return values

EFI_SUCCESS	The ATA command was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_BAD_BUFFER_SIZE	The ATA command was not executed. The number of bytes that could be transferred is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_NOT_READY	The ATA command could not be sent because there are too many ATA commands already queued. The caller may retry again later.
EFI_DEVICE_ERROR	A device error occurred while attempting to send the ATA command.
EFI_INVALID_PARAMETER	Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA command was not sent, so no additional status information is available.

Definition at line 1282 of file AtaAtapiPassThru.c.

◆ AtaPassThruResetDevice()

EFI_STATUS EFIAPI AtaPassThruResetDevice	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN UINT16	Port,
		IN UINT16	PortMultiplierPort
	)

Resets an ATA device that is connected to an ATA controller.

The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort. If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is returned.

If Port or PortMultiplierPort are not in a valid range for this ATA controller, then EFI_INVALID_PARAMETER is returned.

If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR is returned.

If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is returned.

If the device reset operation is completed, then EFI_SUCCESS is returned.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in]	Port	Port represents the port number of the ATA device to be reset.
[in]	PortMultiplierPort	The port multiplier port number of the ATA device to reset. If there is no port multiplier, then specify 0xFFFF.

Return values

EFI_SUCCESS	The ATA device specified by Port and PortMultiplierPort was reset.
EFI_UNSUPPORTED	The ATA controller does not support a device reset operation.
EFI_INVALID_PARAMETER	Port or PortMultiplierPort are invalid.
EFI_DEVICE_ERROR	A device error occurred while attempting to reset the ATA device specified by Port and PortMultiplierPort.
EFI_TIMEOUT	A timeout occurred while attempting to reset the ATA device specified by Port and PortMultiplierPort.

Definition at line 1885 of file AtaAtapiPassThru.c.

◆ AtaPassThruResetPort()

EFI_STATUS EFIAPI AtaPassThruResetPort	(	IN EFI_ATA_PASS_THRU_PROTOCOL *	This,
		IN UINT16	Port
	)

Resets a specific port on the ATA controller. This operation also resets all the ATA devices connected to the port.

The ResetChannel() function resets an a specific port on an ATA controller. This operation resets all the ATA devices connected to that port. If this ATA controller does not support a reset port operation, then EFI_UNSUPPORTED is returned.

If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is returned.

If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.

If the port reset operation is completed, then EFI_SUCCESS is returned.

Parameters

[in]	This	A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
[in]	Port	The port number on the ATA controller.

Return values

EFI_SUCCESS	The ATA controller port was reset.
EFI_UNSUPPORTED	The ATA controller does not support a port reset operation.
EFI_DEVICE_ERROR	A device error occurred while attempting to reset the ATA port.
EFI_TIMEOUT	A timeout occurred while attempting to reset the ATA port.

Definition at line 1841 of file AtaAtapiPassThru.c.

◆ AtaPioDataInOut()

EFI_STATUS EFIAPI AtaPioDataInOut	(	IN EFI_PCI_IO_PROTOCOL *	PciIo,
		IN EFI_IDE_REGISTERS *	IdeRegisters,
		IN OUT VOID *	Buffer,
		IN UINT64	ByteCount,
		IN BOOLEAN	Read,
		IN EFI_ATA_COMMAND_BLOCK *	AtaCommandBlock,
		IN OUT EFI_ATA_STATUS_BLOCK *	AtaStatusBlock,
		IN UINT64	Timeout,
		IN ATA_NONBLOCK_TASK *	Task
	)

This function is used to send out ATA commands conforms to the PIO Data In Protocol.

Parameters

[in]	PciIo	A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data structure.
[in]	IdeRegisters	A pointer to EFI_IDE_REGISTERS data structure.
[in,out]	Buffer	A pointer to the source buffer for the data.
[in]	ByteCount	The length of the data.
[in]	Read	Flag used to determine the data transfer direction. Read equals 1, means data transferred from device to host;Read equals 0, means data transferred from host to device.
[in]	AtaCommandBlock	A pointer to EFI_ATA_COMMAND_BLOCK data structure.
[in,out]	AtaStatusBlock	A pointer to EFI_ATA_STATUS_BLOCK data structure.
[in]	Timeout	The time to complete the command, uses 100ns as a unit.
[in]	Task	Optional. Pointer to the ATA_NONBLOCK_TASK used by non-blocking mode.

Return values

EFI_SUCCESS	send out the ATA command and device send required data successfully.
EFI_DEVICE_ERROR	command sent failed.

Definition at line 934 of file IdeMode.c.

◆ AtaUdmaInOut()

EFI_STATUS EFIAPI AtaUdmaInOut	(	IN ATA_ATAPI_PASS_THRU_INSTANCE *	Instance,
		IN EFI_IDE_REGISTERS *	IdeRegisters,
		IN BOOLEAN	Read,
		IN VOID *	DataBuffer,
		IN UINT64	DataLength,
		IN EFI_ATA_COMMAND_BLOCK *	AtaCommandBlock,
		IN OUT EFI_ATA_STATUS_BLOCK *	AtaStatusBlock,
		IN UINT64	Timeout,
		IN ATA_NONBLOCK_TASK *	Task
	)

Perform an ATA Udma operation (Read, ReadExt, Write, WriteExt).

Parameters

[in]	Instance	A pointer to ATA_ATAPI_PASS_THRU_INSTANCE data structure.
[in]	IdeRegisters	A pointer to EFI_IDE_REGISTERS data structure.
[in]	Read	Flag used to determine the data transfer direction. Read equals 1, means data transferred from device to host;Read equals 0, means data transferred from host to device.
[in]	DataBuffer	A pointer to the source buffer for the data.
[in]	DataLength	The length of the data.
[in]	AtaCommandBlock	A pointer to EFI_ATA_COMMAND_BLOCK data structure.
[in,out]	AtaStatusBlock	A pointer to EFI_ATA_STATUS_BLOCK data structure.
[in]	Timeout	The time to complete the command, uses 100ns as a unit.
[in]	Task	Optional. Pointer to the ATA_NONBLOCK_TASK used by non-blocking mode.

Return values

EFI_SUCCESS	the operation is successful.
EFI_OUT_OF_RESOURCES	Build PRD table failed
EFI_UNSUPPORTED	Unknown channel or operations command
EFI_DEVICE_ERROR	Ata command execute failed

Definition at line 1263 of file IdeMode.c.

◆ CreateNewDeviceInfo()

EFI_STATUS EFIAPI CreateNewDeviceInfo	(	IN ATA_ATAPI_PASS_THRU_INSTANCE *	Instance,
		IN UINT16	Port,
		IN UINT16	PortMultiplier,
		IN EFI_ATA_DEVICE_TYPE	DeviceType,
		IN EFI_IDENTIFY_DATA *	IdentifyData
	)

Allocate device info data structure to contain device info. And insert the data structure to the tail of device list for tracing.

Parameters

[in]	Instance	A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
[in]	Port	The port number of the ATA device to send the command.
[in]	PortMultiplierPort	The port multiplier port number of the ATA device to send the command. If there is no port multiplier, then specify 0xFFFF.
[in]	DeviceType	The device type of the ATA device.
[in]	IdentifyData	The data buffer to store the output of the IDENTIFY cmd.

Return values

EFI_SUCCESS	Successfully insert the ata device to the tail of device list.
EFI_OUT_OF_RESOURCES	Can not allocate enough resource for use.

Definition at line 1071 of file AtaAtapiPassThru.c.

◆ DestroyAsynTaskList()

VOID EFIAPI DestroyAsynTaskList	(	IN ATA_ATAPI_PASS_THRU_INSTANCE *	Instance,
		IN BOOLEAN	IsSigEvent
	)

Destroy all pending non blocking tasks.

Parameters

[in]	Instance	A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
[in]	IsSigEvent	Indicate whether signal the task event when remove the task.

Definition at line 1145 of file AtaAtapiPassThru.c.

◆ DestroyDeviceInfoList()

VOID EFIAPI DestroyDeviceInfoList ( IN ATA_ATAPI_PASS_THRU_INSTANCE * Instance )

Destroy all attached ATA devices info.

Parameters

[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.

Definition at line 1113 of file AtaAtapiPassThru.c.

◆ EnumerateAttachedDevice()

EFI_STATUS EFIAPI EnumerateAttachedDevice ( IN ATA_ATAPI_PASS_THRU_INSTANCE * Instance )

Enumerate all attached ATA devices at IDE mode or AHCI mode separately.

The function is designed to enumerate all attached ATA devices.

Parameters

[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.

Return values

EFI_SUCCESS	Successfully enumerate attached ATA devices.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 1194 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruBuildDevicePath()

EFI_STATUS EFIAPI ExtScsiPassThruBuildDevicePath	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun,
		IN OUT EFI_DEVICE_PATH_PROTOCOL **	DevicePath
	)

Used to allocate and build a device path node for a SCSI device on a SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	The Target is an array of size TARGET_MAX_BYTES and it specifies the Target ID of the SCSI device for which a device path node is to be allocated and built. Transport drivers may chose to utilize a subset of this size to suit the representation of targets. For example, a Fibre Channel driver may use only 8 bytes (WWN) in the array to represent a FC target.
Lun	The LUN of the SCSI device for which a device path node is to be allocated and built.
DevicePath	A pointer to a single device path node that describes the SCSI device specified by Target and Lun. This function is responsible for allocating the buffer DevicePath with the boot service AllocatePool(). It is the caller's responsibility to free DevicePath when the caller is finished with DevicePath.

Return values

EFI_SUCCESS	The device path node that describes the SCSI device specified by Target and Lun was allocated and returned in DevicePath.
EFI_INVALID_PARAMETER	DevicePath is NULL.
EFI_NOT_FOUND	The SCSI devices specified by Target and Lun does not exist on the SCSI channel.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate DevicePath.

Definition at line 2332 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruGetNextTarget()

EFI_STATUS EFIAPI ExtScsiPassThruGetNextTarget	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT8 **	Target
	)

Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to see if a SCSI device is actually present at that location on the SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	(TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID (an array of TARGET_MAX_BYTES) of the next SCSI device present on a SCSI channel. An input value of 0xF(all bytes in the array are 0xF) in the Target array retrieves the Target ID of the first SCSI device present on a SCSI channel.

Return values

EFI_SUCCESS	The Target ID of the next SCSI device on the SCSI channel was returned in Target.
EFI_INVALID_PARAMETER	Target or Lun is NULL.
EFI_TIMEOUT	Target array is not all 0xF, and Target was not returned on a previous call to GetNextTarget().
EFI_NOT_FOUND	There are no more SCSI devices on this SCSI channel.

Definition at line 2594 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruGetNextTargetLun()

EFI_STATUS EFIAPI ExtScsiPassThruGetNextTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN OUT UINT8 **	Target,
		IN OUT UINT64 *	Lun
	)

Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	On input, a pointer to the Target ID (an array of size TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID (an array of TARGET_MAX_BYTES) of the next SCSI device present on a SCSI channel. An input value of 0xF(all bytes in the array are 0xF) in the Target array retrieves the Target ID of the first SCSI device present on a SCSI channel.
Lun	On input, a pointer to the LUN of a SCSI device present on the SCSI channel. On output, a pointer to the LUN of the next SCSI device present on a SCSI channel.

Return values

EFI_SUCCESS	The Target ID and LUN of the next SCSI device on the SCSI channel was returned in Target and Lun.
EFI_INVALID_PARAMETER	Target array is not all 0xF, and Target and Lun were not returned on a previous call to GetNextTargetLun().
EFI_NOT_FOUND	There are no more SCSI devices on this SCSI channel.

Definition at line 2200 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruGetTargetLun()

EFI_STATUS EFIAPI ExtScsiPassThruGetTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		OUT UINT8 **	Target,
		OUT UINT64 *	Lun
	)

Used to translate a device path node to a Target ID and LUN.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
DevicePath	A pointer to a single device path node that describes the SCSI device on the SCSI channel.
Target	A pointer to the Target Array which represents the ID of a SCSI device on the SCSI channel.
Lun	A pointer to the LUN of a SCSI device on the SCSI channel.

Return values

EFI_SUCCESS	DevicePath was successfully translated to a Target ID and LUN, and they were returned in Target and Lun.
EFI_INVALID_PARAMETER	DevicePath or Target or Lun is NULL.
EFI_NOT_FOUND	A valid translation from DevicePath to a Target ID and LUN does not exist.
EFI_UNSUPPORTED	This driver does not support the device path node type in DevicePath.

Definition at line 2419 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruPassThru()

EFI_STATUS EFIAPI ExtScsiPassThruPassThru	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun,
		IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *	Packet,
		IN EFI_EVENT Event	OPTIONAL
	)

Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the nonblocking I/O functionality is optional.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	The Target is an array of size TARGET_MAX_BYTES and it represents the id of the SCSI device to send the SCSI Request Packet. Each transport driver may choose to utilize a subset of this size to suit the needs of transport target representation. For example, a Fibre Channel driver may use only 8 bytes (WWN) to represent an FC target.
Lun	The LUN of the SCSI device to send the SCSI Request Packet.
Packet	A pointer to the SCSI Request Packet to send to the SCSI device specified by Target and Lun.
Event	If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then nonblocking I/O is performed, and Event will be signaled when the SCSI Request Packet completes.

Return values

EFI_SUCCESS	The SCSI Request Packet was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_BAD_BUFFER_SIZE	The SCSI Request Packet was not executed. The number of bytes that could be transferred is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
EFI_NOT_READY	The SCSI Request Packet could not be sent because there are too many SCSI Request Packets already queued. The caller may retry again later.
EFI_DEVICE_ERROR	A device error occurred while attempting to send the SCSI Request Packet.
EFI_INVALID_PARAMETER	Target, Lun, or the contents of ScsiRequestPacket are invalid.
EFI_UNSUPPORTED	The command described by the SCSI Request Packet is not supported by the host adapter. This includes the case of Bi-directional SCSI commands not supported by the implementation. The SCSI Request Packet was not sent, so no additional status information is available.
EFI_TIMEOUT	A timeout occurred while waiting for the SCSI Request Packet to execute.

Definition at line 2002 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruResetChannel()

EFI_STATUS EFIAPI ExtScsiPassThruResetChannel ( IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * This )

Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.

Return values

EFI_SUCCESS	The SCSI channel was reset.
EFI_DEVICE_ERROR	A device error occurred while attempting to reset the SCSI channel.
EFI_TIMEOUT	A timeout occurred while attempting to reset the SCSI channel.
EFI_UNSUPPORTED	The SCSI channel does not support a channel reset operation.

Definition at line 2495 of file AtaAtapiPassThru.c.

◆ ExtScsiPassThruResetTargetLun()

EFI_STATUS EFIAPI ExtScsiPassThruResetTargetLun	(	IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *	This,
		IN UINT8 *	Target,
		IN UINT64	Lun
	)

Resets a SCSI logical unit that is connected to a SCSI channel.

Parameters

This	A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target	The Target is an array of size TARGET_MAX_BYTE and it represents the target port ID of the SCSI device containing the SCSI logical unit to reset. Transport drivers may chose to utilize a subset of this array to suit the representation of their targets.
Lun	The LUN of the SCSI device to reset.

Return values

EFI_SUCCESS	The SCSI device specified by Target and Lun was reset.
EFI_INVALID_PARAMETER	Target or Lun is NULL.
EFI_TIMEOUT	A timeout occurred while attempting to reset the SCSI device specified by Target and Lun.
EFI_UNSUPPORTED	The SCSI channel does not support a target reset operation.
EFI_DEVICE_ERROR	A device error occurred while attempting to reset the SCSI device specified by Target and Lun.

Definition at line 2526 of file AtaAtapiPassThru.c.

◆ IdeModeInitialization()

EFI_STATUS EFIAPI IdeModeInitialization ( IN ATA_ATAPI_PASS_THRU_INSTANCE * Instance )

Initialize ATA host controller at IDE mode.

The function is designed to initialize ATA host controller.

Parameters

[in] Instance A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.

Definition at line 2601 of file IdeMode.c.

◆ SearchDeviceInfoList()

LIST_ENTRY *EFIAPI SearchDeviceInfoList	(	IN ATA_ATAPI_PASS_THRU_INSTANCE *	Instance,
		IN UINT16	Port,
		IN UINT16	PortMultiplier,
		IN EFI_ATA_DEVICE_TYPE	DeviceType
	)

Traverse the attached ATA devices list to find out the device to access.

Parameters

[in]	Instance	A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.
[in]	Port	The port number of the ATA device to send the command.
[in]	PortMultiplierPort	The port multiplier port number of the ATA device to send the command. If there is no port multiplier, then specify 0xFFFF.
[in]	DeviceType	The device type of the ATA device.

Return values

The	pointer to the data structure of the device info to access.

Definition at line 1014 of file AtaAtapiPassThru.c.

Variable Documentation

◆ gAtaAtapiPassThruComponentName

EFI_COMPONENT_NAME_PROTOCOL gAtaAtapiPassThruComponentName

extern

Definition at line 35 of file ComponentName.c.

◆ gAtaAtapiPassThruComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gAtaAtapiPassThruComponentName2

extern

Definition at line 44 of file ComponentName.c.

◆ gAtaAtapiPassThruDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gAtaAtapiPassThruDriverBinding

extern

Definition at line 15 of file AtaAtapiPassThru.c.

◆ mAtaAtapiPolicy

EDKII_ATA_ATAPI_POLICY_PROTOCOL* mAtaAtapiPolicy

extern

Definition at line 139 of file AtaAtapiPassThru.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ATA_ATAPI_DEVICE_INFO_FROM_THIS

◆ ATA_ATAPI_DEVICE_SIGNATURE

◆ ATA_ATAPI_PASS_THRU_SIGNATURE

◆ ATA_ATAPI_TIMEOUT

◆ ATA_NON_BLOCK_TASK_FROM_ENTRY

◆ ATA_NONBLOCKING_TASK_SIGNATURE

◆ ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS

◆ ATA_SPINUP_TIMEOUT

◆ EXT_SCSI_PASS_THRU_PRIVATE_DATA_FROM_THIS

Typedef Documentation

◆ ATA_NONBLOCK_TASK

Enumeration Type Documentation

◆ EFI_ATA_DEVICE_TYPE

◆ EFI_ATA_HC_WORK_MODE

Function Documentation

◆ AhciDmaTransfer()

◆ AhciModeInitialization()

◆ AhciNonDataTransfer()

◆ AhciPioTransfer()

◆ AsyncNonBlockingTransferRoutine()

◆ AtaAtapiPassThruComponentNameGetControllerName()

◆ AtaAtapiPassThruComponentNameGetDriverName()

◆ AtaAtapiPassThruStart()

◆ AtaAtapiPassThruStop()

◆ AtaAtapiPassThruSupported()

◆ AtaNonDataCommandIn()

◆ AtaPassThruBuildDevicePath()

◆ AtaPassThruGetDevice()

◆ AtaPassThruGetNextDevice()

◆ AtaPassThruGetNextPort()

◆ AtaPassThruPassThru()

◆ AtaPassThruResetDevice()

◆ AtaPassThruResetPort()

◆ AtaPioDataInOut()

◆ AtaUdmaInOut()

◆ CreateNewDeviceInfo()

◆ DestroyAsynTaskList()

◆ DestroyDeviceInfoList()

◆ EnumerateAttachedDevice()

◆ ExtScsiPassThruBuildDevicePath()

◆ ExtScsiPassThruGetNextTarget()

◆ ExtScsiPassThruGetNextTargetLun()

◆ ExtScsiPassThruGetTargetLun()

◆ ExtScsiPassThruPassThru()

◆ ExtScsiPassThruResetChannel()

◆ ExtScsiPassThruResetTargetLun()

◆ IdeModeInitialization()

◆ SearchDeviceInfoList()

Variable Documentation

◆ gAtaAtapiPassThruComponentName

◆ gAtaAtapiPassThruComponentName2

◆ gAtaAtapiPassThruDriverBinding

◆ mAtaAtapiPolicy