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_INITIALIZE = 0x0100, 87 TPM2_RC_TESTING = 0x090A, 88 TPM2_RC_DISABLED = 0x0120, 89 }; 90 91 enum tpm2_algorithms { 92 TPM2_ALG_SHA1 = 0x0004, 93 TPM2_ALG_KEYEDHASH = 0x0008, 94 TPM2_ALG_SHA256 = 0x000B, 95 TPM2_ALG_NULL = 0x0010 96 }; 97 98 enum tpm2_command_codes { 99 TPM2_CC_FIRST = 0x011F, 100 TPM2_CC_SELF_TEST = 0x0143, 101 TPM2_CC_STARTUP = 0x0144, 102 TPM2_CC_SHUTDOWN = 0x0145, 103 TPM2_CC_CREATE = 0x0153, 104 TPM2_CC_LOAD = 0x0157, 105 TPM2_CC_UNSEAL = 0x015E, 106 TPM2_CC_FLUSH_CONTEXT = 0x0165, 107 TPM2_CC_GET_CAPABILITY = 0x017A, 108 TPM2_CC_GET_RANDOM = 0x017B, 109 TPM2_CC_PCR_READ = 0x017E, 110 TPM2_CC_PCR_EXTEND = 0x0182, 111 TPM2_CC_LAST = 0x018F, 112 }; 113 114 enum tpm2_permanent_handles { 115 TPM2_RS_PW = 0x40000009, 116 }; 117 118 enum tpm2_capabilities { 119 TPM2_CAP_TPM_PROPERTIES = 6, 120 }; 121 122 enum tpm2_startup_types { 123 TPM2_SU_CLEAR = 0x0000, 124 TPM2_SU_STATE = 0x0001, 125 }; 126 127 enum tpm2_start_method { 128 TPM2_START_ACPI = 2, 129 TPM2_START_FIFO = 6, 130 TPM2_START_CRB = 7, 131 TPM2_START_CRB_WITH_ACPI = 8, 132 }; 133 134 struct tpm_chip; 135 136 struct tpm_vendor_specific { 137 void __iomem *iobase; /* ioremapped address */ 138 unsigned long base; /* TPM base address */ 139 140 int irq; 141 int probed_irq; 142 143 int region_size; 144 int have_region; 145 146 struct list_head list; 147 int locality; 148 unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */ 149 bool timeout_adjusted; 150 unsigned long duration[3]; /* jiffies */ 151 bool duration_adjusted; 152 void *priv; 153 154 wait_queue_head_t read_queue; 155 wait_queue_head_t int_queue; 156 157 u16 manufacturer_id; 158 }; 159 160 #define TPM_VPRIV(c) ((c)->vendor.priv) 161 162 #define TPM_VID_INTEL 0x8086 163 #define TPM_VID_WINBOND 0x1050 164 #define TPM_VID_STM 0x104A 165 166 #define TPM_PPI_VERSION_LEN 3 167 168 enum tpm_chip_flags { 169 TPM_CHIP_FLAG_REGISTERED = BIT(0), 170 TPM_CHIP_FLAG_TPM2 = BIT(1), 171 }; 172 173 struct tpm_chip { 174 struct device *pdev; /* Device stuff */ 175 struct device dev; 176 struct cdev cdev; 177 178 const struct tpm_class_ops *ops; 179 unsigned int flags; 180 181 int dev_num; /* /dev/tpm# */ 182 char devname[7]; 183 unsigned long is_open; /* only one allowed */ 184 int time_expired; 185 186 struct mutex tpm_mutex; /* tpm is processing */ 187 188 struct tpm_vendor_specific vendor; 189 190 struct dentry **bios_dir; 191 192 #ifdef CONFIG_ACPI 193 const struct attribute_group *groups[2]; 194 unsigned int groups_cnt; 195 acpi_handle acpi_dev_handle; 196 char ppi_version[TPM_PPI_VERSION_LEN + 1]; 197 #endif /* CONFIG_ACPI */ 198 199 struct list_head list; 200 }; 201 202 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev) 203 204 static inline void tpm_chip_put(struct tpm_chip *chip) 205 { 206 module_put(chip->pdev->driver->owner); 207 } 208 209 static inline int tpm_read_index(int base, int index) 210 { 211 outb(index, base); 212 return inb(base+1) & 0xFF; 213 } 214 215 static inline void tpm_write_index(int base, int index, int value) 216 { 217 outb(index, base); 218 outb(value & 0xFF, base+1); 219 } 220 struct tpm_input_header { 221 __be16 tag; 222 __be32 length; 223 __be32 ordinal; 224 } __packed; 225 226 struct tpm_output_header { 227 __be16 tag; 228 __be32 length; 229 __be32 return_code; 230 } __packed; 231 232 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193) 233 234 struct stclear_flags_t { 235 __be16 tag; 236 u8 deactivated; 237 u8 disableForceClear; 238 u8 physicalPresence; 239 u8 physicalPresenceLock; 240 u8 bGlobalLock; 241 } __packed; 242 243 struct tpm_version_t { 244 u8 Major; 245 u8 Minor; 246 u8 revMajor; 247 u8 revMinor; 248 } __packed; 249 250 struct tpm_version_1_2_t { 251 __be16 tag; 252 u8 Major; 253 u8 Minor; 254 u8 revMajor; 255 u8 revMinor; 256 } __packed; 257 258 struct timeout_t { 259 __be32 a; 260 __be32 b; 261 __be32 c; 262 __be32 d; 263 } __packed; 264 265 struct duration_t { 266 __be32 tpm_short; 267 __be32 tpm_medium; 268 __be32 tpm_long; 269 } __packed; 270 271 struct permanent_flags_t { 272 __be16 tag; 273 u8 disable; 274 u8 ownership; 275 u8 deactivated; 276 u8 readPubek; 277 u8 disableOwnerClear; 278 u8 allowMaintenance; 279 u8 physicalPresenceLifetimeLock; 280 u8 physicalPresenceHWEnable; 281 u8 physicalPresenceCMDEnable; 282 u8 CEKPUsed; 283 u8 TPMpost; 284 u8 TPMpostLock; 285 u8 FIPS; 286 u8 operator; 287 u8 enableRevokeEK; 288 u8 nvLocked; 289 u8 readSRKPub; 290 u8 tpmEstablished; 291 u8 maintenanceDone; 292 u8 disableFullDALogicInfo; 293 } __packed; 294 295 typedef union { 296 struct permanent_flags_t perm_flags; 297 struct stclear_flags_t stclear_flags; 298 bool owned; 299 __be32 num_pcrs; 300 struct tpm_version_t tpm_version; 301 struct tpm_version_1_2_t tpm_version_1_2; 302 __be32 manufacturer_id; 303 struct timeout_t timeout; 304 struct duration_t duration; 305 } cap_t; 306 307 enum tpm_capabilities { 308 TPM_CAP_FLAG = cpu_to_be32(4), 309 TPM_CAP_PROP = cpu_to_be32(5), 310 CAP_VERSION_1_1 = cpu_to_be32(0x06), 311 CAP_VERSION_1_2 = cpu_to_be32(0x1A) 312 }; 313 314 enum tpm_sub_capabilities { 315 TPM_CAP_PROP_PCR = cpu_to_be32(0x101), 316 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103), 317 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108), 318 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109), 319 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111), 320 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115), 321 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120), 322 323 }; 324 325 struct tpm_getcap_params_in { 326 __be32 cap; 327 __be32 subcap_size; 328 __be32 subcap; 329 } __packed; 330 331 struct tpm_getcap_params_out { 332 __be32 cap_size; 333 cap_t cap; 334 } __packed; 335 336 struct tpm_readpubek_params_out { 337 u8 algorithm[4]; 338 u8 encscheme[2]; 339 u8 sigscheme[2]; 340 __be32 paramsize; 341 u8 parameters[12]; /*assuming RSA*/ 342 __be32 keysize; 343 u8 modulus[256]; 344 u8 checksum[20]; 345 } __packed; 346 347 typedef union { 348 struct tpm_input_header in; 349 struct tpm_output_header out; 350 } tpm_cmd_header; 351 352 struct tpm_pcrread_out { 353 u8 pcr_result[TPM_DIGEST_SIZE]; 354 } __packed; 355 356 struct tpm_pcrread_in { 357 __be32 pcr_idx; 358 } __packed; 359 360 struct tpm_pcrextend_in { 361 __be32 pcr_idx; 362 u8 hash[TPM_DIGEST_SIZE]; 363 } __packed; 364 365 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18 366 * bytes, but 128 is still a relatively large number of random bytes and 367 * anything much bigger causes users of struct tpm_cmd_t to start getting 368 * compiler warnings about stack frame size. */ 369 #define TPM_MAX_RNG_DATA 128 370 371 struct tpm_getrandom_out { 372 __be32 rng_data_len; 373 u8 rng_data[TPM_MAX_RNG_DATA]; 374 } __packed; 375 376 struct tpm_getrandom_in { 377 __be32 num_bytes; 378 } __packed; 379 380 struct tpm_startup_in { 381 __be16 startup_type; 382 } __packed; 383 384 typedef union { 385 struct tpm_getcap_params_out getcap_out; 386 struct tpm_readpubek_params_out readpubek_out; 387 u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)]; 388 struct tpm_getcap_params_in getcap_in; 389 struct tpm_pcrread_in pcrread_in; 390 struct tpm_pcrread_out pcrread_out; 391 struct tpm_pcrextend_in pcrextend_in; 392 struct tpm_getrandom_in getrandom_in; 393 struct tpm_getrandom_out getrandom_out; 394 struct tpm_startup_in startup_in; 395 } tpm_cmd_params; 396 397 struct tpm_cmd_t { 398 tpm_cmd_header header; 399 tpm_cmd_params params; 400 } __packed; 401 402 /* A string buffer type for constructing TPM commands. This is based on the 403 * ideas of string buffer code in security/keys/trusted.h but is heap based 404 * in order to keep the stack usage minimal. 405 */ 406 407 enum tpm_buf_flags { 408 TPM_BUF_OVERFLOW = BIT(0), 409 }; 410 411 struct tpm_buf { 412 struct page *data_page; 413 unsigned int flags; 414 u8 *data; 415 }; 416 417 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal) 418 { 419 struct tpm_input_header *head; 420 421 buf->data_page = alloc_page(GFP_HIGHUSER); 422 if (!buf->data_page) 423 return -ENOMEM; 424 425 buf->flags = 0; 426 buf->data = kmap(buf->data_page); 427 428 head = (struct tpm_input_header *) buf->data; 429 430 head->tag = cpu_to_be16(tag); 431 head->length = cpu_to_be32(sizeof(*head)); 432 head->ordinal = cpu_to_be32(ordinal); 433 434 return 0; 435 } 436 437 static inline void tpm_buf_destroy(struct tpm_buf *buf) 438 { 439 kunmap(buf->data_page); 440 __free_page(buf->data_page); 441 } 442 443 static inline u32 tpm_buf_length(struct tpm_buf *buf) 444 { 445 struct tpm_input_header *head = (struct tpm_input_header *) buf->data; 446 447 return be32_to_cpu(head->length); 448 } 449 450 static inline u16 tpm_buf_tag(struct tpm_buf *buf) 451 { 452 struct tpm_input_header *head = (struct tpm_input_header *) buf->data; 453 454 return be16_to_cpu(head->tag); 455 } 456 457 static inline void tpm_buf_append(struct tpm_buf *buf, 458 const unsigned char *new_data, 459 unsigned int new_len) 460 { 461 struct tpm_input_header *head = (struct tpm_input_header *) buf->data; 462 u32 len = tpm_buf_length(buf); 463 464 /* Return silently if overflow has already happened. */ 465 if (buf->flags & TPM_BUF_OVERFLOW) 466 return; 467 468 if ((len + new_len) > PAGE_SIZE) { 469 WARN(1, "tpm_buf: overflow\n"); 470 buf->flags |= TPM_BUF_OVERFLOW; 471 return; 472 } 473 474 memcpy(&buf->data[len], new_data, new_len); 475 head->length = cpu_to_be32(len + new_len); 476 } 477 478 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value) 479 { 480 tpm_buf_append(buf, &value, 1); 481 } 482 483 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value) 484 { 485 __be16 value2 = cpu_to_be16(value); 486 487 tpm_buf_append(buf, (u8 *) &value2, 2); 488 } 489 490 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value) 491 { 492 __be32 value2 = cpu_to_be32(value); 493 494 tpm_buf_append(buf, (u8 *) &value2, 4); 495 } 496 497 extern struct class *tpm_class; 498 extern dev_t tpm_devt; 499 extern const struct file_operations tpm_fops; 500 501 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *); 502 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf, 503 size_t bufsiz); 504 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len, 505 const char *desc); 506 extern int tpm_get_timeouts(struct tpm_chip *); 507 extern void tpm_gen_interrupt(struct tpm_chip *); 508 extern int tpm_do_selftest(struct tpm_chip *); 509 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32); 510 extern int tpm_pm_suspend(struct device *); 511 extern int tpm_pm_resume(struct device *); 512 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long, 513 wait_queue_head_t *, bool); 514 515 struct tpm_chip *tpm_chip_find_get(int chip_num); 516 extern struct tpm_chip *tpmm_chip_alloc(struct device *dev, 517 const struct tpm_class_ops *ops); 518 extern int tpm_chip_register(struct tpm_chip *chip); 519 extern void tpm_chip_unregister(struct tpm_chip *chip); 520 521 int tpm_sysfs_add_device(struct tpm_chip *chip); 522 void tpm_sysfs_del_device(struct tpm_chip *chip); 523 524 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf); 525 526 #ifdef CONFIG_ACPI 527 extern void tpm_add_ppi(struct tpm_chip *chip); 528 #else 529 static inline void tpm_add_ppi(struct tpm_chip *chip) 530 { 531 } 532 #endif 533 534 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf); 535 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash); 536 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max); 537 int tpm2_seal_trusted(struct tpm_chip *chip, 538 struct trusted_key_payload *payload, 539 struct trusted_key_options *options); 540 int tpm2_unseal_trusted(struct tpm_chip *chip, 541 struct trusted_key_payload *payload, 542 struct trusted_key_options *options); 543 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id, 544 u32 *value, const char *desc); 545 546 extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type); 547 extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type); 548 extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32); 549 extern int tpm2_do_selftest(struct tpm_chip *chip); 550 extern int tpm2_gen_interrupt(struct tpm_chip *chip); 551 extern int tpm2_probe(struct tpm_chip *chip); 552