1 /* 2 * Copyright (C) 2004 IBM Corporation 3 * Copyright (C) 2015 Intel Corporation 4 * 5 * Authors: 6 * Leendert van Doorn <leendert@watson.ibm.com> 7 * Dave Safford <safford@watson.ibm.com> 8 * Reiner Sailer <sailer@watson.ibm.com> 9 * Kylene Hall <kjhall@us.ibm.com> 10 * 11 * Maintained by: <tpmdd-devel@lists.sourceforge.net> 12 * 13 * Device driver for TCG/TCPA TPM (trusted platform module). 14 * Specifications at www.trustedcomputinggroup.org 15 * 16 * This program is free software; you can redistribute it and/or 17 * modify it under the terms of the GNU General Public License as 18 * published by the Free Software Foundation, version 2 of the 19 * License. 20 * 21 */ 22 23 #ifndef __TPM_H__ 24 #define __TPM_H__ 25 26 #include <linux/module.h> 27 #include <linux/delay.h> 28 #include <linux/fs.h> 29 #include <linux/hw_random.h> 30 #include <linux/mutex.h> 31 #include <linux/sched.h> 32 #include <linux/platform_device.h> 33 #include <linux/io.h> 34 #include <linux/tpm.h> 35 #include <linux/acpi.h> 36 #include <linux/cdev.h> 37 #include <linux/highmem.h> 38 #include <linux/tpm_eventlog.h> 39 #include <crypto/hash_info.h> 40 41 #ifdef CONFIG_X86 42 #include <asm/intel-family.h> 43 #endif 44 45 enum tpm_const { 46 TPM_MINOR = 224, /* officially assigned */ 47 TPM_BUFSIZE = 4096, 48 TPM_NUM_DEVICES = 65536, 49 TPM_RETRY = 50, /* 5 seconds */ 50 TPM_NUM_EVENT_LOG_FILES = 3, 51 }; 52 53 enum tpm_timeout { 54 TPM_TIMEOUT = 5, /* msecs */ 55 TPM_TIMEOUT_RETRY = 100, /* msecs */ 56 TPM_TIMEOUT_RANGE_US = 300 /* usecs */ 57 }; 58 59 /* TPM addresses */ 60 enum tpm_addr { 61 TPM_SUPERIO_ADDR = 0x2E, 62 TPM_ADDR = 0x4E, 63 }; 64 65 /* Indexes the duration array */ 66 enum tpm_duration { 67 TPM_SHORT = 0, 68 TPM_MEDIUM = 1, 69 TPM_LONG = 2, 70 TPM_UNDEFINED, 71 }; 72 73 #define TPM_WARN_RETRY 0x800 74 #define TPM_WARN_DOING_SELFTEST 0x802 75 #define TPM_ERR_DEACTIVATED 0x6 76 #define TPM_ERR_DISABLED 0x7 77 #define TPM_ERR_INVALID_POSTINIT 38 78 79 #define TPM_HEADER_SIZE 10 80 81 enum tpm2_const { 82 TPM2_PLATFORM_PCR = 24, 83 TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8), 84 TPM2_TIMEOUT_A = 750, 85 TPM2_TIMEOUT_B = 2000, 86 TPM2_TIMEOUT_C = 200, 87 TPM2_TIMEOUT_D = 30, 88 TPM2_DURATION_SHORT = 20, 89 TPM2_DURATION_MEDIUM = 750, 90 TPM2_DURATION_LONG = 2000, 91 }; 92 93 enum tpm2_structures { 94 TPM2_ST_NO_SESSIONS = 0x8001, 95 TPM2_ST_SESSIONS = 0x8002, 96 }; 97 98 /* Indicates from what layer of the software stack the error comes from */ 99 #define TSS2_RC_LAYER_SHIFT 16 100 #define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT) 101 102 enum tpm2_return_codes { 103 TPM2_RC_SUCCESS = 0x0000, 104 TPM2_RC_HASH = 0x0083, /* RC_FMT1 */ 105 TPM2_RC_HANDLE = 0x008B, 106 TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */ 107 TPM2_RC_DISABLED = 0x0120, 108 TPM2_RC_COMMAND_CODE = 0x0143, 109 TPM2_RC_TESTING = 0x090A, /* RC_WARN */ 110 TPM2_RC_REFERENCE_H0 = 0x0910, 111 }; 112 113 enum tpm2_algorithms { 114 TPM2_ALG_ERROR = 0x0000, 115 TPM2_ALG_SHA1 = 0x0004, 116 TPM2_ALG_KEYEDHASH = 0x0008, 117 TPM2_ALG_SHA256 = 0x000B, 118 TPM2_ALG_SHA384 = 0x000C, 119 TPM2_ALG_SHA512 = 0x000D, 120 TPM2_ALG_NULL = 0x0010, 121 TPM2_ALG_SM3_256 = 0x0012, 122 }; 123 124 enum tpm2_command_codes { 125 TPM2_CC_FIRST = 0x011F, 126 TPM2_CC_SELF_TEST = 0x0143, 127 TPM2_CC_STARTUP = 0x0144, 128 TPM2_CC_SHUTDOWN = 0x0145, 129 TPM2_CC_CREATE = 0x0153, 130 TPM2_CC_LOAD = 0x0157, 131 TPM2_CC_UNSEAL = 0x015E, 132 TPM2_CC_CONTEXT_LOAD = 0x0161, 133 TPM2_CC_CONTEXT_SAVE = 0x0162, 134 TPM2_CC_FLUSH_CONTEXT = 0x0165, 135 TPM2_CC_GET_CAPABILITY = 0x017A, 136 TPM2_CC_GET_RANDOM = 0x017B, 137 TPM2_CC_PCR_READ = 0x017E, 138 TPM2_CC_PCR_EXTEND = 0x0182, 139 TPM2_CC_LAST = 0x018F, 140 }; 141 142 enum tpm2_permanent_handles { 143 TPM2_RS_PW = 0x40000009, 144 }; 145 146 enum tpm2_capabilities { 147 TPM2_CAP_HANDLES = 1, 148 TPM2_CAP_COMMANDS = 2, 149 TPM2_CAP_PCRS = 5, 150 TPM2_CAP_TPM_PROPERTIES = 6, 151 }; 152 153 enum tpm2_properties { 154 TPM_PT_TOTAL_COMMANDS = 0x0129, 155 }; 156 157 enum tpm2_startup_types { 158 TPM2_SU_CLEAR = 0x0000, 159 TPM2_SU_STATE = 0x0001, 160 }; 161 162 enum tpm2_cc_attrs { 163 TPM2_CC_ATTR_CHANDLES = 25, 164 TPM2_CC_ATTR_RHANDLE = 28, 165 }; 166 167 #define TPM_VID_INTEL 0x8086 168 #define TPM_VID_WINBOND 0x1050 169 #define TPM_VID_STM 0x104A 170 171 #define TPM_PPI_VERSION_LEN 3 172 173 struct tpm_space { 174 u32 context_tbl[3]; 175 u8 *context_buf; 176 u32 session_tbl[3]; 177 u8 *session_buf; 178 }; 179 180 enum tpm_chip_flags { 181 TPM_CHIP_FLAG_TPM2 = BIT(1), 182 TPM_CHIP_FLAG_IRQ = BIT(2), 183 TPM_CHIP_FLAG_VIRTUAL = BIT(3), 184 TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4), 185 TPM_CHIP_FLAG_ALWAYS_POWERED = BIT(5), 186 }; 187 188 struct tpm_bios_log { 189 void *bios_event_log; 190 void *bios_event_log_end; 191 }; 192 193 struct tpm_chip_seqops { 194 struct tpm_chip *chip; 195 const struct seq_operations *seqops; 196 }; 197 198 struct tpm_chip { 199 struct device dev; 200 struct device devs; 201 struct cdev cdev; 202 struct cdev cdevs; 203 204 /* A driver callback under ops cannot be run unless ops_sem is held 205 * (sometimes implicitly, eg for the sysfs code). ops becomes null 206 * when the driver is unregistered, see tpm_try_get_ops. 207 */ 208 struct rw_semaphore ops_sem; 209 const struct tpm_class_ops *ops; 210 211 struct tpm_bios_log log; 212 struct tpm_chip_seqops bin_log_seqops; 213 struct tpm_chip_seqops ascii_log_seqops; 214 215 unsigned int flags; 216 217 int dev_num; /* /dev/tpm# */ 218 unsigned long is_open; /* only one allowed */ 219 220 char hwrng_name[64]; 221 struct hwrng hwrng; 222 223 struct mutex tpm_mutex; /* tpm is processing */ 224 225 unsigned long timeout_a; /* jiffies */ 226 unsigned long timeout_b; /* jiffies */ 227 unsigned long timeout_c; /* jiffies */ 228 unsigned long timeout_d; /* jiffies */ 229 bool timeout_adjusted; 230 unsigned long duration[3]; /* jiffies */ 231 bool duration_adjusted; 232 233 struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES]; 234 235 const struct attribute_group *groups[3]; 236 unsigned int groups_cnt; 237 238 u16 active_banks[7]; 239 #ifdef CONFIG_ACPI 240 acpi_handle acpi_dev_handle; 241 char ppi_version[TPM_PPI_VERSION_LEN + 1]; 242 #endif /* CONFIG_ACPI */ 243 244 struct tpm_space work_space; 245 u32 nr_commands; 246 u32 *cc_attrs_tbl; 247 248 /* active locality */ 249 int locality; 250 }; 251 252 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev) 253 254 struct tpm_input_header { 255 __be16 tag; 256 __be32 length; 257 __be32 ordinal; 258 } __packed; 259 260 struct tpm_output_header { 261 __be16 tag; 262 __be32 length; 263 __be32 return_code; 264 } __packed; 265 266 #define TPM_TAG_RQU_COMMAND 193 267 268 struct stclear_flags_t { 269 __be16 tag; 270 u8 deactivated; 271 u8 disableForceClear; 272 u8 physicalPresence; 273 u8 physicalPresenceLock; 274 u8 bGlobalLock; 275 } __packed; 276 277 struct tpm_version_t { 278 u8 Major; 279 u8 Minor; 280 u8 revMajor; 281 u8 revMinor; 282 } __packed; 283 284 struct tpm_version_1_2_t { 285 __be16 tag; 286 u8 Major; 287 u8 Minor; 288 u8 revMajor; 289 u8 revMinor; 290 } __packed; 291 292 struct timeout_t { 293 __be32 a; 294 __be32 b; 295 __be32 c; 296 __be32 d; 297 } __packed; 298 299 struct duration_t { 300 __be32 tpm_short; 301 __be32 tpm_medium; 302 __be32 tpm_long; 303 } __packed; 304 305 struct permanent_flags_t { 306 __be16 tag; 307 u8 disable; 308 u8 ownership; 309 u8 deactivated; 310 u8 readPubek; 311 u8 disableOwnerClear; 312 u8 allowMaintenance; 313 u8 physicalPresenceLifetimeLock; 314 u8 physicalPresenceHWEnable; 315 u8 physicalPresenceCMDEnable; 316 u8 CEKPUsed; 317 u8 TPMpost; 318 u8 TPMpostLock; 319 u8 FIPS; 320 u8 operator; 321 u8 enableRevokeEK; 322 u8 nvLocked; 323 u8 readSRKPub; 324 u8 tpmEstablished; 325 u8 maintenanceDone; 326 u8 disableFullDALogicInfo; 327 } __packed; 328 329 typedef union { 330 struct permanent_flags_t perm_flags; 331 struct stclear_flags_t stclear_flags; 332 __u8 owned; 333 __be32 num_pcrs; 334 struct tpm_version_t tpm_version; 335 struct tpm_version_1_2_t tpm_version_1_2; 336 __be32 manufacturer_id; 337 struct timeout_t timeout; 338 struct duration_t duration; 339 } cap_t; 340 341 enum tpm_capabilities { 342 TPM_CAP_FLAG = 4, 343 TPM_CAP_PROP = 5, 344 TPM_CAP_VERSION_1_1 = 0x06, 345 TPM_CAP_VERSION_1_2 = 0x1A, 346 }; 347 348 enum tpm_sub_capabilities { 349 TPM_CAP_PROP_PCR = 0x101, 350 TPM_CAP_PROP_MANUFACTURER = 0x103, 351 TPM_CAP_FLAG_PERM = 0x108, 352 TPM_CAP_FLAG_VOL = 0x109, 353 TPM_CAP_PROP_OWNER = 0x111, 354 TPM_CAP_PROP_TIS_TIMEOUT = 0x115, 355 TPM_CAP_PROP_TIS_DURATION = 0x120, 356 }; 357 358 typedef union { 359 struct tpm_input_header in; 360 struct tpm_output_header out; 361 } tpm_cmd_header; 362 363 struct tpm_pcrread_out { 364 u8 pcr_result[TPM_DIGEST_SIZE]; 365 } __packed; 366 367 struct tpm_pcrread_in { 368 __be32 pcr_idx; 369 } __packed; 370 371 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18 372 * bytes, but 128 is still a relatively large number of random bytes and 373 * anything much bigger causes users of struct tpm_cmd_t to start getting 374 * compiler warnings about stack frame size. */ 375 #define TPM_MAX_RNG_DATA 128 376 377 struct tpm_getrandom_out { 378 __be32 rng_data_len; 379 u8 rng_data[TPM_MAX_RNG_DATA]; 380 } __packed; 381 382 struct tpm_getrandom_in { 383 __be32 num_bytes; 384 } __packed; 385 386 typedef union { 387 struct tpm_pcrread_in pcrread_in; 388 struct tpm_pcrread_out pcrread_out; 389 struct tpm_getrandom_in getrandom_in; 390 struct tpm_getrandom_out getrandom_out; 391 } tpm_cmd_params; 392 393 struct tpm_cmd_t { 394 tpm_cmd_header header; 395 tpm_cmd_params params; 396 } __packed; 397 398 399 /* A string buffer type for constructing TPM commands. This is based on the 400 * ideas of string buffer code in security/keys/trusted.h but is heap based 401 * in order to keep the stack usage minimal. 402 */ 403 404 enum tpm_buf_flags { 405 TPM_BUF_OVERFLOW = BIT(0), 406 }; 407 408 struct tpm_buf { 409 struct page *data_page; 410 unsigned int flags; 411 u8 *data; 412 }; 413 414 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal) 415 { 416 struct tpm_input_header *head; 417 418 buf->data_page = alloc_page(GFP_HIGHUSER); 419 if (!buf->data_page) 420 return -ENOMEM; 421 422 buf->flags = 0; 423 buf->data = kmap(buf->data_page); 424 425 head = (struct tpm_input_header *) buf->data; 426 427 head->tag = cpu_to_be16(tag); 428 head->length = cpu_to_be32(sizeof(*head)); 429 head->ordinal = cpu_to_be32(ordinal); 430 431 return 0; 432 } 433 434 static inline void tpm_buf_destroy(struct tpm_buf *buf) 435 { 436 kunmap(buf->data_page); 437 __free_page(buf->data_page); 438 } 439 440 static inline u32 tpm_buf_length(struct tpm_buf *buf) 441 { 442 struct tpm_input_header *head = (struct tpm_input_header *) buf->data; 443 444 return be32_to_cpu(head->length); 445 } 446 447 static inline u16 tpm_buf_tag(struct tpm_buf *buf) 448 { 449 struct tpm_input_header *head = (struct tpm_input_header *) buf->data; 450 451 return be16_to_cpu(head->tag); 452 } 453 454 static inline void tpm_buf_append(struct tpm_buf *buf, 455 const unsigned char *new_data, 456 unsigned int new_len) 457 { 458 struct tpm_input_header *head = (struct tpm_input_header *) buf->data; 459 u32 len = tpm_buf_length(buf); 460 461 /* Return silently if overflow has already happened. */ 462 if (buf->flags & TPM_BUF_OVERFLOW) 463 return; 464 465 if ((len + new_len) > PAGE_SIZE) { 466 WARN(1, "tpm_buf: overflow\n"); 467 buf->flags |= TPM_BUF_OVERFLOW; 468 return; 469 } 470 471 memcpy(&buf->data[len], new_data, new_len); 472 head->length = cpu_to_be32(len + new_len); 473 } 474 475 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value) 476 { 477 tpm_buf_append(buf, &value, 1); 478 } 479 480 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value) 481 { 482 __be16 value2 = cpu_to_be16(value); 483 484 tpm_buf_append(buf, (u8 *) &value2, 2); 485 } 486 487 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value) 488 { 489 __be32 value2 = cpu_to_be32(value); 490 491 tpm_buf_append(buf, (u8 *) &value2, 4); 492 } 493 494 extern struct class *tpm_class; 495 extern struct class *tpmrm_class; 496 extern dev_t tpm_devt; 497 extern const struct file_operations tpm_fops; 498 extern const struct file_operations tpmrm_fops; 499 extern struct idr dev_nums_idr; 500 501 enum tpm_transmit_flags { 502 TPM_TRANSMIT_UNLOCKED = BIT(0), 503 TPM_TRANSMIT_RAW = BIT(1), 504 }; 505 506 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space, 507 u8 *buf, size_t bufsiz, unsigned int flags); 508 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space, 509 const void *buf, size_t bufsiz, 510 size_t min_rsp_body_length, unsigned int flags, 511 const char *desc); 512 int tpm_startup(struct tpm_chip *chip); 513 ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap, 514 const char *desc, size_t min_cap_length); 515 int tpm_get_timeouts(struct tpm_chip *); 516 int tpm1_auto_startup(struct tpm_chip *chip); 517 int tpm_do_selftest(struct tpm_chip *chip); 518 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal); 519 int tpm_pm_suspend(struct device *dev); 520 int tpm_pm_resume(struct device *dev); 521 522 static inline void tpm_msleep(unsigned int delay_msec) 523 { 524 usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US, 525 delay_msec * 1000); 526 }; 527 528 struct tpm_chip *tpm_chip_find_get(struct tpm_chip *chip); 529 __must_check int tpm_try_get_ops(struct tpm_chip *chip); 530 void tpm_put_ops(struct tpm_chip *chip); 531 532 struct tpm_chip *tpm_chip_alloc(struct device *dev, 533 const struct tpm_class_ops *ops); 534 struct tpm_chip *tpmm_chip_alloc(struct device *pdev, 535 const struct tpm_class_ops *ops); 536 int tpm_chip_register(struct tpm_chip *chip); 537 void tpm_chip_unregister(struct tpm_chip *chip); 538 539 void tpm_sysfs_add_device(struct tpm_chip *chip); 540 541 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf); 542 543 #ifdef CONFIG_ACPI 544 extern void tpm_add_ppi(struct tpm_chip *chip); 545 #else 546 static inline void tpm_add_ppi(struct tpm_chip *chip) 547 { 548 } 549 #endif 550 551 static inline u32 tpm2_rc_value(u32 rc) 552 { 553 return (rc & BIT(7)) ? rc & 0xff : rc; 554 } 555 556 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf); 557 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, u32 count, 558 struct tpm2_digest *digests); 559 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max); 560 void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle, 561 unsigned int flags); 562 int tpm2_seal_trusted(struct tpm_chip *chip, 563 struct trusted_key_payload *payload, 564 struct trusted_key_options *options); 565 int tpm2_unseal_trusted(struct tpm_chip *chip, 566 struct trusted_key_payload *payload, 567 struct trusted_key_options *options); 568 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id, 569 u32 *value, const char *desc); 570 571 int tpm2_auto_startup(struct tpm_chip *chip); 572 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type); 573 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal); 574 int tpm2_probe(struct tpm_chip *chip); 575 int tpm2_find_cc(struct tpm_chip *chip, u32 cc); 576 int tpm2_init_space(struct tpm_space *space); 577 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space); 578 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u32 cc, 579 u8 *cmd); 580 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space, 581 u32 cc, u8 *buf, size_t *bufsiz); 582 583 extern const struct seq_operations tpm2_binary_b_measurements_seqops; 584 585 #if defined(CONFIG_ACPI) 586 int tpm_read_log_acpi(struct tpm_chip *chip); 587 #else 588 static inline int tpm_read_log_acpi(struct tpm_chip *chip) 589 { 590 return -ENODEV; 591 } 592 #endif 593 #if defined(CONFIG_OF) 594 int tpm_read_log_of(struct tpm_chip *chip); 595 #else 596 static inline int tpm_read_log_of(struct tpm_chip *chip) 597 { 598 return -ENODEV; 599 } 600 #endif 601 #if defined(CONFIG_EFI) 602 int tpm_read_log_efi(struct tpm_chip *chip); 603 #else 604 static inline int tpm_read_log_efi(struct tpm_chip *chip) 605 { 606 return -ENODEV; 607 } 608 #endif 609 610 int tpm_bios_log_setup(struct tpm_chip *chip); 611 void tpm_bios_log_teardown(struct tpm_chip *chip); 612 #endif 613