OvmfPkg/SmmControl2Dxe: select broadcast SMI if available

[mirror_edk2.git] / OvmfPkg / SmmControl2Dxe / SmiFeatures.h

/**@file\r
  Negotiate SMI features with QEMU, and configure UefiCpuPkg/PiSmmCpuDxeSmm\r
  accordingly.\r
\r
  Copyright (C) 2016-2017, Red Hat, Inc.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  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, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
#ifndef __SMI_FEATURES_H__\r
#define __SMI_FEATURES_H__\r
\r
#include <Protocol/S3SaveState.h>\r
\r
/**\r
  Negotiate SMI features with QEMU.\r
\r
  @retval FALSE  If SMI feature negotiation is not supported by QEMU. This is\r
                 not an error, it just means that SaveSmiFeatures() should not\r
                 be called.\r
\r
  @retval TRUE   SMI feature negotiation is supported, and it has completed\r
                 successfully as well. (Failure to negotiate is a fatal error\r
                 and the function never returns in that case.)\r
**/\r
BOOLEAN\r
NegotiateSmiFeatures (\r
  VOID\r
  );\r
\r
/**\r
  Append a boot script fragment that will re-select the previously negotiated\r
  SMI features during S3 resume.\r
\r
  @param[in] S3SaveState  The EFI_S3_SAVE_STATE_PROTOCOL instance to append to\r
                          the S3 boot script with.\r
**/\r
VOID\r
SaveSmiFeatures (\r
  IN EFI_S3_SAVE_STATE_PROTOCOL *S3SaveState\r
  );\r
\r
#endif\r