MdePkg/Include/Protocol/DiskInfo.h

   1 /** @file
   2   Provides the basic interfaces to abstract platform information regarding an
   3   IDE controller.
   4
   5   Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   @par Revision Reference:
  15   This Protocol is defined in UEFI Platform Initialization Specification 1.2
  16   Volume 5: Standards
  17
  18 **/
  19
  20 #ifndef __DISK_INFO_H__
  21 #define __DISK_INFO_H__
  22
  23 ///
  24 /// Global ID for EFI_DISK_INFO_PROTOCOL
  25 ///
  26 #define EFI_DISK_INFO_PROTOCOL_GUID \
  27   { \
  28     0xd432a67f, 0x14dc, 0x484b, {0xb3, 0xbb, 0x3f, 0x2, 0x91, 0x84, 0x93, 0x27 } \
  29   }
  30
  31 ///
  32 /// Forward declaration for EFI_DISK_INFO_PROTOCOL
  33 ///
  34 typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
  35
  36 ///
  37 /// Global ID for an IDE interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface
  38 ///
  39 #define EFI_DISK_INFO_IDE_INTERFACE_GUID \
  40   { \
  41     0x5e948fe3, 0x26d3, 0x42b5, {0xaf, 0x17, 0x61, 0x2, 0x87, 0x18, 0x8d, 0xec } \
  42   }
  43
  44 ///
  45 /// Global ID for a SCSI interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface
  46 ///
  47 #define EFI_DISK_INFO_SCSI_INTERFACE_GUID \
  48   { \
  49     0x8f74baa, 0xea36, 0x41d9, {0x95, 0x21, 0x21, 0xa7, 0xf, 0x87, 0x80, 0xbc } \
  50   }
  51
  52 ///
  53 /// Global ID for a USB interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface
  54 ///
  55 #define EFI_DISK_INFO_USB_INTERFACE_GUID \
  56   { \
  57     0xcb871572, 0xc11a, 0x47b5, {0xb4, 0x92, 0x67, 0x5e, 0xaf, 0xa7, 0x77, 0x27 } \
  58   }
  59
  60 ///
  61 /// Global ID for an AHCI interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface
  62 ///
  63 #define EFI_DISK_INFO_AHCI_INTERFACE_GUID \
  64   { \
  65     0x9e498932, 0x4abc, 0x45af, {0xa3, 0x4d, 0x2, 0x47, 0x78, 0x7b, 0xe7, 0xc6 } \
  66   }
  67
  68 ///
  69 /// Global ID for a NVME interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface
  70 ///
  71 #define EFI_DISK_INFO_NVME_INTERFACE_GUID \
  72   { \
  73     0x3ab14680, 0x5d3f, 0x4a4d, {0xbc, 0xdc, 0xcc, 0x38, 0x0, 0x18, 0xc7, 0xf7 } \
  74   }
  75
  76 ///
  77 /// Global ID for a UFS interface.  Used to fill in EFI_DISK_INFO_PROTOCOL.Interface
  78 ///
  79 #define EFI_DISK_INFO_UFS_INTERFACE_GUID \
  80   { \
  81     0x4b3029cc, 0x6b98, 0x47fb, { 0xbc, 0x96, 0x76, 0xdc, 0xb8, 0x4, 0x41, 0xf0 } \
  82   }
  83
  84 /**
  85   Provides inquiry information for the controller type.
  86
  87   This function is used by the IDE bus driver to get inquiry data.  Data format
  88   of Identify data is defined by the Interface GUID.
  89
  90   @param[in]     This              Pointer to the EFI_DISK_INFO_PROTOCOL instance.
  91   @param[in,out] InquiryData       Pointer to a buffer for the inquiry data.
  92   @param[in,out] InquiryDataSize   Pointer to the value for the inquiry data size.
  93
  94   @retval EFI_SUCCESS            The command was accepted without any errors.
  95   @retval EFI_NOT_FOUND          Device does not support this data class
  96   @retval EFI_DEVICE_ERROR       Error reading InquiryData from device
  97   @retval EFI_BUFFER_TOO_SMALL   InquiryDataSize not big enough
  98
  99 **/
 100 typedef
 101 EFI_STATUS
 102 (EFIAPI *EFI_DISK_INFO_INQUIRY)(
 103   IN     EFI_DISK_INFO_PROTOCOL  *This,
 104   IN OUT VOID                    *InquiryData,
 105   IN OUT UINT32                  *InquiryDataSize
 106   );
 107
 108 /**
 109   Provides identify information for the controller type.
 110
 111   This function is used by the IDE bus driver to get identify data.  Data format
 112   of Identify data is defined by the Interface GUID.
 113
 114   @param[in]     This               Pointer to the EFI_DISK_INFO_PROTOCOL
 115                                     instance.
 116   @param[in,out] IdentifyData       Pointer to a buffer for the identify data.
 117   @param[in,out] IdentifyDataSize   Pointer to the value for the identify data
 118                                     size.
 119
 120   @retval EFI_SUCCESS            The command was accepted without any errors.
 121   @retval EFI_NOT_FOUND          Device does not support this data class
 122   @retval EFI_DEVICE_ERROR       Error reading IdentifyData from device
 123   @retval EFI_BUFFER_TOO_SMALL   IdentifyDataSize not big enough
 124
 125 **/
 126 typedef
 127 EFI_STATUS
 128 (EFIAPI *EFI_DISK_INFO_IDENTIFY)(
 129   IN     EFI_DISK_INFO_PROTOCOL  *This,
 130   IN OUT VOID                    *IdentifyData,
 131   IN OUT UINT32                  *IdentifyDataSize
 132   );
 133
 134 /**
 135   Provides sense data information for the controller type.
 136
 137   This function is used by the IDE bus driver to get sense data.
 138   Data format of Sense data is defined by the Interface GUID.
 139
 140   @param[in]     This              Pointer to the EFI_DISK_INFO_PROTOCOL instance.
 141   @param[in,out] SenseData         Pointer to the SenseData.
 142   @param[in,out] SenseDataSize     Size of SenseData in bytes.
 143   @param[out]    SenseDataNumber   Pointer to the value for the sense data size.
 144
 145   @retval EFI_SUCCESS            The command was accepted without any errors.
 146   @retval EFI_NOT_FOUND          Device does not support this data class.
 147   @retval EFI_DEVICE_ERROR       Error reading SenseData from device.
 148   @retval EFI_BUFFER_TOO_SMALL   SenseDataSize not big enough.
 149
 150 **/
 151 typedef
 152 EFI_STATUS
 153 (EFIAPI *EFI_DISK_INFO_SENSE_DATA)(
 154   IN     EFI_DISK_INFO_PROTOCOL  *This,
 155   IN OUT VOID                    *SenseData,
 156   IN OUT UINT32                  *SenseDataSize,
 157   OUT    UINT8                   *SenseDataNumber
 158   );
 159
 160 /**
 161   This function is used by the IDE bus driver to get controller information.
 162
 163   @param[in]  This         Pointer to the EFI_DISK_INFO_PROTOCOL instance.
 164   @param[out] IdeChannel   Pointer to the Ide Channel number.  Primary or secondary.
 165   @param[out] IdeDevice    Pointer to the Ide Device number.  Master or slave.
 166
 167   @retval EFI_SUCCESS       IdeChannel and IdeDevice are valid.
 168   @retval EFI_UNSUPPORTED   This is not an IDE device.
 169
 170 **/
 171 typedef
 172 EFI_STATUS
 173 (EFIAPI *EFI_DISK_INFO_WHICH_IDE)(
 174   IN  EFI_DISK_INFO_PROTOCOL  *This,
 175   OUT UINT32                  *IdeChannel,
 176   OUT UINT32                  *IdeDevice
 177   );
 178
 179 ///
 180 /// The EFI_DISK_INFO_PROTOCOL provides controller specific information.
 181 ///
 182 struct _EFI_DISK_INFO_PROTOCOL {
 183   ///
 184   /// A GUID that defines the format of buffers for the other member functions
 185   /// of this protocol.
 186   ///
 187   EFI_GUID                  Interface;
 188   ///
 189   /// Return the results of the Inquiry command to a drive in InquiryData. Data
 190   /// format of Inquiry data is defined by the Interface GUID.
 191   ///
 192   EFI_DISK_INFO_INQUIRY     Inquiry;
 193   ///
 194   /// Return the results of the Identify command to a drive in IdentifyData. Data
 195   /// format of Identify data is defined by the Interface GUID.
 196   ///
 197   EFI_DISK_INFO_IDENTIFY    Identify;
 198   ///
 199   /// Return the results of the Request Sense command to a drive in SenseData. Data
 200   /// format of Sense data is defined by the Interface GUID.
 201   ///
 202   EFI_DISK_INFO_SENSE_DATA  SenseData;
 203   ///
 204   /// Specific controller.
 205   ///
 206   EFI_DISK_INFO_WHICH_IDE   WhichIde;
 207 };
 208
 209 extern EFI_GUID gEfiDiskInfoProtocolGuid;
 210
 211 extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;
 212 extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;
 213 extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;
 214 extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;
 215 extern EFI_GUID gEfiDiskInfoNvmeInterfaceGuid;
 216 extern EFI_GUID gEfiDiskInfoUfsInterfaceGuid;
 217
 218 #endif