SecurityPkg/Library/Tpm2DeviceLibDTpm/Tpm2InstanceLibDTpm.c

   1 /** @file
   2   This library is TPM2 DTPM instance.
   3   It can be registered to Tpm2 Device router, to be active TPM2 engine,
   4   based on platform setting.
   5
   6 Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved. <BR>
   7 This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #include <Library/BaseLib.h>
  18 #include <Library/BaseMemoryLib.h>
  19 #include <Library/DebugLib.h>
  20 #include <Library/Tpm2DeviceLib.h>
  21
  22 #include <Guid/TpmInstance.h>
  23
  24 /**
  25   Dump PTP register information.
  26
  27   @param[in] Register                Pointer to PTP register.
  28 **/
  29 VOID
  30 DumpPtpInfo (
  31   IN VOID *Register
  32   );
  33
  34 /**
  35   This service enables the sending of commands to the TPM2.
  36
  37   @param[in]      InputParameterBlockSize  Size of the TPM2 input parameter block.
  38   @param[in]      InputParameterBlock      Pointer to the TPM2 input parameter block.
  39   @param[in,out]  OutputParameterBlockSize Size of the TPM2 output parameter block.
  40   @param[in]      OutputParameterBlock     Pointer to the TPM2 output parameter block.
  41
  42   @retval EFI_SUCCESS            The command byte stream was successfully sent to the device and a response was successfully received.
  43   @retval EFI_DEVICE_ERROR       The command was not successfully sent to the device or a response was not successfully received from the device.
  44   @retval EFI_BUFFER_TOO_SMALL   The output parameter block is too small.
  45 **/
  46 EFI_STATUS
  47 EFIAPI
  48 DTpm2SubmitCommand (
  49   IN UINT32            InputParameterBlockSize,
  50   IN UINT8             *InputParameterBlock,
  51   IN OUT UINT32        *OutputParameterBlockSize,
  52   IN UINT8             *OutputParameterBlock
  53   );
  54
  55 /**
  56   This service requests use TPM2.
  57
  58   @retval EFI_SUCCESS      Get the control of TPM2 chip.
  59   @retval EFI_NOT_FOUND    TPM2 not found.
  60   @retval EFI_DEVICE_ERROR Unexpected device behavior.
  61 **/
  62 EFI_STATUS
  63 EFIAPI
  64 DTpm2RequestUseTpm (
  65   VOID
  66   );
  67
  68 TPM2_DEVICE_INTERFACE  mDTpm2InternalTpm2Device = {
  69   TPM_DEVICE_INTERFACE_TPM20_DTPM,
  70   DTpm2SubmitCommand,
  71   DTpm2RequestUseTpm,
  72 };
  73
  74 /**
  75   The function register DTPM2.0 instance.
  76
  77   @retval EFI_SUCCESS   DTPM2.0 instance is registered, or system dose not surpport registr DTPM2.0 instance
  78 **/
  79 EFI_STATUS
  80 EFIAPI
  81 Tpm2InstanceLibDTpmConstructor (
  82   VOID
  83   )
  84 {
  85   EFI_STATUS  Status;
  86
  87   Status = Tpm2RegisterTpm2DeviceLib (&mDTpm2InternalTpm2Device);
  88   if ((Status == EFI_SUCCESS) || (Status == EFI_UNSUPPORTED)) {
  89     //
  90     // Unsupported means platform policy does not need this instance enabled.
  91     //
  92     if (Status == EFI_SUCCESS) {
  93       DumpPtpInfo ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));
  94     }
  95     return EFI_SUCCESS;
  96   }
  97   return Status;
  98 }