SmmPeriodicSmiLib.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides services to enable and disable periodic SMI handlers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns a pointer to a table of supported periodic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMI tick periods in 100 ns units sorted from largest to smallest.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The table contains a array of UINT64 values terminated by a tick
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync period value of 0. The returned table must be treated as read-only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data and must not be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A pointer to a table of UINT64 tick period values in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 100ns units sorted from largest to smallest terminated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by a tick period of 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the time in 100ns units since the periodic SMI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handler function was called. If the periodic SMI handler was resumed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync through PeriodicSmiYield(), then the time returned is the time in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 100ns units since PeriodicSmiYield() returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The actual time in 100ns units that the periodic SMI handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has been executing. If this function is not called from within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an enabled periodic SMI handler, then 0 is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns control back to the SMM Foundation. When the next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync periodic SMI for the currently executing handler is triggered, the periodic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMI handler will restarted from its registered DispatchFunction entry point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this function is not called from within an enabled periodic SMI handler,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then control is returned to the calling function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function yields control back to the SMM Foundation. When the next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync periodic SMI for the currently executing handler is triggered, the periodic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMI handler will be resumed and this function will return. Use of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function requires a seperate stack for the periodic SMI handler. A non zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stack size must be specified in PeriodicSmiEnable() for this function to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the stack size passed into PeriodicSmiEnable() was zero, the 0 is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this function is not called from within an enabled periodic SMI handler,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then 0 is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The actual time in 100ns units elasped since this function was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync called. A value of 0 indicates an unknown amount of time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is a prototype for a periodic SMI handler function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that may be enabled with PeriodicSmiEnable() and disabled with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PeriodicSmiDisable().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context Content registered with PeriodicSmiEnable().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ElapsedTime The actual time in 100ns units elasped since
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function was called. A value of 0 indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an unknown amount of time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function enables a periodic SMI handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DispatchHandle A pointer to the handle associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enabled periodic SMI handler. This is an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync optional parameter that may be NULL. If it is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL, then the handle will not be returned,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which means that the periodic SMI handler can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync never be disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DispatchFunction A pointer to a periodic SMI handler function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context Optional content to pass into DispatchFunction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TickPeriod The requested tick period in 100ns units that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync control should be givien to the periodic SMI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handler. Must be one of the supported values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned by PeriodicSmiSupportedPickPeriod().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Cpu Specifies the CPU that is required to execute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the periodic SMI handler. If Cpu is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PERIODIC_SMI_LIBRARY_ANY_CPU, then the periodic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMI handler will always be executed on the SMST
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CurrentlyExecutingCpu, which may vary across
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync periodic SMIs. If Cpu is between 0 and the SMST
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NumberOfCpus, then the periodic SMI will always
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be executed on the requested CPU.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] StackSize The size, in bytes, of the stack to allocate for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync use by the periodic SMI handler. If 0, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync default stack will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DispatchFunction is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED TickPeriod is not a supported tick period. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported tick periods can be retrieved using
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PeriodicSmiSupportedTickPeriod().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Cpu is not PERIODIC_SMI_LIBRARY_ANY_CPU or in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the range 0 to SMST NumberOfCpus.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to enable the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync periodic SMI handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stack speficied by StackSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The periodic SMI handler was enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function disables a periodic SMI handler that has been previously
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enabled with PeriodicSmiEnable().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DispatchHandle A handle associated with a previously enabled periodic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMI handler. This is an optional parameter that may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be NULL. If it is NULL, then the active periodic SMI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handlers is disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE DispatchHandle is NULL and there is no active periodic SMI handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The periodic SMI handler specified by DispatchHandle has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not been enabled with PeriodicSmiEnable().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The periodic SMI handler specified by DispatchHandle has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been disabled. If DispatchHandle is NULL, then the active
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync periodic SMI handler has been disabled.