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