<p>Philipp Deppenwiese <strong>merged</strong> this change.</p><p><a href="https://review.coreboot.org/29026">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  build bot (Jenkins): Verified
  Aaron Durbin: Looks good to me, approved
  Philipp Deppenwiese: Looks good to me, approved
  Furquan Shaikh: Looks good to me, approved

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">tpm/tspi: clean up tpm_setup function flow<br><br>Introduce two helper functions for more readable code.<br>Use epilogue function instead of goto for error handling.<br><br>BUG=None<br>TEST=None<br><br>Change-Id: Ibea44880683a301e82ee2ba049003c36fcb44eba<br>Signed-off-by: Joel Kitching <kitching@google.com><br>Reviewed-on: https://review.coreboot.org/29026<br>Tested-by: build bot (Jenkins) <no-reply@coreboot.org><br>Reviewed-by: Aaron Durbin <adurbin@chromium.org><br>Reviewed-by: Furquan Shaikh <furquan@google.com><br>Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com><br>---<br>M src/security/tpm/tspi/tspi.c<br>1 file changed, 46 insertions(+), 38 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/security/tpm/tspi/tspi.c b/src/security/tpm/tspi/tspi.c</span><br><span>index c1779e6..d9cade9 100644</span><br><span>--- a/src/security/tpm/tspi/tspi.c</span><br><span>+++ b/src/security/tpm/tspi/tspi.c</span><br><span>@@ -64,6 +64,43 @@</span><br><span> }</span><br><span> #endif</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static uint32_t tpm_setup_s3_helper(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t result;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+    result = tlcl_resume();</span><br><span style="color: hsl(120, 100%, 40%);">+       switch (result) {</span><br><span style="color: hsl(120, 100%, 40%);">+     case TPM_SUCCESS:</span><br><span style="color: hsl(120, 100%, 40%);">+             break;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+      case TPM_E_INVALID_POSTINIT:</span><br><span style="color: hsl(120, 100%, 40%);">+          /*</span><br><span style="color: hsl(120, 100%, 40%);">+             * We're on a platform where the TPM maintains power</span><br><span style="color: hsl(120, 100%, 40%);">+               * in S3, so it's already initialized.</span><br><span style="color: hsl(120, 100%, 40%);">+             */</span><br><span style="color: hsl(120, 100%, 40%);">+           printk(BIOS_INFO, "TPM: Already initialized.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+           result = TPM_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+         break;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+      default:</span><br><span style="color: hsl(120, 100%, 40%);">+              printk(BIOS_ERR, "TPM: Resume failed (%#x).\n", result);</span><br><span style="color: hsl(120, 100%, 40%);">+            break;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+      }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   return result;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static uint32_t tpm_setup_epilogue(uint32_t result)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+   if (result != TPM_SUCCESS)</span><br><span style="color: hsl(120, 100%, 40%);">+            post_code(POST_TPM_FAILURE);</span><br><span style="color: hsl(120, 100%, 40%);">+  else</span><br><span style="color: hsl(120, 100%, 40%);">+          printk(BIOS_INFO, "TPM: setup succeeded\n");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+      return result;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*</span><br><span>  * tpm_setup starts the TPM and establishes the root of trust for the</span><br><span>  * anti-rollback mechanism.  SetupTPM can fail for three reasons.  1 A bug. 2 a</span><br><span>@@ -91,37 +128,19 @@</span><br><span>         result = tlcl_lib_init();</span><br><span>    if (result != TPM_SUCCESS) {</span><br><span>                 printk(BIOS_ERR, "TPM: Can't initialize.\n");</span><br><span style="color: hsl(0, 100%, 40%);">-             goto out;</span><br><span style="color: hsl(120, 100%, 40%);">+             return tpm_setup_epilogue(result);</span><br><span>   }</span><br><span> </span><br><span>        /* Handle special init for S3 resume path */</span><br><span>         if (s3flag) {</span><br><span style="color: hsl(0, 100%, 40%);">-           result = tlcl_resume();</span><br><span style="color: hsl(0, 100%, 40%);">-         switch (result) {</span><br><span style="color: hsl(0, 100%, 40%);">-               case TPM_SUCCESS:</span><br><span style="color: hsl(0, 100%, 40%);">-                       break;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-          case TPM_E_INVALID_POSTINIT:</span><br><span style="color: hsl(0, 100%, 40%);">-                    /*</span><br><span style="color: hsl(0, 100%, 40%);">-                       * We're on a platform where the TPM maintains power</span><br><span style="color: hsl(0, 100%, 40%);">-                         * in S3, so it's already initialized.</span><br><span style="color: hsl(0, 100%, 40%);">-                       */</span><br><span style="color: hsl(0, 100%, 40%);">-                     printk(BIOS_INFO, "TPM: Already initialized.\n");</span><br><span style="color: hsl(0, 100%, 40%);">-                     result = TPM_SUCCESS;</span><br><span style="color: hsl(0, 100%, 40%);">-                   break;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-          default:</span><br><span style="color: hsl(0, 100%, 40%);">-                        printk(BIOS_ERR, "TPM: Resume failed (%#x).\n", result);</span><br><span style="color: hsl(0, 100%, 40%);">-                      break;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-          }</span><br><span style="color: hsl(0, 100%, 40%);">-               goto out;</span><br><span style="color: hsl(120, 100%, 40%);">+             printk(BIOS_INFO, "TPM: Handle S3 resume.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+              return tpm_setup_epilogue(tpm_setup_s3_helper());</span><br><span>    }</span><br><span> </span><br><span>        result = tlcl_startup();</span><br><span>     if (result != TPM_SUCCESS) {</span><br><span>                 printk(BIOS_ERR, "TPM: Can't run startup command.\n");</span><br><span style="color: hsl(0, 100%, 40%);">-            goto out;</span><br><span style="color: hsl(120, 100%, 40%);">+             return tpm_setup_epilogue(result);</span><br><span>   }</span><br><span> </span><br><span>        result = tlcl_assert_physical_presence();</span><br><span>@@ -133,33 +152,22 @@</span><br><span>             */</span><br><span>          result = tlcl_physical_presence_cmd_enable();</span><br><span>                if (result != TPM_SUCCESS) {</span><br><span style="color: hsl(0, 100%, 40%);">-                    printk(</span><br><span style="color: hsl(0, 100%, 40%);">-                         BIOS_ERR,</span><br><span style="color: hsl(0, 100%, 40%);">-                               "TPM: Can't enable physical presence command.\n");</span><br><span style="color: hsl(0, 100%, 40%);">-                        goto out;</span><br><span style="color: hsl(120, 100%, 40%);">+                     printk(BIOS_ERR, "TPM: Can't enable physical presence command.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+                     return tpm_setup_epilogue(result);</span><br><span>           }</span><br><span> </span><br><span>                result = tlcl_assert_physical_presence();</span><br><span>            if (result != TPM_SUCCESS) {</span><br><span style="color: hsl(0, 100%, 40%);">-                    printk(BIOS_ERR,</span><br><span style="color: hsl(0, 100%, 40%);">-                               "TPM: Can't assert physical presence.\n");</span><br><span style="color: hsl(0, 100%, 40%);">-                 goto out;</span><br><span style="color: hsl(120, 100%, 40%);">+                     printk(BIOS_ERR, "TPM: Can't assert physical presence.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+                     return tpm_setup_epilogue(result);</span><br><span>           }</span><br><span>    }</span><br><span> </span><br><span> #if IS_ENABLED(CONFIG_TPM1)</span><br><span>         result = tpm1_invoke_state_machine();</span><br><span style="color: hsl(0, 100%, 40%);">-   if (result != TPM_SUCCESS)</span><br><span style="color: hsl(0, 100%, 40%);">-              return result;</span><br><span> #endif</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-out:</span><br><span style="color: hsl(0, 100%, 40%);">-        if (result != TPM_SUCCESS)</span><br><span style="color: hsl(0, 100%, 40%);">-              post_code(POST_TPM_FAILURE);</span><br><span style="color: hsl(0, 100%, 40%);">-    else</span><br><span style="color: hsl(0, 100%, 40%);">-            printk(BIOS_INFO, "TPM: setup succeeded\n");</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-  return result;</span><br><span style="color: hsl(120, 100%, 40%);">+        return tpm_setup_epilogue(result);</span><br><span> }</span><br><span> </span><br><span> uint32_t tpm_clear_and_reenable(void)</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/29026">change 29026</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/29026"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: Ibea44880683a301e82ee2ba049003c36fcb44eba </div>
<div style="display:none"> Gerrit-Change-Number: 29026 </div>
<div style="display:none"> Gerrit-PatchSet: 6 </div>
<div style="display:none"> Gerrit-Owner: Joel Kitching <kitching@google.com> </div>
<div style="display:none"> Gerrit-Reviewer: Aaron Durbin <adurbin@chromium.org> </div>
<div style="display:none"> Gerrit-Reviewer: Furquan Shaikh <furquan@google.com> </div>
<div style="display:none"> Gerrit-Reviewer: Joel Kitching <kitching@google.com> </div>
<div style="display:none"> Gerrit-Reviewer: Paul Menzel <paulepanter@users.sourceforge.net> </div>
<div style="display:none"> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: build bot (Jenkins) <no-reply@coreboot.org> </div>
<div style="display:none"> Gerrit-CC: Patrick Rudolph <siro@das-labor.org> </div>