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 #include <linux/module.h> 23 #include <linux/delay.h> 24 #include <linux/fs.h> 25 #include <linux/mutex.h> 26 #include <linux/sched.h> 27 #include <linux/platform_device.h> 28 #include <linux/io.h> 29 #include <linux/tpm.h> 30 #include <linux/acpi.h> 31 #include <linux/cdev.h> 32 #include <linux/highmem.h> 33 34 enum tpm_const { 35 TPM_MINOR = 224, /* officially assigned */ 36 TPM_BUFSIZE = 4096, 37 TPM_NUM_DEVICES = 256, 38 TPM_RETRY = 50, /* 5 seconds */ 39 }; 40 41 enum tpm_timeout { 42 TPM_TIMEOUT = 5, /* msecs */ 43 TPM_TIMEOUT_RETRY = 100 /* msecs */ 44 }; 45 46 /* TPM addresses */ 47 enum tpm_addr { 48 TPM_SUPERIO_ADDR = 0x2E, 49 TPM_ADDR = 0x4E, 50 }; 51 52 /* Indexes the duration array */ 53 enum tpm_duration { 54 TPM_SHORT = 0, 55 TPM_MEDIUM = 1, 56 TPM_LONG = 2, 57 TPM_UNDEFINED, 58 }; 59 60 #define TPM_WARN_RETRY 0x800 61 #define TPM_WARN_DOING_SELFTEST 0x802 62 #define TPM_ERR_DEACTIVATED 0x6 63 #define TPM_ERR_DISABLED 0x7 64 #define TPM_ERR_INVALID_POSTINIT 38 65 66 #define TPM_HEADER_SIZE 10 67 68 enum tpm2_const { 69 TPM2_PLATFORM_PCR = 24, 70 TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8), 71 TPM2_TIMEOUT_A = 750, 72 TPM2_TIMEOUT_B = 2000, 73 TPM2_TIMEOUT_C = 200, 74 TPM2_TIMEOUT_D = 30, 75 TPM2_DURATION_SHORT = 20, 76 TPM2_DURATION_MEDIUM = 750, 77 TPM2_DURATION_LONG = 2000, 78 }; 79 80 enum tpm2_structures { 81 TPM2_ST_NO_SESSIONS = 0x8001, 82 TPM2_ST_SESSIONS = 0x8002, 83 }; 84 85 enum tpm2_return_codes { 86 TPM2_RC_HASH = 0x0083, /* RC_FMT1 */ 87 TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */ 88 TPM2_RC_DISABLED = 0x0120, 89 TPM2_RC_TESTING = 0x090A, /* RC_WARN */ 90 }; 91 92 enum tpm2_algorithms { 93 TPM2_ALG_SHA1 = 0x0004, 94 TPM2_ALG_KEYEDHASH = 0x0008, 95 TPM2_ALG_SHA256 = 0x000B, 96 TPM2_ALG_SHA384 = 0x000C, 97 TPM2_ALG_SHA512 = 0x000D, 98 TPM2_ALG_NULL = 0x0010, 99 TPM2_ALG_SM3_256 = 0x0012, 100 }; 101 102 enum tpm2_command_codes { 103 TPM2_CC_FIRST = 0x011F, 104 TPM2_CC_SELF_TEST = 0x0143, 105 TPM2_CC_STARTUP = 0x0144, 106 TPM2_CC_SHUTDOWN = 0x0145, 107 TPM2_CC_CREATE = 0x0153, 108 TPM2_CC_LOAD = 0x0157, 109 TPM2_CC_UNSEAL = 0x015E, 110 TPM2_CC_FLUSH_CONTEXT = 0x0165, 111 TPM2_CC_GET_CAPABILITY = 0x017A, 112 TPM2_CC_GET_RANDOM = 0x017B, 113 TPM2_CC_PCR_READ = 0x017E, 114 TPM2_CC_PCR_EXTEND = 0x0182, 115 TPM2_CC_LAST = 0x018F, 116 }; 117 118 enum tpm2_permanent_handles { 119 TPM2_RS_PW = 0x40000009, 120 }; 121 122 enum tpm2_capabilities { 123 TPM2_CAP_TPM_PROPERTIES = 6, 124 }; 125 126 enum tpm2_startup_types { 127 TPM2_SU_CLEAR = 0x0000, 128 TPM2_SU_STATE = 0x0001, 129 }; 130 131 enum tpm2_start_method { 132 TPM2_START_ACPI = 2, 133 TPM2_START_FIFO = 6, 134 TPM2_START_CRB = 7, 135 TPM2_START_CRB_WITH_ACPI = 8, 136 }; 137 138 struct tpm_chip; 139 140 struct tpm_vendor_specific { 141 void __iomem *iobase; /* ioremapped address */ 142 unsigned long base; /* TPM base address */ 143 144 int irq; 145 146 int region_size; 147 int have_region; 148 149 struct list_head list; 150 int locality; 151 unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */ 152 bool timeout_adjusted; 153 unsigned long duration[3]; /* jiffies */ 154 bool duration_adjusted; 155 void *priv; 156 157 wait_queue_head_t read_queue; 158 wait_queue_head_t int_queue; 159 160 u16 manufacturer_id; 161 }; 162 163 #define TPM_VPRIV(c) ((c)->vendor.priv) 164 165 #define TPM_VID_INTEL 0x8086 166 #define TPM_VID_WINBOND 0x1050 167 #define TPM_VID_STM 0x104A 168 169 #define TPM_PPI_VERSION_LEN 3 170 171 enum tpm_chip_flags { 172 TPM_CHIP_FLAG_REGISTERED = BIT(0), 173 TPM_CHIP_FLAG_TPM2 = BIT(1), 174 }; 175 176 struct tpm_chip { 177 struct device *pdev; /* Device stuff */ 178 struct device dev; 179 struct cdev cdev; 180 181 const struct tpm_class_ops *ops; 182 unsigned int flags; 183 184 int dev_num; /* /dev/tpm# */ 185 char devname[7]; 186 unsigned long is_open; /* only one allowed */ 187 int time_expired; 188 189 struct mutex tpm_mutex; /* tpm is processing */ 190 191 struct tpm_vendor_specific vendor; 192 193 struct dentry **bios_dir; 194 195 #ifdef CONFIG_ACPI 196 const struct attribute_group *groups[2]; 197 unsigned int groups_cnt; 198 acpi_handle acpi_dev_handle; 199 char ppi_version[TPM_PPI_VERSION_LEN + 1]; 200 #endif /* CONFIG_ACPI */ 201 202 struct list_head list; 203 }; 204 205 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev) 206 207 static inline void tpm_chip_put(struct tpm_chip *chip) 208 { 209 module_put(chip->pdev->driver->owner); 210 } 211 212 static inline int tpm_read_index(int base, int index) 213 { 214 outb(index, base); 215 return inb(base+1) & 0xFF; 216 } 217 218 static inline void tpm_write_index(int base, int index, int value) 219 { 220 outb(index, base); 221 outb(value & 0xFF, base+1); 222 } 223 struct tpm_input_header { 224 __be16 tag; 225 __be32 length; 226 __be32 ordinal; 227 } __packed; 228 229 struct tpm_output_header { 230 __be16 tag; 231 __be32 length; 232 __be32 return_code; 233 } __packed; 234 235 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193) 236 237 struct stclear_flags_t { 238 __be16 tag; 239 u8 deactivated; 240 u8 disableForceClear; 241 u8 physicalPresence; 242 u8 physicalPresenceLock; 243 u8 bGlobalLock; 244 } __packed; 245 246 struct tpm_version_t { 247 u8 Major; 248 u8 Minor; 249 u8 revMajor; 250 u8 revMinor; 251 } __packed; 252 253 struct tpm_version_1_2_t { 254 __be16 tag; 255 u8 Major; 256 u8 Minor; 257 u8 revMajor; 258 u8 revMinor; 259 } __packed; 260 261 struct timeout_t { 262 __be32 a; 263 __be32 b; 264 __be32 c; 265 __be32 d; 266 } __packed; 267 268 struct duration_t { 269 __be32 tpm_short; 270 __be32 tpm_medium; 271 __be32 tpm_long; 272 } __packed; 273 274 struct permanent_flags_t { 275 __be16 tag; 276 u8 disable; 277 u8 ownership; 278 u8 deactivated; 279 u8 readPubek; 280 u8 disableOwnerClear; 281 u8 allowMaintenance; 282 u8 physicalPresenceLifetimeLock; 283 u8 physicalPresenceHWEnable; 284 u8 physicalPresenceCMDEnable; 285 u8 CEKPUsed; 286 u8 TPMpost; 287 u8 TPMpostLock; 288 u8 FIPS; 289 u8 operator; 290 u8 enableRevokeEK; 291 u8 nvLocked; 292 u8 readSRKPub; 293 u8 tpmEstablished; 294 u8 maintenanceDone; 295 u8 disableFullDALogicInfo; 296 } __packed; 297 298 typedef union { 299 struct permanent_flags_t perm_flags; 300 struct stclear_flags_t stclear_flags; 301 bool owned; 302 __be32 num_pcrs; 303 struct tpm_version_t tpm_version; 304 struct tpm_version_1_2_t tpm_version_1_2; 305 __be32 manufacturer_id; 306 struct timeout_t timeout; 307 struct duration_t duration; 308 } cap_t; 309 310 enum tpm_capabilities { 311 TPM_CAP_FLAG = cpu_to_be32(4), 312 TPM_CAP_PROP = cpu_to_be32(5), 313 CAP_VERSION_1_1 = cpu_to_be32(0x06), 314 CAP_VERSION_1_2 = cpu_to_be32(0x1A) 315 }; 316 317 enum tpm_sub_capabilities { 318 TPM_CAP_PROP_PCR = cpu_to_be32(0x101), 319 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103), 320 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108), 321 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109), 322 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111), 323 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115), 324 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120), 325 326 }; 327 328 struct tpm_getcap_params_in { 329 __be32 cap; 330 __be32 subcap_size; 331 __be32 subcap; 332 } __packed; 333 334 struct tpm_getcap_params_out { 335 __be32 cap_size; 336 cap_t cap; 337 } __packed; 338 339 struct tpm_readpubek_params_out { 340 u8 algorithm[4]; 341 u8 encscheme[2]; 342 u8 sigscheme[2]; 343 __be32 paramsize; 344 u8 parameters[12]; /*assuming RSA*/ 345 __be32 keysize; 346 u8 modulus[256]; 347 u8 checksum[20]; 348 } __packed; 349 350 typedef union { 351 struct tpm_input_header in; 352 struct tpm_output_header out; 353 } tpm_cmd_header; 354 355 struct tpm_pcrread_out { 356 u8 pcr_result[TPM_DIGEST_SIZE]; 357 } __packed; 358 359 struct tpm_pcrread_in { 360 __be32 pcr_idx; 361 } __packed; 362 363 struct tpm_pcrextend_in { 364 __be32 pcr_idx; 365 u8 hash[TPM_DIGEST_SIZE]; 366 } __packed; 367 368 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18 369 * bytes, but 128 is still a relatively large number of random bytes and 370 * anything much bigger causes users of struct tpm_cmd_t to start getting 371 * compiler warnings about stack frame size. */ 372 #define TPM_MAX_RNG_DATA 128 373 374 struct tpm_getrandom_out { 375 __be32 rng_data_len; 376 u8 rng_data[TPM_MAX_RNG_DATA]; 377 } __packed; 378 379 struct tpm_getrandom_in { 380 __be32 num_bytes; 381 } __packed; 382 383 struct tpm_startup_in { 384 __be16 startup_type; 385 } __packed; 386 387 typedef union { 388 struct tpm_getcap_params_out getcap_out; 389 struct tpm_readpubek_params_out readpubek_out; 390 u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)]; 391 struct tpm_getcap_params_in getcap_in; 392 struct tpm_pcrread_in pcrread_in; 393 struct tpm_pcrread_out pcrread_out; 394 struct tpm_pcrextend_in pcrextend_in; 395 struct tpm_getrandom_in getrandom_in; 396 struct tpm_getrandom_out getrandom_out; 397 struct tpm_startup_in startup_in; 398 } tpm_cmd_params; 399 400 struct tpm_cmd_t { 401 tpm_cmd_header header; 402 tpm_cmd_params params; 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 dev_t tpm_devt; 502 extern const struct file_operations tpm_fops; 503 504 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *); 505 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf, 506 size_t bufsiz); 507 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len, 508 const char *desc); 509 extern int tpm_get_timeouts(struct tpm_chip *); 510 extern void tpm_gen_interrupt(struct tpm_chip *); 511 extern int tpm_do_selftest(struct tpm_chip *); 512 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32); 513 extern int tpm_pm_suspend(struct device *); 514 extern int tpm_pm_resume(struct device *); 515 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long, 516 wait_queue_head_t *, bool); 517 518 struct tpm_chip *tpm_chip_find_get(int chip_num); 519 extern struct tpm_chip *tpmm_chip_alloc(struct device *dev, 520 const struct tpm_class_ops *ops); 521 extern int tpm_chip_register(struct tpm_chip *chip); 522 extern void tpm_chip_unregister(struct tpm_chip *chip); 523 524 int tpm_sysfs_add_device(struct tpm_chip *chip); 525 void tpm_sysfs_del_device(struct tpm_chip *chip); 526 527 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf); 528 529 #ifdef CONFIG_ACPI 530 extern void tpm_add_ppi(struct tpm_chip *chip); 531 #else 532 static inline void tpm_add_ppi(struct tpm_chip *chip) 533 { 534 } 535 #endif 536 537 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf); 538 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash); 539 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max); 540 int tpm2_seal_trusted(struct tpm_chip *chip, 541 struct trusted_key_payload *payload, 542 struct trusted_key_options *options); 543 int tpm2_unseal_trusted(struct tpm_chip *chip, 544 struct trusted_key_payload *payload, 545 struct trusted_key_options *options); 546 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id, 547 u32 *value, const char *desc); 548 549 extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type); 550 extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type); 551 extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32); 552 extern int tpm2_do_selftest(struct tpm_chip *chip); 553 extern int tpm2_gen_interrupt(struct tpm_chip *chip); 554 extern int tpm2_probe(struct tpm_chip *chip); 555