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