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