/** @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 - 2007, 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) 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 PI.\r
- Version 1.00.\r
+ This PPI is introduced in PI Version 1.0.\r
\r
**/\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
@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
- UINTN Resolution;\r
- EFI_PEI_STALL Stall;\r
+ ///\r
+ /// The resolution in microseconds of the stall services.\r
+ ///\r
+ UINTN Resolution;\r
+\r
+ EFI_PEI_STALL Stall;\r
};\r
\r
-extern EFI_GUID gEfiPeiStallPpiGuid;\r
+extern EFI_GUID gEfiPeiStallPpiGuid;\r
\r
#endif\r