MdePkg/Include/Protocol/BlockIo.h

   1 /** @file
   2   Block IO protocol as defined in the EFI 1.0 specification.
   3
   4   The Block IO protocol is used to abstract block devices like hard drives,
   5   DVD-ROMs and floppy drives.
   6
   7   Copyright (c) 2006, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   Module Name:  BlockIo.h
  17
  18 **/
  19
  20 #ifndef __BLOCK_IO_H__
  21 #define __BLOCK_IO_H__
  22
  23 #define EFI_BLOCK_IO_PROTOCOL_GUID \
  24   { \
  25     0x964e5b21, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  26   }
  27
  28 typedef struct _EFI_BLOCK_IO_PROTOCOL  EFI_BLOCK_IO_PROTOCOL;
  29
  30 //
  31 // Protocol GUID name defined in EFI1.1.
  32 //
  33 #define BLOCK_IO_PROTOCOL       EFI_BLOCK_IO_PROTOCOL_GUID
  34
  35 //
  36 // Protocol defined in EFI1.1.
  37 //
  38 typedef EFI_BLOCK_IO_PROTOCOL   EFI_BLOCK_IO;
  39
  40 /**
  41   Reset the Block Device.
  42
  43   @param  This                 Protocol instance pointer.
  44   @param  ExtendedVerification Driver may perform diagnostics on reset.
  45
  46   @retval EFI_SUCCESS          The device was reset.
  47   @retval EFI_DEVICE_ERROR     The device is not functioning properly and could
  48                                not be reset.
  49
  50 **/
  51 typedef
  52 EFI_STATUS
  53 (EFIAPI *EFI_BLOCK_RESET) (
  54   IN EFI_BLOCK_IO_PROTOCOL          *This,
  55   IN BOOLEAN                        ExtendedVerification
  56   )
  57 ;
  58
  59 /**
  60   Read BufferSize bytes from Lba into Buffer.
  61
  62   @param  This       Protocol instance pointer.
  63   @param  MediaId    Id of the media, changes every time the media is replaced.
  64   @param  Lba        The starting Logical Block Address to read from
  65   @param  BufferSize Size of Buffer, must be a multiple of device block size.
  66   @param  Buffer     Buffer containing read data
  67
  68   @retval EFI_SUCCESS           The data was read correctly from the device.
  69   @retval EFI_DEVICE_ERROR      The device reported an error while performing the read.
  70   @retval EFI_NO_MEDIA          There is no media in the device.
  71   @retval EFI_MEDIA_CHANGED     The MediaId does not matched the current device.
  72   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.
  73   @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not
  74                                 valid for the device.
  75
  76 **/
  77 typedef
  78 EFI_STATUS
  79 (EFIAPI *EFI_BLOCK_READ) (
  80   IN EFI_BLOCK_IO_PROTOCOL          *This,
  81   IN UINT32                         MediaId,
  82   IN EFI_LBA                        Lba,
  83   IN UINTN                          BufferSize,
  84   OUT VOID                          *Buffer
  85   )
  86 ;
  87
  88 /**
  89   Write BufferSize bytes from Lba into Buffer.
  90
  91   @param  This       Protocol instance pointer.
  92   @param  MediaId    Id of the media, changes every time the media is replaced.
  93   @param  Lba        The starting Logical Block Address to read from
  94   @param  BufferSize Size of Buffer, must be a multiple of device block size.
  95   @param  Buffer     Buffer containing read data
  96
  97   @retval EFI_SUCCESS           The data was written correctly to the device.
  98   @retval EFI_WRITE_PROTECTED   The device can not be written to.
  99   @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.
 100   @retval EFI_NO_MEDIA          There is no media in the device.
 101   @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.
 102   @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.
 103   @retval EFI_INVALID_PARAMETER The write request contains a LBA that is not
 104                                 valid for the device.
 105
 106 **/
 107 typedef
 108 EFI_STATUS
 109 (EFIAPI *EFI_BLOCK_WRITE) (
 110   IN EFI_BLOCK_IO_PROTOCOL          *This,
 111   IN UINT32                         MediaId,
 112   IN EFI_LBA                        Lba,
 113   IN UINTN                          BufferSize,
 114   IN VOID                           *Buffer
 115   )
 116 ;
 117
 118 /**
 119   Flush the Block Device.
 120
 121   @param  This              Protocol instance pointer.
 122
 123   @retval EFI_SUCCESS       All outstanding data was written to the device
 124   @retval EFI_DEVICE_ERROR  The device reported an error while writting back the data
 125   @retval EFI_NO_MEDIA      There is no media in the device.
 126
 127 **/
 128 typedef
 129 EFI_STATUS
 130 (EFIAPI *EFI_BLOCK_FLUSH) (
 131   IN EFI_BLOCK_IO_PROTOCOL  *This
 132   )
 133 ;
 134
 135 /**
 136   Block IO read only mode data and updated only via members of BlockIO
 137
 138 **/
 139 typedef struct {
 140   UINT32  MediaId;    ///< The curent media Id. If the media changes, this value is changed.
 141   BOOLEAN RemovableMedia;  ///< TRUE if the media is removable; otherwise, FALSE.
 142   BOOLEAN MediaPresent;    /**< TRUE if there is a media currently present in the device;
 143              othersise, FALSE. THis field shows the media present status
 144              as of the most recent ReadBlocks() or WriteBlocks() call.
 145         **/
 146   BOOLEAN LogicalPartition;  /**< TRUE if LBA 0 is the first block of a partition; otherwise
 147              FALSE. For media with only one partition this would be TRUE.
 148         **/
 149   BOOLEAN ReadOnly;    /**< TRUE if the media is marked read-only otherwise, FALSE.
 150              This field shows the read-only status as of the most recent WriteBlocks () call.
 151         **/
 152   BOOLEAN WriteCaching;    ///< TRUE if the WriteBlock () function caches write data.
 153
 154   UINT32  BlockSize;    /**< The intrinsic block size of the device. If the media changes, then
 155              this field is updated.
 156         **/
 157   UINT32  IoAlign;    ///< Supplies the alignment requirement for any buffer to read or write block(s).
 158
 159   EFI_LBA LastBlock;    /**< The last logical block address on the device.
 160              If the media changes, then this field is updated.
 161         **/
 162 } EFI_BLOCK_IO_MEDIA;
 163
 164 #define EFI_BLOCK_IO_PROTOCOL_REVISION  0x00010000
 165 //
 166 // Revision defined in EFI1.1.
 167 //
 168 #define EFI_BLOCK_IO_INTERFACE_REVISION   EFI_BLOCK_IO_PROTOCOL_REVISION
 169
 170 struct _EFI_BLOCK_IO_PROTOCOL {
 171   UINT64              Revision;
 172
 173   EFI_BLOCK_IO_MEDIA  *Media;
 174
 175   EFI_BLOCK_RESET     Reset;
 176   EFI_BLOCK_READ      ReadBlocks;
 177   EFI_BLOCK_WRITE     WriteBlocks;
 178   EFI_BLOCK_FLUSH     FlushBlocks;
 179
 180 };
 181
 182 extern EFI_GUID gEfiBlockIoProtocolGuid;
 183
 184 #endif