MdePkg: Add UEFI2.5 EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL definitions

[mirror_edk2.git] / MdePkg / Include / Protocol / Metronome.h

diff --git a/MdePkg/Include/Protocol/Metronome.h b/MdePkg/Include/Protocol/Metronome.h
index edc4927d35c8402ae7a1dafd04011104d00f8252..c71cd40043da3f7a444252f064c24b96399059c1 100644 (file)
--- a/MdePkg/Include/Protocol/Metronome.h
+++ b/MdePkg/Include/Protocol/Metronome.h
@@ -3,8 +3,8 @@
 \r
   This code abstracts the DXE core to provide delay services.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
@@ -17,15 +17,15 @@
 #ifndef __ARCH_PROTOCOL_METRONOME_H__\r
 #define __ARCH_PROTOCOL_METRONOME_H__\r
 \r
-//\r
-// Global ID for the Metronome Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Metronome Architectural Protocol\r
+///\r
 #define EFI_METRONOME_ARCH_PROTOCOL_GUID \\r
   { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
 \r
-//\r
-// Declare forward reference for the Metronome Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Metronome Architectural Protocol\r
+///\r
 typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;\r
 \r
 /**\r
@@ -57,34 +57,21 @@ EFI_STATUS
    IN UINT32                        TickNumber\r
   );\r
 \r
-//\r
-//\r
-\r
-/**\r
-  Interface stucture for the Metronome Architectural Protocol.\r
-\r
-  @par Protocol Description:\r
-  This protocol provides access to a known time source in the platform to the\r
-  core.  The core uses this known time source to produce core services that \r
-  require calibrated delays.  \r
-\r
-  @param WaitForTick\r
-  Waits for a specified number of ticks from a known time source \r
-  in the platform.  The actual time passed between entry of this \r
-  function and the first tick is between 0 and TickPeriod 100 nS \r
-  units.  If you want to guarantee that at least TickPeriod time \r
-  has elapsed, wait for two ticks.\r
-\r
-  @param TickPeriod\r
-  The period of platform's known time source in 100 nS units.  \r
-  This value on any platform must be at least 10 uS, and must not \r
-  exceed 200 uS.  The value in this field is a constant that must \r
-  not be modified after the Metronome architectural protocol is \r
-  installed.  All consumers must treat this as a read-only field.\r
-\r
-**/\r
+///\r
+/// This protocol provides access to a known time source in the platform to the\r
+/// core.  The core uses this known time source to produce core services that \r
+/// require calibrated delays.  \r
+///\r
 struct _EFI_METRONOME_ARCH_PROTOCOL {\r
   EFI_METRONOME_WAIT_FOR_TICK  WaitForTick;\r
+  \r
+  ///\r
+  /// The period of platform's known time source in 100 nS units.  \r
+  /// This value on any platform must be at least 10 uS, and must not \r
+  /// exceed 200 uS.  The value in this field is a constant that must \r
+  /// not be modified after the Metronome architectural protocol is \r
+  /// installed.  All consumers must treat this as a read-only field.  \r
+  ///\r
   UINT32                       TickPeriod;\r
 };\r
 \r