MdePkg/Include/Ppi/BlockIo.h

   1 /** @file
   2   This file declares BlockIo PPI used to access block-oriented storage devices
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  BlockIo.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in Framework of EFI Recovery Spec
  17   Version 0.9
  18
  19 **/
  20
  21 #ifndef _PEI_BLOCK_IO_H_
  22 #define _PEI_BLOCK_IO_H_
  23
  24 #define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \
  25   { \
  26     0x695d8aa1, 0x42ee, 0x4c46, {0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \
  27   }
  28
  29 typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI;
  30
  31 typedef UINT64  EFI_PEI_LBA;
  32
  33 typedef enum {
  34   LegacyFloppy  = 0,
  35   IdeCDROM      = 1,
  36   IdeLS120      = 2,
  37   UsbMassStorage= 3,
  38   MaxDeviceType
  39 } EFI_PEI_BLOCK_DEVICE_TYPE;
  40
  41 typedef struct {
  42   EFI_PEI_BLOCK_DEVICE_TYPE  DeviceType;
  43   BOOLEAN                    MediaPresent;
  44   UINTN                      LastBlock;
  45   UINTN                      BlockSize;
  46 } EFI_PEI_BLOCK_IO_MEDIA;
  47
  48 /**
  49   Gets the count of block I/O devices that one specific block driver detects.
  50
  51   @param  PeiServices General-purpose services that are available to every PEIM.
  52
  53   @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
  54
  55   @param  NumberBlockDevices The number of block I/O devices discovered.
  56
  57   @return Status code
  58
  59 **/
  60 typedef
  61 EFI_STATUS
  62 (EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES) (
  63   IN  EFI_PEI_SERVICES                         **PeiServices,
  64   IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI            *This,
  65   OUT UINTN                                    *NumberBlockDevices
  66   );
  67
  68 /**
  69   Gets a block device¡¯s media information.
  70
  71   @param  PeiServices General-purpose services that are available to every PEIM
  72
  73   @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
  74
  75   @param  DeviceIndex Specifies the block device to which the function
  76   wants to talk. Because the driver that implements Block I/O PPIs
  77   will manage multiple block devices, the PPIs that want to talk to a single
  78   device must specify the device index that was assigned during the enumeration
  79   process. This index is a number from one to NumberBlockDevices.
  80
  81   @param  MediaInfo The media information of the specified block media.
  82
  83   @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
  84
  85   @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
  86
  87 **/
  88 typedef
  89 EFI_STATUS
  90 (EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION) (
  91   IN  EFI_PEI_SERVICES                         **PeiServices,
  92   IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI            *This,
  93   IN  UINTN                                    DeviceIndex,
  94   OUT EFI_PEI_BLOCK_IO_MEDIA                   *MediaInfo
  95   );
  96
  97 /**
  98   Reads the requested number of blocks from the specified block device.
  99
 100   @param  PeiServices General-purpose services that are available to every PEIM.
 101
 102   @param  This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
 103
 104   @param  DeviceIndex Specifies the block device to which the function wants to talk.
 105
 106   @param  StartLBA The starting logical block address (LBA) to read from on the device
 107
 108   @param  BufferSize The size of the Buffer in bytes. This number must
 109   be a multiple of the intrinsic block size of the device.
 110
 111   @param  Buffer A pointer to the destination buffer for the data.
 112   The caller is responsible for the ownership of the buffer.
 113
 114   @retval EFI_SUCCESS The data was read correctly from the device.
 115
 116   @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
 117
 118   @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
 119   or the buffer is not properly aligned.
 120
 121   @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
 122   the intrinsic block size of the device.
 123
 124   @retval EFI_NO_MEDIA There is no media in the device.
 125
 126 **/
 127 typedef
 128 EFI_STATUS
 129 (EFIAPI *EFI_PEI_READ_BLOCKS) (
 130   IN  EFI_PEI_SERVICES                         **PeiServices,
 131   IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI            *This,
 132   IN  UINTN                                    DeviceIndex,
 133   IN  EFI_PEI_LBA                              StartLBA,
 134   IN  UINTN                                    BufferSize,
 135   OUT VOID                                     *Buffer
 136   );
 137
 138 /**
 139   @par Ppi Description:
 140   EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required
 141   to access a block I/O device during PEI recovery boot mode.
 142
 143   @param GetNumberOfBlockDevices
 144   Gets the number of block I/O devices that the specific block driver manages.
 145
 146   @param GetBlockDeviceMediaInfo
 147   Gets the specified media information.
 148
 149   @param ReadBlocks
 150   Reads the requested number of blocks from the specified block device.
 151
 152 **/
 153 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {
 154   EFI_PEI_GET_NUMBER_BLOCK_DEVICES      GetNumberOfBlockDevices;
 155   EFI_PEI_GET_DEVICE_MEDIA_INFORMATION  GetBlockDeviceMediaInfo;
 156   EFI_PEI_READ_BLOCKS                   ReadBlocks;
 157 };
 158
 159 extern EFI_GUID gEfiPeiBlockIoPpiGuid;
 160
 161 #endif