Correct typo in comments, clean IfrSupportLib.h

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / DiskInfo.h

/** @file\r
  Disk Info protocol is used to export Inquiry Data for a drive.\r
  It supports low level formating of drives in a DOS compatible manner.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __DISK_INFO_H__\r
#define __DISK_INFO_H__\r
\r
#define EFI_DISK_INFO_PROTOCOL_GUID \\r
  { \\r
    0xd432a67f, 0x14dc, 0x484b, {0xb3, 0xbb, 0x3f, 0x2, 0x91, 0x84, 0x93, 0x27 } \\r
  }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;\r
\r
/**\r
  Return the results of the Inquiry command to a drive in InquiryData.\r
  Data format of Inquiry data is defined by the Interface GUID.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  InquiryData           Results of Inquiry command to device \r
  @param  InquiryDataSize       Size of InquiryData in bytes. \r
\r
  @retval EFI_SUCCESS           InquiryData valid \r
  @retval EFI_NOT_FOUND         Device does not support this data class \r
  @retval EFI_DEVICE_ERROR      Error reading InquiryData from device \r
  @retval EFI_BUFFER_TOO_SMALL  IntquiryDataSize not big enough \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_INQUIRY)(\r
  IN EFI_DISK_INFO_PROTOCOL           * This,\r
  IN OUT VOID                         *InquiryData,\r
  IN OUT UINT32                       *InquiryDataSize\r
  );\r
\r
\r
/**\r
  Return the results of the Identify command to a drive in IdentifyData.\r
  Data format of Identify data is defined by the Interface GUID.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  IdentifyData          Results of Identify command to device \r
  @param  IdentifyDataSize      Size of IdentifyData in bytes. \r
\r
  @retval EFI_SUCCESS           IdentifyData valid \r
  @retval EFI_NOT_FOUND         Device does not support this data class \r
  @retval EFI_DEVICE_ERROR      Error reading IdentifyData from device \r
  @retval EFI_BUFFER_TOO_SMALL  IdentifyDataSize not big enough \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_IDENTIFY)(\r
  IN EFI_DISK_INFO_PROTOCOL           * This,\r
  IN OUT VOID                         *IdentifyData,\r
  IN OUT UINT32                       *IdentifyDataSize\r
  );\r
\r
\r
/**\r
  Return the results of the Request Sense command to a drive in SenseData.\r
  Data format of Sense data is defined by the Interface GUID.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  SenseData             Results of Request Sense command to device \r
  @param  SenseDataSize         Size of SenseData in bytes. \r
  @param  SenseDataNumber       Type of SenseData \r
\r
  @retval EFI_SUCCESS           InquiryData valid \r
  @retval EFI_NOT_FOUND         Device does not support this data class \r
  @retval EFI_DEVICE_ERROR      Error reading InquiryData from device \r
  @retval EFI_BUFFER_TOO_SMALL  SenseDataSize not big enough \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_SENSE_DATA)(\r
  IN EFI_DISK_INFO_PROTOCOL           * This,\r
  IN OUT VOID                         *SenseData,\r
  IN OUT UINT32                       *SenseDataSize,\r
  OUT UINT8                           *SenseDataNumber\r
  );\r
\r
/**\r
  Return the IDE device information.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  IdeChannel            Primary or Secondary \r
  @param  IdeDevice             Master or Slave \r
\r
  @retval EFI_SUCCESS           IdeChannel and IdeDevice are valid \r
  @retval EFI_UNSUPPORTED       This is not an IDE device \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DISK_INFO_WHICH_IDE)(\r
  IN EFI_DISK_INFO_PROTOCOL           * This,\r
  OUT UINT32                          *IdeChannel,\r
  OUT UINT32                          *IdeDevice\r
  );\r
\r
//\r
// GUIDs for EFI_DISK_INFO_PROTOCOL.Interface. Defines the format of the\r
// buffers returned by member functions.\r
//\r
#define EFI_DISK_INFO_IDE_INTERFACE_GUID \\r
  { \\r
    0x5e948fe3, 0x26d3, 0x42b5, {0xaf, 0x17, 0x61, 0x2, 0x87, 0x18, 0x8d, 0xec } \\r
  }\r
extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;\r
\r
#define EFI_DISK_INFO_SCSI_INTERFACE_GUID \\r
  { \\r
    0x8f74baa, 0xea36, 0x41d9, {0x95, 0x21, 0x21, 0xa7, 0xf, 0x87, 0x80, 0xbc } \\r
  }\r
extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;\r
\r
#define EFI_DISK_INFO_USB_INTERFACE_GUID \\r
  { \\r
    0xcb871572, 0xc11a, 0x47b5, {0xb4, 0x92, 0x67, 0x5e, 0xaf, 0xa7, 0x77, 0x27 } \\r
  }\r
extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;\r
\r
#define EFI_DISK_INFO_AHCI_INTERFACE_GUID \\r
  { \\r
    0x9e498932, 0x4abc, 0x45af, {0xa3, 0x4d, 0x2, 0x47, 0x78, 0x7b, 0xe7, 0xc6} \\r
  }\r
extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r
\r
struct _EFI_DISK_INFO_PROTOCOL {\r
  EFI_GUID                  Interface;  ///> The format of the buffers returned by member functions.\r
  EFI_DISK_INFO_INQUIRY     Inquiry;\r
  EFI_DISK_INFO_IDENTIFY    Identify;\r
  EFI_DISK_INFO_SENSE_DATA  SenseData;\r
  EFI_DISK_INFO_WHICH_IDE   WhichIde;\r
};\r
\r
extern EFI_GUID gEfiDiskInfoProtocolGuid;\r
\r
#endif\r
\r
\r