QuarkSocPkg: Add new package for Quark SoC X1000

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

/** @file\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\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
**/\r
\r
#ifndef QNC_SMM_HELPERS_H\r
#define QNC_SMM_HELPERS_H\r
\r
//\r
// Include common header file for this module.\r
//\r
#include "CommonHeader.h"\r
\r
#include "QNCSmm.h"\r
#include "QNCxSmmHelpers.h"\r
\r
//\r
// /////////////////////////////////////////////////////////////////////////////\r
// SUPPORT / HELPER FUNCTIONS (QNC version-independent)\r
//\r
VOID\r
QNCSmmPublishDispatchProtocols (\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
CompareEnables (\r
  CONST IN QNC_SMM_SOURCE_DESC *Src1,\r
  CONST IN QNC_SMM_SOURCE_DESC *Src2\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  Src1  - GC_TODO: add argument description\r
  Src2  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
CompareStatuses (\r
  CONST IN QNC_SMM_SOURCE_DESC *Src1,\r
  CONST IN QNC_SMM_SOURCE_DESC *Src2\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  Src1  - GC_TODO: add argument description\r
  Src2  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
CompareSources (\r
  CONST IN QNC_SMM_SOURCE_DESC *Src1,\r
  CONST IN QNC_SMM_SOURCE_DESC *Src2\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  Src1  - GC_TODO: add argument description\r
  Src2  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
BOOLEAN\r
SourceIsActive (\r
  CONST IN QNC_SMM_SOURCE_DESC *Src\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  Src - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
QNCSmmEnableSource (\r
  CONST QNC_SMM_SOURCE_DESC *SrcDesc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  SrcDesc - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
QNCSmmDisableSource (\r
  CONST QNC_SMM_SOURCE_DESC *SrcDesc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  SrcDesc - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
QNCSmmClearSource (\r
  CONST QNC_SMM_SOURCE_DESC *SrcDesc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  SrcDesc - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
VOID\r
QNCSmmClearSourceAndBlock (\r
  CONST QNC_SMM_SOURCE_DESC *SrcDesc\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  SrcDesc - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r