OvmfPkg/XenPvBlkDxe: Add BlockIo.

Implement the BlockIo protocol.

Change in V4:
- Replace the license by the commonly used file header text.

Change in V3:
- assert(Media->BlockSize % 512 == 0)
- Use Sector instead of Offset to issue IOs.

Change in V2:
- Remove blockIo2 headers.
- Fix few comment.
- file header, copyright
- Rewrite few comment and error messages
- No more callback
- Improving block read/write, increase to the max size in one request
  (instead of only 8pages)
- Fix lastblock when it's a cdrom
- Do uninitialisation when fail to install fail
- few comment
- Licenses

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16274 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 108 insertions, 0 deletions

diff --git a/OvmfPkg/XenPvBlkDxe/BlockIo.h b/OvmfPkg/XenPvBlkDxe/BlockIo.h
new file mode 100644
index 0000000000..a05f27c813
--- /dev/null
+++ b/OvmfPkg/XenPvBlkDxe/BlockIo.h
@@ -0,0 +1,108 @@
+/** @file

+  BlockIo function declaration for Xen PV block driver.

+

+  Copyright (C) 2014, Citrix Ltd.

+

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+/**

+  Read BufferSize bytes from Lba into Buffer.

+

+  @param  This       Indicates a pointer to the calling context.

+  @param  MediaId    Id of the media, changes every time the media is replaced.

+  @param  Lba        The starting Logical Block Address to read from

+  @param  BufferSize Size of Buffer, must be a multiple of device block size.

+  @param  Buffer     A pointer to the destination buffer for the data. The caller is

+                     responsible for either having implicit or explicit ownership of the buffer.

+

+  @retval EFI_SUCCESS           The data was read correctly from the device.

+  @retval EFI_DEVICE_ERROR      The device reported an error while performing the read.

+  @retval EFI_NO_MEDIA          There is no media in the device.

+  @retval EFI_MEDIA_CHANGED     The MediaId does not matched the current device.

+  @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.

+  @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,

+                                or the buffer is not on proper alignment.

+

+**/

+EFI_STATUS

+EFIAPI

+XenPvBlkDxeBlockIoReadBlocks (

+  IN EFI_BLOCK_IO_PROTOCOL          *This,

+  IN UINT32                         MediaId,

+  IN EFI_LBA                        Lba,

+  IN UINTN                          BufferSize,

+  OUT VOID                          *Buffer

+  );

+

+/**

+  Write BufferSize bytes from Lba into Buffer.

+

+  @param  This       Indicates a pointer to the calling context.

+  @param  MediaId    The media ID that the write request is for.

+  @param  Lba        The starting logical block address to be written. The caller is

+                     responsible for writing to only legitimate locations.

+  @param  BufferSize Size of Buffer, must be a multiple of device block size.

+  @param  Buffer     A pointer to the source buffer for the data.

+

+  @retval EFI_SUCCESS           The data was written correctly to the device.

+  @retval EFI_WRITE_PROTECTED   The device can not be written to.

+  @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.

+  @retval EFI_NO_MEDIA          There is no media in the device.

+  @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.

+  @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.

+  @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,

+                                or the buffer is not on proper alignment.

+

+**/

+EFI_STATUS

+EFIAPI

+XenPvBlkDxeBlockIoWriteBlocks (

+  IN EFI_BLOCK_IO_PROTOCOL          *This,

+  IN UINT32                         MediaId,

+  IN EFI_LBA                        Lba,

+  IN UINTN                          BufferSize,

+  IN VOID                           *Buffer

+  );

+

+/**

+  Flush the Block Device.

+

+  @param  This              Indicates a pointer to the calling context.

+

+  @retval EFI_SUCCESS       All outstanding data was written to the device

+  @retval EFI_DEVICE_ERROR  The device reported an error while writting back the data

+  @retval EFI_NO_MEDIA      There is no media in the device.

+

+**/

+EFI_STATUS

+EFIAPI

+XenPvBlkDxeBlockIoFlushBlocks (

+  IN EFI_BLOCK_IO_PROTOCOL  *This

+  );

+

+/**

+  Reset the block device hardware.

+

+  @param[in]  This                 Indicates a pointer to the calling context.

+  @param[in]  ExtendedVerification Not used.

+

+  @retval EFI_SUCCESS          The device was reset.

+

+**/

+EFI_STATUS

+EFIAPI

+XenPvBlkDxeBlockIoReset (

+  IN EFI_BLOCK_IO_PROTOCOL   *This,

+  IN BOOLEAN                 ExtendedVerification

+  );

+

+extern EFI_BLOCK_IO_MEDIA  gXenPvBlkDxeBlockIoMedia;

+extern EFI_BLOCK_IO_PROTOCOL  gXenPvBlkDxeBlockIo;