/** @file\r
- Timer Architectural Protocol as defined in the DXE CIS\r
+ Timer Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
\r
This code is used to provide the timer tick for the DXE core.\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
+ Copyright (c) 2006 - 2018, 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
\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
- @par Revision Reference:\r
- Version 0.91B.\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
**/\r
\r
#ifndef __ARCH_PROTOCOL_TIMER_H__\r
#define __ARCH_PROTOCOL_TIMER_H__\r
\r
-//\r
-// Global ID for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Timer Architectural Protocol\r
+///\r
#define EFI_TIMER_ARCH_PROTOCOL_GUID \\r
{ 0x26baccb3, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
\r
-//\r
-// Declare forward reference for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Timer Architectural Protocol\r
+///\r
typedef struct _EFI_TIMER_ARCH_PROTOCOL EFI_TIMER_ARCH_PROTOCOL;\r
\r
/**\r
- This function of this type is called when a timer interrupt fires. This \r
- function executes at TPL_HIGH_LEVEL. The DXE Core will register a funtion\r
- of tyis type to be called for the timer interrupt, so it can know how much \r
- time has passed. This information is used to signal timer based events. \r
+ This function of this type is called when a timer interrupt fires. This\r
+ function executes at TPL_HIGH_LEVEL. The DXE Core will register a function\r
+ of this type to be called for the timer interrupt, so it can know how much\r
+ time has passed. This information is used to signal timer based events.\r
\r
- @param Time Time since the last timer interrupt in 100 ns units. This will\r
- typically be TimerPeriod, but if a timer interrupt is missed, and the\r
- EFI_TIMER_ARCH_PROTOCOL driver can detect missed interrupts, then Time\r
- will contain the actual amount of time since the last interrupt.\r
+ @param Time Time since the last timer interrupt in 100 ns units. This will\r
+ typically be TimerPeriod, but if a timer interrupt is missed, and the\r
+ EFI_TIMER_ARCH_PROTOCOL driver can detect missed interrupts, then Time\r
+ will contain the actual amount of time since the last interrupt.\r
\r
None.\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_TIMER_NOTIFY) (\r
+(EFIAPI *EFI_TIMER_NOTIFY)(\r
IN UINT64 Time\r
);\r
\r
/**\r
- This function registers the handler NotifyFunction so it is called every time \r
- the timer interrupt fires. It also passes the amount of time since the last \r
- handler call to the NotifyFunction. If NotifyFunction is NULL, then the \r
- handler is unregistered. If the handler is registered, then EFI_SUCCESS is \r
- returned. If the CPU does not support registering a timer interrupt handler, \r
- then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler \r
- when a handler is already registered, then EFI_ALREADY_STARTED is returned. \r
- If an attempt is made to unregister a handler when a handler is not registered, \r
- then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to \r
- register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR \r
+ This function registers the handler NotifyFunction so it is called every time\r
+ the timer interrupt fires. It also passes the amount of time since the last\r
+ handler call to the NotifyFunction. If NotifyFunction is NULL, then the\r
+ handler is unregistered. If the handler is registered, then EFI_SUCCESS is\r
+ returned. If the CPU does not support registering a timer interrupt handler,\r
+ then EFI_UNSUPPORTED is returned. If an attempt is made to register a handler\r
+ when a handler is already registered, then EFI_ALREADY_STARTED is returned.\r
+ If an attempt is made to unregister a handler when a handler is not registered,\r
+ then EFI_INVALID_PARAMETER is returned. If an error occurs attempting to\r
+ register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR\r
is returned.\r
\r
@param This The EFI_TIMER_ARCH_PROTOCOL instance.\r
@retval EFI_DEVICE_ERROR The timer handler could not be registered.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_TIMER_REGISTER_HANDLER) (\r
+(EFIAPI *EFI_TIMER_REGISTER_HANDLER)(\r
IN EFI_TIMER_ARCH_PROTOCOL *This,\r
IN EFI_TIMER_NOTIFY NotifyFunction\r
);\r
\r
/**\r
- This function adjusts the period of timer interrupts to the value specified \r
- by TimerPeriod. If the timer period is updated, then the selected timer \r
- period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If \r
- the timer hardware is not programmable, then EFI_UNSUPPORTED is returned. \r
- If an error occurs while attempting to update the timer period, then the \r
- timer hardware will be put back in its state prior to this call, and \r
- EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt \r
- is disabled. This is not the same as disabling the CPU's interrupts. \r
- Instead, it must either turn off the timer hardware, or it must adjust the \r
- interrupt controller so that a CPU interrupt is not generated when the timer \r
- interrupt fires. \r
+ This function adjusts the period of timer interrupts to the value specified\r
+ by TimerPeriod. If the timer period is updated, then the selected timer\r
+ period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned. If\r
+ the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.\r
+ If an error occurs while attempting to update the timer period, then the\r
+ timer hardware will be put back in its state prior to this call, and\r
+ EFI_DEVICE_ERROR is returned. If TimerPeriod is 0, then the timer interrupt\r
+ is disabled. This is not the same as disabling the CPU's interrupts.\r
+ Instead, it must either turn off the timer hardware, or it must adjust the\r
+ interrupt controller so that a CPU interrupt is not generated when the timer\r
+ interrupt fires.\r
\r
@param This The EFI_TIMER_ARCH_PROTOCOL instance.\r
@param TimerPeriod The rate to program the timer interrupt in 100 nS units. If\r
@retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_TIMER_SET_TIMER_PERIOD) (\r
+(EFIAPI *EFI_TIMER_SET_TIMER_PERIOD)(\r
IN EFI_TIMER_ARCH_PROTOCOL *This,\r
IN UINT64 TimerPeriod\r
);\r
\r
/**\r
- This function retrieves the period of timer interrupts in 100 ns units, \r
- returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod \r
- is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is \r
+ This function retrieves the period of timer interrupts in 100 ns units,\r
+ returns that value in TimerPeriod, and returns EFI_SUCCESS. If TimerPeriod\r
+ is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is\r
returned, then the timer is currently disabled.\r
\r
@param This The EFI_TIMER_ARCH_PROTOCOL instance.\r
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_TIMER_GET_TIMER_PERIOD) (\r
+(EFIAPI *EFI_TIMER_GET_TIMER_PERIOD)(\r
IN EFI_TIMER_ARCH_PROTOCOL *This,\r
OUT UINT64 *TimerPeriod\r
);\r
\r
/**\r
- This function generates a soft timer interrupt. If the platform does not support soft \r
- timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned. \r
- If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler() \r
- service, then a soft timer interrupt will be generated. If the timer interrupt is \r
- enabled when this service is called, then the registered handler will be invoked. The \r
- registered handler should not be able to distinguish a hardware-generated timer \r
+ This function generates a soft timer interrupt. If the platform does not support soft\r
+ timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned.\r
+ If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler()\r
+ service, then a soft timer interrupt will be generated. If the timer interrupt is\r
+ enabled when this service is called, then the registered handler will be invoked. The\r
+ registered handler should not be able to distinguish a hardware-generated timer\r
interrupt from a software-generated timer interrupt.\r
\r
- @param This The EFI_TIMER_ARCH_PROTOCOL instance.\r
+ @param This The EFI_TIMER_ARCH_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The soft timer interrupt was generated.\r
- @retval EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.\r
+ @retval EFI_UNSUPPORTED The platform does not support the generation of soft timer interrupts.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_TIMER_GENERATE_SOFT_INTERRUPT) (\r
+(EFIAPI *EFI_TIMER_GENERATE_SOFT_INTERRUPT)(\r
IN EFI_TIMER_ARCH_PROTOCOL *This\r
);\r
\r
\r
-/**\r
- Interface stucture for the Timer Architectural Protocol.\r
-\r
- @par Protocol Description:\r
- This protocol provides the services to initialize a periodic timer \r
- interrupt, and to register a handler that is called each time the timer\r
- interrupt fires. It may also provide a service to adjust the rate of the\r
- periodic timer interrupt. When a timer interrupt occurs, the handler is \r
- passed the amount of time that has passed since the previous timer \r
- interrupt.\r
-\r
- @param RegisterHandler\r
- Registers a handler that will be called each time the \r
- timer interrupt fires. TimerPeriod defines the minimum \r
- time between timer interrupts, so TimerPeriod will also \r
- be the minimum time between calls to the registered \r
- handler.\r
-\r
- @param SetTimerPeriod\r
- Sets the period of the timer interrupt in 100 nS units. \r
- This function is optional, and may return EFI_UNSUPPORTED. \r
- If this function is supported, then the timer period will \r
- be rounded up to the nearest supported timer period.\r
-\r
- @param GetTimerPeriod\r
- Retrieves the period of the timer interrupt in 100 nS units.\r
-\r
- @param GenerateSoftInterrupt\r
- Generates a soft timer interrupt that simulates the firing of \r
- the timer interrupt. This service can be used to invoke the \r
- registered handler if the timer interrupt has been masked for \r
- a period of time.\r
-\r
-**/\r
+///\r
+/// This protocol provides the services to initialize a periodic timer\r
+/// interrupt, and to register a handler that is called each time the timer\r
+/// interrupt fires. It may also provide a service to adjust the rate of the\r
+/// periodic timer interrupt. When a timer interrupt occurs, the handler is\r
+/// passed the amount of time that has passed since the previous timer\r
+/// interrupt.\r
+///\r
struct _EFI_TIMER_ARCH_PROTOCOL {\r
EFI_TIMER_REGISTER_HANDLER RegisterHandler;\r
EFI_TIMER_SET_TIMER_PERIOD SetTimerPeriod;\r
projects / mirror_edk2.git / blobdiff