QuarkSocPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / QuarkSocPkg / QuarkNorthCluster / Smm / DxeSmm / QncSmmDispatcher / QNCxSmmHelpers.h

/** @file\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef QNCX_SMM_HELPERS_H\r
#define QNCX_SMM_HELPERS_H\r
\r
//\r
// Include common header file for this module.\r
//\r
#include "CommonHeader.h"\r
\r
#include "QNCSmm.h"\r
\r
EFI_STATUS\r
QNCSmmInitHardware (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
QNCSmmEnableGlobalSmiBit (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Enables the QNC to generate SMIs. Note that no SMIs will be generated\r
  if no SMI sources are enabled. Conversely, no enabled SMI source will\r
  generate SMIs if SMIs are not globally enabled. This is the main\r
  switchbox for SMI generation.\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  EFI_SUCCESS.\r
  Asserts, otherwise.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
QNCSmmClearSmi (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
QNCSmmSetAndCheckEos (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
QNCSmmGetSciEn (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// ///////////////////////////////////////////////////////////////////////////\r
//\r
// These may or may not need to change w/ the QNC version;\r
// they're here because they're highly IA-32 dependent.\r
//\r
BOOLEAN\r
ReadBitDesc (\r
  CONST QNC_SMM_BIT_DESC *BitDesc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  BitDesc - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
WriteBitDesc (\r
  CONST QNC_SMM_BIT_DESC  *BitDesc,\r
  CONST BOOLEAN          ValueToWrite\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  BitDesc       - GC_TODO: add argument description\r
  ValueToWrite  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r