QuarkSocPkg/QuarkNorthCluster/Smm/DxeSmm/QncSmmDispatcher/QNCSmmHelpers.h

   1 /** @file
   2
   3 Copyright (c) 2013-2015 Intel Corporation.
   4
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef QNC_SMM_HELPERS_H
  16 #define QNC_SMM_HELPERS_H
  17
  18 //
  19 // Include common header file for this module.
  20 //
  21 #include "CommonHeader.h"
  22
  23 #include "QNCSmm.h"
  24 #include "QNCxSmmHelpers.h"
  25
  26 //
  27 // /////////////////////////////////////////////////////////////////////////////
  28 // SUPPORT / HELPER FUNCTIONS (QNC version-independent)
  29 //
  30 VOID
  31 QNCSmmPublishDispatchProtocols (
  32   VOID
  33   )
  34 /*++
  35
  36 Routine Description:
  37
  38   GC_TODO: Add function description
  39
  40 Arguments:
  41
  42   None
  43
  44 Returns:
  45
  46   GC_TODO: add return values
  47
  48 --*/
  49 ;
  50
  51 BOOLEAN
  52 CompareEnables (
  53   CONST IN QNC_SMM_SOURCE_DESC *Src1,
  54   CONST IN QNC_SMM_SOURCE_DESC *Src2
  55   )
  56 /*++
  57
  58 Routine Description:
  59
  60   GC_TODO: Add function description
  61
  62 Arguments:
  63
  64   Src1  - GC_TODO: add argument description
  65   Src2  - GC_TODO: add argument description
  66
  67 Returns:
  68
  69   GC_TODO: add return values
  70
  71 --*/
  72 ;
  73
  74 BOOLEAN
  75 CompareStatuses (
  76   CONST IN QNC_SMM_SOURCE_DESC *Src1,
  77   CONST IN QNC_SMM_SOURCE_DESC *Src2
  78   )
  79 /*++
  80
  81 Routine Description:
  82
  83   GC_TODO: Add function description
  84
  85 Arguments:
  86
  87   Src1  - GC_TODO: add argument description
  88   Src2  - GC_TODO: add argument description
  89
  90 Returns:
  91
  92   GC_TODO: add return values
  93
  94 --*/
  95 ;
  96
  97 BOOLEAN
  98 CompareSources (
  99   CONST IN QNC_SMM_SOURCE_DESC *Src1,
 100   CONST IN QNC_SMM_SOURCE_DESC *Src2
 101   )
 102 /*++
 103
 104 Routine Description:
 105
 106   GC_TODO: Add function description
 107
 108 Arguments:
 109
 110   Src1  - GC_TODO: add argument description
 111   Src2  - GC_TODO: add argument description
 112
 113 Returns:
 114
 115   GC_TODO: add return values
 116
 117 --*/
 118 ;
 119
 120 BOOLEAN
 121 SourceIsActive (
 122   CONST IN QNC_SMM_SOURCE_DESC *Src
 123   )
 124 /*++
 125
 126 Routine Description:
 127
 128   GC_TODO: Add function description
 129
 130 Arguments:
 131
 132   Src - GC_TODO: add argument description
 133
 134 Returns:
 135
 136   GC_TODO: add return values
 137
 138 --*/
 139 ;
 140
 141 VOID
 142 QNCSmmEnableSource (
 143   CONST QNC_SMM_SOURCE_DESC *SrcDesc
 144   )
 145 /*++
 146
 147 Routine Description:
 148
 149   GC_TODO: Add function description
 150
 151 Arguments:
 152
 153   SrcDesc - GC_TODO: add argument description
 154
 155 Returns:
 156
 157   GC_TODO: add return values
 158
 159 --*/
 160 ;
 161
 162 VOID
 163 QNCSmmDisableSource (
 164   CONST QNC_SMM_SOURCE_DESC *SrcDesc
 165   )
 166 /*++
 167
 168 Routine Description:
 169
 170   GC_TODO: Add function description
 171
 172 Arguments:
 173
 174   SrcDesc - GC_TODO: add argument description
 175
 176 Returns:
 177
 178   GC_TODO: add return values
 179
 180 --*/
 181 ;
 182
 183 VOID
 184 QNCSmmClearSource (
 185   CONST QNC_SMM_SOURCE_DESC *SrcDesc
 186   )
 187 /*++
 188
 189 Routine Description:
 190
 191   GC_TODO: Add function description
 192
 193 Arguments:
 194
 195   SrcDesc - GC_TODO: add argument description
 196
 197 Returns:
 198
 199   GC_TODO: add return values
 200
 201 --*/
 202 ;
 203
 204 VOID
 205 QNCSmmClearSourceAndBlock (
 206   CONST QNC_SMM_SOURCE_DESC *SrcDesc
 207   )
 208 /*++
 209
 210 Routine Description:
 211
 212   GC_TODO: Add function description
 213
 214 Arguments:
 215
 216   SrcDesc - GC_TODO: add argument description
 217
 218 Returns:
 219
 220   GC_TODO: add return values
 221
 222 --*/
 223 ;
 224
 225 #endif