]> git.proxmox.com Git - mirror_edk2.git/blobdiff - SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.c
SecurityPkg: Tcg2Smm: Refine type cast in pointer abstraction
[mirror_edk2.git] / SecurityPkg / Tcg / Tcg2Smm / Tcg2Smm.c
index e8880585449278b5e775d9ea2c6daca163af841e..c3cee834ae8dbb6d65cc47bec21d36ba5814391b 100644 (file)
@@ -9,7 +9,7 @@
 \r
   PhysicalPresenceCallback() and MemoryClearCallback() will receive untrusted input and do some check.\r
 \r
-Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2018, 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
@@ -83,7 +83,8 @@ EFI_TPM2_ACPI_TABLE  mTpm2AcpiTemplate = {
     // These fields should be filled in in production\r
     //\r
   },\r
-  0, // Flags\r
+  0, // BIT0~15:  PlatformClass\r
+     // BIT16~31: Reserved\r
   0, // Control Area\r
   EFI_TPM2_ACPI_TABLE_START_METHOD_TIS, // StartMethod\r
 };\r
@@ -302,6 +303,252 @@ UpdatePPVersion (
   return EFI_NOT_FOUND;\r
 }\r
 \r
+/**\r
+  Patch interrupt resources returned by TPM _PRS. ResourceTemplate to patch is determined by input\r
+  interrupt buffer size. BufferSize, PkgLength and interrupt descirptor in ByteList need to be patched\r
+\r
+  @param[in, out] Table            The TPM item in ACPI table.\r
+  @param[in]      IrqBuffer        Input new IRQ buffer.\r
+  @param[in]      IrqBuffserSize   Input new IRQ buffer size.\r
+\r
+  @return                          patch status.\r
+\r
+**/\r
+EFI_STATUS\r
+UpdatePossibleResource (\r
+  EFI_ACPI_DESCRIPTION_HEADER    *Table,\r
+  UINT32                         *IrqBuffer,\r
+  UINT32                         IrqBuffserSize\r
+  )\r
+{\r
+  UINT8       *DataPtr;\r
+  UINT8       *DataEndPtr;\r
+  UINT32      NewPkgLength;\r
+  UINT32      OrignalPkgLength;\r
+\r
+  NewPkgLength     = 0;\r
+  OrignalPkgLength = 0;\r
+  DataEndPtr       = NULL;\r
+\r
+  //\r
+  // Follow ACPI spec\r
+  //           6.4.3   Extend Interrupt Descriptor.\r
+  //           19.3.3 ASL Resource Template\r
+  //           20      AML specification\r
+  // to patch TPM ACPI object _PRS returned ResourceTemplate() containing 2 resource descriptors and an auto appended End Tag\r
+  //\r
+  //  AML data is organized by following rule.\r
+  //  Code need to patch BufferSize and PkgLength and interrupt descirptor in ByteList\r
+  //\r
+  // =============  Buffer ====================\r
+  //           DefBuffer := BufferOp PkgLength BufferSize ByteList\r
+  //            BufferOp := 0x11\r
+  //\r
+  // ==============PkgLength==================\r
+  //          PkgLength := PkgLeadByte |\r
+  //                              <PkgLeadByte ByteData> |\r
+  //                              <PkgLeadByte ByteData ByteData> |\r
+  //                              <PkgLeadByte ByteData ByteData ByteData>\r
+  //\r
+  //       PkgLeadByte := <bit 7-6: ByteData count that follows (0-3)>\r
+  //                               <bit 5-4: Only used if PkgLength <= 63 >\r
+  //                               <bit 3-0: Least significant package length nybble>\r
+  //\r
+  //==============BufferSize==================\r
+  //        BufferSize := Integar\r
+  //           Integar := ByteConst|WordConst|DwordConst....\r
+  //\r
+  //           ByteConst := BytePrefix ByteData\r
+  //\r
+  //==============ByteList===================\r
+  //          ByteList := ByteData ByteList\r
+  //\r
+  //=========================================\r
+\r
+  //\r
+  // 1. Check TPM_PRS_RESS with PkgLength <=63 can hold the input interrupt number buffer for patching\r
+  //\r
+  for (DataPtr  = (UINT8 *)(Table + 1);\r
+       DataPtr < (UINT8 *) ((UINT8 *) Table + Table->Length - (TPM_PRS_RES_NAME_SIZE + TPM_POS_RES_TEMPLATE_MIN_SIZE));\r
+       DataPtr += 1) {\r
+    if (CompareMem(DataPtr, TPM_PRS_RESS, TPM_PRS_RES_NAME_SIZE) == 0) {\r
+      //\r
+      // Jump over object name & BufferOp\r
+      //\r
+      DataPtr += TPM_PRS_RES_NAME_SIZE + 1;\r
+\r
+      if ((*DataPtr & (BIT7|BIT6)) == 0) {\r
+        OrignalPkgLength = (UINT32)*DataPtr;\r
+        DataEndPtr       = DataPtr + OrignalPkgLength;\r
+\r
+        //\r
+        // Jump over PkgLength = PkgLeadByte only\r
+        //\r
+        NewPkgLength++;\r
+\r
+        //\r
+        // Jump over BufferSize\r
+        //\r
+        if (*(DataPtr + 1) == AML_BYTE_PREFIX) {\r
+          NewPkgLength += 2;\r
+        } else if (*(DataPtr + 1) == AML_WORD_PREFIX) {\r
+          NewPkgLength += 3;\r
+        } else if (*(DataPtr + 1) == AML_DWORD_PREFIX) {\r
+          NewPkgLength += 5;\r
+        } else {\r
+          ASSERT(FALSE);\r
+          return EFI_UNSUPPORTED;\r
+        }\r
+      } else {\r
+        ASSERT(FALSE);\r
+        return EFI_UNSUPPORTED;\r
+      }\r
+\r
+      //\r
+      // Include Memory32Fixed Descritor (12 Bytes) + Interrupt Descriptor header(5 Bytes) + End Tag(2 Bytes)\r
+      //\r
+      NewPkgLength += 19 + IrqBuffserSize;\r
+      if (NewPkgLength > 63) {\r
+        break;\r
+      }\r
+\r
+      if (NewPkgLength > OrignalPkgLength) {\r
+        ASSERT(FALSE);\r
+        return EFI_INVALID_PARAMETER;\r
+      }\r
+\r
+      //\r
+      // 1.1 Patch PkgLength\r
+      //\r
+      *DataPtr = (UINT8)NewPkgLength;\r
+\r
+      //\r
+      // 1.2 Patch BufferSize = sizeof(Memory32Fixed Descritor + Interrupt Descriptor + End Tag).\r
+      //      It is Little endian. So only patch lowest byte of BufferSize due to current interrupt number limit.\r
+      //\r
+      *(DataPtr + 2) = (UINT8)(IrqBuffserSize + 19);\r
+\r
+      //\r
+      // Notify _PRS to report short formed ResourceTemplate\r
+      //\r
+      mTcgNvs->IsShortFormPkgLength = TRUE;\r
+\r
+      break;\r
+    }\r
+  }\r
+\r
+  //\r
+  // 2. Use TPM_PRS_RESL with PkgLength > 63 to hold longer input interrupt number buffer for patching\r
+  //\r
+  if (NewPkgLength > 63) {\r
+    NewPkgLength     = 0;\r
+    OrignalPkgLength = 0;\r
+    for (DataPtr  = (UINT8 *)(Table + 1);\r
+         DataPtr < (UINT8 *) ((UINT8 *) Table + Table->Length - (TPM_PRS_RES_NAME_SIZE + TPM_POS_RES_TEMPLATE_MIN_SIZE));\r
+         DataPtr += 1) {\r
+      if (CompareMem(DataPtr, TPM_PRS_RESL, TPM_PRS_RES_NAME_SIZE) == 0) {\r
+        //\r
+        // Jump over object name & BufferOp\r
+        //\r
+        DataPtr += TPM_PRS_RES_NAME_SIZE + 1;\r
+\r
+        if ((*DataPtr & (BIT7|BIT6)) != 0) {\r
+          OrignalPkgLength = (UINT32)(*(DataPtr + 1) << 4) + (*DataPtr & 0x0F);\r
+          DataEndPtr       = DataPtr + OrignalPkgLength;\r
+          //\r
+          // Jump over PkgLength = PkgLeadByte + ByteData length\r
+          //\r
+          NewPkgLength += 1 + ((*DataPtr & (BIT7|BIT6)) >> 6);\r
+\r
+          //\r
+          // Jump over BufferSize\r
+          //\r
+          if (*(DataPtr + NewPkgLength) == AML_BYTE_PREFIX) {\r
+            NewPkgLength += 2;\r
+          } else if (*(DataPtr + NewPkgLength) == AML_WORD_PREFIX) {\r
+            NewPkgLength += 3;\r
+          } else if (*(DataPtr + NewPkgLength) == AML_DWORD_PREFIX) {\r
+            NewPkgLength += 5;\r
+          } else {\r
+            ASSERT(FALSE);\r
+            return EFI_UNSUPPORTED;\r
+          }\r
+        } else {\r
+          ASSERT(FALSE);\r
+          return EFI_UNSUPPORTED;\r
+        }\r
+\r
+        //\r
+        // Include Memory32Fixed Descritor (12 Bytes) + Interrupt Descriptor header(5 Bytes) + End Tag(2  Bytes)\r
+        //\r
+        NewPkgLength += 19 + IrqBuffserSize;\r
+\r
+        if (NewPkgLength > OrignalPkgLength) {\r
+          ASSERT(FALSE);\r
+          return EFI_INVALID_PARAMETER;\r
+        }\r
+\r
+        //\r
+        // 2.1 Patch PkgLength. Only patch PkgLeadByte and first ByteData\r
+        //\r
+        *DataPtr = (UINT8)((*DataPtr) & 0xF0) | (NewPkgLength & 0x0F);\r
+        *(DataPtr + 1) = (UINT8)((NewPkgLength & 0xFF0) >> 4);\r
+\r
+        //\r
+        // 2.2 Patch BufferSize = sizeof(Memory32Fixed Descritor + Interrupt Descriptor + End Tag).\r
+        //     It is Little endian. Only patch lowest byte of BufferSize due to current interrupt number limit.\r
+        //\r
+        *(DataPtr + 2 + ((*DataPtr & (BIT7|BIT6)) >> 6)) = (UINT8)(IrqBuffserSize + 19);\r
+\r
+        //\r
+        // Notify _PRS to report long formed ResourceTemplate\r
+        //\r
+        mTcgNvs->IsShortFormPkgLength = FALSE;\r
+        break;\r
+      }\r
+    }\r
+  }\r
+\r
+  if (DataPtr >= (UINT8 *) ((UINT8 *) Table + Table->Length - (TPM_PRS_RES_NAME_SIZE + TPM_POS_RES_TEMPLATE_MIN_SIZE))) {\r
+    return EFI_NOT_FOUND;\r
+  }\r
+\r
+  //\r
+  // 3. Move DataPtr to Interrupt descriptor header and patch interrupt descriptor.\r
+  //     5 bytes for interrupt descriptor header, 2 bytes for End Tag\r
+  //\r
+  DataPtr += NewPkgLength - (5 + IrqBuffserSize + 2);\r
+  //\r
+  //   3.1 Patch Length bit[7:0] of Interrupt descirptor patch interrupt descriptor\r
+  //\r
+  *(DataPtr + 1) = (UINT8)(2 + IrqBuffserSize);\r
+  //\r
+  //   3.2 Patch Interrupt Table Length\r
+  //\r
+  *(DataPtr + 4) = (UINT8)(IrqBuffserSize / sizeof(UINT32));\r
+  //\r
+  //   3.3 Copy patched InterruptNumBuffer\r
+  //\r
+  CopyMem(DataPtr + 5, IrqBuffer, IrqBuffserSize);\r
+\r
+  //\r
+  // 4. Jump over Interrupt descirptor and Patch END Tag, set Checksum field to 0\r
+  //\r
+  DataPtr       += 5 + IrqBuffserSize;\r
+  *DataPtr       = ACPI_END_TAG_DESCRIPTOR;\r
+  *(DataPtr + 1) = 0;\r
+\r
+  //\r
+  // 5. Jump over new ResourceTemplate. Stuff rest bytes to NOOP\r
+  //\r
+  DataPtr += 2;\r
+  if (DataPtr < DataEndPtr) {\r
+    SetMem(DataPtr, (UINTN)DataEndPtr - (UINTN)DataPtr, AML_NOOP_OP);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
 /**\r
   Patch TPM2 device HID string.  The initial string tag in TPM2 ACPI table is "NNN0000".\r
 \r
@@ -317,7 +564,7 @@ UpdateHID (
 {\r
   EFI_STATUS  Status;\r
   UINT8       *DataPtr;\r
-  CHAR8       HID[TPM_HID_ACPI_SIZE];\r
+  CHAR8       Hid[TPM_HID_ACPI_SIZE];\r
   UINT32      ManufacturerID;\r
   UINT32      FirmwareVersion1;\r
   UINT32      FirmwareVersion2;\r
@@ -328,7 +575,7 @@ UpdateHID (
   //\r
   // Initialize HID with Default PNP string\r
   //\r
-  ZeroMem(HID, TPM_HID_ACPI_SIZE);\r
+  ZeroMem(Hid, TPM_HID_ACPI_SIZE);\r
 \r
   //\r
   // Get Manufacturer ID\r
@@ -337,7 +584,7 @@ UpdateHID (
   if (!EFI_ERROR(Status)) {\r
     DEBUG((EFI_D_INFO, "TPM_PT_MANUFACTURER 0x%08x\n", ManufacturerID));\r
     //\r
-    // ManfacturerID defined in TCG Vendor ID Registry \r
+    // ManufacturerID defined in TCG Vendor ID Registry \r
     // may tailed with 0x00 or 0x20\r
     //\r
     if ((ManufacturerID >> 24) == 0x00 || ((ManufacturerID >> 24) == 0x20)) {\r
@@ -345,13 +592,13 @@ UpdateHID (
       //  HID containing PNP ID "NNN####"\r
       //   NNN is uppercase letter for Vendor ID specified by manufacturer\r
       //\r
-      CopyMem(HID, &ManufacturerID, 3);\r
+      CopyMem(Hid, &ManufacturerID, 3);\r
     } else {\r
       //\r
       //  HID containing ACP ID "NNNN####"\r
       //   NNNN is uppercase letter for Vendor ID specified by manufacturer\r
       //\r
-      CopyMem(HID, &ManufacturerID, 4);\r
+      CopyMem(Hid, &ManufacturerID, 4);\r
       PnpHID = FALSE;\r
     }\r
   } else {\r
@@ -368,9 +615,9 @@ UpdateHID (
     //   #### is Firmware Version 1\r
     //\r
     if (PnpHID) {\r
-      AsciiSPrint(HID + 3, TPM_HID_PNP_SIZE - 3, "%02d%02d", ((FirmwareVersion1 & 0xFFFF0000) >> 16), (FirmwareVersion1 && 0x0000FFFF));\r
+      AsciiSPrint(Hid + 3, TPM_HID_PNP_SIZE - 3, "%02d%02d", ((FirmwareVersion1 & 0xFFFF0000) >> 16), (FirmwareVersion1 & 0x0000FFFF));\r
     } else {\r
-      AsciiSPrint(HID + 4, TPM_HID_ACPI_SIZE - 4, "%02d%02d", ((FirmwareVersion1 & 0xFFFF0000) >> 16), (FirmwareVersion1 && 0x0000FFFF));\r
+      AsciiSPrint(Hid + 4, TPM_HID_ACPI_SIZE - 4, "%02d%02d", ((FirmwareVersion1 & 0xFFFF0000) >> 16), (FirmwareVersion1 & 0x0000FFFF));\r
     }\r
     \r
   } else {\r
@@ -387,16 +634,17 @@ UpdateHID (
        DataPtr += 1) {\r
     if (AsciiStrCmp((CHAR8 *)DataPtr,  TPM_HID_TAG) == 0) {\r
       if (PnpHID) {\r
-        CopyMem(DataPtr, HID, TPM_HID_PNP_SIZE);\r
+        CopyMem(DataPtr, Hid, TPM_HID_PNP_SIZE);\r
         //\r
         // if HID is PNP ID, patch the last byte in HID TAG to Noop\r
         //\r
         *(DataPtr + TPM_HID_PNP_SIZE) = AML_NOOP_OP;\r
       } else {\r
 \r
-        CopyMem(DataPtr, HID, TPM_HID_ACPI_SIZE);\r
+        CopyMem(DataPtr, Hid, TPM_HID_ACPI_SIZE);\r
       }\r
-      DEBUG((EFI_D_INFO, "TPM2 ACPI _HID updated to %a\n", HID));\r
+      DEBUG((DEBUG_INFO, "TPM2 ACPI _HID is patched to %a\n", DataPtr));\r
+\r
       return Status;\r
     }\r
   }\r
@@ -422,6 +670,8 @@ PublishAcpiTable (
   UINTN                          TableKey;\r
   EFI_ACPI_DESCRIPTION_HEADER    *Table;\r
   UINTN                          TableSize;\r
+  UINT32                         *PossibleIrqNumBuf;\r
+  UINT32                         PossibleIrqNumBufSize;\r
 \r
   Status = GetSectionFromFv (\r
              &gEfiCallerIdGuid,\r
@@ -438,6 +688,12 @@ PublishAcpiTable (
   Status = UpdatePPVersion(Table, (CHAR8 *)PcdGetPtr(PcdTcgPhysicalPresenceInterfaceVer));\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  DEBUG ((\r
+    DEBUG_INFO,\r
+    "Current physical presence interface version - %a\n",\r
+    (CHAR8 *) PcdGetPtr(PcdTcgPhysicalPresenceInterfaceVer)\r
+    ));\r
+\r
   //\r
   // Update TPM2 HID before measuring it to PCR\r
   //\r
@@ -446,6 +702,29 @@ PublishAcpiTable (
     return Status;\r
   }\r
 \r
+  if (PcdGet32(PcdTpm2CurrentIrqNum) != 0) {\r
+    //\r
+    // Patch _PRS interrupt resource only when TPM interrupt is supported\r
+    //\r
+    PossibleIrqNumBuf     = (UINT32 *)PcdGetPtr(PcdTpm2PossibleIrqNumBuf);\r
+    PossibleIrqNumBufSize = (UINT32)PcdGetSize(PcdTpm2PossibleIrqNumBuf);\r
+\r
+    if (PossibleIrqNumBufSize <= MAX_PRS_INT_BUF_SIZE && (PossibleIrqNumBufSize % sizeof(UINT32)) == 0) {\r
+      Status = UpdatePossibleResource(Table, PossibleIrqNumBuf, PossibleIrqNumBufSize);\r
+      DEBUG ((\r
+        DEBUG_INFO,\r
+        "UpdatePossibleResource status - %x. TPM2 service may not ready in OS.\n",\r
+        Status\r
+        ));\r
+    } else {\r
+      DEBUG ((\r
+        DEBUG_INFO,\r
+        "PcdTpm2PossibleIrqNumBuf size %x is not correct. TPM2 service may not ready in OS.\n",\r
+        PossibleIrqNumBufSize\r
+      ));\r
+    }\r
+  }\r
+\r
   //\r
   // Measure to PCR[0] with event EV_POST_CODE ACPI DATA\r
   //\r
@@ -463,6 +742,8 @@ PublishAcpiTable (
   CopyMem (Table->OemId, PcdGetPtr (PcdAcpiDefaultOemId), sizeof (Table->OemId) );\r
   mTcgNvs = AssignOpRegion (Table, SIGNATURE_32 ('T', 'N', 'V', 'S'), (UINT16) sizeof (TCG_NVS));\r
   ASSERT (mTcgNvs != NULL);\r
+  mTcgNvs->TpmIrqNum            = PcdGet32(PcdTpm2CurrentIrqNum);\r
+  mTcgNvs->IsShortFormPkgLength = FALSE;\r
 \r
   //\r
   // Publish the TPM ACPI table. Table is re-checksumed.\r
@@ -501,6 +782,19 @@ PublishTpm2 (
   EFI_TPM2_ACPI_CONTROL_AREA     *ControlArea;\r
   PTP_INTERFACE_TYPE             InterfaceType;\r
 \r
+  mTpm2AcpiTemplate.Header.Revision = PcdGet8(PcdTpm2AcpiTableRev);\r
+  DEBUG((DEBUG_INFO, "Tpm2 ACPI table revision is %d\n", mTpm2AcpiTemplate.Header.Revision));\r
+\r
+  //\r
+  // PlatformClass is only valid for version 4 and above\r
+  //    BIT0~15:  PlatformClass \r
+  //    BIT16~31: Reserved\r
+  //\r
+  if (mTpm2AcpiTemplate.Header.Revision >= EFI_TPM2_ACPI_TABLE_REVISION_4) {\r
+    mTpm2AcpiTemplate.Flags = (mTpm2AcpiTemplate.Flags & 0xFFFF0000) | PcdGet8(PcdTpmPlatformClass);\r
+    DEBUG((DEBUG_INFO, "Tpm2 ACPI table PlatformClass is %d\n", (mTpm2AcpiTemplate.Flags & 0x0000FFFF)));\r
+  }\r
+\r
   //\r
   // Measure to PCR[0] with event EV_POST_CODE ACPI DATA\r
   //\r