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

   1 /** @file
   2
   3 Copyright (c) 2013-2015 Intel Corporation.
   4
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef QNCX_SMM_HELPERS_H
  10 #define QNCX_SMM_HELPERS_H
  11
  12 //
  13 // Include common header file for this module.
  14 //
  15 #include "CommonHeader.h"
  16
  17 #include "QNCSmm.h"
  18
  19 EFI_STATUS
  20 QNCSmmInitHardware (
  21   VOID
  22   )
  23 /*++
  24
  25 Routine Description:
  26
  27   GC_TODO: Add function description
  28
  29 Arguments:
  30
  31   None
  32
  33 Returns:
  34
  35   GC_TODO: add return values
  36
  37 --*/
  38 ;
  39
  40 EFI_STATUS
  41 QNCSmmEnableGlobalSmiBit (
  42   VOID
  43   )
  44 /*++
  45
  46 Routine Description:
  47
  48   Enables the QNC to generate SMIs. Note that no SMIs will be generated
  49   if no SMI sources are enabled. Conversely, no enabled SMI source will
  50   generate SMIs if SMIs are not globally enabled. This is the main
  51   switchbox for SMI generation.
  52
  53 Arguments:
  54
  55   None
  56
  57 Returns:
  58
  59   EFI_SUCCESS.
  60   Asserts, otherwise.
  61
  62 --*/
  63 ;
  64
  65 EFI_STATUS
  66 QNCSmmClearSmi (
  67   VOID
  68   )
  69 /*++
  70
  71 Routine Description:
  72
  73   GC_TODO: Add function description
  74
  75 Arguments:
  76
  77   None
  78
  79 Returns:
  80
  81   GC_TODO: add return values
  82
  83 --*/
  84 ;
  85
  86 BOOLEAN
  87 QNCSmmSetAndCheckEos (
  88   VOID
  89   )
  90 /*++
  91
  92 Routine Description:
  93
  94   GC_TODO: Add function description
  95
  96 Arguments:
  97
  98   None
  99
 100 Returns:
 101
 102   GC_TODO: add return values
 103
 104 --*/
 105 ;
 106
 107 BOOLEAN
 108 QNCSmmGetSciEn (
 109   VOID
 110   )
 111 /*++
 112
 113 Routine Description:
 114
 115   GC_TODO: Add function description
 116
 117 Arguments:
 118
 119   None
 120
 121 Returns:
 122
 123   GC_TODO: add return values
 124
 125 --*/
 126 ;
 127
 128 //
 129 // ///////////////////////////////////////////////////////////////////////////
 130 //
 131 // These may or may not need to change w/ the QNC version;
 132 // they're here because they're highly IA-32 dependent.
 133 //
 134 BOOLEAN
 135 ReadBitDesc (
 136   CONST QNC_SMM_BIT_DESC *BitDesc
 137   )
 138 /*++
 139
 140 Routine Description:
 141
 142   GC_TODO: Add function description
 143
 144 Arguments:
 145
 146   BitDesc - GC_TODO: add argument description
 147
 148 Returns:
 149
 150   GC_TODO: add return values
 151
 152 --*/
 153 ;
 154
 155 VOID
 156 WriteBitDesc (
 157   CONST QNC_SMM_BIT_DESC  *BitDesc,
 158   CONST BOOLEAN          ValueToWrite
 159   )
 160 /*++
 161
 162 Routine Description:
 163
 164   GC_TODO: Add function description
 165
 166 Arguments:
 167
 168   BitDesc       - GC_TODO: add argument description
 169   ValueToWrite  - GC_TODO: add argument description
 170
 171 Returns:
 172
 173   GC_TODO: add return values
 174
 175 --*/
 176 ;
 177
 178 #endif