EdkCompatibilityPkg/Compatibility/SmmControl2OnSmmControlThunk/SmmControl2OnSmmControlThunk.c

   1 /** @file
   2   SMM Control2 Protocol on SMM Control Protocol Thunk driver.
   3
   4   Copyright (c) 2009 Intel Corporation
   5   All rights reserved. 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 #include "SmmControl2OnSmmControlThunk.h"
  16
  17 EFI_SMM_CONTROL2_PROTOCOL gSmmControl2 = {
  18   SmmControl2Trigger,
  19   SmmControl2Clear,
  20   0
  21 };
  22
  23 EFI_SMM_CONTROL_PROTOCOL  *mSmmControl;
  24 UINT8                      mDataPort;
  25
  26 /**
  27   Invokes SMI activation from either the preboot or runtime environment.
  28
  29   This function generates an SMI.
  30
  31   @param[in]     This                The EFI_SMM_CONTROL2_PROTOCOL instance.
  32   @param[in,out] CommandPort         The value written to the command port.
  33   @param[in,out] DataPort            The value written to the data port.
  34   @param[in]     Periodic            Optional mechanism to engender a periodic stream.
  35   @param[in]     ActivationInterval  Optional parameter to repeat at this period one
  36                                      time or, if the Periodic Boolean is set, periodically.
  37
  38   @retval EFI_SUCCESS            The SMI/PMI has been engendered.
  39   @retval EFI_DEVICE_ERROR       The timing is unsupported.
  40   @retval EFI_INVALID_PARAMETER  The activation period is unsupported.
  41   @retval EFI_NOT_STARTED        The SMM base service has not been initialized.
  42 **/
  43 EFI_STATUS
  44 EFIAPI
  45 SmmControl2Trigger (
  46   IN CONST EFI_SMM_CONTROL2_PROTOCOL  *This,
  47   IN OUT UINT8                        *CommandPort       OPTIONAL,
  48   IN OUT UINT8                        *DataPort          OPTIONAL,
  49   IN BOOLEAN                          Periodic           OPTIONAL,
  50   IN UINTN                            ActivationInterval OPTIONAL
  51   )
  52 {
  53   UINTN  ArgumentBufferSize = 0;
  54
  55   if (CommandPort != NULL) {
  56     ArgumentBufferSize = 1;
  57   }
  58   if (DataPort != NULL) {
  59     IoWrite8 (mDataPort, *DataPort);
  60   }
  61   return mSmmControl->Trigger (mSmmControl, (INT8 *)CommandPort, &ArgumentBufferSize, Periodic, ActivationInterval);
  62 }
  63
  64 /**
  65   Clears any system state that was created in response to the Trigger() call.
  66
  67   This function acknowledges and causes the deassertion of the SMI activation source.
  68
  69   @param[in] This                The EFI_SMM_CONTROL2_PROTOCOL instance.
  70   @param[in] Periodic            Optional parameter to repeat at this period one time
  71
  72   @retval EFI_SUCCESS            The SMI/PMI has been engendered.
  73   @retval EFI_DEVICE_ERROR       The source could not be cleared.
  74   @retval EFI_INVALID_PARAMETER  The service did not support the Periodic input argument.
  75 **/
  76 EFI_STATUS
  77 EFIAPI
  78 SmmControl2Clear (
  79   IN CONST EFI_SMM_CONTROL2_PROTOCOL  *This,
  80   IN BOOLEAN                          Periodic OPTIONAL
  81   )
  82 {
  83   return mSmmControl->Clear (mSmmControl, Periodic);
  84 }
  85
  86 /**
  87   Entry Point for this thunk driver.
  88
  89   @param[in] ImageHandle  Image handle of this driver.
  90   @param[in] SystemTable  A Pointer to the EFI System Table.
  91
  92   @retval EFI_SUCCESS  The entry point is executed successfully.
  93   @retval other        Some error occurred when executing this entry point.
  94 **/
  95 EFI_STATUS
  96 EFIAPI
  97 SmmControl2ThunkMain (
  98   IN EFI_HANDLE        ImageHandle,
  99   IN EFI_SYSTEM_TABLE  *SystemTable
 100   )
 101 {
 102   EFI_STATUS               Status;
 103   EFI_SMM_CONTROL_REGISTER RegisterInfo;
 104
 105   ///
 106   /// Locate Framework SMM Control Protocol
 107   ///
 108   Status = gBS->LocateProtocol (&gEfiSmmControlProtocolGuid, NULL, (VOID **)&mSmmControl);
 109   ASSERT_EFI_ERROR (Status);
 110
 111   gSmmControl2.MinimumTriggerPeriod = mSmmControl->MinimumTriggerPeriod;
 112
 113   Status = mSmmControl->GetRegisterInfo (mSmmControl, &RegisterInfo);
 114   ASSERT_EFI_ERROR (Status);
 115   mDataPort = RegisterInfo.SmiDataRegister;
 116
 117   ///
 118   /// Publish framework SMM Control Protocol
 119   ///
 120   Status = gBS->InstallProtocolInterface (
 121                   &ImageHandle,
 122                   &gEfiSmmControl2ProtocolGuid,
 123                   EFI_NATIVE_INTERFACE,
 124                   &gSmmControl2
 125                   );
 126   return Status;
 127 }
 128