\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
- 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
**/\r
\r
typedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL;\r
\r
/**\r
- The WaitForTick() function waits for the number of ticks specified by \r
- TickNumber from a known time source in the platform. If TickNumber of \r
- ticks are detected, then EFI_SUCCESS is returned. The actual time passed \r
- between entry of this function and the first tick is between 0 and \r
- TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod \r
- time has elapsed, wait for two ticks. This function waits for a hardware \r
- event to determine when a tick occurs. It is possible for interrupt \r
- processing, or exception processing to interrupt the execution of the \r
- WaitForTick() function. Depending on the hardware source for the ticks, it \r
- is possible for a tick to be missed. This function cannot guarantee that \r
- ticks will not be missed. If a timeout occurs waiting for the specified \r
+ The WaitForTick() function waits for the number of ticks specified by\r
+ TickNumber from a known time source in the platform. If TickNumber of\r
+ ticks are detected, then EFI_SUCCESS is returned. The actual time passed\r
+ between entry of this function and the first tick is between 0 and\r
+ TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod\r
+ time has elapsed, wait for two ticks. This function waits for a hardware\r
+ event to determine when a tick occurs. It is possible for interrupt\r
+ processing, or exception processing to interrupt the execution of the\r
+ WaitForTick() function. Depending on the hardware source for the ticks, it\r
+ is possible for a tick to be missed. This function cannot guarantee that\r
+ ticks will not be missed. If a timeout occurs waiting for the specified\r
number of ticks, then EFI_TIMEOUT is returned.\r
\r
@param This The EFI_METRONOME_ARCH_PROTOCOL instance.\r
@retval EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_METRONOME_WAIT_FOR_TICK)(\r
IN EFI_METRONOME_ARCH_PROTOCOL *This,\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
+/// 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
///\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
+ /// 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