Add TPM1.2 SaveState API.

[mirror_edk2.git] / SecurityPkg / Library / Tpm12CommandLib / Tpm12Startup.c

/** @file\r
  Implement TPM1.2 Startup related command.\r
\r
Copyright (c) 2013, Intel Corporation. All rights reserved. <BR>\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
#include <Uefi.h>\r
#include <IndustryStandard/Tpm12.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/Tpm12DeviceLib.h>\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  TPM_RQU_COMMAND_HDR   Hdr;\r
  TPM_STARTUP_TYPE      TpmSt;\r
} TPM_CMD_START_UP;\r
\r
typedef struct {\r
  TPM_RSP_COMMAND_HDR   Hdr;\r
} TPM_RSP_START_UP;\r
\r
typedef struct {\r
  TPM_RQU_COMMAND_HDR   Hdr;\r
} TPM_CMD_SAVE_STATE;\r
\r
typedef struct {\r
  TPM_RSP_COMMAND_HDR   Hdr;\r
} TPM_RSP_SAVE_STATE;\r
\r
#pragma pack()\r
\r
/**\r
  Send Startup command to TPM1.2.\r
\r
  @param TpmSt           Startup Type.\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm12Startup (\r
  IN TPM_STARTUP_TYPE          TpmSt\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  UINT32                            TpmRecvSize;\r
  UINT32                            TpmSendSize;\r
  TPM_CMD_START_UP                  SendBuffer;\r
  TPM_RSP_START_UP                  RecvBuffer;\r
  UINT32                            ReturnCode;\r
\r
  //\r
  // send Tpm command TPM_ORD_Startup\r
  //\r
  TpmRecvSize               = sizeof (TPM_RSP_START_UP);\r
  TpmSendSize               = sizeof (TPM_CMD_START_UP);\r
  SendBuffer.Hdr.tag        = SwapBytes16 (TPM_TAG_RQU_COMMAND);\r
  SendBuffer.Hdr.paramSize  = SwapBytes32 (TpmSendSize);\r
  SendBuffer.Hdr.ordinal    = SwapBytes32 (TPM_ORD_Startup);\r
  SendBuffer.TpmSt          = SwapBytes16 (TpmSt);\r
\r
  Status = Tpm12SubmitCommand (TpmSendSize, (UINT8 *)&SendBuffer, &TpmRecvSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  ReturnCode = SwapBytes32(RecvBuffer.Hdr.returnCode);\r
  switch (ReturnCode) {\r
  case TPM_SUCCESS:\r
  case TPM_INVALID_POSTINIT:\r
    // In warm reset, TPM may response TPM_INVALID_POSTINIT\r
    return EFI_SUCCESS;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r
\r
/**\r
  Send SaveState command to TPM1.2.\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm12SaveState (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  UINT32                            TpmRecvSize;\r
  UINT32                            TpmSendSize;\r
  TPM_CMD_SAVE_STATE                SendBuffer;\r
  TPM_RSP_SAVE_STATE                RecvBuffer;\r
  UINT32                            ReturnCode;\r
\r
  //\r
  // send Tpm command TPM_ORD_SaveState\r
  //\r
  TpmRecvSize               = sizeof (TPM_RSP_SAVE_STATE);\r
  TpmSendSize               = sizeof (TPM_CMD_SAVE_STATE);\r
  SendBuffer.Hdr.tag        = SwapBytes16 (TPM_TAG_RQU_COMMAND);\r
  SendBuffer.Hdr.paramSize  = SwapBytes32 (TpmSendSize);\r
  SendBuffer.Hdr.ordinal    = SwapBytes32 (TPM_ORD_SaveState);\r
\r
  Status = Tpm12SubmitCommand (TpmSendSize, (UINT8 *)&SendBuffer, &TpmRecvSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  ReturnCode = SwapBytes32(RecvBuffer.Hdr.returnCode);\r
  switch (ReturnCode) {\r
  case TPM_SUCCESS:\r
    return EFI_SUCCESS;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r