Update ScsiIo protocol and ScsiPassThruExt protocol guid value to UEFI 2.1

And remove DriverHealth protocol file.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6099 6f19259b-4bc3-4df7-8a09-765794883524

7 files changed, 34 insertions, 259 deletions

diff --git a/MdePkg/Include/Protocol/Dhcp4.h b/MdePkg/Include/Protocol/Dhcp4.h
index 2031f2b5da..f59e9d74c5 100644
--- a/MdePkg/Include/Protocol/Dhcp4.h
+++ b/MdePkg/Include/Protocol/Dhcp4.h
@@ -331,7 +331,7 @@ EFI_STATUS
   Builds a DHCP packet, given the options to be appended or deleted or replaced.

 

   @param  This        Pointer to the EFI_DHCP4_PROTOCOL instance.

- @param  SeedPacket  Initial packet to be used as a base for building new packet.

+  @param  SeedPacket  Initial packet to be used as a base for building new packet.

   @param  DeleteCount Number of opcodes in the DeleteList.

   @param  DeleteList  List of opcodes to be deleted from the seed packet.

                       Ignored if DeleteCount is zero.

diff --git a/MdePkg/Include/Protocol/DriverHealth.h b/MdePkg/Include/Protocol/DriverHealth.h
deleted file mode 100644
index f7bf0b857e..0000000000
--- a/MdePkg/Include/Protocol/DriverHealth.h
+++ /dev/null
@@ -1,247 +0,0 @@
-/** @file

-  EFI Driver Health Protocol

-

-  Copyright (c) 2006 - 2008, Intel Corporation                                                         

-  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        

-  http://opensource.org/licenses/bsd-license.php                                            

-

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

-

-**/

-

-#ifndef __EFI_DRIVER_HEALTH_H__

-#define __EFI_DRIVER_HEALTH_H__

-

-#define EFI_DRIVER_HEALTH_PROTOCOL_GUID \

-  { \

-    0x2a534210, 0x9280, 0x41d8, { 0xae, 0x79, 0xca, 0xda, 0x1, 0xa2, 0xb1, 0x27 } \

-  }

-  

-typedef struct _EFI_DRIVER_HEALTH_PROTOCOL  EFI_DRIVER_HEALTH_PROTOCOL;

-

-///

-/// EFI_DRIVER_HEALTH_HEALTH_STATUS

-///

-typedef enum {

-  EfiDriverHealthStatusHealthy,

-  EfiDriverHealthStatusRepairRequired,

-  EfiDriverHealthStatusConfigurationRequired,

-  EfiDriverHealthStatusFailed,

-  EfiDriverHealthStatusReconnectRequired,

-  EfiDriverHealthStatusRebootRequired

-} EFI_DRIVER_HEALTH_HEALTH_STATUS;

-

-///

-/// EFI_DRIVER_HEALTH_HII_MESSAGE

-///

-typedef struct {

-  EFI_HII_HANDLE  HiiHandle;

-  EFI_STRING_ID   StringId;

-  UINT64          Reserved;

-} EFI_DRIVER_HEALTH_HII_MESSAGE;

-

-/**

-  Reports the progress of a repair operation

-

-  @param  Value            A value between 0 and Limit that identifies the current 

-                           progress of the repair operation.

-  

-  @param  Limit            The maximum value of Value for the current repair operation.

-                           For example, a driver that wants to specify progress in 

-                           percent would use a Limit value of 100.

-**/

-typedef

-VOID

-(EFIAPI *EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY)(

-  IN UINTN  Value,

-  IN UINTN  Limit

-  );

-

