IntelFrameworkPkg/Include/Ppi/BlockIo.h

   1 /** @file
   2   This file declares BlockIo PPI used to access block-oriented storage devices
   3
   4   Copyright (c) 2007, 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 #include <PiPei.h>
  25
  26 #define EFI_PEI_IDE_BLOCK_IO_PPI \
  27   { \
  28     0x0964e5b22, 0x6459, 0x11d2, { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b }  \
  29   }
  30
  31 #define EFI_PEI_144_FLOPPY_BLOCK_IO_PPI \
  32   { \
  33     0xda6855bd, 0x07b7, 0x4c05, { 0x9e, 0xd8, 0xe2, 0x59, 0xfd, 0x36, 0x0e, 0x22 }  \
  34   }
  35
  36 #define EFI_PEI_VIRTUAL_BLOCK_IO_PPI \
  37   { \
  38     0x695d8aa1, 0x42ee, 0x4c46, { 0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 } \
  39   }
  40
  41 typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI;
  42
  43 typedef UINT64  EFI_PEI_LBA;
  44
  45 typedef enum {
  46   LegacyFloppy  = 0,
  47   IdeCDROM      = 1,
  48   IdeLS120      = 2,
  49   UsbMassStorage= 3,
  50   MaxDeviceType
  51 } EFI_PEI_BLOCK_DEVICE_TYPE;
  52
  53 typedef struct {
  54   EFI_PEI_BLOCK_DEVICE_TYPE  DeviceType;
  55   BOOLEAN                    MediaPresent;
  56   UINTN                      LastBlock;
  57   UINTN                      BlockSize;
  58 } EFI_PEI_BLOCK_IO_MEDIA;
  59
  60 /**
  61   Gets the count of block I/O devices that one specific block driver detects.
  62
  63   @param  PeiServices        General-purpose services that are available to every PEIM.
  64   @param  This               Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
  65   @param  NumberBlockDevices The number of block I/O devices discovered.
  66
  67   @return Status code
  68
  69 **/
  70 typedef
  71 EFI_STATUS
  72 (EFIAPI *EFI_PEI_GET_NUMBER_BLOCK_DEVICES) (
  73   IN  EFI_PEI_SERVICES                         **PeiServices,
  74   IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI            *This,
  75   OUT UINTN                                    *NumberBlockDevices
  76   );
  77
  78 /**
  79   Gets a block device's media information.
  80
  81   @param  PeiServices    General-purpose services that are available to every PEIM
  82   @param  This           Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
  83   @param  DeviceIndex    Specifies the block device to which the function
  84                          wants to talk. Because the driver that implements Block I/O PPIs
  85                          will manage multiple block devices, the PPIs that want to talk to a single
  86                          device must specify the device index that was assigned during the enumeration
  87                          process. This index is a number from one to NumberBlockDevices.
  88   @param  MediaInfo      The media information of the specified block media.
  89
  90   @retval EFI_SUCCESS           Media information about the specified block device was obtained successfully.
  91   @retval EFI_DEVICE_ERROR      Cannot get the media information due to a hardware error.
  92
  93 **/
  94 typedef
  95 EFI_STATUS
  96 (EFIAPI *EFI_PEI_GET_DEVICE_MEDIA_INFORMATION) (
  97   IN  EFI_PEI_SERVICES                         **PeiServices,
  98   IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI            *This,
  99   IN  UINTN                                    DeviceIndex,
 100   OUT EFI_PEI_BLOCK_IO_MEDIA                   *MediaInfo
 101   );
 102
 103 /**
 104   Reads the requested number of blocks from the specified block device.
 105
 106   @param  PeiServices    General-purpose services that are available to every PEIM.
 107   @param  This           Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
 108   @param  DeviceIndex    Specifies the block device to which the function wants to talk.
 109   @param  StartLBA       The starting logical block address (LBA) to read from on the device
 110   @param  BufferSize     The size of the Buffer in bytes. This number must
 111                          be a multiple of the intrinsic block size of the device.
 112   @param  Buffer         A pointer to the destination buffer for the data.
 113                          The caller is responsible for the ownership of the buffer.
 114
 115   @retval EFI_SUCCESS           The data was read correctly from the device.
 116   @retval EFI_DEVICE_ERROR      The device reported an error while attempting to perform the read operation.
 117   @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
 118                                 or the buffer is not properly aligned.
 119   @retval EFI_BAD_BUFFER_SIZE   The BufferSize parameter is not a multiple of
 120                                 the intrinsic block size of the device.
 121   @retval EFI_NO_MEDIA          There is no media in the device.
 122
 123 **/
 124 typedef
 125 EFI_STATUS
 126 (EFIAPI *EFI_PEI_READ_BLOCKS) (
 127   IN  EFI_PEI_SERVICES                         **PeiServices,
 128   IN  EFI_PEI_RECOVERY_BLOCK_IO_PPI            *This,
 129   IN  UINTN                                    DeviceIndex,
 130   IN  EFI_PEI_LBA                              StartLBA,
 131   IN  UINTN                                    BufferSize,
 132   OUT VOID                                     *Buffer
 133   );
 134
 135 /**
 136   @par Ppi Description:
 137   EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required
 138   to access a block I/O device during PEI recovery boot mode.
 139
 140   @param GetNumberOfBlockDevices
 141   Gets the number of block I/O devices that the specific block driver manages.
 142
 143   @param GetBlockDeviceMediaInfo
 144   Gets the specified media information.
 145
 146   @param ReadBlocks
 147   Reads the requested number of blocks from the specified block device.
 148
 149 **/
 150 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {
 151   EFI_PEI_GET_NUMBER_BLOCK_DEVICES      GetNumberOfBlockDevices;
 152   EFI_PEI_GET_DEVICE_MEDIA_INFORMATION  GetBlockDeviceMediaInfo;
 153   EFI_PEI_READ_BLOCKS                   ReadBlocks;
 154 };
 155
 156 extern EFI_GUID gEfiPeiIdeBlockIoPpiGuid;
 157 extern EFI_GUID gEfiPei144FloppyBlockIoPpiGuid;
 158 extern EFI_GUID gEfiPeiVirtualBlockIoPpiGuid;
 159
 160 #endif