2 * Copyright (C) 2004 IBM Corporation
3 * Copyright (C) 2015 Intel Corporation
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>
11 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
13 * Device driver for TCG/TCPA TPM (trusted platform module).
14 * Specifications at www.trustedcomputinggroup.org
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
22 #include <linux/module.h>
23 #include <linux/delay.h>
25 #include <linux/mutex.h>
26 #include <linux/sched.h>
27 #include <linux/platform_device.h>
29 #include <linux/tpm.h>
30 #include <linux/acpi.h>
31 #include <linux/cdev.h>
32 #include <linux/highmem.h>
35 TPM_MINOR = 224, /* officially assigned */
37 TPM_NUM_DEVICES = 65536,
38 TPM_RETRY = 50, /* 5 seconds */
42 TPM_TIMEOUT = 5, /* msecs */
43 TPM_TIMEOUT_RETRY = 100 /* msecs */
48 TPM_SUPERIO_ADDR = 0x2E,
52 /* Indexes the duration array */
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
66 #define TPM_HEADER_SIZE 10
69 TPM2_PLATFORM_PCR = 24,
70 TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
72 TPM2_TIMEOUT_B = 2000,
75 TPM2_DURATION_SHORT = 20,
76 TPM2_DURATION_MEDIUM = 750,
77 TPM2_DURATION_LONG = 2000,
80 enum tpm2_structures {
81 TPM2_ST_NO_SESSIONS = 0x8001,
82 TPM2_ST_SESSIONS = 0x8002,
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 */
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,
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,
118 enum tpm2_permanent_handles {
119 TPM2_RS_PW = 0x40000009,
122 enum tpm2_capabilities {
123 TPM2_CAP_TPM_PROPERTIES = 6,
126 enum tpm2_startup_types {
127 TPM2_SU_CLEAR = 0x0000,
128 TPM2_SU_STATE = 0x0001,
133 struct tpm_vendor_specific {
135 unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
136 bool timeout_adjusted;
137 unsigned long duration[3]; /* jiffies */
138 bool duration_adjusted;
142 #define TPM_VPRIV(c) ((c)->vendor.priv)
144 #define TPM_VID_INTEL 0x8086
145 #define TPM_VID_WINBOND 0x1050
146 #define TPM_VID_STM 0x104A
148 #define TPM_PPI_VERSION_LEN 3
150 enum tpm_chip_flags {
151 TPM_CHIP_FLAG_REGISTERED = BIT(0),
152 TPM_CHIP_FLAG_TPM2 = BIT(1),
153 TPM_CHIP_FLAG_IRQ = BIT(2),
160 /* A driver callback under ops cannot be run unless ops_sem is held
161 * (sometimes implicitly, eg for the sysfs code). ops becomes null
162 * when the driver is unregistered, see tpm_try_get_ops.
164 struct rw_semaphore ops_sem;
165 const struct tpm_class_ops *ops;
169 int dev_num; /* /dev/tpm# */
170 unsigned long is_open; /* only one allowed */
172 struct mutex tpm_mutex; /* tpm is processing */
174 struct tpm_vendor_specific vendor;
176 struct dentry **bios_dir;
179 const struct attribute_group *groups[2];
180 unsigned int groups_cnt;
181 acpi_handle acpi_dev_handle;
182 char ppi_version[TPM_PPI_VERSION_LEN + 1];
183 #endif /* CONFIG_ACPI */
186 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
188 static inline int tpm_read_index(int base, int index)
191 return inb(base+1) & 0xFF;
194 static inline void tpm_write_index(int base, int index, int value)
197 outb(value & 0xFF, base+1);
199 struct tpm_input_header {
205 struct tpm_output_header {
211 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
213 struct stclear_flags_t {
216 u8 disableForceClear;
218 u8 physicalPresenceLock;
222 struct tpm_version_t {
229 struct tpm_version_1_2_t {
250 struct permanent_flags_t {
256 u8 disableOwnerClear;
258 u8 physicalPresenceLifetimeLock;
259 u8 physicalPresenceHWEnable;
260 u8 physicalPresenceCMDEnable;
271 u8 disableFullDALogicInfo;
275 struct permanent_flags_t perm_flags;
276 struct stclear_flags_t stclear_flags;
279 struct tpm_version_t tpm_version;
280 struct tpm_version_1_2_t tpm_version_1_2;
281 __be32 manufacturer_id;
282 struct timeout_t timeout;
283 struct duration_t duration;
286 enum tpm_capabilities {
287 TPM_CAP_FLAG = cpu_to_be32(4),
288 TPM_CAP_PROP = cpu_to_be32(5),
289 CAP_VERSION_1_1 = cpu_to_be32(0x06),
290 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
293 enum tpm_sub_capabilities {
294 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
295 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
296 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
297 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
298 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
299 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
300 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
304 struct tpm_getcap_params_in {
310 struct tpm_getcap_params_out {
315 struct tpm_readpubek_params_out {
320 u8 parameters[12]; /*assuming RSA*/
327 struct tpm_input_header in;
328 struct tpm_output_header out;
331 struct tpm_pcrread_out {
332 u8 pcr_result[TPM_DIGEST_SIZE];
335 struct tpm_pcrread_in {
339 struct tpm_pcrextend_in {
341 u8 hash[TPM_DIGEST_SIZE];
344 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
345 * bytes, but 128 is still a relatively large number of random bytes and
346 * anything much bigger causes users of struct tpm_cmd_t to start getting
347 * compiler warnings about stack frame size. */
348 #define TPM_MAX_RNG_DATA 128
350 struct tpm_getrandom_out {
352 u8 rng_data[TPM_MAX_RNG_DATA];
355 struct tpm_getrandom_in {
359 struct tpm_startup_in {
364 struct tpm_getcap_params_out getcap_out;
365 struct tpm_readpubek_params_out readpubek_out;
366 u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
367 struct tpm_getcap_params_in getcap_in;
368 struct tpm_pcrread_in pcrread_in;
369 struct tpm_pcrread_out pcrread_out;
370 struct tpm_pcrextend_in pcrextend_in;
371 struct tpm_getrandom_in getrandom_in;
372 struct tpm_getrandom_out getrandom_out;
373 struct tpm_startup_in startup_in;
377 tpm_cmd_header header;
378 tpm_cmd_params params;
381 /* A string buffer type for constructing TPM commands. This is based on the
382 * ideas of string buffer code in security/keys/trusted.h but is heap based
383 * in order to keep the stack usage minimal.
387 TPM_BUF_OVERFLOW = BIT(0),
391 struct page *data_page;
396 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
398 struct tpm_input_header *head;
400 buf->data_page = alloc_page(GFP_HIGHUSER);
405 buf->data = kmap(buf->data_page);
407 head = (struct tpm_input_header *) buf->data;
409 head->tag = cpu_to_be16(tag);
410 head->length = cpu_to_be32(sizeof(*head));
411 head->ordinal = cpu_to_be32(ordinal);
416 static inline void tpm_buf_destroy(struct tpm_buf *buf)
418 kunmap(buf->data_page);
419 __free_page(buf->data_page);
422 static inline u32 tpm_buf_length(struct tpm_buf *buf)
424 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
426 return be32_to_cpu(head->length);
429 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
431 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
433 return be16_to_cpu(head->tag);
436 static inline void tpm_buf_append(struct tpm_buf *buf,
437 const unsigned char *new_data,
438 unsigned int new_len)
440 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
441 u32 len = tpm_buf_length(buf);
443 /* Return silently if overflow has already happened. */
444 if (buf->flags & TPM_BUF_OVERFLOW)
447 if ((len + new_len) > PAGE_SIZE) {
448 WARN(1, "tpm_buf: overflow\n");
449 buf->flags |= TPM_BUF_OVERFLOW;
453 memcpy(&buf->data[len], new_data, new_len);
454 head->length = cpu_to_be32(len + new_len);
457 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
459 tpm_buf_append(buf, &value, 1);
462 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
464 __be16 value2 = cpu_to_be16(value);
466 tpm_buf_append(buf, (u8 *) &value2, 2);
469 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
471 __be32 value2 = cpu_to_be32(value);
473 tpm_buf_append(buf, (u8 *) &value2, 4);
476 extern struct class *tpm_class;
477 extern dev_t tpm_devt;
478 extern const struct file_operations tpm_fops;
479 extern struct idr dev_nums_idr;
481 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
482 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
484 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
486 extern int tpm_get_timeouts(struct tpm_chip *);
487 extern void tpm_gen_interrupt(struct tpm_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);
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);
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);
506 int tpm_sysfs_add_device(struct tpm_chip *chip);
507 void tpm_sysfs_del_device(struct tpm_chip *chip);
509 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
512 extern void tpm_add_ppi(struct tpm_chip *chip);
514 static inline void tpm_add_ppi(struct tpm_chip *chip)
519 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
520 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash);
521 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
522 int tpm2_seal_trusted(struct tpm_chip *chip,
523 struct trusted_key_payload *payload,
524 struct trusted_key_options *options);
525 int tpm2_unseal_trusted(struct tpm_chip *chip,
526 struct trusted_key_payload *payload,
527 struct trusted_key_options *options);
528 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
529 u32 *value, const char *desc);
531 extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type);
532 extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
533 extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32);
534 extern int tpm2_do_selftest(struct tpm_chip *chip);
535 extern int tpm2_gen_interrupt(struct tpm_chip *chip);
536 extern int tpm2_probe(struct tpm_chip *chip);