-/**

-  Retrieves the health status of a controller in the platform.  This function can also 

-  optionally return warning messages, error messages, and a set of HII Forms that may 

-  be repair a controller that is not proper configured. 

-  

-  @param  This             A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.

-

-  @param  ControllerHandle The handle of the controller to retrieve the health status 

-                           on.  This is an optional parameter that may be NULL.  If 

-                           this parameter is NULL, then the value of ChildHandle is 

-                           ignored, and the combined health status of all the devices 

-                           that the driver is managing is returned.

-

-  @param  ChildHandle      The handle of the child controller to retrieve the health 

-                           status on.  This is an optional parameter that may be NULL.  

-                           This parameter is ignored of ControllerHandle is NULL.  It 

-                           will be NULL for device drivers.  It will also be NULL for 

-                           bus drivers when an attempt is made to collect the health 

-                           status of the bus controller.  If will not be NULL when an 

-                           attempt is made to collect the health status for a child 

-                           controller produced by the driver.

-

-  @param  HealthStatus     A pointer to the health status that is returned by this 

-                           function.  This is an optional parameter that may be NULL.  

-                           This parameter is ignored of ControllerHandle is NULL.  

-                           The health status for the controller specified by 

-                           ControllerHandle and ChildHandle is returned. 

-

-  @param  MessageList      A pointer to an array of warning or error messages associated 

-                           with the controller specified by ControllerHandle and 

-                           ChildHandle.  This is an optional parameter that may be NULL.  

-                           MessageList is allocated by this function with the EFI Boot 

-                           Service AllocatePool(), and it is the caller's responsibility 

-                           to free MessageList with the EFI Boot Service FreePool().  

-                           Each message is specified by tuple of an EFI_HII_HANDLE and 

-                           an EFI_STRING_ID.  The array of messages is terminated by tuple 

-                           containing a EFI_HII_HANDLE with a value of NULL.  The 

-                           EFI_HII_STRING_PROTOCOL.GetString() function can be used to 

-                           retrieve the warning or error message as a Null-terminated 

-                           Unicode string in a specific language.  Messages may be 

-                           returned for any of the HealthStatus values except 

-                           EfiDriverHealthStatusReconnectRequired and 

-                           EfiDriverHealthStatusRebootRequired.

-

-  @param  FormHiiHandle    A pointer to the HII handle for an HII form associated with the 

-                           controller specified by ControllerHandle and ChildHandle.  

-                           This is an optional parameter that may be NULL.  An HII form 

-                           is specified by a combination of an EFI_HII_HANDLE and an 

-                           EFI_GUID that identifies the Form Set GUID.  The 

-                           EFI_FORM_BROWSER2_PROTOCOL.SendForm() function can be used 

-                           to display and allow the user to make configuration changes 

-                           to the HII Form.  An HII form may only be returned with a 

-                           HealthStatus value of EfiDriverHealthStatusConfigurationRequired.

-

-  @param  FormSetGuid      A pointer to the GUID for an HII form associated with the 

-                           controller specified by ControllerHandle and ChildHandle.  

-                           This is an optional parameter that may be NULL.  An HII form 

-                           is specified by a combination of an EFI_HII_HANDLE and an 

-                           EFI_GUID that identifies the Form Set GUID.  The 

-                           EFI_FORM_BROWSER2_PROTOCOL.SendForm() function can be used 

-                           to display and allow the user to make configuration changes 

-                           to the HII Form.  An HII form may only be returned with a 

-                           HealthStatus value of EfiDriverHealthStatusConfigurationRequired.

-

-  @retval EFI_SUCCESS           ControllerHandle is NULL, and all the controllers 

-                                managed by this driver specified by This have a health 

-                                status of EfiDriverHealthStatusHealthy with no warning 

-                                messages to be returned.  The ChildHandle, HealthStatus, 

-                                MessageList, and FormList parameters are ignored.

-

-  @retval EFI_DEVICE_ERROR      ControllerHandle is NULL, and one or more of the 

-                                controllers managed by this driver specified by This 

-                                do not have a health status of EfiDriverHealthStatusHealthy.  

-                                The ChildHandle, HealthStatus, MessageList, and 

-                                FormList parameters are ignored.

-

-  @retval EFI_DEVICE_ERROR      ControllerHandle is NULL, and one or more of the 

-                                controllers managed by this driver specified by This 

-                                have one or more warning and/or error messages.  

-                                The ChildHandle, HealthStatus, MessageList, and 

-                                FormList parameters are ignored.

-

-  @retval EFI_SUCCESS           ControllerHandle is not NULL and the health status 

-                                of the controller specified by ControllerHandle and 

-                                ChildHandle was returned in HealthStatus.  A list 

-                                of warning and error messages may be optionally 

-                                returned in MessageList, and a list of HII Forms 

-                                may be optionally returned in FormList.

-

-  @retval EFI_UNSUPPORTED	      ControllerHandle is not NULL, and the controller 

-                                specified by ControllerHandle and ChildHandle is not 

-                                currently being managed by the driver specified by This.

-

-  @retval EFI_INVALID_PARAMETER	HealthStatus is NULL.

-

-  @retval EFI_OUT_OF_RESOURCES	MessageList is not NULL, and there are not enough 

-                                resource available to allocate memory for MessageList.

-

-**/

