/* Microsoft Reference Implementation for TPM 2.0 | |
* | |
* The copyright in this software is being made available under the BSD License, | |
* included below. This software may be subject to other third party and | |
* contributor rights, including patent rights, and no such rights are granted | |
* under this license. | |
* | |
* Copyright (c) Microsoft Corporation | |
* | |
* All rights reserved. | |
* | |
* BSD License | |
* | |
* Redistribution and use in source and binary forms, with or without modification, | |
* are permitted provided that the following conditions are met: | |
* | |
* Redistributions of source code must retain the above copyright notice, this list | |
* of conditions and the following disclaimer. | |
* | |
* Redistributions in binary form must reproduce the above copyright notice, this | |
* list of conditions and the following disclaimer in the documentation and/or other | |
* materials provided with the distribution. | |
* | |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ""AS IS"" | |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR | |
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | |
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
*/ | |
#include "Tpm.h" | |
#include "Shutdown_fp.h" | |
#ifdef TPM_CC_Shutdown // Conditional expansion of this file | |
/*(See part 3 specification) | |
// Shut down TPM for power off | |
*/ | |
// return type: TPM_RC | |
// TPM_RC_TYPE if PCR bank has been re-configured, a | |
// CLEAR StateSave is required | |
TPM_RC | |
TPM2_Shutdown( | |
Shutdown_In *in // IN: input parameter list | |
) | |
{ | |
// The command needs NV update. Check if NV is available. | |
// A TPM_RC_NV_UNAVAILABLE or TPM_RC_NV_RATE error may be returned at | |
// this point | |
RETURN_IF_NV_IS_NOT_AVAILABLE; | |
// Input Validation | |
// If PCR bank has been reconfigured, a CLEAR state save is required | |
if(g_pcrReConfig && in->shutdownType == TPM_SU_STATE) | |
return TPM_RCS_TYPE + RC_Shutdown_shutdownType; | |
// Internal Data Update | |
gp.orderlyState = in->shutdownType; | |
// PCR private date state save | |
PCRStateSave(in->shutdownType); | |
// Save RAM backed NV index data | |
NvUpdateIndexOrderlyData(); | |
#ifdef ACCUMULATE_SELF_HEAL_TIMER | |
// Save the current time value | |
go.time = g_time; | |
#endif | |
// Save all orderly data | |
NvWrite(NV_ORDERLY_DATA, sizeof(ORDERLY_DATA), &go); | |
if(in->shutdownType == TPM_SU_STATE) | |
{ | |
// Save STATE_RESET and STATE_CLEAR data | |
NvWrite(NV_STATE_CLEAR_DATA, sizeof(STATE_CLEAR_DATA), &gc); | |
NvWrite(NV_STATE_RESET_DATA, sizeof(STATE_RESET_DATA), &gr); | |
// Save the startup flags for resume | |
if(g_DrtmPreStartup) | |
gp.orderlyState = TPM_SU_STATE | PRE_STARTUP_FLAG; | |
else if(g_StartupLocality3) | |
gp.orderlyState = TPM_SU_STATE | STARTUP_LOCALITY_3; | |
} | |
else if(in->shutdownType == TPM_SU_CLEAR) | |
{ | |
// Save STATE_RESET data | |
NvWrite(NV_STATE_RESET_DATA, sizeof(STATE_RESET_DATA), &gr); | |
} | |
else | |
FAIL(FATAL_ERROR_INTERNAL); | |
NV_SYNC_PERSISTENT(orderlyState); | |
return TPM_RC_SUCCESS; | |
} | |
#endif // CC_Shutdown |