MdePkg Protocol/DevicePath.h: Update SATA Device Path comments

The UEFI2.5 spec (Mantis ticket 1353 -
https://mantis.uefi.org/mantis/view.php?id=1353) updated the Port
Multiplier Port Number description of SATA device path to use 0xFFFF when
the device is directly connected to the HBA.

Please note that this is an incompatible semantic change. The consumer of
SATA device path needs to re-examine its usage to follow UEFI 2.5 mantis
1353.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Feng Tian <feng.tian@intel.com>

diff --git a/MdePkg/Include/Protocol/DevicePath.h b/MdePkg/Include/Protocol/DevicePath.h
index 9a9ad2c08979c99a628f16139b867c20770f5c6a..aa7aec793e3132429b1053df3f5e9ec8e12d276e 100644 (file)
--- a/MdePkg/Include/Protocol/DevicePath.h
+++ b/MdePkg/Include/Protocol/DevicePath.h
@@ -5,7 +5,7 @@
   from a software point of view. The path must persist from boot to boot, so \r
   it can not contain things like PCI bus numbers that change from boot to boot.\r
 \r
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -509,7 +509,7 @@ typedef struct {
   UINT16                          HBAPortNumber;\r
   ///\r
   /// The Port multiplier port number that facilitates the connection\r
-  /// to the device. Bit 15 should be set if the device is directly\r
+  /// to the device. Must be set to 0xFFFF if the device is directly\r
   /// connected to the HBA.\r
   ///\r
   UINT16                          PortMultiplierPortNumber;\r