[mirror_edk2.git] / SecurityPkg / Library / Tpm2CommandLib / Tpm2NVStorage.c

/** @file\r
  Implement TPM2 NVStorage 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 <IndustryStandard/UefiTcgPlatform.h>\r
#include <Library/Tpm2CommandLib.h>\r
#include <Library/Tpm2DeviceLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
\r
#pragma pack(1)\r
\r
#define RC_NV_ReadPublic_nvIndex            (TPM_RC_H + TPM_RC_1)\r
\r
#define RC_NV_DefineSpace_authHandle        (TPM_RC_H + TPM_RC_1)\r
#define RC_NV_DefineSpace_auth              (TPM_RC_P + TPM_RC_1)\r
#define RC_NV_DefineSpace_publicInfo        (TPM_RC_P + TPM_RC_2)\r
\r
#define RC_NV_UndefineSpace_authHandle      (TPM_RC_H + TPM_RC_1)\r
#define RC_NV_UndefineSpace_nvIndex         (TPM_RC_H + TPM_RC_2)\r
\r
#define RC_NV_Read_authHandle               (TPM_RC_H + TPM_RC_1)\r
#define RC_NV_Read_nvIndex                  (TPM_RC_H + TPM_RC_2)\r
#define RC_NV_Read_size                     (TPM_RC_P + TPM_RC_1)\r
#define RC_NV_Read_offset                   (TPM_RC_P + TPM_RC_2)\r
\r
#define RC_NV_Write_authHandle              (TPM_RC_H + TPM_RC_1)\r
#define RC_NV_Write_nvIndex                 (TPM_RC_H + TPM_RC_2)\r
#define RC_NV_Write_data                    (TPM_RC_P + TPM_RC_1)\r
#define RC_NV_Write_offset                  (TPM_RC_P + TPM_RC_2)\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_NV_INDEX          NvIndex;\r
} TPM2_NV_READPUBLIC_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER      Header;\r
  TPM2B_NV_PUBLIC           NvPublic;\r
  TPM2B_NAME                NvName;\r
} TPM2_NV_READPUBLIC_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_PROVISION         AuthHandle;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
  TPM2B_AUTH                Auth;\r
  TPM2B_NV_PUBLIC           NvPublic;\r
} TPM2_NV_DEFINESPACE_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_DEFINESPACE_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_PROVISION         AuthHandle;\r
  TPMI_RH_NV_INDEX          NvIndex;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
} TPM2_NV_UNDEFINESPACE_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_UNDEFINESPACE_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_NV_AUTH           AuthHandle;\r
  TPMI_RH_NV_INDEX          NvIndex;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
  UINT16                    Size;\r
  UINT16                    Offset;\r
} TPM2_NV_READ_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPM2B_MAX_BUFFER           Data;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_READ_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_NV_AUTH           AuthHandle;\r
  TPMI_RH_NV_INDEX          NvIndex;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
  TPM2B_MAX_BUFFER          Data;\r
  UINT16                    Offset;\r
} TPM2_NV_WRITE_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_WRITE_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_NV_AUTH           AuthHandle;\r
  TPMI_RH_NV_INDEX          NvIndex;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
} TPM2_NV_READLOCK_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_READLOCK_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_NV_AUTH           AuthHandle;\r
  TPMI_RH_NV_INDEX          NvIndex;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
} TPM2_NV_WRITELOCK_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_WRITELOCK_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_PROVISION         AuthHandle;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
} TPM2_NV_GLOBALWRITELOCK_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER       Header;\r
  UINT32                     AuthSessionSize;\r
  TPMS_AUTH_RESPONSE         AuthSession;\r
} TPM2_NV_GLOBALWRITELOCK_RESPONSE;\r
\r
#pragma pack()\r
\r
/**\r
  This command is used to read the public area and Name of an NV Index.\r
\r
  @param[in]  NvIndex            The NV Index.\r
  @param[out] NvPublic           The public area of the index.\r
  @param[out] NvName             The Name of the nvIndex.\r
  \r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvReadPublic (\r
  IN      TPMI_RH_NV_INDEX          NvIndex,\r
  OUT     TPM2B_NV_PUBLIC           *NvPublic,\r
  OUT     TPM2B_NAME                *NvName\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_READPUBLIC_COMMAND        SendBuffer;\r
  TPM2_NV_READPUBLIC_RESPONSE       RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT16                            NvPublicSize;\r
  UINT16                            NvNameSize;\r
  UINT8                             *Buffer;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_NO_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_ReadPublic);\r
\r
  SendBuffer.NvIndex = SwapBytes32 (NvIndex);\r
 \r
  SendBufferSize = (UINT32) sizeof (SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvReadPublic - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvReadPublic - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  case TPM_RC_HANDLE + RC_NV_ReadPublic_nvIndex: // TPM_RC_NV_DEFINED:\r
    return EFI_NOT_FOUND;\r
  case TPM_RC_VALUE + RC_NV_ReadPublic_nvIndex:\r
    return EFI_INVALID_PARAMETER;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (RecvBufferSize <= sizeof (TPM2_RESPONSE_HEADER) + sizeof (UINT16) + sizeof(UINT16)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvReadPublic - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Basic check\r
  //\r
  NvPublicSize = SwapBytes16 (RecvBuffer.NvPublic.size);\r
  NvNameSize = SwapBytes16 (ReadUnaligned16 ((UINT16 *)((UINT8 *)&RecvBuffer + sizeof(TPM2_RESPONSE_HEADER) + sizeof(UINT16) + NvPublicSize)));\r
\r
  if (RecvBufferSize != sizeof(TPM2_RESPONSE_HEADER) + sizeof(UINT16) + NvPublicSize + sizeof(UINT16) + NvNameSize) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvReadPublic - RecvBufferSize Error - NvPublicSize %x, NvNameSize %x\n", RecvBufferSize, NvNameSize));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Return the response\r
  //\r
  CopyMem (NvPublic, &RecvBuffer.NvPublic, sizeof(UINT16) + NvPublicSize);\r
  NvPublic->size = NvPublicSize;\r
  NvPublic->nvPublic.nvIndex = SwapBytes32 (NvPublic->nvPublic.nvIndex);\r
  NvPublic->nvPublic.nameAlg = SwapBytes16 (NvPublic->nvPublic.nameAlg);\r
  WriteUnaligned32 ((UINT32 *)&NvPublic->nvPublic.attributes, SwapBytes32 (ReadUnaligned32 ((UINT32 *)&NvPublic->nvPublic.attributes)));\r
  NvPublic->nvPublic.authPolicy.size = SwapBytes16 (NvPublic->nvPublic.authPolicy.size);\r
  Buffer = (UINT8 *)&NvPublic->nvPublic.authPolicy;\r
  Buffer += sizeof(UINT16) + NvPublic->nvPublic.authPolicy.size;\r
  NvPublic->nvPublic.dataSize = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));\r
\r
  CopyMem (NvName, (UINT8 *)&RecvBuffer + sizeof(TPM2_RESPONSE_HEADER) + sizeof(UINT16) + NvPublicSize, NvNameSize);\r
  NvName->size = NvNameSize;\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This command defines the attributes of an NV Index and causes the TPM to\r
  reserve space to hold the data associated with the index.\r
  If a definition already exists at the index, the TPM will return TPM_RC_NV_DEFINED.\r
\r
  @param[in]  AuthHandle         TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.\r
  @param[in]  AuthSession        Auth Session context\r
  @param[in]  Auth               The authorization data.\r
  @param[in]  NvPublic           The public area of the index.\r
  \r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_ALREADY_STARTED    The command was returned successfully, but NvIndex is already defined.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvDefineSpace (\r
  IN      TPMI_RH_PROVISION         AuthHandle,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession, OPTIONAL\r
  IN      TPM2B_AUTH                *Auth,\r
  IN      TPM2B_NV_PUBLIC           *NvPublic\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_DEFINESPACE_COMMAND       SendBuffer;\r
  TPM2_NV_DEFINESPACE_RESPONSE      RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT16                            NvPublicSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_DefineSpace);\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  //\r
  // IndexAuth\r
  //\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16(Auth->size));\r
  Buffer += sizeof(UINT16);\r
  CopyMem(Buffer, Auth->buffer, Auth->size);\r
  Buffer += Auth->size;\r
\r
  //\r
  // NvPublic\r
  //\r
  NvPublicSize = NvPublic->size;\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (NvPublicSize));\r
  Buffer += sizeof(UINT16);\r
  WriteUnaligned32 ((UINT32 *)Buffer, SwapBytes32 (NvPublic->nvPublic.nvIndex));\r
  Buffer += sizeof(UINT32);\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (NvPublic->nvPublic.nameAlg));\r
  Buffer += sizeof(UINT16);\r
  WriteUnaligned32 ((UINT32 *)Buffer, SwapBytes32 (ReadUnaligned32 ((UINT32 *)&NvPublic->nvPublic.attributes)));\r
  Buffer += sizeof(UINT32);\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (NvPublic->nvPublic.authPolicy.size));\r
  Buffer += sizeof(UINT16);\r
  CopyMem (Buffer, NvPublic->nvPublic.authPolicy.buffer, NvPublic->nvPublic.authPolicy.size);\r
  Buffer += NvPublic->nvPublic.authPolicy.size;\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (NvPublic->nvPublic.dataSize));\r
  Buffer += sizeof(UINT16);\r
\r
  SendBufferSize = (UINT32)(Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvDefineSpace - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvDefineSpace - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  case TPM_RC_SIZE + RC_NV_DefineSpace_publicInfo:\r
  case TPM_RC_SIZE + RC_NV_DefineSpace_auth:\r
    return EFI_BAD_BUFFER_SIZE;\r
  case TPM_RC_ATTRIBUTES:\r
  case TPM_RC_ATTRIBUTES + RC_NV_DefineSpace_publicInfo:\r
    return EFI_UNSUPPORTED;\r
  case TPM_RC_ATTRIBUTES + RC_NV_DefineSpace_authHandle:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_NV_DEFINED:\r
    return EFI_ALREADY_STARTED;\r
  case TPM_RC_VALUE + RC_NV_DefineSpace_publicInfo:\r
  case TPM_RC_VALUE + RC_NV_DefineSpace_authHandle:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_NV_SPACE:\r
    return EFI_OUT_OF_RESOURCES;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This command removes an index from the TPM.\r
\r
  @param[in]  AuthHandle         TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.\r
  @param[in]  NvIndex            The NV Index.\r
  @param[in]  AuthSession        Auth Session context\r
  \r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvUndefineSpace (\r
  IN      TPMI_RH_PROVISION         AuthHandle,\r
  IN      TPMI_RH_NV_INDEX          NvIndex,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession OPTIONAL\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_UNDEFINESPACE_COMMAND     SendBuffer;\r
  TPM2_NV_UNDEFINESPACE_RESPONSE    RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_UndefineSpace);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
  SendBuffer.NvIndex = SwapBytes32 (NvIndex);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  SendBufferSize = (UINT32)(Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvUndefineSpace - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvUndefineSpace - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  case TPM_RC_ATTRIBUTES:\r
  case TPM_RC_ATTRIBUTES + RC_NV_UndefineSpace_nvIndex:\r
    return EFI_UNSUPPORTED;\r
  case TPM_RC_NV_AUTHORIZATION:\r
    return EFI_SECURITY_VIOLATION;\r
  case TPM_RC_HANDLE + RC_NV_UndefineSpace_nvIndex: // TPM_RC_NV_DEFINED:\r
    return EFI_NOT_FOUND;\r
  case TPM_RC_HANDLE + RC_NV_UndefineSpace_authHandle: // TPM_RC_NV_DEFINED:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_VALUE + RC_NV_UndefineSpace_authHandle:\r
  case TPM_RC_VALUE + RC_NV_UndefineSpace_nvIndex:\r
    return EFI_INVALID_PARAMETER;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This command reads a value from an area in NV memory previously defined by TPM2_NV_DefineSpace().\r
\r
  @param[in]     AuthHandle         the handle indicating the source of the authorization value.\r
  @param[in]     NvIndex            The index to be read.\r
  @param[in]     AuthSession        Auth Session context\r
  @param[in]     Size               Number of bytes to read.\r
  @param[in]     Offset             Byte offset into the area.\r
  @param[in,out] OutData            The data read.\r
  \r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvRead (\r
  IN      TPMI_RH_NV_AUTH           AuthHandle,\r
  IN      TPMI_RH_NV_INDEX          NvIndex,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession, OPTIONAL\r
  IN      UINT16                    Size,\r
  IN      UINT16                    Offset,\r
  IN OUT  TPM2B_MAX_BUFFER          *OutData\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_READ_COMMAND              SendBuffer;\r
  TPM2_NV_READ_RESPONSE             RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_Read);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
  SendBuffer.NvIndex = SwapBytes32 (NvIndex);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Size));\r
  Buffer += sizeof(UINT16);\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Offset));\r
  Buffer += sizeof(UINT16);\r
\r
  SendBufferSize = (UINT32)(Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvRead - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvRead - responseCode - %x\n", ResponseCode));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  case TPM_RC_NV_AUTHORIZATION:\r
    return EFI_SECURITY_VIOLATION;\r
  case TPM_RC_NV_LOCKED:\r
    return EFI_ACCESS_DENIED;\r
  case TPM_RC_NV_RANGE:\r
    return EFI_BAD_BUFFER_SIZE;\r
  case TPM_RC_NV_UNINITIALIZED:\r
    return EFI_NOT_READY;\r
  case TPM_RC_HANDLE + RC_NV_Read_nvIndex: // TPM_RC_NV_DEFINED:\r
    return EFI_NOT_FOUND;\r
  case TPM_RC_HANDLE + RC_NV_Read_authHandle: // TPM_RC_NV_DEFINED:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_VALUE + RC_NV_Read_nvIndex:\r
  case TPM_RC_VALUE + RC_NV_Read_authHandle:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_BAD_AUTH + RC_NV_Read_authHandle + TPM_RC_S:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_AUTH_UNAVAILABLE:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_AUTH_FAIL + RC_NV_Read_authHandle + TPM_RC_S:\r
    return EFI_INVALID_PARAMETER;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  case TPM_RC_ATTRIBUTES + RC_NV_Read_authHandle + TPM_RC_S:\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Return the response\r
  //\r
  OutData->size = SwapBytes16 (RecvBuffer.Data.size);\r
  CopyMem (OutData->buffer, &RecvBuffer.Data.buffer, OutData->size);\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This command writes a value to an area in NV memory that was previously defined by TPM2_NV_DefineSpace().\r
\r
  @param[in]  AuthHandle         the handle indicating the source of the authorization value.\r
  @param[in]  NvIndex            The NV Index of the area to write.\r
  @param[in]  AuthSession        Auth Session context\r
  @param[in]  InData             The data to write.\r
  @param[in]  Offset             The offset into the NV Area.\r
  \r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvWrite (\r
  IN      TPMI_RH_NV_AUTH           AuthHandle,\r
  IN      TPMI_RH_NV_INDEX          NvIndex,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession, OPTIONAL\r
  IN      TPM2B_MAX_BUFFER          *InData,\r
  IN      UINT16                    Offset\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_WRITE_COMMAND             SendBuffer;\r
  TPM2_NV_WRITE_RESPONSE            RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_Write);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
  SendBuffer.NvIndex = SwapBytes32 (NvIndex);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (InData->size));\r
  Buffer += sizeof(UINT16);\r
  CopyMem (Buffer, InData->buffer, InData->size);\r
  Buffer += InData->size;\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Offset));\r
  Buffer += sizeof(UINT16);\r
\r
  SendBufferSize = (UINT32) (Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvWrite - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvWrite - responseCode - %x\n", ResponseCode));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    return EFI_SUCCESS;\r
  case TPM_RC_ATTRIBUTES:\r
    return EFI_UNSUPPORTED;\r
  case TPM_RC_NV_AUTHORIZATION:\r
    return EFI_SECURITY_VIOLATION;\r
  case TPM_RC_NV_LOCKED:\r
    return EFI_ACCESS_DENIED;\r
  case TPM_RC_NV_RANGE:\r
    return EFI_BAD_BUFFER_SIZE;\r
  case TPM_RC_HANDLE + RC_NV_Write_nvIndex: // TPM_RC_NV_DEFINED:\r
    return EFI_NOT_FOUND;\r
  case TPM_RC_HANDLE + RC_NV_Write_authHandle: // TPM_RC_NV_DEFINED:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_VALUE + RC_NV_Write_nvIndex:\r
  case TPM_RC_VALUE + RC_NV_Write_authHandle:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_BAD_AUTH + RC_NV_Write_authHandle + TPM_RC_S:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_AUTH_UNAVAILABLE:\r
    return EFI_INVALID_PARAMETER;\r
  case TPM_RC_AUTH_FAIL + RC_NV_Write_authHandle + TPM_RC_S:\r
    return EFI_INVALID_PARAMETER;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  case TPM_RC_ATTRIBUTES + RC_NV_Write_authHandle + TPM_RC_S:\r
    return EFI_UNSUPPORTED;\r
  }\r
}\r
\r
/**\r
  This command may be used to prevent further reads of the Index until the next TPM2_Startup (TPM_SU_CLEAR).\r
\r
  @param[in]  AuthHandle         the handle indicating the source of the authorization value.\r
  @param[in]  NvIndex            The NV Index of the area to lock.\r
  @param[in]  AuthSession        Auth Session context\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvReadLock (\r
  IN      TPMI_RH_NV_AUTH           AuthHandle,\r
  IN      TPMI_RH_NV_INDEX          NvIndex,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession OPTIONAL\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_READLOCK_COMMAND          SendBuffer;\r
  TPM2_NV_READLOCK_RESPONSE         RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_ReadLock);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
  SendBuffer.NvIndex = SwapBytes32 (NvIndex);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  SendBufferSize = (UINT32)(Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvReadLock - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvReadLock - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This command may be used to inhibit further writes of the Index.\r
\r
  @param[in]  AuthHandle         the handle indicating the source of the authorization value.\r
  @param[in]  NvIndex            The NV Index of the area to lock.\r
  @param[in]  AuthSession        Auth Session context\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvWriteLock (\r
  IN      TPMI_RH_NV_AUTH           AuthHandle,\r
  IN      TPMI_RH_NV_INDEX          NvIndex,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession OPTIONAL\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_WRITELOCK_COMMAND         SendBuffer;\r
  TPM2_NV_WRITELOCK_RESPONSE        RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_WriteLock);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
  SendBuffer.NvIndex = SwapBytes32 (NvIndex);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  SendBufferSize = (UINT32)(Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvWriteLock - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvWriteLock - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The command will SET TPMA_NV_WRITELOCKED for all indexes that have their TPMA_NV_GLOBALLOCK attribute SET.\r
\r
  @param[in]  AuthHandle         TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.\r
  @param[in]  AuthSession        Auth Session context\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
  @retval EFI_NOT_FOUND          The command was returned successfully, but NvIndex is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2NvGlobalWriteLock (\r
  IN      TPMI_RH_PROVISION         AuthHandle,\r
  IN      TPMS_AUTH_COMMAND         *AuthSession OPTIONAL\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_NV_GLOBALWRITELOCK_COMMAND   SendBuffer;\r
  TPM2_NV_GLOBALWRITELOCK_RESPONSE  RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
  TPM_RC                            ResponseCode;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_NV_GlobalWriteLock);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32(SessionInfoSize);\r
\r
  SendBufferSize = (UINT32)(Buffer - (UINT8 *)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvGlobalWriteLock - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ResponseCode = SwapBytes32(RecvBuffer.Header.responseCode);\r
  if (ResponseCode != TPM_RC_SUCCESS) {\r
    DEBUG ((EFI_D_ERROR, "Tpm2NvGlobalWriteLock - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
  }\r
  switch (ResponseCode) {\r
  case TPM_RC_SUCCESS:\r
    // return data\r
    break;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r