-typedef

-EFI_STATUS

-(EFIAPI *EFI_DRIVER_HEALTH_GET_HEALTH_STATUS)(

-  IN  EFI_DRIVER_HEALTH_PROTOCOL       *This,

-  IN  EFI_HANDLE                       ControllerHandle  OPTIONAL,

-  IN  EFI_HANDLE                       ChildHandle       OPTIONAL,

-  OUT EFI_DRIVER_HEALTH_HEALTH_STATUS  *HealthStatus,

-  OUT EFI_DRIVER_HEALTH_HII_MESSAGE    **MessageList     OPTIONAL,

-  OUT EFI_HII_HANDLE                   *FormHiiHandle    OPTIONAL,

-  OUT EFI_GUID                         **FormSetGuid     OPTIONAL

-  );

-

-/**

-  Performs a repair operation on a controller in the platform.  This function can 

-  optionally report repair progress information back to the platform. 

-  

-  @param  This             A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.

-  @param  ControllerHandle The handle of the controller to repair.

-  @param  ChildHandle      The handle of the child controller to repair.  This is 

-                           an optional parameter that may be NULL.  It will be NULL 

-                           for device drivers.  It will also be NULL for bus 

-                           drivers when an attempt is made to repair a bus controller.

-                           If will not be NULL when an attempt is made to repair a 

-                           child controller produced by the driver.

-  @param  ProgressNotification

-                           A notification function that may be used by a driver to 

-                           report the progress of the repair operation.  This is 

-                           an optional parameter that may be NULL.  

-

-

-  @retval EFI_SUCCESS	          An attempt to repair the controller specified by 

-                                ControllerHandle and ChildHandle was performed.  

-                                The result of the repair operation can bet 

-                                determined by calling GetHealthStatus().

-  @retval EFI_UNSUPPORTED	      The driver specified by This is not currently 

-                                managing the controller specified by ControllerHandle 

-                                and ChildHandle.

-  @retval EFI_OUT_OF_RESOURCES	There are not enough resources to perform the 

-                                repair operation.

-

-*/

-typedef

-EFI_STATUS

-(EFIAPI *EFI_DRIVER_HEALTH_REPAIR)(

-  IN  EFI_DRIVER_HEALTH_PROTOCOL                *This,

-  IN  EFI_HANDLE                                ControllerHandle,

-  IN  EFI_HANDLE                                ChildHandle           OPTIONAL,

-  IN  EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY  ProgressNotification  OPTIONAL

-  );

-

-/**

-  When installed, the Driver Health Protocol produces a collection of services 

-  that allow the health status for a controller to be retrieved.  If a controller 

-  is not in a usable state, status messages may be reported to the user, repair 

-  operations can be invoked, and the user may be asked to make software and/or 

-  hardware configuration changes. 

-

-  @par Protocol Description:

-  The Driver Health Protocol is optionally produced by a driver that follows the 

-  EFI Driver Model.  If an EFI Driver needs to report health status to the platform, 

-  provide warning or error messages to the user, perform length repair operations, 

-  or request the user to make hardware or software configuration changes, then the 

-  Driver Health Protocol must be produced.

-  

-  A controller that is managed by driver that follows the EFI Driver Model and 

-  produces the Driver Health Protocol must report the current health of the 

-  controllers that the driver is currently managing.  The controller can initially 

-  be healthy, failed, require repair, or require configuration.  If a controller 

-  requires configuration, and the user make configuration changes, the controller 

-  may then need to be reconnected or the system may need to be rebooted for the 

-  configuration changes to take affect.  Figure 2-1 below shows all the possible 

-  health states of a controller and the legal transitions between the health states. 

-

-**/

