include/tpm.h

   1 /*
   2  * Copyright (c) 2013 The Chromium OS Authors.
   3  * Coypright (c) 2013 Guntermann & Drunck GmbH
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #ifndef __TPM_H
   9 #define __TPM_H
  10
  11 /*
  12  * Here is a partial implementation of TPM commands.  Please consult TCG Main
  13  * Specification for definitions of TPM commands.
  14  */
  15
  16 #define TPM_HEADER_SIZE         10
  17
  18 enum tpm_duration {
  19         TPM_SHORT = 0,
  20         TPM_MEDIUM = 1,
  21         TPM_LONG = 2,
  22         TPM_UNDEFINED,
  23
  24         TPM_DURATION_COUNT,
  25 };
  26
  27 enum tpm_startup_type {
  28         TPM_ST_CLEAR            = 0x0001,
  29         TPM_ST_STATE            = 0x0002,
  30         TPM_ST_DEACTIVATED      = 0x0003,
  31 };
  32
  33 enum tpm_physical_presence {
  34         TPM_PHYSICAL_PRESENCE_HW_DISABLE        = 0x0200,
  35         TPM_PHYSICAL_PRESENCE_CMD_DISABLE       = 0x0100,
  36         TPM_PHYSICAL_PRESENCE_LIFETIME_LOCK     = 0x0080,
  37         TPM_PHYSICAL_PRESENCE_HW_ENABLE         = 0x0040,
  38         TPM_PHYSICAL_PRESENCE_CMD_ENABLE        = 0x0020,
  39         TPM_PHYSICAL_PRESENCE_NOTPRESENT        = 0x0010,
  40         TPM_PHYSICAL_PRESENCE_PRESENT           = 0x0008,
  41         TPM_PHYSICAL_PRESENCE_LOCK              = 0x0004,
  42 };
  43
  44 enum tpm_nv_index {
  45         TPM_NV_INDEX_LOCK       = 0xffffffff,
  46         TPM_NV_INDEX_0          = 0x00000000,
  47         TPM_NV_INDEX_DIR        = 0x10000001,
  48 };
  49
  50 enum tpm_resource_type {
  51         TPM_RT_KEY      = 0x00000001,
  52         TPM_RT_AUTH     = 0x00000002,
  53         TPM_RT_HASH     = 0x00000003,
  54         TPM_RT_TRANS    = 0x00000004,
  55         TPM_RT_CONTEXT  = 0x00000005,
  56         TPM_RT_COUNTER  = 0x00000006,
  57         TPM_RT_DELEGATE = 0x00000007,
  58         TPM_RT_DAA_TPM  = 0x00000008,
  59         TPM_RT_DAA_V0   = 0x00000009,
  60         TPM_RT_DAA_V1   = 0x0000000A,
  61 };
  62
  63 enum tpm_capability_areas {
  64         TPM_CAP_ORD             = 0x00000001,
  65         TPM_CAP_ALG             = 0x00000002,
  66         TPM_CAP_PID             = 0x00000003,
  67         TPM_CAP_FLAG            = 0x00000004,
  68         TPM_CAP_PROPERTY        = 0x00000005,
  69         TPM_CAP_VERSION         = 0x00000006,
  70         TPM_CAP_KEY_HANDLE      = 0x00000007,
  71         TPM_CAP_CHECK_LOADED    = 0x00000008,
  72         TPM_CAP_SYM_MODE        = 0x00000009,
  73         TPM_CAP_KEY_STATUS      = 0x0000000C,
  74         TPM_CAP_NV_LIST         = 0x0000000D,
  75         TPM_CAP_MFR             = 0x00000010,
  76         TPM_CAP_NV_INDEX        = 0x00000011,
  77         TPM_CAP_TRANS_ALG       = 0x00000012,
  78         TPM_CAP_HANDLE          = 0x00000014,
  79         TPM_CAP_TRANS_ES        = 0x00000015,
  80         TPM_CAP_AUTH_ENCRYPT    = 0x00000017,
  81         TPM_CAP_SELECT_SIZE     = 0x00000018,
  82         TPM_CAP_DA_LOGIC        = 0x00000019,
  83         TPM_CAP_VERSION_VAL     = 0x0000001A,
  84 };
  85
  86 #define TPM_NV_PER_GLOBALLOCK           (1U << 15)
  87 #define TPM_NV_PER_PPREAD               (1U << 16)
  88 #define TPM_NV_PER_PPWRITE              (1U << 0)
  89 #define TPM_NV_PER_READ_STCLEAR         (1U << 31)
  90 #define TPM_NV_PER_WRITE_STCLEAR        (1U << 14)
  91 #define TPM_NV_PER_WRITEDEFINE          (1U << 13)
  92 #define TPM_NV_PER_WRITEALL             (1U << 12)
  93
  94 enum {
  95         TPM_PUBEK_SIZE                  = 256,
  96 };
  97
  98 /**
  99  * TPM return codes as defined in the TCG Main specification
 100  * (TPM Main Part 2 Structures; Specification version 1.2)
 101  */
 102 enum tpm_return_code {
 103         TPM_BASE        = 0x00000000,
 104         TPM_NON_FATAL   = 0x00000800,
 105         TPM_SUCCESS     = TPM_BASE,
 106         /* TPM-defined fatal error codes */
 107         TPM_AUTHFAIL                    = TPM_BASE +  1,
 108         TPM_BADINDEX                    = TPM_BASE +  2,
 109         TPM_BAD_PARAMETER               = TPM_BASE +  3,
 110         TPM_AUDITFAILURE                = TPM_BASE +  4,
 111         TPM_CLEAR_DISABLED              = TPM_BASE +  5,
 112         TPM_DEACTIVATED                 = TPM_BASE +  6,
 113         TPM_DISABLED                    = TPM_BASE +  7,
 114         TPM_DISABLED_CMD                = TPM_BASE +  8,
 115         TPM_FAIL                        = TPM_BASE +  9,
 116         TPM_BAD_ORDINAL                 = TPM_BASE + 10,
 117         TPM_INSTALL_DISABLED            = TPM_BASE + 11,
 118         TPM_INVALID_KEYHANDLE           = TPM_BASE + 12,
 119         TPM_KEYNOTFOUND                 = TPM_BASE + 13,
 120         TPM_INAPPROPRIATE_ENC           = TPM_BASE + 14,
 121         TPM_MIGRATE_FAIL                = TPM_BASE + 15,
 122         TPM_INVALID_PCR_INFO            = TPM_BASE + 16,
 123         TPM_NOSPACE                     = TPM_BASE + 17,
 124         TPM_NOSRK                       = TPM_BASE + 18,
 125         TPM_NOTSEALED_BLOB              = TPM_BASE + 19,
 126         TPM_OWNER_SET                   = TPM_BASE + 20,
 127         TPM_RESOURCES                   = TPM_BASE + 21,
 128         TPM_SHORTRANDOM                 = TPM_BASE + 22,
 129         TPM_SIZE                        = TPM_BASE + 23,
 130         TPM_WRONGPCRVAL                 = TPM_BASE + 24,
 131         TPM_BAD_PARAM_SIZE              = TPM_BASE + 25,
 132         TPM_SHA_THREAD                  = TPM_BASE + 26,
 133         TPM_SHA_ERROR                   = TPM_BASE + 27,
 134         TPM_FAILEDSELFTEST              = TPM_BASE + 28,
 135         TPM_AUTH2FAIL                   = TPM_BASE + 29,
 136         TPM_BADTAG                      = TPM_BASE + 30,
 137         TPM_IOERROR                     = TPM_BASE + 31,
 138         TPM_ENCRYPT_ERROR               = TPM_BASE + 32,
 139         TPM_DECRYPT_ERROR               = TPM_BASE + 33,
 140         TPM_INVALID_AUTHHANDLE          = TPM_BASE + 34,
 141         TPM_NO_ENDORSEMENT              = TPM_BASE + 35,
 142         TPM_INVALID_KEYUSAGE            = TPM_BASE + 36,
 143         TPM_WRONG_ENTITYTYPE            = TPM_BASE + 37,
 144         TPM_INVALID_POSTINIT            = TPM_BASE + 38,
 145         TPM_INAPPROPRIATE_SIG           = TPM_BASE + 39,
 146         TPM_BAD_KEY_PROPERTY            = TPM_BASE + 40,
 147         TPM_BAD_MIGRATION               = TPM_BASE + 41,
 148         TPM_BAD_SCHEME                  = TPM_BASE + 42,
 149         TPM_BAD_DATASIZE                = TPM_BASE + 43,
 150         TPM_BAD_MODE                    = TPM_BASE + 44,
 151         TPM_BAD_PRESENCE                = TPM_BASE + 45,
 152         TPM_BAD_VERSION                 = TPM_BASE + 46,
 153         TPM_NO_WRAP_TRANSPORT           = TPM_BASE + 47,
 154         TPM_AUDITFAIL_UNSUCCESSFUL      = TPM_BASE + 48,
 155         TPM_AUDITFAIL_SUCCESSFUL        = TPM_BASE + 49,
 156         TPM_NOTRESETABLE                = TPM_BASE + 50,
 157         TPM_NOTLOCAL                    = TPM_BASE + 51,
 158         TPM_BAD_TYPE                    = TPM_BASE + 52,
 159         TPM_INVALID_RESOURCE            = TPM_BASE + 53,
 160         TPM_NOTFIPS                     = TPM_BASE + 54,
 161         TPM_INVALID_FAMILY              = TPM_BASE + 55,
 162         TPM_NO_NV_PERMISSION            = TPM_BASE + 56,
 163         TPM_REQUIRES_SIGN               = TPM_BASE + 57,
 164         TPM_KEY_NOTSUPPORTED            = TPM_BASE + 58,
 165         TPM_AUTH_CONFLICT               = TPM_BASE + 59,
 166         TPM_AREA_LOCKED                 = TPM_BASE + 60,
 167         TPM_BAD_LOCALITY                = TPM_BASE + 61,
 168         TPM_READ_ONLY                   = TPM_BASE + 62,
 169         TPM_PER_NOWRITE                 = TPM_BASE + 63,
 170         TPM_FAMILY_COUNT                = TPM_BASE + 64,
 171         TPM_WRITE_LOCKED                = TPM_BASE + 65,
 172         TPM_BAD_ATTRIBUTES              = TPM_BASE + 66,
 173         TPM_INVALID_STRUCTURE           = TPM_BASE + 67,
 174         TPM_KEY_OWNER_CONTROL           = TPM_BASE + 68,
 175         TPM_BAD_COUNTER                 = TPM_BASE + 69,
 176         TPM_NOT_FULLWRITE               = TPM_BASE + 70,
 177         TPM_CONTEXT_GAP                 = TPM_BASE + 71,
 178         TPM_MAXNVWRITES                 = TPM_BASE + 72,
 179         TPM_NOOPERATOR                  = TPM_BASE + 73,
 180         TPM_RESOURCEMISSING             = TPM_BASE + 74,
 181         TPM_DELEGATE_LOCK               = TPM_BASE + 75,
 182         TPM_DELEGATE_FAMILY             = TPM_BASE + 76,
 183         TPM_DELEGATE_ADMIN              = TPM_BASE + 77,
 184         TPM_TRANSPORT_NOTEXCLUSIVE      = TPM_BASE + 78,
 185         TPM_OWNER_CONTROL               = TPM_BASE + 79,
 186         TPM_DAA_RESOURCES               = TPM_BASE + 80,
 187         TPM_DAA_INPUT_DATA0             = TPM_BASE + 81,
 188         TPM_DAA_INPUT_DATA1             = TPM_BASE + 82,
 189         TPM_DAA_ISSUER_SETTINGS         = TPM_BASE + 83,
 190         TPM_DAA_TPM_SETTINGS            = TPM_BASE + 84,
 191         TPM_DAA_STAGE                   = TPM_BASE + 85,
 192         TPM_DAA_ISSUER_VALIDITY         = TPM_BASE + 86,
 193         TPM_DAA_WRONG_W                 = TPM_BASE + 87,
 194         TPM_BAD_HANDLE                  = TPM_BASE + 88,
 195         TPM_BAD_DELEGATE                = TPM_BASE + 89,
 196         TPM_BADCONTEXT                  = TPM_BASE + 90,
 197         TPM_TOOMANYCONTEXTS             = TPM_BASE + 91,
 198         TPM_MA_TICKET_SIGNATURE         = TPM_BASE + 92,
 199         TPM_MA_DESTINATION              = TPM_BASE + 93,
 200         TPM_MA_SOURCE                   = TPM_BASE + 94,
 201         TPM_MA_AUTHORITY                = TPM_BASE + 95,
 202         TPM_PERMANENTEK                 = TPM_BASE + 97,
 203         TPM_BAD_SIGNATURE               = TPM_BASE + 98,
 204         TPM_NOCONTEXTSPACE              = TPM_BASE + 99,
 205         /* TPM-defined non-fatal errors */
 206         TPM_RETRY               = TPM_BASE + TPM_NON_FATAL,
 207         TPM_NEEDS_SELFTEST      = TPM_BASE + TPM_NON_FATAL + 1,
 208         TPM_DOING_SELFTEST      = TPM_BASE + TPM_NON_FATAL + 2,
 209         TPM_DEFEND_LOCK_RUNNING = TPM_BASE + TPM_NON_FATAL + 3,
 210 };
 211
 212 struct tpm_permanent_flags {
 213         __be16  tag;
 214         u8      disable;
 215         u8      ownership;
 216         u8      deactivated;
 217         u8      read_pubek;
 218         u8      disable_owner_clear;
 219         u8      allow_maintenance;
 220         u8      physical_presence_lifetime_lock;
 221         u8      physical_presence_hw_enable;
 222         u8      physical_presence_cmd_enable;
 223         u8      cekp_used;
 224         u8      tpm_post;
 225         u8      tpm_post_lock;
 226         u8      fips;
 227         u8      operator;
 228         u8      enable_revoke_ek;
 229         u8      nv_locked;
 230         u8      read_srk_pub;
 231         u8      tpm_established;
 232         u8      maintenance_done;
 233         u8      disable_full_da_logic_info;
 234 } __packed;
 235
 236 /* Max buffer size supported by our tpm */
 237 #define TPM_DEV_BUFSIZE         1260
 238
 239 /**
 240  * struct tpm_chip_priv - Information about a TPM, stored by the uclass
 241  *
 242  * These values must be set up by the device's probe() method before
 243  * communcation is attempted. If the device has an xfer() method, this is
 244  * not needed. There is no need to set up @buf.
 245  *
 246  * @duration_ms:        Length of each duration type in milliseconds
 247  * @retry_time_ms:      Time to wait before retrying receive
 248  */
 249 struct tpm_chip_priv {
 250         uint duration_ms[TPM_DURATION_COUNT];
 251         uint retry_time_ms;
 252         u8 buf[TPM_DEV_BUFSIZE + sizeof(u8)];  /* Max buffer size + addr */
 253 };
 254
 255 /**
 256  * struct tpm_ops - low-level TPM operations
 257  *
 258  * These are designed to avoid loops and delays in the driver itself. These
 259  * should be handled in the uclass.
 260  *
 261  * In gneral you should implement everything except xfer(). Where you need
 262  * complete control of the transfer, then xfer() can be provided and will
 263  * override the other methods.
 264  *
 265  * This interface is for low-level TPM access. It does not understand the
 266  * concept of localities or the various TPM messages. That interface is
 267  * defined in the functions later on in this file, but they all translate
 268  * to bytes which are sent and received.
 269  */
 270 struct tpm_ops {
 271         /**
 272          * open() - Request access to locality 0 for the caller
 273          *
 274          * After all commands have been completed the caller should call
 275          * close().
 276          *
 277          * @dev:        Device to close
 278          * @return 0 ok OK, -ve on error
 279          */
 280         int (*open)(struct udevice *dev);
 281
 282         /**
 283          * close() - Close the current session
 284          *
 285          * Releasing the locked locality. Returns 0 on success, -ve 1 on
 286          * failure (in case lock removal did not succeed).
 287          *
 288          * @dev:        Device to close
 289          * @return 0 ok OK, -ve on error
 290          */
 291         int (*close)(struct udevice *dev);
 292
 293         /**
 294          * get_desc() - Get a text description of the TPM
 295          *
 296          * @dev:        Device to check
 297          * @buf:        Buffer to put the string
 298          * @size:       Maximum size of buffer
 299          * @return length of string, or -ENOSPC it no space
 300          */
 301         int (*get_desc)(struct udevice *dev, char *buf, int size);
 302
 303         /**
 304          * send() - send data to the TPM
 305          *
 306          * @dev:        Device to talk to
 307          * @sendbuf:    Buffer of the data to send
 308          * @send_size:  Size of the data to send
 309          *
 310          * Returns 0 on success or -ve on failure.
 311          */
 312         int (*send)(struct udevice *dev, const uint8_t *sendbuf,
 313                     size_t send_size);
 314
 315         /**
 316          * recv() - receive a response from the TPM
 317          *
 318          * @dev:        Device to talk to
 319          * @recvbuf:    Buffer to save the response to
 320          * @max_size:   Maximum number of bytes to receive
 321          *
 322          * Returns number of bytes received on success, -EAGAIN if the TPM
 323          * response is not ready, -EINTR if cancelled, or other -ve value on
 324          * failure.
 325          */
 326         int (*recv)(struct udevice *dev, uint8_t *recvbuf, size_t max_size);
 327
 328         /**
 329          * cleanup() - clean up after an operation in progress
 330          *
 331          * This is called if receiving times out. The TPM may need to abort
 332          * the current transaction if it did not complete, and make itself
 333          * ready for another.
 334          *
 335          * @dev:        Device to talk to
 336          */
 337         int (*cleanup)(struct udevice *dev);
 338
 339         /**
 340          * xfer() - send data to the TPM and get response
 341          *
 342          * This method is optional. If it exists it is used in preference
 343          * to send(), recv() and cleanup(). It should handle all aspects of
 344          * TPM communication for a single transfer.
 345          *
 346          * @dev:        Device to talk to
 347          * @sendbuf:    Buffer of the data to send
 348          * @send_size:  Size of the data to send
 349          * @recvbuf:    Buffer to save the response to
 350          * @recv_size:  Pointer to the size of the response buffer
 351          *
 352          * Returns 0 on success (and places the number of response bytes at
 353          * recv_size) or -ve on failure.
 354          */
 355         int (*xfer)(struct udevice *dev, const uint8_t *sendbuf,
 356                     size_t send_size, uint8_t *recvbuf, size_t *recv_size);
 357 };
 358
 359 #define tpm_get_ops(dev)        ((struct tpm_ops *)device_get_ops(dev))
 360
 361 /**
 362  * tpm_open() - Request access to locality 0 for the caller
 363  *
 364  * After all commands have been completed the caller is supposed to
 365  * call tpm_close().
 366  *
 367  * Returns 0 on success, -ve on failure.
 368  */
 369 int tpm_open(struct udevice *dev);
 370
 371 /**
 372  * tpm_close() - Close the current session
 373  *
 374  * Releasing the locked locality. Returns 0 on success, -ve 1 on
 375  * failure (in case lock removal did not succeed).
 376  */
 377 int tpm_close(struct udevice *dev);
 378
 379 /**
 380  * tpm_get_desc() - Get a text description of the TPM
 381  *
 382  * @dev:        Device to check
 383  * @buf:        Buffer to put the string
 384  * @size:       Maximum size of buffer
 385  * @return length of string, or -ENOSPC it no space
 386  */
 387 int tpm_get_desc(struct udevice *dev, char *buf, int size);
 388
 389 /**
 390  * tpm_xfer() - send data to the TPM and get response
 391  *
 392  * This first uses the device's send() method to send the bytes. Then it calls
 393  * recv() to get the reply. If recv() returns -EAGAIN then it will delay a
 394  * short time and then call recv() again.
 395  *
 396  * Regardless of whether recv() completes successfully, it will then call
 397  * cleanup() to finish the transaction.
 398  *
 399  * Note that the outgoing data is inspected to determine command type
 400  * (ordinal) and a timeout is used for that command type.
 401  *
 402  * @sendbuf - buffer of the data to send
 403  * @send_size size of the data to send
 404  * @recvbuf - memory to save the response to
 405  * @recv_len - pointer to the size of the response buffer
 406  *
 407  * Returns 0 on success (and places the number of response bytes at
 408  * recv_len) or -ve on failure.
 409  */
 410 int tpm_xfer(struct udevice *dev, const uint8_t *sendbuf, size_t send_size,
 411              uint8_t *recvbuf, size_t *recv_size);
 412
 413 /**
 414  * Initialize TPM device.  It must be called before any TPM commands.
 415  *
 416  * @return 0 on success, non-0 on error.
 417  */
 418 int tpm_init(void);
 419
 420 /**
 421  * Issue a TPM_Startup command.
 422  *
 423  * @param mode          TPM startup mode
 424  * @return return code of the operation
 425  */
 426 uint32_t tpm_startup(enum tpm_startup_type mode);
 427
 428 /**
 429  * Issue a TPM_SelfTestFull command.
 430  *
 431  * @return return code of the operation
 432  */
 433 uint32_t tpm_self_test_full(void);
 434
 435 /**
 436  * Issue a TPM_ContinueSelfTest command.
 437  *
 438  * @return return code of the operation
 439  */
 440 uint32_t tpm_continue_self_test(void);
 441
 442 /**
 443  * Issue a TPM_NV_DefineSpace command.  The implementation is limited
 444  * to specify TPM_NV_ATTRIBUTES and size of the area.  The area index
 445  * could be one of the special value listed in enum tpm_nv_index.
 446  *
 447  * @param index         index of the area
 448  * @param perm          TPM_NV_ATTRIBUTES of the area
 449  * @param size          size of the area
 450  * @return return code of the operation
 451  */
 452 uint32_t tpm_nv_define_space(uint32_t index, uint32_t perm, uint32_t size);
 453
 454 /**
 455  * Issue a TPM_NV_ReadValue command.  This implementation is limited
 456  * to read the area from offset 0.  The area index could be one of
 457  * the special value listed in enum tpm_nv_index.
 458  *
 459  * @param index         index of the area
 460  * @param data          output buffer of the area contents
 461  * @param count         size of output buffer
 462  * @return return code of the operation
 463  */
 464 uint32_t tpm_nv_read_value(uint32_t index, void *data, uint32_t count);
 465
 466 /**
 467  * Issue a TPM_NV_WriteValue command.  This implementation is limited
 468  * to write the area from offset 0.  The area index could be one of
 469  * the special value listed in enum tpm_nv_index.
 470  *
 471  * @param index         index of the area
 472  * @param data          input buffer to be wrote to the area
 473  * @param length        length of data bytes of input buffer
 474  * @return return code of the operation
 475  */
 476 uint32_t tpm_nv_write_value(uint32_t index, const void *data, uint32_t length);
 477
 478 /**
 479  * Issue a TPM_Extend command.
 480  *
 481  * @param index         index of the PCR
 482  * @param in_digest     160-bit value representing the event to be
 483  *                      recorded
 484  * @param out_digest    160-bit PCR value after execution of the
 485  *                      command
 486  * @return return code of the operation
 487  */
 488 uint32_t tpm_extend(uint32_t index, const void *in_digest, void *out_digest);
 489
 490 /**
 491  * Issue a TPM_PCRRead command.
 492  *
 493  * @param index         index of the PCR
 494  * @param data          output buffer for contents of the named PCR
 495  * @param count         size of output buffer
 496  * @return return code of the operation
 497  */
 498 uint32_t tpm_pcr_read(uint32_t index, void *data, size_t count);
 499
 500 /**
 501  * Issue a TSC_PhysicalPresence command.  TPM physical presence flag
 502  * is bit-wise OR'ed of flags listed in enum tpm_physical_presence.
 503  *
 504  * @param presence      TPM physical presence flag
 505  * @return return code of the operation
 506  */
 507 uint32_t tpm_tsc_physical_presence(uint16_t presence);
 508
 509 /**
 510  * Issue a TPM_ReadPubek command.
 511  *
 512  * @param data          output buffer for the public endorsement key
 513  * @param count         size of ouput buffer
 514  * @return return code of the operation
 515  */
 516 uint32_t tpm_read_pubek(void *data, size_t count);
 517
 518 /**
 519  * Issue a TPM_ForceClear command.
 520  *
 521  * @return return code of the operation
 522  */
 523 uint32_t tpm_force_clear(void);
 524
 525 /**
 526  * Issue a TPM_PhysicalEnable command.
 527  *
 528  * @return return code of the operation
 529  */
 530 uint32_t tpm_physical_enable(void);
 531
 532 /**
 533  * Issue a TPM_PhysicalDisable command.
 534  *
 535  * @return return code of the operation
 536  */
 537 uint32_t tpm_physical_disable(void);
 538
 539 /**
 540  * Issue a TPM_PhysicalSetDeactivated command.
 541  *
 542  * @param state         boolean state of the deactivated flag
 543  * @return return code of the operation
 544  */
 545 uint32_t tpm_physical_set_deactivated(uint8_t state);
 546
 547 /**
 548  * Issue a TPM_GetCapability command.  This implementation is limited
 549  * to query sub_cap index that is 4-byte wide.
 550  *
 551  * @param cap_area      partition of capabilities
 552  * @param sub_cap       further definition of capability, which is
 553  *                      limited to be 4-byte wide
 554  * @param cap           output buffer for capability information
 555  * @param count         size of ouput buffer
 556  * @return return code of the operation
 557  */
 558 uint32_t tpm_get_capability(uint32_t cap_area, uint32_t sub_cap,
 559                 void *cap, size_t count);
 560
 561 /**
 562  * Issue a TPM_FlushSpecific command for a AUTH ressource.
 563  *
 564  * @param auth_handle   handle of the auth session
 565  * @return return code of the operation
 566  */
 567 uint32_t tpm_terminate_auth_session(uint32_t auth_handle);
 568
 569 /**
 570  * Issue a TPM_OIAP command to setup an object independant authorization
 571  * session.
 572  * Information about the session is stored internally.
 573  * If there was already an OIAP session active it is terminated and a new
 574  * session is set up.
 575  *
 576  * @param auth_handle   pointer to the (new) auth handle or NULL.
 577  * @return return code of the operation
 578  */
 579 uint32_t tpm_oiap(uint32_t *auth_handle);
 580
 581 /**
 582  * Ends an active OIAP session.
 583  *
 584  * @return return code of the operation
 585  */
 586 uint32_t tpm_end_oiap(void);
 587
 588 /**
 589  * Issue a TPM_LoadKey2 (Auth1) command using an OIAP session for authenticating
 590  * the usage of the parent key.
 591  *
 592  * @param parent_handle handle of the parent key.
 593  * @param key           pointer to the key structure (TPM_KEY or TPM_KEY12).
 594  * @param key_length    size of the key structure
 595  * @param parent_key_usage_auth usage auth for the parent key
 596  * @param key_handle    pointer to the key handle
 597  * @return return code of the operation
 598  */
 599 uint32_t tpm_load_key2_oiap(uint32_t parent_handle,
 600                 const void *key, size_t key_length,
 601                 const void *parent_key_usage_auth,
 602                 uint32_t *key_handle);
 603
 604 /**
 605  * Issue a TPM_GetPubKey (Auth1) command using an OIAP session for
 606  * authenticating the usage of the key.
 607  *
 608  * @param key_handle    handle of the key
 609  * @param usage_auth    usage auth for the key
 610  * @param pubkey        pointer to the pub key buffer; may be NULL if the pubkey
 611  *                      should not be stored.
 612  * @param pubkey_len    pointer to the pub key buffer len. On entry: the size of
 613  *                      the provided pubkey buffer. On successful exit: the size
 614  *                      of the stored TPM_PUBKEY structure (iff pubkey != NULL).
 615  * @return return code of the operation
 616  */
 617 uint32_t tpm_get_pub_key_oiap(uint32_t key_handle, const void *usage_auth,
 618                 void *pubkey, size_t *pubkey_len);
 619
 620 /**
 621  * Get the TPM permanent flags value
 622  *
 623  * @param pflags        Place to put permanent flags
 624  * @return return code of the operation
 625  */
 626 uint32_t tpm_get_permanent_flags(struct tpm_permanent_flags *pflags);
 627
 628 /**
 629  * Get the TPM permissions
 630  *
 631  * @param perm          Returns permissions value
 632  * @return return code of the operation
 633  */
 634 uint32_t tpm_get_permissions(uint32_t index, uint32_t *perm);
 635
 636 /**
 637  * Flush a resource with a given handle and type from the TPM
 638  *
 639  * @param key_handle           handle of the resource
 640  * @param resource_type                type of the resource
 641  * @return return code of the operation
 642  */
 643 uint32_t tpm_flush_specific(uint32_t key_handle, uint32_t resource_type);
 644
 645 #ifdef CONFIG_TPM_LOAD_KEY_BY_SHA1
 646 /**
 647  * Search for a key by usage AuthData and the hash of the parent's pub key.
 648  *
 649  * @param auth          Usage auth of the key to search for
 650  * @param pubkey_digest SHA1 hash of the pub key structure of the key
 651  * @param[out] handle   The handle of the key (Non-null iff found)
 652  * @return 0 if key was found in TPM; != 0 if not.
 653  */
 654 uint32_t tpm_find_key_sha1(const uint8_t auth[20], const uint8_t
 655                            pubkey_digest[20], uint32_t *handle);
 656 #endif /* CONFIG_TPM_LOAD_KEY_BY_SHA1 */
 657
 658 /**
 659  * Read random bytes from the TPM RNG. The implementation deals with the fact
 660  * that the TPM may legally return fewer bytes than requested by retrying
 661  * until @p count bytes have been received.
 662  *
 663  * @param data          output buffer for the random bytes
 664  * @param count         size of output buffer
 665  * @return return code of the operation
 666  */
 667 uint32_t tpm_get_random(void *data, uint32_t count);
 668
 669 #endif /* __TPM_H */