mirror of
https://github.com/stefanberger/libtpms
synced 2026-01-06 18:17:49 +00:00
147 lines
6.8 KiB
C
147 lines
6.8 KiB
C
/********************************************************************************/
|
|
/* */
|
|
/* Functions relating to the TPM's time functions */
|
|
/* Written by Ken Goldman */
|
|
/* IBM Thomas J. Watson Research Center */
|
|
/* */
|
|
/* Licenses and Notices */
|
|
/* */
|
|
/* 1. Copyright Licenses: */
|
|
/* */
|
|
/* - Trusted Computing Group (TCG) grants to the user of the source code in */
|
|
/* this specification (the "Source Code") a worldwide, irrevocable, */
|
|
/* nonexclusive, royalty free, copyright license to reproduce, create */
|
|
/* derivative works, distribute, display and perform the Source Code and */
|
|
/* derivative works thereof, and to grant others the rights granted herein. */
|
|
/* */
|
|
/* - The TCG grants to the user of the other parts of the specification */
|
|
/* (other than the Source Code) the rights to reproduce, distribute, */
|
|
/* display, and perform the specification solely for the purpose of */
|
|
/* developing products based on such documents. */
|
|
/* */
|
|
/* 2. Source Code Distribution Conditions: */
|
|
/* */
|
|
/* - Redistributions of Source Code must retain the above copyright licenses, */
|
|
/* this list of conditions and the following disclaimers. */
|
|
/* */
|
|
/* - Redistributions in binary form must reproduce the above copyright */
|
|
/* licenses, this list of conditions and the following disclaimers in the */
|
|
/* documentation and/or other materials provided with the distribution. */
|
|
/* */
|
|
/* 3. Disclaimers: */
|
|
/* */
|
|
/* - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF */
|
|
/* LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH */
|
|
/* RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES) */
|
|
/* THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE. */
|
|
/* Contact TCG Administration (admin@trustedcomputinggroup.org) for */
|
|
/* information on specification licensing rights available through TCG */
|
|
/* membership agreements. */
|
|
/* */
|
|
/* - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED */
|
|
/* WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR */
|
|
/* FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR */
|
|
/* NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY */
|
|
/* OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. */
|
|
/* */
|
|
/* - Without limitation, TCG and its members and licensors disclaim all */
|
|
/* liability, including liability for infringement of any proprietary */
|
|
/* rights, relating to use of information in this specification and to the */
|
|
/* implementation of this specification, and TCG disclaims all liability for */
|
|
/* cost of procurement of substitute goods or services, lost profits, loss */
|
|
/* of use, loss of data or any incidental, consequential, direct, indirect, */
|
|
/* or special damages, whether under contract, tort, warranty or otherwise, */
|
|
/* arising in any way out of use or reliance upon this specification or any */
|
|
/* information herein. */
|
|
/* */
|
|
/* (c) Copyright IBM Corp. and others, 2016 - 2023 */
|
|
/* */
|
|
/********************************************************************************/
|
|
|
|
/*(Auto-generated)
|
|
* Created by TpmPrototypes; Version 3.0 July 18, 2017
|
|
* Date: Apr 2, 2019 Time: 04:23:27PM
|
|
*/
|
|
|
|
#ifndef _TIME_FP_H_
|
|
#define _TIME_FP_H_
|
|
|
|
//*** TimePowerOn()
|
|
// This function initialize time info at _TPM_Init().
|
|
//
|
|
// This function is called at _TPM_Init() so that the TPM time can start counting
|
|
// as soon as the TPM comes out of reset and doesn't have to wait until
|
|
// TPM2_Startup() in order to begin the new time epoch. This could be significant
|
|
// for systems that could get powered up but not run any TPM commands for some
|
|
// period of time.
|
|
//
|
|
void TimePowerOn(void);
|
|
|
|
//*** TimeStartup()
|
|
// This function updates the resetCount and restartCount components of
|
|
// TPMS_CLOCK_INFO structure at TPM2_Startup().
|
|
//
|
|
// This function will deal with the deferred creation of a new epoch.
|
|
// TimeUpdateToCurrent() will not start a new epoch even if one is due when
|
|
// TPM_Startup() has not been run. This is because the state of NV is not known
|
|
// until startup completes. When Startup is done, then it will create the epoch
|
|
// nonce to complete the initializations by calling this function.
|
|
BOOL TimeStartup(STARTUP_TYPE type // IN: start up type
|
|
);
|
|
|
|
//*** TimeClockUpdate()
|
|
// This function updates go.clock. If 'newTime' requires an update of NV, then
|
|
// NV is checked for availability. If it is not available or is rate limiting, then
|
|
// go.clock is not updated and the function returns an error. If 'newTime' would
|
|
// not cause an NV write, then go.clock is updated. If an NV write occurs, then
|
|
// go.safe is SET.
|
|
void TimeClockUpdate(UINT64 newTime // IN: New time value in mS.
|
|
);
|
|
|
|
//*** TimeUpdate()
|
|
// This function is used to update the time and clock values. If the TPM
|
|
// has run TPM2_Startup(), this function is called at the start of each command.
|
|
// If the TPM has not run TPM2_Startup(), this is called from TPM2_Startup() to
|
|
// get the clock values initialized. It is not called on command entry because, in
|
|
// this implementation, the go structure is not read from NV until TPM2_Startup().
|
|
// The reason for this is that the initialization code (_TPM_Init()) may run before
|
|
// NV is accessible.
|
|
void TimeUpdate(void);
|
|
|
|
//*** TimeUpdateToCurrent()
|
|
// This function updates the 'Time' and 'Clock' in the global
|
|
// TPMS_TIME_INFO structure.
|
|
//
|
|
// In this implementation, 'Time' and 'Clock' are updated at the beginning
|
|
// of each command and the values are unchanged for the duration of the
|
|
// command.
|
|
//
|
|
// Because 'Clock' updates may require a write to NV memory, 'Time' and 'Clock'
|
|
// are not allowed to advance if NV is not available. When clock is not advancing,
|
|
// any function that uses 'Clock' will fail and return TPM_RC_NV_UNAVAILABLE or
|
|
// TPM_RC_NV_RATE.
|
|
//
|
|
// This implementation does not do rate limiting. If the implementation does do
|
|
// rate limiting, then the 'Clock' update should not be inhibited even when doing
|
|
// rate limiting.
|
|
void TimeUpdateToCurrent(void);
|
|
|
|
//*** TimeSetAdjustRate()
|
|
// This function is used to perform rate adjustment on 'Time' and 'Clock'.
|
|
void TimeSetAdjustRate(TPM_CLOCK_ADJUST adjust // IN: adjust constant
|
|
);
|
|
|
|
//*** TimeGetMarshaled()
|
|
// This function is used to access TPMS_TIME_INFO in canonical form.
|
|
// The function collects the time information and marshals it into 'dataBuffer'
|
|
// and returns the marshaled size
|
|
UINT16
|
|
TimeGetMarshaled(TIME_INFO* dataBuffer // OUT: result buffer
|
|
);
|
|
|
|
//*** TimeFillInfo
|
|
// This function gathers information to fill in a TPMS_CLOCK_INFO structure.
|
|
void TimeFillInfo(TPMS_CLOCK_INFO* clockInfo);
|
|
|
|
#endif // _TIME_FP_H_
|