Changed the tool chain name from MSFT to MYTOOLS

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

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \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
Module Name:\r
  \r
    DiskInfo.h\r
\r
Abstract:\r
\r
  Disk Info protocol is used to export Inquiry Data for a drive.\r
  Its needed to support low level formating of drives in a mannor\r
  thats DOS compatible.\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
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                       *IntquiryDataSize\r
  )\r
/*++\r
\r
  Routine Description:\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
  Arguments:\r
    This        - Protocol instance pointer.\r
    InquiryData - Results of Inquiry command to device\r
    InquiryDataSize - Size of InquiryData in bytes.\r
\r
  Returns:\r
    EFI_SUCCESS       - InquiryData valid\r
    EFI_NOT_FOUND     - Device does not support this data class\r
    EFI_DEVICE_ERROR  - Error reading InquiryData from device \r
    EFI_BUFFER_TOO_SMALL - IntquiryDataSize not big enough\r
\r
--*/\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
  Routine Description:\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
  Arguments:\r
    This        - Protocol instance pointer.\r
    IdentifyData - Results of Identify command to device\r
    IdentifyDataSize - Size of IdentifyData in bytes.\r
\r
  Returns:\r
    EFI_SUCCESS       - IdentifyData valid\r
    EFI_NOT_FOUND     - Device does not support this data class\r
    EFI_DEVICE_ERROR  - Error reading IdentifyData from device \r
    EFI_BUFFER_TOO_SMALL - IdentifyDataSize not big enough\r
\r
--*/\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
  Routine Description:\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
  Arguments:\r
    This            - Protocol instance pointer.\r
    SenseData       - Results of Request Sense command to device\r
    SenseDataSize   - Size of SenseData in bytes.\r
    SenseDataNumber - Type of SenseData\r
\r
  Returns:\r
    EFI_SUCCESS       - InquiryData valid\r
    EFI_NOT_FOUND     - Device does not support this data class\r
    EFI_DEVICE_ERROR  - Error reading InquiryData from device \r
    EFI_BUFFER_TOO_SMALL - SenseDataSize not big enough\r
\r
--*/\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
  Routine Description:\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
  Arguments:\r
    This        - Protocol instance pointer.\r
    IdeChannel  - Primary or Secondary\r
    IdeDevice   - Master or Slave\r
\r
  Returns:\r
    EFI_SUCCESS       - IdeChannel and IdeDevice are valid\r
    EFI_UNSUPPORTED   - This is not an IDE device\r
\r
--*/\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
struct _EFI_DISK_INFO_PROTOCOL {\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