IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h

   1 /** @file
   2   Disk Info protocol is used to export Inquiry Data for a drive.
   3   It supports low level formating of drives in a DOS compatible manner.
   4
   5 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   6 All rights reserved. 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 **/
  15
  16 #ifndef __DISK_INFO_H__
  17 #define __DISK_INFO_H__
  18
  19 #define EFI_DISK_INFO_PROTOCOL_GUID \
  20   { \
  21     0xd432a67f, 0x14dc, 0x484b, {0xb3, 0xbb, 0x3f, 0x2, 0x91, 0x84, 0x93, 0x27 } \
  22   }
  23
  24 //
  25 // Forward reference for pure ANSI compatability
  26 //
  27 typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
  28
  29 /**
  30   Return the results of the Inquiry command to a drive in InquiryData.
  31   Data format of Inquiry data is defined by the Interface GUID.
  32
  33   @param  This                  Protocol instance pointer.
  34   @param  InquiryData           Results of Inquiry command to device
  35   @param  InquiryDataSize       Size of InquiryData in bytes.
  36
  37   @retval EFI_SUCCESS           InquiryData valid
  38   @retval EFI_NOT_FOUND         Device does not support this data class
  39   @retval EFI_DEVICE_ERROR      Error reading InquiryData from device
  40   @retval EFI_BUFFER_TOO_SMALL  IntquiryDataSize not big enough
  41
  42 **/
  43 typedef
  44 EFI_STATUS
  45 (EFIAPI *EFI_DISK_INFO_INQUIRY)(
  46   IN EFI_DISK_INFO_PROTOCOL           * This,
  47   IN OUT VOID                         *InquiryData,
  48   IN OUT UINT32                       *InquiryDataSize
  49   );
  50
  51
  52 /**
  53   Return the results of the Identify command to a drive in IdentifyData.
  54   Data format of Identify data is defined by the Interface GUID.
  55
  56   @param  This                  Protocol instance pointer.
  57   @param  IdentifyData          Results of Identify command to device
  58   @param  IdentifyDataSize      Size of IdentifyData in bytes.
  59
  60   @retval EFI_SUCCESS           IdentifyData valid
  61   @retval EFI_NOT_FOUND         Device does not support this data class
  62   @retval EFI_DEVICE_ERROR      Error reading IdentifyData from device
  63   @retval EFI_BUFFER_TOO_SMALL  IdentifyDataSize not big enough
  64
  65 **/
  66 typedef
  67 EFI_STATUS
  68 (EFIAPI *EFI_DISK_INFO_IDENTIFY)(
  69   IN EFI_DISK_INFO_PROTOCOL           * This,
  70   IN OUT VOID                         *IdentifyData,
  71   IN OUT UINT32                       *IdentifyDataSize
  72   );
  73
  74
  75 /**
  76   Return the results of the Request Sense command to a drive in SenseData.
  77   Data format of Sense data is defined by the Interface GUID.
  78
  79   @param  This                  Protocol instance pointer.
  80   @param  SenseData             Results of Request Sense command to device
  81   @param  SenseDataSize         Size of SenseData in bytes.
  82   @param  SenseDataNumber       Type of SenseData
  83
  84   @retval EFI_SUCCESS           InquiryData valid
  85   @retval EFI_NOT_FOUND         Device does not support this data class
  86   @retval EFI_DEVICE_ERROR      Error reading InquiryData from device
  87   @retval EFI_BUFFER_TOO_SMALL  SenseDataSize not big enough
  88
  89 **/
  90 typedef
  91 EFI_STATUS
  92 (EFIAPI *EFI_DISK_INFO_SENSE_DATA)(
  93   IN EFI_DISK_INFO_PROTOCOL           * This,
  94   IN OUT VOID                         *SenseData,
  95   IN OUT UINT32                       *SenseDataSize,
  96   OUT UINT8                           *SenseDataNumber
  97   );
  98
  99 /**
 100   Return the IDE device information.
 101
 102   @param  This                  Protocol instance pointer.
 103   @param  IdeChannel            Primary or Secondary
 104   @param  IdeDevice             Master or Slave
 105
 106   @retval EFI_SUCCESS           IdeChannel and IdeDevice are valid
 107   @retval EFI_UNSUPPORTED       This is not an IDE device
 108
 109 **/
 110 typedef
 111 EFI_STATUS
 112 (EFIAPI *EFI_DISK_INFO_WHICH_IDE)(
 113   IN EFI_DISK_INFO_PROTOCOL           * This,
 114   OUT UINT32                          *IdeChannel,
 115   OUT UINT32                          *IdeDevice
 116   );
 117
 118 //
 119 // GUIDs for EFI_DISK_INFO_PROTOCOL.Interface. Defines the format of the
 120 // buffers returned by member functions.
 121 //
 122 #define EFI_DISK_INFO_IDE_INTERFACE_GUID \
 123   { \
 124     0x5e948fe3, 0x26d3, 0x42b5, {0xaf, 0x17, 0x61, 0x2, 0x87, 0x18, 0x8d, 0xec } \
 125   }
 126 extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;
 127
 128 #define EFI_DISK_INFO_SCSI_INTERFACE_GUID \
 129   { \
 130     0x8f74baa, 0xea36, 0x41d9, {0x95, 0x21, 0x21, 0xa7, 0xf, 0x87, 0x80, 0xbc } \
 131   }
 132 extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;
 133
 134 #define EFI_DISK_INFO_USB_INTERFACE_GUID \
 135   { \
 136     0xcb871572, 0xc11a, 0x47b5, {0xb4, 0x92, 0x67, 0x5e, 0xaf, 0xa7, 0x77, 0x27 } \
 137   }
 138 extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;
 139
 140 #define EFI_DISK_INFO_AHCI_INTERFACE_GUID \
 141   { \
 142     0x9e498932, 0x4abc, 0x45af, {0xa3, 0x4d, 0x2, 0x47, 0x78, 0x7b, 0xe7, 0xc6} \
 143   }
 144 extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;
 145
 146 struct _EFI_DISK_INFO_PROTOCOL {
 147   EFI_GUID                  Interface;  ///> The format of the buffers returned by member functions.
 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