sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add comments for IntelFrameworkModulePkg Header file.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8539 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2009-06-12 09:02:15 +00:00
parent f423cbf1e9
commit 20774adc0f
4 changed files with 98 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
View File

@ -1,8 +1,8 @@
/** @file
Disk Info protocol is used to export Inquiry Data for a drive.
It supports low level formating of drives in a DOS compatible manner.
Disk Info protocol Provides the basic interfaces to abstract
platform information regarding an IDE controller.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@ -27,14 +27,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL;
/**
Return the results of the Inquiry command to a drive in InquiryData.
Data format of Inquiry data is defined by the Interface GUID.
This function is used by the IDE bus driver to get inquiry data.
Data format of Identify data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param InquiryData Results of Inquiry command to device
@param InquiryDataSize Size of InquiryData in bytes.
@param InquiryData Pointer to a buffer for the inquiry data.
@param InquiryDataSize Pointer to the value for the inquiry data size.
@retval EFI_SUCCESS InquiryData valid
@retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
@retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough
@ -50,14 +50,14 @@ EFI_STATUS
/**
Return the results of the Identify command to a drive in IdentifyData.
This function is used by the IDE bus driver to get identify data.
Data format of Identify data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param IdentifyData Results of Identify command to device
@param IdentifyDataSize Size of IdentifyData in bytes.
@param IdentifyData Pointer to a buffer for the identify data.
@param IdentifyDataSize Pointer to the value for the identify data size.
@retval EFI_SUCCESS IdentifyData valid
@retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading IdentifyData from device
@retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough
@ -73,15 +73,15 @@ EFI_STATUS
/**
Return the results of the Request Sense command to a drive in SenseData.
This function is used by the IDE bus driver to get sense data.
Data format of Sense data is defined by the Interface GUID.
@param This Protocol instance pointer.
@param SenseData Results of Request Sense command to device
@param SenseData Pointer to the SenseData.
@param SenseDataSize Size of SenseData in bytes.
@param SenseDataNumber Type of SenseData
@param SenseDataNumber Pointer to the value for the identify data size.
@retval EFI_SUCCESS InquiryData valid
@retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
@retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough
@ -97,11 +97,11 @@ EFI_STATUS
);
/**
Return the IDE device information.
This function is used by the IDE bus driver to get controller information.
@param This Protocol instance pointer.
@param IdeChannel Primary or Secondary
@param IdeDevice Master or Slave
@param IdeChannel Pointer to the Ide Channel number. Primary or secondary.
@param IdeDevice Pointer to the Ide Device number. Master or slave.
@retval EFI_SUCCESS IdeChannel and IdeDevice are valid
@retval EFI_UNSUPPORTED This is not an IDE device
@ -116,8 +116,7 @@ EFI_STATUS
);
//
// GUIDs for EFI_DISK_INFO_PROTOCOL.Interface. Defines the format of the
// buffers returned by member functions.
// GUID of the type of interfaces
//
#define EFI_DISK_INFO_IDE_INTERFACE_GUID \
{ \
@ -144,7 +143,10 @@ extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;
extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;
struct _EFI_DISK_INFO_PROTOCOL {
EFI_GUID Interface; ///> The format of the buffers returned by member functions.
///
/// A GUID that defines the format of buffers for the other member functions of this protocol.
///
EFI_GUID Interface;
EFI_DISK_INFO_INQUIRY Inquiry;
EFI_DISK_INFO_IDENTIFY Identify;
EFI_DISK_INFO_SENSE_DATA SenseData;