MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Ppi / Stall.h

diff --git a/MdePkg/Include/Ppi/Stall.h b/MdePkg/Include/Ppi/Stall.h
index 363baa6d393929f5035574185015704c5fc708d2..edabaab5242bf27c7213b2e299c82ff305883550 100644 (file)
--- a/MdePkg/Include/Ppi/Stall.h
+++ b/MdePkg/Include/Ppi/Stall.h
@@ -1,22 +1,13 @@
 /** @file\r
   This file declares Stall PPI.\r
 \r
-  This code abstracts the PEI core to provide Stall services.\r
+  This ppi abstracts the blocking stall service to other agents.\r
 \r
-  Copyright (c) 2006, 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
-\r
-  Module Name:  Stall.h\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
-  This PPI is defined in PEI CIS.\r
-  Version 0.91.\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -24,47 +15,39 @@
 #define __STALL_PPI_H__\r
 \r
 #define EFI_PEI_STALL_PPI_GUID \\r
-  { \\r
-    0x1f4c6f90, 0xb06b, 0x48d8, {0xa2, 0x01, 0xba, 0xe5, 0xf1, 0xcd, 0x7d, 0x56 } \\r
-  }\r
+  { 0x1f4c6f90, 0xb06b, 0x48d8, {0xa2, 0x01, 0xba, 0xe5, 0xf1, 0xcd, 0x7d, 0x56 } }\r
 \r
 typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI;\r
 \r
 /**\r
-  The Stall() function provides a blocking stall for at least the number \r
+  The Stall() function provides a blocking stall for at least the number\r
   of microseconds stipulated in the final argument of the API.\r
 \r
-  @param  PeiServices An indirect pointer to the PEI Services Table \r
-  published by the PEI Foundation. \r
-  \r
-  @param  This Pointer to the local data for the interface.\r
-  \r
-  @param  Microseconds Number of microseconds for which to stall.\r
+  @param  PeiServices    An indirect pointer to the PEI Services Table\r
+                         published by the PEI Foundation.\r
+  @param  This           Pointer to the local data for the interface.\r
+  @param  Microseconds   Number of microseconds for which to stall.\r
 \r
-  @retval EFI_SUCCESS The service provided at least the required delay.\r
+  @retval EFI_SUCCESS    The service provided at least the required delay.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_STALL) (\r
-  IN EFI_PEI_SERVICES           **PeiServices,\r
-  IN EFI_PEI_STALL_PPI          *This,\r
+(EFIAPI *EFI_PEI_STALL)(\r
+  IN CONST EFI_PEI_SERVICES     **PeiServices,\r
+  IN CONST EFI_PEI_STALL_PPI    *This,\r
   IN UINTN                      Microseconds\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This service provides a simple, blocking stall with platform-specific resolution. \r
-\r
-  @param Resolution\r
-  The resolution in microseconds of the stall services.\r
-\r
-  @param Stall\r
-  The actual stall procedure call. \r
-\r
-**/\r
+///\r
+/// This service provides a simple, blocking stall with platform-specific resolution.\r
+///\r
 struct _EFI_PEI_STALL_PPI {\r
+  ///\r
+  /// The resolution in microseconds of the stall services.\r
+  ///\r
   UINTN          Resolution;\r
+\r
   EFI_PEI_STALL  Stall;\r
 };\r
 \r