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