MdePkg Base.h: Use correct style to check the defined macro

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / SmBus.h

diff --git a/MdePkg/Include/IndustryStandard/SmBus.h b/MdePkg/Include/IndustryStandard/SmBus.h
index 89142c1f85d20d5862c759d784323fd0750275da..f5d6e5ef9b7d325cf9b652496a78e84c9acf0713 100644 (file)
--- a/MdePkg/Include/IndustryStandard/SmBus.h
+++ b/MdePkg/Include/IndustryStandard/SmBus.h
@@ -1,14 +1,9 @@
 /** @file\r
-  This file declares the SMBus definitions defined in SmBus Specifciation V2.0.\r
+  This file declares the SMBus definitions defined in SmBus Specifciation V2.0\r
+  and defined in PI1.0 specification volume 5.\r
 \r
-  Copyright (c) 2007 - 2008, 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
+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -34,14 +29,29 @@ typedef struct {
 /// Smbus Device Address\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// The SMBUS hardware address to which the SMBUS device is preassigned or allocated.\r
+  ///\r
   UINTN SmbusDeviceAddress : 7;\r
 } EFI_SMBUS_DEVICE_ADDRESS;\r
 \r
+typedef struct {\r
+  ///\r
+  /// The SMBUS hardware address to which the SMBUS device is preassigned or\r
+  /// allocated. Type EFI_SMBUS_DEVICE_ADDRESS is defined in EFI_PEI_SMBUS2_PPI.Execute().\r
+  ///\r
+  EFI_SMBUS_DEVICE_ADDRESS  SmbusDeviceAddress;\r
+  ///\r
+  /// The SMBUS Unique Device Identifier (UDID) as defined in EFI_SMBUS_UDID.\r
+  /// Type EFI_SMBUS_UDID is defined in EFI_PEI_SMBUS2_PPI.ArpDevice().\r
+  ///\r
+  EFI_SMBUS_UDID            SmbusDeviceUdid;\r
+} EFI_SMBUS_DEVICE_MAP;\r
+\r
 ///\r
 /// Smbus Operations\r
 ///\r
-typedef enum _EFI_SMBUS_OPERATION\r
-{\r
+typedef enum _EFI_SMBUS_OPERATION {\r
   EfiSmbusQuickRead,\r
   EfiSmbusQuickWrite,\r
   EfiSmbusReceiveByte,\r
@@ -56,5 +66,10 @@ typedef enum _EFI_SMBUS_OPERATION
   EfiSmbusBWBRProcessCall\r
 } EFI_SMBUS_OPERATION;\r
 \r
+///\r
+/// EFI_SMBUS_DEVICE_COMMAND\r
+///\r
+typedef UINTN   EFI_SMBUS_DEVICE_COMMAND;\r
+\r
 #endif\r
 \r