4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI_ATA_PASS_THRU_PROTOCOL provides information about an ATA controller and the ability
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to send ATA Command Blocks to any ATA device attached to that ATA controller. The information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync includes the attributes of the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x1d3de7f0, 0x807, 0x424f, {0xaa, 0x69, 0x11, 0xa5, 0x4e, 0x19, 0xa4, 0x6f } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_ATA_PASS_THRU_PROTOCOL EFI_ATA_PASS_THRU_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If this bit is set, then the EFI_ATA_PASS_THRU_PROTOCOL interface is for physical
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// devices on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL 0x0001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If this bit is set, then the EFI_ATA_PASS_THRU_PROTOCOL interface is for logical
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// devices on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If this bit is set, then the EFI_ATA_PASS_THRU_PROTOCOL interface supports non blocking
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// I/O. Every EFI_ATA_PASS_THRU_PROTOCOL must support blocking I/O. The support of non-blocking
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// I/O is optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_ATTRIBUTES_NONBLOCKIO 0x0004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_ATA_HARDWARE_RESET 0x00
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_ATA_SOFTWARE_RESET 0x01
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_ATA_NON_DATA 0x02
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_PIO_DATA_OUT 0x05
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_DEVICE_DIAGNOSTIC 0x08
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_DEVICE_RESET 0x09
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_IN 0x0A
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_UDMA_DATA_OUT 0x0B
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_PROTOCOL_RETURN_RESPONSE 0xFF
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_ATA_PASS_THRU_LENGTH_NO_DATA_TRANSFER 0x00
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the sense data that was generated by the execution of the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// command. It must be aligned to the boundary specified in the IoAlign field
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// in the EFI_ATA_PASS_THRU_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to buffer that contains the Command Data Block to send to the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// device specified by Port and PortMultiplierPort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The timeout, in 100 ns units, to use for the execution of this ATA command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A Timeout value of 0 means that this function will wait indefinitely for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ATA command to execute. If Timeout is greater than zero, then this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// will return EFI_TIMEOUT if the time required to execute the ATA command is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// greater than Timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the data buffer to transfer between the ATA controller and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ATA device for read and bidirectional commands. For all write and non data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// commands where InTransferLength is 0 this field is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If this field is not NULL, then it must be aligned on the boundary specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// by the IoAlign field in the EFI_ATA_PASS_THRU_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the data buffer to transfer between the ATA controller and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ATA device for write or bidirectional commands. For all read and non data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// commands where OutTransferLength is 0 this field is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If this field is not NULL, then it must be aligned on the boundary specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// by the IoAlign field in the EFI_ATA_PASS_THRU_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// On input, the size, in bytes, of InDataBuffer. On output, the number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// transferred between the ATA controller and the ATA device. If InTransferLength
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is larger than the ATA controller can handle, no data will be transferred,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// InTransferLength will be updated to contain the number of bytes that the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// controller is able to transfer, and EFI_BAD_BUFFER_SIZE will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// On Input, the size, in bytes of OutDataBuffer. On Output, the Number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// transferred between ATA Controller and the ATA device. If OutTransferLength is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// larger than the ATA controller can handle, no data will be transferred,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// OutTransferLength will be updated to contain the number of bytes that the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// controller is able to transfer, and EFI_BAD_BUFFER_SIZE will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies the protocol used when the ATA device executes the command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies the way in which the ATA command length is encoded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends an ATA command to an ATA device that is attached to the ATA controller. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supports both blocking I/O and non-blocking I/O. The blocking I/O functionality is required,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the non-blocking I/O functionality is optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Port The port number of the ATA device to send the command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PortMultiplierPort The port multiplier port number of the ATA device to send the command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there is no port multiplier, then specify 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] Packet A pointer to the ATA command to send to the ATA device specified by Port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and PortMultiplierPort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Event If non-blocking I/O is not supported then Event is ignored, and blocking
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync I/O is performed. If Event is NULL, then blocking I/O is performed. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Event is not NULL and non blocking I/O is supported, then non-blocking
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync I/O is performed, and Event will be signaled when the ATA command completes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The ATA command was sent by the host. For bi-directional commands,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InTransferLength bytes were transferred from InDataBuffer. For write and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. The number of bytes that could be transferred
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned in InTransferLength. For write and bi-directional commands,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutTransferLength bytes were transferred by OutDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The ATA command could not be sent because there are too many ATA commands
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync already queued. The caller may retry again later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the ATA command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Port, PortMultiplierPort, or the contents of Acb are invalid. The ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command was not sent, so no additional status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Used to retrieve the lis t of legal port numbers for ATA devices on an ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync These can either be the list of ports where ATA devices are actually present or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync list of legal port numbers for the ATA controller. Regardless, the caller of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function must probe the port number returned to see if an ATA device is actually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync present at that location on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetNextPort() function retrieves the port number on an ATA controller. If on input
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Port is 0xFFFF, then the port number of the first port on the ATA controller is returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Port and EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Port is a port number that was returned on a previous call to GetNextPort(), then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync port number of the next port on the ATA controller is returned in Port, and EFI_SUCCESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned. If Port is not 0xFFFF and Port was not returned on a previous call to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetNextPort(), then EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Port is the port number of the last port on the ATA controller, then EFI_NOT_FOUND is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] Port On input, a pointer to the port number on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, a pointer to the next port number on the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller. An input value of 0xFFFF retrieves the first port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The next port number on the ATA controller was returned in Port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There are no more ports on this ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not returned on a previous call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to GetNextPort().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Used to retrieve the list of legal port multiplier port numbers for ATA devices on a port of an ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller. These can either be the list of port multiplier ports where ATA devices are actually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync present on port or the list of legal port multiplier ports on that port. Regardless, the caller of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function must probe the port number and port multiplier port number returned to see if an ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device is actually present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetNextDevice() function retrieves the port multiplier port number of an ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync present on a port of an ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PortMultiplierPort points to a port multiplier port number value that was returned on a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previous call to GetNextDevice(), then the port multiplier port number of the next ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the port of the ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PortMultiplierPort points to 0xFFFF, then the port multiplier port number of the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ATA device on port of the ATA controller is returned in PortMultiplierPort and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PortMultiplierPort is not 0xFFFF and the value pointed to by PortMultiplierPort
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was not returned on a previous call to GetNextDevice(), then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PortMultiplierPort is the port multiplier port number of the last ATA device on the port of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the ATA controller, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Port The port number present on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] PortMultiplierPort On input, a pointer to the port multiplier port number of an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ATA device present on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If on input a PortMultiplierPort of 0xFFFF is specified,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the port multiplier port number of the first ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned. On output, a pointer to the port multiplier port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of the next ATA device present on an ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The port multiplier port number of the next ATA device on the port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the ATA controller was returned in PortMultiplierPort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There are no more ATA devices on this port of the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and PortMultiplierPort was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned on a previous call to GetNextDevice().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Used to allocate and build a device path node for an ATA device on an ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The BuildDevicePath() function allocates and builds a single device node for the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device specified by Port and PortMultiplierPort. If the ATA device specified by Port and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PortMultiplierPort is not present on the ATA controller, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DevicePath is NULL, then EFI_INVALID_PARAMETER is returned. If there are not enough
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resources to allocate the device path node, then EFI_OUT_OF_RESOURCES is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, DevicePath is allocated with the boot service AllocatePool(), the contents of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePath are initialized to describe the ATA device specified by Port and PortMultiplierPort,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Port Port specifies the port number of the ATA device for which a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device path node is to be allocated and built.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PortMultiplierPort The port multiplier port number of the ATA device for which a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device path node is to be allocated and built. If there is no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync port multiplier, then specify 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] DevicePath A pointer to a single device path node that describes the ATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device specified by Port and PortMultiplierPort. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is responsible for allocating the buffer DevicePath with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync boot service AllocatePool(). It is the caller's responsibility
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to free DevicePath when the caller is finished with DevicePath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The device path node that describes the ATA device specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Port and PortMultiplierPort was allocated and returned in DevicePath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The ATA device specified by Port and PortMultiplierPort does not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exist on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DevicePath is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Used to translate a device path node to a port number and port multiplier port number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetDevice() function determines the port and port multiplier port number associated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the ATA device described by DevicePath. If DevicePath is a device path node type that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ATA Pass Thru driver supports, then the ATA Pass Thru driver will attempt to translate the contents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePath into a port number and port multiplier port number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this translation is successful, then that port number and port multiplier port number are returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Port and PortMultiplierPort, and EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DevicePath, Port, or PortMultiplierPort are NULL, then EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DevicePath is not a device path node type that the ATA Pass Thru driver supports, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UNSUPPORTED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DevicePath is a device path node type that the ATA Pass Thru driver supports, but there is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a valid translation from DevicePath to a port number and port multiplier port number, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DevicePath A pointer to the device path node that describes an ATA device on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Port On return, points to the port number of an ATA device on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] PortMultiplierPort On return, points to the port multiplier port number of an ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS DevicePath was successfully translated to a port number and port multiplier
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync port number, and they were returned in Port and PortMultiplierPort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DevicePath is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Port is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PortMultiplierPort is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This driver does not support the device path node type in DevicePath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND A valid translation from DevicePath to a port number and port multiplier
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync port number does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets a specific port on the ATA controller. This operation also resets all the ATA devices
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync connected to the port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ResetChannel() function resets an a specific port on an ATA controller. This operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resets all the ATA devices connected to that port. If this ATA controller does not support
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a reset port operation, then EFI_UNSUPPORTED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a device error occurs while executing that port reset operation, then EFI_DEVICE_ERROR is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a timeout occurs during the execution of the port reset operation, then EFI_TIMEOUT is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the port reset operation is completed, then EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Port The port number on the ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The ATA controller port was reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The ATA controller does not support a port reset operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets an ATA device that is connected to an ATA controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ResetDevice() function resets the ATA device specified by Port and PortMultiplierPort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this ATA controller does not support a device reset operation, then EFI_UNSUPPORTED is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Port or PortMultiplierPort are not in a valid range for this ATA controller, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a device error occurs while executing that device reset operation, then EFI_DEVICE_ERROR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a timeout occurs during the execution of the device reset operation, then EFI_TIMEOUT is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the device reset operation is completed, then EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_ATA_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Port Port represents the port number of the ATA device to be reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PortMultiplierPort The port multiplier port number of the ATA device to reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there is no port multiplier, then specify 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The ATA device specified by Port and PortMultiplierPort was reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The ATA controller does not support a device reset operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Port or PortMultiplierPort are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Port and PortMultiplierPort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while attempting to reset the ATA device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Port and PortMultiplierPort.