Remove BugBug in comments and adjust function header according to code style doc.

[mirror_edk2.git] / MdePkg / Include / Dxe / ArchProtocol / Timer.h

diff --git a/MdePkg/Include/Dxe/ArchProtocol/Timer.h b/MdePkg/Include/Dxe/ArchProtocol/Timer.h
index 330f4cfd68a39c81c52c0e7dc1e6b85c4ebf491c..302ae1428acd862788033582f9721d46d6e4cd10 100644 (file)
--- a/MdePkg/Include/Dxe/ArchProtocol/Timer.h
+++ b/MdePkg/Include/Dxe/ArchProtocol/Timer.h
@@ -39,10 +39,10 @@ typedef struct _EFI_TIMER_ARCH_PROTOCOL   EFI_TIMER_ARCH_PROTOCOL;
   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
 \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
 \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
   None.\r
 \r


@@ -66,25 +66,20 @@ VOID
   register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR \r
   is returned.\r
 \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
-  \r
-  @param  NotifyFunction The function to call when a timer interrupt fires.  This\r
-  function executes at TPL_HIGH_LEVEL.  The DXE Core will\r
-  register a handler for the timer interrupt, so it can know\r
-  how much time has passed.  This information is used to\r
-  signal timer based events.  NULL will unregister the handler.\r
-\r
-  @retval  EFI_SUCCESS The timer handler was registered.\r
-  \r
-  @retval  EFI_UNSUPPORTED The platform does not support timer interrupts.\r
-  \r
-  @retval  EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already\r
-  registered.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
-  previously registered.\r
-  \r
-  @retval  EFI_DEVICE_ERROR The timer handler could not be registered.\r
+  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.\r
+  @param  NotifyFunction   The function to call when a timer interrupt fires. This\r
+                           function executes at TPL_HIGH_LEVEL. The DXE Core will\r
+                           register a handler for the timer interrupt, so it can know\r
+                           how much time has passed. This information is used to\r
+                           signal timer based events. NULL will unregister the handler.\r
+\r
+  @retval EFI_SUCCESS           The timer handler was registered.\r
+  @retval EFI_UNSUPPORTED       The platform does not support timer interrupts.\r
+  @retval EFI_ALREADY_STARTED   NotifyFunction is not NULL, and a handler is already\r
+                                registered.\r
+  @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
+                                previously registered.\r
+  @retval EFI_DEVICE_ERROR      The timer handler could not be registered.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -107,20 +102,17 @@ EFI_STATUS
   interrupt controller so that a CPU interrupt is not generated when the timer \r
   interrupt fires. \r
 \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
-  \r
-  @param  TimerPeriod The rate to program the timer interrupt in 100 nS units.  If\r
-  the timer hardware is not programmable, then EFI_UNSUPPORTED is\r
-  returned.  If the timer is programmable, then the timer period\r
-  will be rounded up to the nearest timer period that is supported\r
-  by the timer hardware.  If TimerPeriod is set to 0, then the\r
-  timer interrupts will be disabled.\r
-\r
-  @retval  EFI_SUCCESS The timer period was changed.\r
-  \r
-  @retval  EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.\r
-  \r
-  @retval  EFI_DEVICE_ERROR The timer period could not be changed due to a device error.\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
+                           the timer hardware is not programmable, then EFI_UNSUPPORTED is\r
+                           returned. If the timer is programmable, then the timer period\r
+                           will be rounded up to the nearest timer period that is supported\r
+                           by the timer hardware. If TimerPeriod is set to 0, then the\r
+                           timer interrupts will be disabled.\r
+\r
+  @retval EFI_SUCCESS           The timer period was changed.\r
+  @retval EFI_UNSUPPORTED       The platform cannot change the period of the timer interrupt.\r
+  @retval EFI_DEVICE_ERROR      The timer period could not be changed due to a device error.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -136,14 +128,12 @@ EFI_STATUS
   is NULL, then EFI_INVALID_PARAMETER is returned.  If a TimerPeriod of 0 is \r
   returned, then the timer is currently disabled.\r
 \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
-  \r
-  @param  TimerPeriod A pointer to the timer period to retrieve in 100 ns units.  If\r
-  0 is returned, then the timer is currently disabled.\r
+  @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      A pointer to the timer period to retrieve in 100 ns units. If\r
+                           0 is returned, then the timer is currently disabled.\r

 \r
 \r

-  @retval  EFI_SUCCESS The timer period was returned in TimerPeriod.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
+  @retval EFI_SUCCESS           The timer period was returned in TimerPeriod.\r
+  @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -162,11 +152,10 @@ EFI_STATUS
   registered handler should not be able to distinguish a hardware-generated timer \r
   interrupt from a software-generated timer interrupt.\r
 \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
 \r

-  @retval  EFI_SUCCESS The soft timer interrupt was generated.\r
-  \r
-  @retval  EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.\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

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r