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