Add comments for IntelFrameworkModulePkg Header file.

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

/** @file\r
  Disk Info protocol Provides the basic interfaces to abstract \r
  platform information regarding an IDE controller.\r
\r
Copyright (c) 2006 - 2009, 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
  This function is used by the IDE bus driver to get inquiry data. \r
  Data format of Identify data is defined by the Interface GUID.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  InquiryData           Pointer to a buffer for the inquiry data.\r
  @param  InquiryDataSize       Pointer to the value for the inquiry data size.\r
\r
  @retval EFI_SUCCESS           The command was accepted without any errors.\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
  This function is used by the IDE bus driver to get identify data. \r
  Data format of Identify data is defined by the Interface GUID.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  IdentifyData          Pointer to a buffer for the identify data.\r
  @param  IdentifyDataSize      Pointer to the value for the identify data size.\r
\r
  @retval EFI_SUCCESS           The command was accepted without any errors.\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
  This function is used by the IDE bus driver to get sense data. \r
  Data format of Sense data is defined by the Interface GUID.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  SenseData             Pointer to the SenseData. \r
  @param  SenseDataSize         Size of SenseData in bytes. \r
  @param  SenseDataNumber       Pointer to the value for the identify data size.\r
\r
  @retval EFI_SUCCESS           The command was accepted without any errors.\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
  This function is used by the IDE bus driver to get controller information.\r
\r
  @param  This                  Protocol instance pointer. \r
  @param  IdeChannel            Pointer to the Ide Channel number. Primary or secondary.\r
  @param  IdeDevice             Pointer to the Ide Device number. 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
// GUID of the type of interfaces\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
  ///\r
  /// A GUID that defines the format of buffers for the other member functions of this protocol.\r
  ///\r
  EFI_GUID                  Interface;\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