MdeModulePkg/Include/Protocol/DiskInfo.h

   1 /** @file
   2   Disk Info protocol is used to export Inquiry Data for a drive.
   3   Its needed to support low level formating of drives in a mannor
   4   thats DOS compatible.
   5
   6 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   7 All rights reserved. This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __DISK_INFO_H__
  18 #define __DISK_INFO_H__
  19
  20 #define EFI_DISK_INFO_PROTOCOL_GUID \
  21   { \
  22     0xd432a67f, 0x14dc, 0x484b, {0xb3, 0xbb, 0x3f, 0x2, 0x91, 0x84, 0x93, 0x27 } \
  23   }
  24
  25 //
  26 // Forward reference for pure ANSI compatability
  27 //
  28 typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
  29
  30 /**
  31   Return the results of the Inquiry command to a drive in InquiryData.
  32   Data format of Inquiry data is defined by the Interface GUID.
  33
  34   @param  This                  Protocol instance pointer.
  35   @param  InquiryData           Results of Inquiry command to device
  36   @param  InquiryDataSize       Size of InquiryData in bytes.
  37
  38   @retval EFI_SUCCESS           InquiryData valid
  39   @retval EFI_NOT_FOUND         Device does not support this data class
  40   @retval EFI_DEVICE_ERROR      Error reading InquiryData from device
  41   @retval EFI_BUFFER_TOO_SMALL  IntquiryDataSize not big enough
  42
  43 **/
  44 typedef
  45 EFI_STATUS
  46 (EFIAPI *EFI_DISK_INFO_INQUIRY) (
  47   IN EFI_DISK_INFO_PROTOCOL           * This,
  48   IN OUT VOID                         *InquiryData,
  49   IN OUT UINT32                       *IntquiryDataSize
  50   )
  51 ;
  52
  53
  54 /**
  55   Return the results of the Identify command to a drive in IdentifyData.
  56   Data format of Identify data is defined by the Interface GUID.
  57
  58   @param  This                  Protocol instance pointer.
  59   @param  IdentifyData          Results of Identify command to device
  60   @param  IdentifyDataSize      Size of IdentifyData in bytes.
  61
  62   @retval EFI_SUCCESS           IdentifyData valid
  63   @retval EFI_NOT_FOUND         Device does not support this data class
  64   @retval EFI_DEVICE_ERROR      Error reading IdentifyData from device
  65   @retval EFI_BUFFER_TOO_SMALL  IdentifyDataSize not big enough
  66
  67 **/
  68 typedef
  69 EFI_STATUS
  70 (EFIAPI *EFI_DISK_INFO_IDENTIFY) (
  71   IN EFI_DISK_INFO_PROTOCOL           * This,
  72   IN OUT VOID                         *IdentifyData,
  73   IN OUT UINT32                       *IdentifyDataSize
  74   )
  75 ;
  76
  77
  78 /**
  79   Return the results of the Request Sense command to a drive in SenseData.
  80   Data format of Sense data is defined by the Interface GUID.
  81
  82   @param  This                  Protocol instance pointer.
  83   @param  SenseData             Results of Request Sense command to device
  84   @param  SenseDataSize         Size of SenseData in bytes.
  85   @param  SenseDataNumber       Type of SenseData
  86
  87   @retval EFI_SUCCESS           InquiryData valid
  88   @retval EFI_NOT_FOUND         Device does not support this data class
  89   @retval EFI_DEVICE_ERROR      Error reading InquiryData from device
  90   @retval EFI_BUFFER_TOO_SMALL  SenseDataSize not big enough
  91
  92 **/
  93 typedef
  94 EFI_STATUS
  95 (EFIAPI *EFI_DISK_INFO_SENSE_DATA) (
  96   IN EFI_DISK_INFO_PROTOCOL           * This,
  97   IN OUT VOID                         *SenseData,
  98   IN OUT UINT32                       *SenseDataSize,
  99   OUT UINT8                           *SenseDataNumber
 100   )
 101 ;
 102
 103 /**
 104   Return the results of the Request Sense command to a drive in SenseData.
 105   Data format of Sense data is defined by the Interface GUID.
 106
 107   @param  This                  Protocol instance pointer.
 108   @param  IdeChannel            Primary or Secondary
 109   @param  IdeDevice             Master or Slave
 110
 111   @retval EFI_SUCCESS           IdeChannel and IdeDevice are valid
 112   @retval EFI_UNSUPPORTED       This is not an IDE device
 113
 114 **/
 115 typedef
 116 EFI_STATUS
 117 (EFIAPI *EFI_DISK_INFO_WHICH_IDE) (
 118   IN EFI_DISK_INFO_PROTOCOL           * This,
 119   OUT UINT32                          *IdeChannel,
 120   OUT UINT32                          *IdeDevice
 121   )
 122 ;
 123
 124 //
 125 // GUIDs for EFI_DISK_INFO_PROTOCOL.Interface. Defines the format of the
 126 // buffers returned by member functions
 127 //
 128 #define EFI_DISK_INFO_IDE_INTERFACE_GUID \
 129   { \
 130     0x5e948fe3, 0x26d3, 0x42b5, {0xaf, 0x17, 0x61, 0x2, 0x87, 0x18, 0x8d, 0xec } \
 131   }
 132 extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;
 133
 134 #define EFI_DISK_INFO_SCSI_INTERFACE_GUID \
 135   { \
 136     0x8f74baa, 0xea36, 0x41d9, {0x95, 0x21, 0x21, 0xa7, 0xf, 0x87, 0x80, 0xbc } \
 137   }
 138 extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;
 139
 140 #define EFI_DISK_INFO_USB_INTERFACE_GUID \
 141   { \
 142     0xcb871572, 0xc11a, 0x47b5, {0xb4, 0x92, 0x67, 0x5e, 0xaf, 0xa7, 0x77, 0x27 } \
 143   }
 144 extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;
 145
 146 struct _EFI_DISK_INFO_PROTOCOL {
 147   EFI_GUID                  Interface;
 148   EFI_DISK_INFO_INQUIRY     Inquiry;
 149   EFI_DISK_INFO_IDENTIFY    Identify;
 150   EFI_DISK_INFO_SENSE_DATA  SenseData;
 151   EFI_DISK_INFO_WHICH_IDE   WhichIde;
 152 };
 153
 154 extern EFI_GUID gEfiDiskInfoProtocolGuid;
 155
 156 #endif
 157
 158