include/tpm_api.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2013 The Chromium OS Authors.
   4  * Coypright (c) 2013 Guntermann & Drunck GmbH
   5  */
   6
   7 #ifndef __TPM_API_H
   8 #define __TPM_API_H
   9
  10 #include <tpm-common.h>
  11 #include <tpm-v1.h>
  12 #include <tpm-v2.h>
  13
  14 /**
  15  * Issue a TPM_Startup command.
  16  *
  17  * @param dev           TPM device
  18  * @param mode          TPM startup mode
  19  * Return: return code of the operation
  20  */
  21 u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode);
  22
  23 /**
  24  * Issue a TPM_SelfTestFull command.
  25  *
  26  * @param dev           TPM device
  27  * Return: return code of the operation
  28  */
  29 u32 tpm_self_test_full(struct udevice *dev);
  30
  31 /**
  32  * Issue a TPM_ContinueSelfTest command.
  33  *
  34  * @param dev           TPM device
  35  * Return: return code of the operation
  36  */
  37 u32 tpm_continue_self_test(struct udevice *dev);
  38
  39 /**
  40  * Issue a TPM_NV_DefineSpace command.  The implementation is limited
  41  * to specify TPM_NV_ATTRIBUTES and size of the area.  The area index
  42  * could be one of the special value listed in enum tpm_nv_index.
  43  *
  44  * @param dev           TPM device
  45  * @param index         index of the area
  46  * @param perm          TPM_NV_ATTRIBUTES of the area
  47  * @param size          size of the area
  48  * Return: return code of the operation
  49  */
  50 u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size);
  51
  52 /**
  53  * Issue a TPM_NV_ReadValue command.  This implementation is limited
  54  * to read the area from offset 0.  The area index could be one of
  55  * the special value listed in enum tpm_nv_index.
  56  *
  57  * @param dev           TPM device
  58  * @param index         index of the area
  59  * @param data          output buffer of the area contents
  60  * @param count         size of output buffer
  61  * Return: return code of the operation
  62  */
  63 u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count);
  64
  65 /**
  66  * Issue a TPM_NV_WriteValue command.  This implementation is limited
  67  * to write the area from offset 0.  The area index could be one of
  68  * the special value listed in enum tpm_nv_index.
  69  *
  70  * @param dev           TPM device
  71  * @param index         index of the area
  72  * @param data          input buffer to be wrote to the area
  73  * @param length        length of data bytes of input buffer
  74  * Return: return code of the operation
  75  */
  76 u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data,
  77                        u32 length);
  78
  79 /**
  80  * Issue a TPM_Extend command.
  81  *
  82  * @param dev           TPM device
  83  * @param index         index of the PCR
  84  * @param in_digest     160/256-bit value representing the event to be
  85  *                      recorded
  86  * @param size          size of digest in bytes
  87  * @param out_digest    160/256-bit PCR value after execution of the
  88  *                      command
  89  * @param name          digest source, used for log output
  90  * Return: return code of the operation
  91  */
  92 u32 tpm_pcr_extend(struct udevice *dev, u32 index, const void *in_digest,
  93                    uint size, void *out_digest, const char *name);
  94
  95 /**
  96  * Issue a TPM_PCRRead command.
  97  *
  98  * @param dev           TPM device
  99  * @param index         index of the PCR
 100  * @param data          output buffer for contents of the named PCR
 101  * @param count         size of output buffer
 102  * Return: return code of the operation
 103  */
 104 u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count);
 105
 106 /**
 107  * Issue a TSC_PhysicalPresence command.  TPM physical presence flag
 108  * is bit-wise OR'ed of flags listed in enum tpm_physical_presence.
 109  *
 110  * @param dev           TPM device
 111  * @param presence      TPM physical presence flag
 112  * Return: return code of the operation
 113  */
 114 u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence);
 115
 116 /**
 117  * Issue a TPM_ReadPubek command.
 118  *
 119  * @param dev           TPM device
 120  * @param data          output buffer for the public endorsement key
 121  * @param count         size of output buffer
 122  * Return: return code of the operation
 123  */
 124 u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count);
 125
 126 /**
 127  * Issue a TPM_ForceClear command.
 128  *
 129  * @param dev           TPM device
 130  * Return: return code of the operation
 131  */
 132 u32 tpm_force_clear(struct udevice *dev);
 133
 134 /**
 135  * Issue a TPM_PhysicalEnable command.
 136  *
 137  * @param dev           TPM device
 138  * Return: return code of the operation
 139  */
 140 u32 tpm_physical_enable(struct udevice *dev);
 141
 142 /**
 143  * Issue a TPM_PhysicalDisable command.
 144  *
 145  * @param dev           TPM device
 146  * Return: return code of the operation
 147  */
 148 u32 tpm_physical_disable(struct udevice *dev);
 149
 150 /**
 151  * Issue a TPM_PhysicalSetDeactivated command.
 152  *
 153  * @param dev           TPM device
 154  * @param state         boolean state of the deactivated flag
 155  * Return: return code of the operation
 156  */
 157 u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state);
 158
 159 /**
 160  * Issue a TPM_GetCapability command.  This implementation is limited
 161  * to query sub_cap index that is 4-byte wide.
 162  *
 163  * @param dev           TPM device
 164  * @param cap_area      partition of capabilities
 165  * @param sub_cap       further definition of capability, which is
 166  *                      limited to be 4-byte wide
 167  * @param cap           output buffer for capability information
 168  * @param count         size of output buffer
 169  * Return: return code of the operation
 170  */
 171 u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap,
 172                        void *cap, size_t count);
 173
 174 /**
 175  * Issue a TPM_FlushSpecific command for a AUTH resource.
 176  *
 177  * @param dev           TPM device
 178  * @param auth_handle   handle of the auth session
 179  * Return: return code of the operation
 180  */
 181 u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle);
 182
 183 /**
 184  * Issue a TPM_OIAP command to setup an object independent authorization
 185  * session.
 186  * Information about the session is stored internally.
 187  * If there was already an OIAP session active it is terminated and a new
 188  * session is set up.
 189  *
 190  * @param dev           TPM device
 191  * @param auth_handle   pointer to the (new) auth handle or NULL.
 192  * Return: return code of the operation
 193  */
 194 u32 tpm_oiap(struct udevice *dev, u32 *auth_handle);
 195
 196 /**
 197  * Ends an active OIAP session.
 198  *
 199  * @param dev           TPM device
 200  * Return: return code of the operation
 201  */
 202 u32 tpm_end_oiap(struct udevice *dev);
 203
 204 /**
 205  * Issue a TPM_LoadKey2 (Auth1) command using an OIAP session for authenticating
 206  * the usage of the parent key.
 207  *
 208  * @param dev           TPM device
 209  * @param parent_handle handle of the parent key.
 210  * @param key           pointer to the key structure (TPM_KEY or TPM_KEY12).
 211  * @param key_length    size of the key structure
 212  * @param parent_key_usage_auth usage auth for the parent key
 213  * @param key_handle    pointer to the key handle
 214  * Return: return code of the operation
 215  */
 216 u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key,
 217                        size_t key_length, const void *parent_key_usage_auth,
 218                        u32 *key_handle);
 219
 220 /**
 221  * Issue a TPM_GetPubKey (Auth1) command using an OIAP session for
 222  * authenticating the usage of the key.
 223  *
 224  * @param dev           TPM device
 225  * @param key_handle    handle of the key
 226  * @param usage_auth    usage auth for the key
 227  * @param pubkey        pointer to the pub key buffer; may be NULL if the pubkey
 228  *                      should not be stored.
 229  * @param pubkey_len    pointer to the pub key buffer len. On entry: the size of
 230  *                      the provided pubkey buffer. On successful exit: the size
 231  *                      of the stored TPM_PUBKEY structure (iff pubkey != NULL).
 232  * Return: return code of the operation
 233  */
 234 u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle,
 235                          const void *usage_auth, void *pubkey,
 236                          size_t *pubkey_len);
 237
 238 /**
 239  * Get the TPM permissions
 240  *
 241  * @param dev           TPM device
 242  * @param perm          Returns permissions value
 243  * Return: return code of the operation
 244  */
 245 u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm);
 246
 247 /**
 248  * Flush a resource with a given handle and type from the TPM
 249  *
 250  * @param dev           TPM device
 251  * @param key_handle           handle of the resource
 252  * @param resource_type                type of the resource
 253  * Return: return code of the operation
 254  */
 255 u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type);
 256
 257 #ifdef CONFIG_TPM_LOAD_KEY_BY_SHA1
 258 /**
 259  * Search for a key by usage AuthData and the hash of the parent's pub key.
 260  *
 261  * @param dev           TPM device
 262  * @param auth          Usage auth of the key to search for
 263  * @param pubkey_digest SHA1 hash of the pub key structure of the key
 264  * @param[out] handle   The handle of the key (Non-null iff found)
 265  * Return: 0 if key was found in TPM; != 0 if not.
 266  */
 267 u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20],
 268                       const u8 pubkey_digest[20], u32 *handle);
 269 #endif /* CONFIG_TPM_LOAD_KEY_BY_SHA1 */
 270
 271 /**
 272  * Read random bytes from the TPM RNG. The implementation deals with the fact
 273  * that the TPM may legally return fewer bytes than requested by retrying
 274  * until @p count bytes have been received.
 275  *
 276  * @param dev           TPM device
 277  * @param data          output buffer for the random bytes
 278  * @param count         size of output buffer
 279  * Return: return code of the operation
 280  */
 281 u32 tpm_get_random(struct udevice *dev, void *data, u32 count);
 282
 283 /**
 284  * tpm_finalise_physical_presence() - Finalise physical presence
 285  *
 286  * @param dev           TPM device
 287  * Return: return code of the operation (0 = success)
 288  */
 289 u32 tpm_finalise_physical_presence(struct udevice *dev);
 290
 291 /**
 292  * tpm_nv_enable_locking() - lock the non-volatile space
 293  *
 294  * @param dev           TPM device
 295  * Return: return code of the operation (0 = success)
 296  */
 297 u32 tpm_nv_enable_locking(struct udevice *dev);
 298
 299 /**
 300  * tpm_set_global_lock() - set the global lock
 301  *
 302  * @param dev           TPM device
 303  * Return: return code of the operation (0 = success)
 304  */
 305 u32 tpm_set_global_lock(struct udevice *dev);
 306
 307 /**
 308  * tpm_write_lock() - lock the non-volatile space
 309  *
 310  * @param dev           TPM device
 311  * @param index         Index of space to lock
 312  * Return: return code of the operation (0 = success)
 313  */
 314 u32 tpm_write_lock(struct udevice *dev, u32 index);
 315
 316 /**
 317  * tpm_resume() - start up the TPM from resume (after suspend)
 318  *
 319  * @param dev           TPM device
 320  * Return: return code of the operation (0 = success)
 321  */
 322 u32 tpm_resume(struct udevice *dev);
 323
 324 static inline bool tpm_is_v1(struct udevice *dev)
 325 {
 326         return IS_ENABLED(CONFIG_TPM_V1) && tpm_get_version(dev) == TPM_V1;
 327 }
 328
 329 static inline bool tpm_is_v2(struct udevice *dev)
 330 {
 331         return IS_ENABLED(CONFIG_TPM_V2) && tpm_get_version(dev) == TPM_V2;
 332 }
 333
 334 /**
 335  * tpm_auto_start() - start up the TPM and perform selftests
 336  *
 337  * @param dev           TPM device
 338  * Return: return code of the operation (0 = success)
 339  */
 340 u32 tpm_auto_start(struct udevice *dev);
 341
 342 #endif /* __TPM_API_H */