-struct _EFI_DRIVER_HEALTH_PROTOCOL {

-  EFI_DRIVER_HEALTH_GET_HEALTH_STATUS  GetHealthStatus;

-  EFI_DRIVER_HEALTH_REPAIR             Repair;

-};

-

-extern EFI_GUID gEfiDriverHealthProtocolGuid;

-

-#endif

-

-

-

-

diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h
index 5961c8b741..62218d7149 100644
--- a/MdePkg/Include/Protocol/FirmwareVolume2.h
+++ b/MdePkg/Include/Protocol/FirmwareVolume2.h
@@ -85,7 +85,8 @@ typedef UINT64  EFI_FV_ATTRIBUTES;
 #define EFI_FV2_ALIGNMENT_2G            0x00000000001F0000ULL

 

 /**

-  

+  Returns the attributes and current settings of the firmware volume.

+

   Because of constraints imposed by the underlying firmware

   storage, an instance of the Firmware Volume Protocol may not

   be to able to support all possible variations of this

@@ -116,6 +117,8 @@ EFI_STATUS
 

 

 /**

+  Modifies the current settings of the firmware volume according to the input parameter.

+  

   The SetVolumeAttributes() function is used to set configurable

   firmware volume attributes. Only EFI_FV_READ_STATUS,

   EFI_FV_WRITE_STATUS, and EFI_FV_LOCK_STATUS may be modified, and

@@ -209,11 +212,13 @@ EFI_STATUS
 

 

 /**

+  Retrieves a file and/or file information from the firmware volume.

+

   ReadFile() is used to retrieve any file from a firmware volume

   during the DXE phase. The actual binary encoding of the file in

   the firmware volume media may be in any arbitrary format as long

-  as it does the following: ?It is accessed using the Firmware

-  Volume Protocol. ?The image that is returned follows the image

+  as it does the following: It is accessed using the Firmware

+  Volume Protocol. The image that is returned follows the image

   format defined in Code Definitions: PI Firmware File Format.

   If the input value of Buffer==NULL, it indicates the caller is

   requesting only that the type, attributes, and size of the

@@ -308,12 +313,12 @@ EFI_STATUS
 

 

 /**

+  Locates the requested section within a file and returns it in a buffer.

+

   ReadSection() is used to retrieve a specific section from a file

   within a firmware volume. The section returned is determined

   using a depth-first, left-to-right search algorithm through all

-  sections found in the specified file. See

-   ????Firmware File Sections???? on page 9 for more details about

-  sections. The output buffer is specified by a double indirection

+  sections found in the specified file. The output buffer is specified by a double indirection

   of the Buffer parameter. The input value of Buffer is used to

   determine if the output buffer is caller allocated or is

   dynamically allocated by ReadSection(). If the input value of

@@ -432,6 +437,8 @@ typedef struct {
 } EFI_FV_WRITE_FILE_DATA;

 

 /**

+  Locates the requested section within a file and returns it in a buffer.

+

   WriteFile() is used to write one or more files to a firmware

   volume. Each file to be written is described by an

   EFI_FV_WRITE_FILE_DATA structure. The caller must ensure that

@@ -506,6 +513,9 @@ EFI_STATUS
 

 

 /**

+	Retrieves information about the next file in the firmware volume store 

+	that matches the search criteria.

+

   GetNextFile() is the interface that is used to search a firmware

   volume for a particular file. It is called successively until

   the desired file is located or the function returns

@@ -589,6 +599,8 @@ EFI_STATUS
 );

 

 /**

+  Return information about a firmware volume.

+

   The GetInfo() function returns information of type

   InformationType for the requested firmware volume. If the volume

   does not support the requested information type, then

@@ -644,6 +656,7 @@ EFI_STATUS
 

 

 /**

+  Sets information about a firmware volume.

 

   The SetInfo() function sets information of type InformationType

   on the requested firmware volume.

diff --git a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
index 9c20ba2296..ab996778d7 100644
--- a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
+++ b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
@@ -139,6 +139,8 @@ EFI_STATUS
 

 

 /**

+  Reads the specified number of bytes into a buffer from the specified block.

+

   The Read() function reads the requested number of bytes from the

   requested block and stores them in the provided buffer.

   Implementations should be mindful that the firmware volume

@@ -194,6 +196,8 @@ EFI_STATUS
 );

 

 /**

+  Writes the specified number of bytes from the input buffer to the block.

+

   The Write() function writes the specified number of bytes from

   the provided buffer to the specified block and offset. If the

   firmware volume is sticky write, the caller must ensure that

@@ -270,6 +274,8 @@ EFI_STATUS
 

 

 /**

+  Erases and initializes a firmware volume block.

+

   The EraseBlocks() function erases one or more blocks as denoted

   by the variable argument list. The entire parameter list of

   blocks must be verified before erasing any blocks. If a block is

diff --git a/MdePkg/Include/Protocol/FormBrowser2.h b/MdePkg/Include/Protocol/FormBrowser2.h
index 021e04d377..3dc8fa2116 100644
--- a/MdePkg/Include/Protocol/FormBrowser2.h
+++ b/MdePkg/Include/Protocol/FormBrowser2.h
@@ -60,6 +60,8 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST;
 

 

 /**

+  Initialize the browser to display the specified configuration forms.

+

   This function is the primary interface to the internal forms-based browser. 

   The forms browser will display forms associated with the specified Handles. 

   The browser will select all forms in packages which have the specified Type 

@@ -68,7 +70,7 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST;
   @param This            A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance

 

   @param Handles         A pointer to an array of Handles. This value should correspond 

-                         to the value of the HII form package that is required to be displayed. Type

+                         to the value of the HII form package that is required to be displayed.

 

   @param HandleCount     The number of Handles specified in Handle.

 

@@ -107,7 +109,8 @@ EFI_STATUS
 

 

 /**

-   

+  This function is called by a callback handler to retrieve uncommitted state data from the browser.

+

   This routine is called by a routine which was called by the

   browser. This routine called this service in the browser to

   retrieve or set certain uncommitted state information.

diff --git a/MdePkg/Include/Protocol/ScsiIo.h b/MdePkg/Include/Protocol/ScsiIo.h
index 51840a17a8..db209c8ec9 100644
--- a/MdePkg/Include/Protocol/ScsiIo.h
+++ b/MdePkg/Include/Protocol/ScsiIo.h
@@ -20,7 +20,7 @@
 

 #define EFI_SCSI_IO_PROTOCOL_GUID \

   { \

-    0x932f4736, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \

+    0x932f47e6, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \

   }

 

 ///

diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h
index 02c2de8b9f..39b2ba5907 100644
--- a/MdePkg/Include/Protocol/ScsiPassThruExt.h
+++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h
@@ -19,7 +19,7 @@
 

 #define EFI_EXT_SCSI_PASS_THRU_PROTOCOL_GUID \

   { \

-    0x1d3de7f0, 0x0807, 0x424f, {0xaa, 0x69, 0x11, 0xa5, 0x4e, 0x19, 0xa4, 0x6f } \

+    0x143b7632, 0xb81b, 0x4cb7, {0xab, 0xd3, 0xb6, 0x25, 0xa5, 0xb9, 0xbf, 0xfe } \

   }

 

 typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL;

@@ -205,7 +205,7 @@ EFI_STATUS
   IN UINT8                                         *Target,

   IN UINT64                                        Lun,

   IN OUT EFI_DEVICE_PATH_PROTOCOL                  **DevicePath

-  );     

+  );

 

 /**

   Used to translate a device path node to a Target ID and LUN.