Files
slimbootloader/BootloaderCommonPkg/Include/Library/AhciBlockIoLib.h
T
Guo Dong 5e10bd1e07 Update BSD license to BSD+Patent license
To align with EDK2, update file license
to use BSD+Patent license

Signed-off-by: Guo Dong <guo.dong@intel.com>
2019-06-13 10:46:49 -07:00

117 lines
4.2 KiB
C

/** @file
Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _AHCI_BLOCK_IO_LIB_H_
#define _AHCI_BLOCK_IO_LIB_H_
#include <BlockDevice.h>
/**
Reads the requested number of blocks from the specified block device.
The function reads the requested number of blocks from the device. All the
blocks are read, or an error is returned. If there is no media in the device,
the function returns EFI_NO_MEDIA.
@param[in] DeviceIndex Specifies the block device to which the function wants
to talk.
@param[in] StartLBA The starting logical block address (LBA) to read from
on the device
@param[in] BufferSize The size of the Buffer in bytes. This number must be
a multiple of the intrinsic block size of the device.
@param[out] Buffer A pointer to the destination buffer for the data.
The caller is responsible for the ownership of the
buffer.
@retval EFI_SUCCESS The data was read correctly from the device.
@retval EFI_DEVICE_ERROR The device reported an error while attempting
to perform the read operation.
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not
valid, or the buffer is not properly aligned.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
the intrinsic block size of the device.
**/
EFI_STATUS
EFIAPI
AhciReadBlocks (
IN UINTN DeviceIndex,
IN EFI_LBA StartLBA,
IN UINTN BufferSize,
OUT VOID *Buffer
);
/**
This function writes data from Memory to AHCI
@param[in] DeviceIndex Specifies the block device to which the function wants
to talk.
@param[in] StartLBA Target AHCI block number(LBA) where data will be written
@param[in] BufferSize Total data size to be written in bytes unit
@param[out] Buffer Data address in Memory to be copied to AHCI
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails.
**/
EFI_STATUS
EFIAPI
AhciWriteBlocks (
IN UINTN DeviceIndex,
IN EFI_PEI_LBA StartLBA,
IN UINTN BufferSize,
OUT VOID *Buffer
);
/**
Gets a block device's media information.
This function will provide the caller with the specified block device's media
information. If the media changes, calling this function will update the media
information accordingly.
@param[in] DeviceIndex Specifies the block device to which the function wants
to talk.
@param[out] DevBlockInfo The Block Io information of the specified block partition.
@retval EFI_SUCCESS The Block Io information about the specified block device
was obtained successfully.
@retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware
error.
**/
EFI_STATUS
EFIAPI
AhciGetMediaInfo (
IN UINTN DeviceIndex,
OUT DEVICE_BLOCK_INFO *DevBlockInfo
);
/**
The function will initialize AHCI device.
Based on AhciHcPciBase, this function will initialize AHCI host controller, allocate
necessary resources, and enumarate all the LUNs.
@param[in] AhciHcPciBase AHCI Host Controller's PCI ConfigSpace Base address
@param[in] DevInitPhase For the performance optimization,
Device initialization is separated to several phases.
@retval EFI_SUCCESS The driver is successfully initialized.
@retval Others Can't initialize the AHCI device.
**/
EFI_STATUS
EFIAPI
AhciInitialize (
IN UINTN AhciHcPciBase,
IN DEVICE_INIT_PHASE DevInitPhase
);
#endif