Revert: tpm_tis: Use timeouts returned from TPM
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / char / tpm / tpm.c
blobd5284bcb64a3197670d4e78d548cc4473b0422a1
1 /*
2 * Copyright (C) 2004 IBM Corporation
4 * Authors:
5 * Leendert van Doorn <leendert@watson.ibm.com>
6 * Dave Safford <safford@watson.ibm.com>
7 * Reiner Sailer <sailer@watson.ibm.com>
8 * Kylene Hall <kjhall@us.ibm.com>
10 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
12 * Device driver for TCG/TCPA TPM (trusted platform module).
13 * Specifications at www.trustedcomputinggroup.org
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License as
17 * published by the Free Software Foundation, version 2 of the
18 * License.
20 * Note, the TPM chip is not interrupt driven (only polling)
21 * and can have very long timeouts (minutes!). Hence the unusual
22 * calls to msleep.
26 #include <linux/poll.h>
27 #include <linux/slab.h>
28 #include <linux/mutex.h>
29 #include <linux/spinlock.h>
31 #include "tpm.h"
33 enum tpm_const {
34 TPM_MINOR = 224, /* officially assigned */
35 TPM_BUFSIZE = 4096,
36 TPM_NUM_DEVICES = 256,
39 enum tpm_duration {
40 TPM_SHORT = 0,
41 TPM_MEDIUM = 1,
42 TPM_LONG = 2,
43 TPM_UNDEFINED,
46 #define TPM_MAX_ORDINAL 243
47 #define TPM_MAX_PROTECTED_ORDINAL 12
48 #define TPM_PROTECTED_ORDINAL_MASK 0xFF
51 * Bug workaround - some TPM's don't flush the most
52 * recently changed pcr on suspend, so force the flush
53 * with an extend to the selected _unused_ non-volatile pcr.
55 static int tpm_suspend_pcr;
56 module_param_named(suspend_pcr, tpm_suspend_pcr, uint, 0644);
57 MODULE_PARM_DESC(suspend_pcr,
58 "PCR to use for dummy writes to faciltate flush on suspend.");
60 static LIST_HEAD(tpm_chip_list);
61 static DEFINE_SPINLOCK(driver_lock);
62 static DECLARE_BITMAP(dev_mask, TPM_NUM_DEVICES);
65 * Array with one entry per ordinal defining the maximum amount
66 * of time the chip could take to return the result. The ordinal
67 * designation of short, medium or long is defined in a table in
68 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
69 * values of the SHORT, MEDIUM, and LONG durations are retrieved
70 * from the chip during initialization with a call to tpm_get_timeouts.
72 static const u8 tpm_protected_ordinal_duration[TPM_MAX_PROTECTED_ORDINAL] = {
73 TPM_UNDEFINED, /* 0 */
74 TPM_UNDEFINED,
75 TPM_UNDEFINED,
76 TPM_UNDEFINED,
77 TPM_UNDEFINED,
78 TPM_UNDEFINED, /* 5 */
79 TPM_UNDEFINED,
80 TPM_UNDEFINED,
81 TPM_UNDEFINED,
82 TPM_UNDEFINED,
83 TPM_SHORT, /* 10 */
84 TPM_SHORT,
87 static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
88 TPM_UNDEFINED, /* 0 */
89 TPM_UNDEFINED,
90 TPM_UNDEFINED,
91 TPM_UNDEFINED,
92 TPM_UNDEFINED,
93 TPM_UNDEFINED, /* 5 */
94 TPM_UNDEFINED,
95 TPM_UNDEFINED,
96 TPM_UNDEFINED,
97 TPM_UNDEFINED,
98 TPM_SHORT, /* 10 */
99 TPM_SHORT,
100 TPM_MEDIUM,
101 TPM_LONG,
102 TPM_LONG,
103 TPM_MEDIUM, /* 15 */
104 TPM_SHORT,
105 TPM_SHORT,
106 TPM_MEDIUM,
107 TPM_LONG,
108 TPM_SHORT, /* 20 */
109 TPM_SHORT,
110 TPM_MEDIUM,
111 TPM_MEDIUM,
112 TPM_MEDIUM,
113 TPM_SHORT, /* 25 */
114 TPM_SHORT,
115 TPM_MEDIUM,
116 TPM_SHORT,
117 TPM_SHORT,
118 TPM_MEDIUM, /* 30 */
119 TPM_LONG,
120 TPM_MEDIUM,
121 TPM_SHORT,
122 TPM_SHORT,
123 TPM_SHORT, /* 35 */
124 TPM_MEDIUM,
125 TPM_MEDIUM,
126 TPM_UNDEFINED,
127 TPM_UNDEFINED,
128 TPM_MEDIUM, /* 40 */
129 TPM_LONG,
130 TPM_MEDIUM,
131 TPM_SHORT,
132 TPM_SHORT,
133 TPM_SHORT, /* 45 */
134 TPM_SHORT,
135 TPM_SHORT,
136 TPM_SHORT,
137 TPM_LONG,
138 TPM_MEDIUM, /* 50 */
139 TPM_MEDIUM,
140 TPM_UNDEFINED,
141 TPM_UNDEFINED,
142 TPM_UNDEFINED,
143 TPM_UNDEFINED, /* 55 */
144 TPM_UNDEFINED,
145 TPM_UNDEFINED,
146 TPM_UNDEFINED,
147 TPM_UNDEFINED,
148 TPM_MEDIUM, /* 60 */
149 TPM_MEDIUM,
150 TPM_MEDIUM,
151 TPM_SHORT,
152 TPM_SHORT,
153 TPM_MEDIUM, /* 65 */
154 TPM_UNDEFINED,
155 TPM_UNDEFINED,
156 TPM_UNDEFINED,
157 TPM_UNDEFINED,
158 TPM_SHORT, /* 70 */
159 TPM_SHORT,
160 TPM_UNDEFINED,
161 TPM_UNDEFINED,
162 TPM_UNDEFINED,
163 TPM_UNDEFINED, /* 75 */
164 TPM_UNDEFINED,
165 TPM_UNDEFINED,
166 TPM_UNDEFINED,
167 TPM_UNDEFINED,
168 TPM_LONG, /* 80 */
169 TPM_UNDEFINED,
170 TPM_MEDIUM,
171 TPM_LONG,
172 TPM_SHORT,
173 TPM_UNDEFINED, /* 85 */
174 TPM_UNDEFINED,
175 TPM_UNDEFINED,
176 TPM_UNDEFINED,
177 TPM_UNDEFINED,
178 TPM_SHORT, /* 90 */
179 TPM_SHORT,
180 TPM_SHORT,
181 TPM_SHORT,
182 TPM_SHORT,
183 TPM_UNDEFINED, /* 95 */
184 TPM_UNDEFINED,
185 TPM_UNDEFINED,
186 TPM_UNDEFINED,
187 TPM_UNDEFINED,
188 TPM_MEDIUM, /* 100 */
189 TPM_SHORT,
190 TPM_SHORT,
191 TPM_UNDEFINED,
192 TPM_UNDEFINED,
193 TPM_UNDEFINED, /* 105 */
194 TPM_UNDEFINED,
195 TPM_UNDEFINED,
196 TPM_UNDEFINED,
197 TPM_UNDEFINED,
198 TPM_SHORT, /* 110 */
199 TPM_SHORT,
200 TPM_SHORT,
201 TPM_SHORT,
202 TPM_SHORT,
203 TPM_SHORT, /* 115 */
204 TPM_SHORT,
205 TPM_SHORT,
206 TPM_UNDEFINED,
207 TPM_UNDEFINED,
208 TPM_LONG, /* 120 */
209 TPM_LONG,
210 TPM_MEDIUM,
211 TPM_UNDEFINED,
212 TPM_SHORT,
213 TPM_SHORT, /* 125 */
214 TPM_SHORT,
215 TPM_LONG,
216 TPM_SHORT,
217 TPM_SHORT,
218 TPM_SHORT, /* 130 */
219 TPM_MEDIUM,
220 TPM_UNDEFINED,
221 TPM_SHORT,
222 TPM_MEDIUM,
223 TPM_UNDEFINED, /* 135 */
224 TPM_UNDEFINED,
225 TPM_UNDEFINED,
226 TPM_UNDEFINED,
227 TPM_UNDEFINED,
228 TPM_SHORT, /* 140 */
229 TPM_SHORT,
230 TPM_UNDEFINED,
231 TPM_UNDEFINED,
232 TPM_UNDEFINED,
233 TPM_UNDEFINED, /* 145 */
234 TPM_UNDEFINED,
235 TPM_UNDEFINED,
236 TPM_UNDEFINED,
237 TPM_UNDEFINED,
238 TPM_SHORT, /* 150 */
239 TPM_MEDIUM,
240 TPM_MEDIUM,
241 TPM_SHORT,
242 TPM_SHORT,
243 TPM_UNDEFINED, /* 155 */
244 TPM_UNDEFINED,
245 TPM_UNDEFINED,
246 TPM_UNDEFINED,
247 TPM_UNDEFINED,
248 TPM_SHORT, /* 160 */
249 TPM_SHORT,
250 TPM_SHORT,
251 TPM_SHORT,
252 TPM_UNDEFINED,
253 TPM_UNDEFINED, /* 165 */
254 TPM_UNDEFINED,
255 TPM_UNDEFINED,
256 TPM_UNDEFINED,
257 TPM_UNDEFINED,
258 TPM_LONG, /* 170 */
259 TPM_UNDEFINED,
260 TPM_UNDEFINED,
261 TPM_UNDEFINED,
262 TPM_UNDEFINED,
263 TPM_UNDEFINED, /* 175 */
264 TPM_UNDEFINED,
265 TPM_UNDEFINED,
266 TPM_UNDEFINED,
267 TPM_UNDEFINED,
268 TPM_MEDIUM, /* 180 */
269 TPM_SHORT,
270 TPM_MEDIUM,
271 TPM_MEDIUM,
272 TPM_MEDIUM,
273 TPM_MEDIUM, /* 185 */
274 TPM_SHORT,
275 TPM_UNDEFINED,
276 TPM_UNDEFINED,
277 TPM_UNDEFINED,
278 TPM_UNDEFINED, /* 190 */
279 TPM_UNDEFINED,
280 TPM_UNDEFINED,
281 TPM_UNDEFINED,
282 TPM_UNDEFINED,
283 TPM_UNDEFINED, /* 195 */
284 TPM_UNDEFINED,
285 TPM_UNDEFINED,
286 TPM_UNDEFINED,
287 TPM_UNDEFINED,
288 TPM_SHORT, /* 200 */
289 TPM_UNDEFINED,
290 TPM_UNDEFINED,
291 TPM_UNDEFINED,
292 TPM_SHORT,
293 TPM_SHORT, /* 205 */
294 TPM_SHORT,
295 TPM_SHORT,
296 TPM_SHORT,
297 TPM_SHORT,
298 TPM_MEDIUM, /* 210 */
299 TPM_UNDEFINED,
300 TPM_MEDIUM,
301 TPM_MEDIUM,
302 TPM_MEDIUM,
303 TPM_UNDEFINED, /* 215 */
304 TPM_MEDIUM,
305 TPM_UNDEFINED,
306 TPM_UNDEFINED,
307 TPM_SHORT,
308 TPM_SHORT, /* 220 */
309 TPM_SHORT,
310 TPM_SHORT,
311 TPM_SHORT,
312 TPM_SHORT,
313 TPM_UNDEFINED, /* 225 */
314 TPM_UNDEFINED,
315 TPM_UNDEFINED,
316 TPM_UNDEFINED,
317 TPM_UNDEFINED,
318 TPM_SHORT, /* 230 */
319 TPM_LONG,
320 TPM_MEDIUM,
321 TPM_UNDEFINED,
322 TPM_UNDEFINED,
323 TPM_UNDEFINED, /* 235 */
324 TPM_UNDEFINED,
325 TPM_UNDEFINED,
326 TPM_UNDEFINED,
327 TPM_UNDEFINED,
328 TPM_SHORT, /* 240 */
329 TPM_UNDEFINED,
330 TPM_MEDIUM,
333 static void user_reader_timeout(unsigned long ptr)
335 struct tpm_chip *chip = (struct tpm_chip *) ptr;
337 schedule_work(&chip->work);
340 static void timeout_work(struct work_struct *work)
342 struct tpm_chip *chip = container_of(work, struct tpm_chip, work);
344 mutex_lock(&chip->buffer_mutex);
345 atomic_set(&chip->data_pending, 0);
346 memset(chip->data_buffer, 0, TPM_BUFSIZE);
347 mutex_unlock(&chip->buffer_mutex);
351 * Returns max number of jiffies to wait
353 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
354 u32 ordinal)
356 int duration_idx = TPM_UNDEFINED;
357 int duration = 0;
359 if (ordinal < TPM_MAX_ORDINAL)
360 duration_idx = tpm_ordinal_duration[ordinal];
361 else if ((ordinal & TPM_PROTECTED_ORDINAL_MASK) <
362 TPM_MAX_PROTECTED_ORDINAL)
363 duration_idx =
364 tpm_protected_ordinal_duration[ordinal &
365 TPM_PROTECTED_ORDINAL_MASK];
367 if (duration_idx != TPM_UNDEFINED) {
368 duration = chip->vendor.duration[duration_idx];
369 /* if duration is 0, it's because chip->vendor.duration wasn't */
370 /* filled yet, so we set the lowest timeout just to give enough */
371 /* time for tpm_get_timeouts() to succeed */
372 return (duration <= 0 ? HZ : duration);
373 } else
374 return 2 * 60 * HZ;
376 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
379 * Internal kernel interface to transmit TPM commands
381 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
382 size_t bufsiz)
384 ssize_t rc;
385 u32 count, ordinal;
386 unsigned long stop;
388 count = be32_to_cpu(*((__be32 *) (buf + 2)));
389 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
390 if (count == 0)
391 return -ENODATA;
392 if (count > bufsiz) {
393 dev_err(chip->dev,
394 "invalid count value %x %zx \n", count, bufsiz);
395 return -E2BIG;
398 mutex_lock(&chip->tpm_mutex);
400 if ((rc = chip->vendor.send(chip, (u8 *) buf, count)) < 0) {
401 dev_err(chip->dev,
402 "tpm_transmit: tpm_send: error %zd\n", rc);
403 goto out;
406 if (chip->vendor.irq)
407 goto out_recv;
409 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
410 do {
411 u8 status = chip->vendor.status(chip);
412 if ((status & chip->vendor.req_complete_mask) ==
413 chip->vendor.req_complete_val)
414 goto out_recv;
416 if ((status == chip->vendor.req_canceled)) {
417 dev_err(chip->dev, "Operation Canceled\n");
418 rc = -ECANCELED;
419 goto out;
422 msleep(TPM_TIMEOUT); /* CHECK */
423 rmb();
424 } while (time_before(jiffies, stop));
426 chip->vendor.cancel(chip);
427 dev_err(chip->dev, "Operation Timed out\n");
428 rc = -ETIME;
429 goto out;
431 out_recv:
432 rc = chip->vendor.recv(chip, (u8 *) buf, bufsiz);
433 if (rc < 0)
434 dev_err(chip->dev,
435 "tpm_transmit: tpm_recv: error %zd\n", rc);
436 out:
437 mutex_unlock(&chip->tpm_mutex);
438 return rc;
441 #define TPM_DIGEST_SIZE 20
442 #define TPM_ERROR_SIZE 10
443 #define TPM_RET_CODE_IDX 6
445 enum tpm_capabilities {
446 TPM_CAP_FLAG = cpu_to_be32(4),
447 TPM_CAP_PROP = cpu_to_be32(5),
448 CAP_VERSION_1_1 = cpu_to_be32(0x06),
449 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
452 enum tpm_sub_capabilities {
453 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
454 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
455 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
456 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
457 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
458 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
459 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
463 static ssize_t transmit_cmd(struct tpm_chip *chip, struct tpm_cmd_t *cmd,
464 int len, const char *desc)
466 int err;
468 len = tpm_transmit(chip,(u8 *) cmd, len);
469 if (len < 0)
470 return len;
471 if (len == TPM_ERROR_SIZE) {
472 err = be32_to_cpu(cmd->header.out.return_code);
473 dev_dbg(chip->dev, "A TPM error (%d) occurred %s\n", err, desc);
474 return err;
476 return 0;
479 #define TPM_INTERNAL_RESULT_SIZE 200
480 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
481 #define TPM_ORD_GET_CAP cpu_to_be32(101)
483 static const struct tpm_input_header tpm_getcap_header = {
484 .tag = TPM_TAG_RQU_COMMAND,
485 .length = cpu_to_be32(22),
486 .ordinal = TPM_ORD_GET_CAP
489 ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
490 const char *desc)
492 struct tpm_cmd_t tpm_cmd;
493 int rc;
494 struct tpm_chip *chip = dev_get_drvdata(dev);
496 tpm_cmd.header.in = tpm_getcap_header;
497 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
498 tpm_cmd.params.getcap_in.cap = subcap_id;
499 /*subcap field not necessary */
500 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
501 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
502 } else {
503 if (subcap_id == TPM_CAP_FLAG_PERM ||
504 subcap_id == TPM_CAP_FLAG_VOL)
505 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
506 else
507 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
508 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
509 tpm_cmd.params.getcap_in.subcap = subcap_id;
511 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
512 if (!rc)
513 *cap = tpm_cmd.params.getcap_out.cap;
514 return rc;
517 void tpm_gen_interrupt(struct tpm_chip *chip)
519 struct tpm_cmd_t tpm_cmd;
520 ssize_t rc;
522 tpm_cmd.header.in = tpm_getcap_header;
523 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
524 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
525 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
527 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
528 "attempting to determine the timeouts");
530 EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
532 void tpm_get_timeouts(struct tpm_chip *chip)
534 struct tpm_cmd_t tpm_cmd;
535 struct timeout_t *timeout_cap;
536 struct duration_t *duration_cap;
537 ssize_t rc;
538 u32 timeout;
540 tpm_cmd.header.in = tpm_getcap_header;
541 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
542 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
543 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
545 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
546 "attempting to determine the timeouts");
547 if (rc)
548 goto duration;
550 if (be32_to_cpu(tpm_cmd.header.out.length)
551 != 4 * sizeof(u32))
552 goto duration;
554 timeout_cap = &tpm_cmd.params.getcap_out.cap.timeout;
555 /* Don't overwrite default if value is 0 */
556 timeout = be32_to_cpu(timeout_cap->a);
557 if (timeout)
558 chip->vendor.timeout_a = usecs_to_jiffies(timeout);
559 timeout = be32_to_cpu(timeout_cap->b);
560 if (timeout)
561 chip->vendor.timeout_b = usecs_to_jiffies(timeout);
562 timeout = be32_to_cpu(timeout_cap->c);
563 if (timeout)
564 chip->vendor.timeout_c = usecs_to_jiffies(timeout);
565 timeout = be32_to_cpu(timeout_cap->d);
566 if (timeout)
567 chip->vendor.timeout_d = usecs_to_jiffies(timeout);
569 duration:
570 tpm_cmd.header.in = tpm_getcap_header;
571 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
572 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
573 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
575 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
576 "attempting to determine the durations");
577 if (rc)
578 return;
580 if (be32_to_cpu(tpm_cmd.header.out.return_code)
581 != 3 * sizeof(u32))
582 return;
583 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
584 chip->vendor.duration[TPM_SHORT] =
585 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
586 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
587 * value wrong and apparently reports msecs rather than usecs. So we
588 * fix up the resulting too-small TPM_SHORT value to make things work.
590 if (chip->vendor.duration[TPM_SHORT] < (HZ/100))
591 chip->vendor.duration[TPM_SHORT] = HZ;
593 chip->vendor.duration[TPM_MEDIUM] =
594 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
595 chip->vendor.duration[TPM_LONG] =
596 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
598 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
600 void tpm_continue_selftest(struct tpm_chip *chip)
602 u8 data[] = {
603 0, 193, /* TPM_TAG_RQU_COMMAND */
604 0, 0, 0, 10, /* length */
605 0, 0, 0, 83, /* TPM_ORD_GetCapability */
608 tpm_transmit(chip, data, sizeof(data));
610 EXPORT_SYMBOL_GPL(tpm_continue_selftest);
612 ssize_t tpm_show_enabled(struct device * dev, struct device_attribute * attr,
613 char *buf)
615 cap_t cap;
616 ssize_t rc;
618 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
619 "attempting to determine the permanent enabled state");
620 if (rc)
621 return 0;
623 rc = sprintf(buf, "%d\n", !cap.perm_flags.disable);
624 return rc;
626 EXPORT_SYMBOL_GPL(tpm_show_enabled);
628 ssize_t tpm_show_active(struct device * dev, struct device_attribute * attr,
629 char *buf)
631 cap_t cap;
632 ssize_t rc;
634 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
635 "attempting to determine the permanent active state");
636 if (rc)
637 return 0;
639 rc = sprintf(buf, "%d\n", !cap.perm_flags.deactivated);
640 return rc;
642 EXPORT_SYMBOL_GPL(tpm_show_active);
644 ssize_t tpm_show_owned(struct device * dev, struct device_attribute * attr,
645 char *buf)
647 cap_t cap;
648 ssize_t rc;
650 rc = tpm_getcap(dev, TPM_CAP_PROP_OWNER, &cap,
651 "attempting to determine the owner state");
652 if (rc)
653 return 0;
655 rc = sprintf(buf, "%d\n", cap.owned);
656 return rc;
658 EXPORT_SYMBOL_GPL(tpm_show_owned);
660 ssize_t tpm_show_temp_deactivated(struct device * dev,
661 struct device_attribute * attr, char *buf)
663 cap_t cap;
664 ssize_t rc;
666 rc = tpm_getcap(dev, TPM_CAP_FLAG_VOL, &cap,
667 "attempting to determine the temporary state");
668 if (rc)
669 return 0;
671 rc = sprintf(buf, "%d\n", cap.stclear_flags.deactivated);
672 return rc;
674 EXPORT_SYMBOL_GPL(tpm_show_temp_deactivated);
677 * tpm_chip_find_get - return tpm_chip for given chip number
679 static struct tpm_chip *tpm_chip_find_get(int chip_num)
681 struct tpm_chip *pos, *chip = NULL;
683 rcu_read_lock();
684 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
685 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
686 continue;
688 if (try_module_get(pos->dev->driver->owner)) {
689 chip = pos;
690 break;
693 rcu_read_unlock();
694 return chip;
697 #define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
698 #define READ_PCR_RESULT_SIZE 30
699 static struct tpm_input_header pcrread_header = {
700 .tag = TPM_TAG_RQU_COMMAND,
701 .length = cpu_to_be32(14),
702 .ordinal = TPM_ORDINAL_PCRREAD
705 int __tpm_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
707 int rc;
708 struct tpm_cmd_t cmd;
710 cmd.header.in = pcrread_header;
711 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
712 rc = transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
713 "attempting to read a pcr value");
715 if (rc == 0)
716 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
717 TPM_DIGEST_SIZE);
718 return rc;
722 * tpm_pcr_read - read a pcr value
723 * @chip_num: tpm idx # or ANY
724 * @pcr_idx: pcr idx to retrieve
725 * @res_buf: TPM_PCR value
726 * size of res_buf is 20 bytes (or NULL if you don't care)
728 * The TPM driver should be built-in, but for whatever reason it
729 * isn't, protect against the chip disappearing, by incrementing
730 * the module usage count.
732 int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
734 struct tpm_chip *chip;
735 int rc;
737 chip = tpm_chip_find_get(chip_num);
738 if (chip == NULL)
739 return -ENODEV;
740 rc = __tpm_pcr_read(chip, pcr_idx, res_buf);
741 module_put(chip->dev->driver->owner);
742 return rc;
744 EXPORT_SYMBOL_GPL(tpm_pcr_read);
747 * tpm_pcr_extend - extend pcr value with hash
748 * @chip_num: tpm idx # or AN&
749 * @pcr_idx: pcr idx to extend
750 * @hash: hash value used to extend pcr value
752 * The TPM driver should be built-in, but for whatever reason it
753 * isn't, protect against the chip disappearing, by incrementing
754 * the module usage count.
756 #define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
757 #define EXTEND_PCR_RESULT_SIZE 34
758 static struct tpm_input_header pcrextend_header = {
759 .tag = TPM_TAG_RQU_COMMAND,
760 .length = cpu_to_be32(34),
761 .ordinal = TPM_ORD_PCR_EXTEND
764 int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
766 struct tpm_cmd_t cmd;
767 int rc;
768 struct tpm_chip *chip;
770 chip = tpm_chip_find_get(chip_num);
771 if (chip == NULL)
772 return -ENODEV;
774 cmd.header.in = pcrextend_header;
775 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
776 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
777 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
778 "attempting extend a PCR value");
780 module_put(chip->dev->driver->owner);
781 return rc;
783 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
785 ssize_t tpm_show_pcrs(struct device *dev, struct device_attribute *attr,
786 char *buf)
788 cap_t cap;
789 u8 digest[TPM_DIGEST_SIZE];
790 ssize_t rc;
791 int i, j, num_pcrs;
792 char *str = buf;
793 struct tpm_chip *chip = dev_get_drvdata(dev);
795 rc = tpm_getcap(dev, TPM_CAP_PROP_PCR, &cap,
796 "attempting to determine the number of PCRS");
797 if (rc)
798 return 0;
800 num_pcrs = be32_to_cpu(cap.num_pcrs);
801 for (i = 0; i < num_pcrs; i++) {
802 rc = __tpm_pcr_read(chip, i, digest);
803 if (rc)
804 break;
805 str += sprintf(str, "PCR-%02d: ", i);
806 for (j = 0; j < TPM_DIGEST_SIZE; j++)
807 str += sprintf(str, "%02X ", digest[j]);
808 str += sprintf(str, "\n");
810 return str - buf;
812 EXPORT_SYMBOL_GPL(tpm_show_pcrs);
814 #define READ_PUBEK_RESULT_SIZE 314
815 #define TPM_ORD_READPUBEK cpu_to_be32(124)
816 struct tpm_input_header tpm_readpubek_header = {
817 .tag = TPM_TAG_RQU_COMMAND,
818 .length = cpu_to_be32(30),
819 .ordinal = TPM_ORD_READPUBEK
822 ssize_t tpm_show_pubek(struct device *dev, struct device_attribute *attr,
823 char *buf)
825 u8 *data;
826 struct tpm_cmd_t tpm_cmd;
827 ssize_t err;
828 int i, rc;
829 char *str = buf;
831 struct tpm_chip *chip = dev_get_drvdata(dev);
833 tpm_cmd.header.in = tpm_readpubek_header;
834 err = transmit_cmd(chip, &tpm_cmd, READ_PUBEK_RESULT_SIZE,
835 "attempting to read the PUBEK");
836 if (err)
837 goto out;
840 ignore header 10 bytes
841 algorithm 32 bits (1 == RSA )
842 encscheme 16 bits
843 sigscheme 16 bits
844 parameters (RSA 12->bytes: keybit, #primes, expbit)
845 keylenbytes 32 bits
846 256 byte modulus
847 ignore checksum 20 bytes
849 data = tpm_cmd.params.readpubek_out_buffer;
850 str +=
851 sprintf(str,
852 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
853 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
854 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
855 "Modulus length: %d\nModulus: \n",
856 data[10], data[11], data[12], data[13], data[14],
857 data[15], data[16], data[17], data[22], data[23],
858 data[24], data[25], data[26], data[27], data[28],
859 data[29], data[30], data[31], data[32], data[33],
860 be32_to_cpu(*((__be32 *) (data + 34))));
862 for (i = 0; i < 256; i++) {
863 str += sprintf(str, "%02X ", data[i + 38]);
864 if ((i + 1) % 16 == 0)
865 str += sprintf(str, "\n");
867 out:
868 rc = str - buf;
869 return rc;
871 EXPORT_SYMBOL_GPL(tpm_show_pubek);
874 ssize_t tpm_show_caps(struct device *dev, struct device_attribute *attr,
875 char *buf)
877 cap_t cap;
878 ssize_t rc;
879 char *str = buf;
881 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
882 "attempting to determine the manufacturer");
883 if (rc)
884 return 0;
885 str += sprintf(str, "Manufacturer: 0x%x\n",
886 be32_to_cpu(cap.manufacturer_id));
888 rc = tpm_getcap(dev, CAP_VERSION_1_1, &cap,
889 "attempting to determine the 1.1 version");
890 if (rc)
891 return 0;
892 str += sprintf(str,
893 "TCG version: %d.%d\nFirmware version: %d.%d\n",
894 cap.tpm_version.Major, cap.tpm_version.Minor,
895 cap.tpm_version.revMajor, cap.tpm_version.revMinor);
896 return str - buf;
898 EXPORT_SYMBOL_GPL(tpm_show_caps);
900 ssize_t tpm_show_caps_1_2(struct device * dev,
901 struct device_attribute * attr, char *buf)
903 cap_t cap;
904 ssize_t rc;
905 char *str = buf;
907 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
908 "attempting to determine the manufacturer");
909 if (rc)
910 return 0;
911 str += sprintf(str, "Manufacturer: 0x%x\n",
912 be32_to_cpu(cap.manufacturer_id));
913 rc = tpm_getcap(dev, CAP_VERSION_1_2, &cap,
914 "attempting to determine the 1.2 version");
915 if (rc)
916 return 0;
917 str += sprintf(str,
918 "TCG version: %d.%d\nFirmware version: %d.%d\n",
919 cap.tpm_version_1_2.Major, cap.tpm_version_1_2.Minor,
920 cap.tpm_version_1_2.revMajor,
921 cap.tpm_version_1_2.revMinor);
922 return str - buf;
924 EXPORT_SYMBOL_GPL(tpm_show_caps_1_2);
926 ssize_t tpm_store_cancel(struct device *dev, struct device_attribute *attr,
927 const char *buf, size_t count)
929 struct tpm_chip *chip = dev_get_drvdata(dev);
930 if (chip == NULL)
931 return 0;
933 chip->vendor.cancel(chip);
934 return count;
936 EXPORT_SYMBOL_GPL(tpm_store_cancel);
939 * Device file system interface to the TPM
941 * It's assured that the chip will be opened just once,
942 * by the check of is_open variable, which is protected
943 * by driver_lock.
945 int tpm_open(struct inode *inode, struct file *file)
947 int minor = iminor(inode);
948 struct tpm_chip *chip = NULL, *pos;
950 rcu_read_lock();
951 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
952 if (pos->vendor.miscdev.minor == minor) {
953 chip = pos;
954 get_device(chip->dev);
955 break;
958 rcu_read_unlock();
960 if (!chip)
961 return -ENODEV;
963 if (test_and_set_bit(0, &chip->is_open)) {
964 dev_dbg(chip->dev, "Another process owns this TPM\n");
965 put_device(chip->dev);
966 return -EBUSY;
969 chip->data_buffer = kmalloc(TPM_BUFSIZE * sizeof(u8), GFP_KERNEL);
970 if (chip->data_buffer == NULL) {
971 clear_bit(0, &chip->is_open);
972 put_device(chip->dev);
973 return -ENOMEM;
976 atomic_set(&chip->data_pending, 0);
978 file->private_data = chip;
979 return 0;
981 EXPORT_SYMBOL_GPL(tpm_open);
984 * Called on file close
986 int tpm_release(struct inode *inode, struct file *file)
988 struct tpm_chip *chip = file->private_data;
990 del_singleshot_timer_sync(&chip->user_read_timer);
991 flush_scheduled_work();
992 file->private_data = NULL;
993 atomic_set(&chip->data_pending, 0);
994 kfree(chip->data_buffer);
995 clear_bit(0, &chip->is_open);
996 put_device(chip->dev);
997 return 0;
999 EXPORT_SYMBOL_GPL(tpm_release);
1001 ssize_t tpm_write(struct file *file, const char __user *buf,
1002 size_t size, loff_t *off)
1004 struct tpm_chip *chip = file->private_data;
1005 size_t in_size = size, out_size;
1007 /* cannot perform a write until the read has cleared
1008 either via tpm_read or a user_read_timer timeout */
1009 while (atomic_read(&chip->data_pending) != 0)
1010 msleep(TPM_TIMEOUT);
1012 mutex_lock(&chip->buffer_mutex);
1014 if (in_size > TPM_BUFSIZE)
1015 in_size = TPM_BUFSIZE;
1017 if (copy_from_user
1018 (chip->data_buffer, (void __user *) buf, in_size)) {
1019 mutex_unlock(&chip->buffer_mutex);
1020 return -EFAULT;
1023 /* atomic tpm command send and result receive */
1024 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
1026 atomic_set(&chip->data_pending, out_size);
1027 mutex_unlock(&chip->buffer_mutex);
1029 /* Set a timeout by which the reader must come claim the result */
1030 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
1032 return in_size;
1034 EXPORT_SYMBOL_GPL(tpm_write);
1036 ssize_t tpm_read(struct file *file, char __user *buf,
1037 size_t size, loff_t *off)
1039 struct tpm_chip *chip = file->private_data;
1040 ssize_t ret_size;
1042 del_singleshot_timer_sync(&chip->user_read_timer);
1043 flush_scheduled_work();
1044 ret_size = atomic_read(&chip->data_pending);
1045 atomic_set(&chip->data_pending, 0);
1046 if (ret_size > 0) { /* relay data */
1047 if (size < ret_size)
1048 ret_size = size;
1050 mutex_lock(&chip->buffer_mutex);
1051 if (copy_to_user(buf, chip->data_buffer, ret_size))
1052 ret_size = -EFAULT;
1053 mutex_unlock(&chip->buffer_mutex);
1056 return ret_size;
1058 EXPORT_SYMBOL_GPL(tpm_read);
1060 void tpm_remove_hardware(struct device *dev)
1062 struct tpm_chip *chip = dev_get_drvdata(dev);
1064 if (chip == NULL) {
1065 dev_err(dev, "No device data found\n");
1066 return;
1069 spin_lock(&driver_lock);
1070 list_del_rcu(&chip->list);
1071 spin_unlock(&driver_lock);
1072 synchronize_rcu();
1074 misc_deregister(&chip->vendor.miscdev);
1075 sysfs_remove_group(&dev->kobj, chip->vendor.attr_group);
1076 tpm_bios_log_teardown(chip->bios_dir);
1078 /* write it this way to be explicit (chip->dev == dev) */
1079 put_device(chip->dev);
1081 EXPORT_SYMBOL_GPL(tpm_remove_hardware);
1083 #define TPM_ORD_SAVESTATE cpu_to_be32(152)
1084 #define SAVESTATE_RESULT_SIZE 10
1086 static struct tpm_input_header savestate_header = {
1087 .tag = TPM_TAG_RQU_COMMAND,
1088 .length = cpu_to_be32(10),
1089 .ordinal = TPM_ORD_SAVESTATE
1093 * We are about to suspend. Save the TPM state
1094 * so that it can be restored.
1096 int tpm_pm_suspend(struct device *dev, pm_message_t pm_state)
1098 struct tpm_chip *chip = dev_get_drvdata(dev);
1099 struct tpm_cmd_t cmd;
1100 int rc;
1102 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
1104 if (chip == NULL)
1105 return -ENODEV;
1107 /* for buggy tpm, flush pcrs with extend to selected dummy */
1108 if (tpm_suspend_pcr) {
1109 cmd.header.in = pcrextend_header;
1110 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(tpm_suspend_pcr);
1111 memcpy(cmd.params.pcrextend_in.hash, dummy_hash,
1112 TPM_DIGEST_SIZE);
1113 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
1114 "extending dummy pcr before suspend");
1117 /* now do the actual savestate */
1118 cmd.header.in = savestate_header;
1119 rc = transmit_cmd(chip, &cmd, SAVESTATE_RESULT_SIZE,
1120 "sending savestate before suspend");
1121 return rc;
1123 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1126 * Resume from a power safe. The BIOS already restored
1127 * the TPM state.
1129 int tpm_pm_resume(struct device *dev)
1131 struct tpm_chip *chip = dev_get_drvdata(dev);
1133 if (chip == NULL)
1134 return -ENODEV;
1136 return 0;
1138 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1140 /* In case vendor provided release function, call it too.*/
1142 void tpm_dev_vendor_release(struct tpm_chip *chip)
1144 if (chip->vendor.release)
1145 chip->vendor.release(chip->dev);
1147 clear_bit(chip->dev_num, dev_mask);
1148 kfree(chip->vendor.miscdev.name);
1150 EXPORT_SYMBOL_GPL(tpm_dev_vendor_release);
1154 * Once all references to platform device are down to 0,
1155 * release all allocated structures.
1157 void tpm_dev_release(struct device *dev)
1159 struct tpm_chip *chip = dev_get_drvdata(dev);
1161 tpm_dev_vendor_release(chip);
1163 chip->release(dev);
1164 kfree(chip);
1166 EXPORT_SYMBOL_GPL(tpm_dev_release);
1169 * Called from tpm_<specific>.c probe function only for devices
1170 * the driver has determined it should claim. Prior to calling
1171 * this function the specific probe function has called pci_enable_device
1172 * upon errant exit from this function specific probe function should call
1173 * pci_disable_device
1175 struct tpm_chip *tpm_register_hardware(struct device *dev,
1176 const struct tpm_vendor_specific *entry)
1178 #define DEVNAME_SIZE 7
1180 char *devname;
1181 struct tpm_chip *chip;
1183 /* Driver specific per-device data */
1184 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1185 devname = kmalloc(DEVNAME_SIZE, GFP_KERNEL);
1187 if (chip == NULL || devname == NULL)
1188 goto out_free;
1190 mutex_init(&chip->buffer_mutex);
1191 mutex_init(&chip->tpm_mutex);
1192 INIT_LIST_HEAD(&chip->list);
1194 INIT_WORK(&chip->work, timeout_work);
1196 setup_timer(&chip->user_read_timer, user_reader_timeout,
1197 (unsigned long)chip);
1199 memcpy(&chip->vendor, entry, sizeof(struct tpm_vendor_specific));
1201 chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
1203 if (chip->dev_num >= TPM_NUM_DEVICES) {
1204 dev_err(dev, "No available tpm device numbers\n");
1205 goto out_free;
1206 } else if (chip->dev_num == 0)
1207 chip->vendor.miscdev.minor = TPM_MINOR;
1208 else
1209 chip->vendor.miscdev.minor = MISC_DYNAMIC_MINOR;
1211 set_bit(chip->dev_num, dev_mask);
1213 scnprintf(devname, DEVNAME_SIZE, "%s%d", "tpm", chip->dev_num);
1214 chip->vendor.miscdev.name = devname;
1216 chip->vendor.miscdev.parent = dev;
1217 chip->dev = get_device(dev);
1218 chip->release = dev->release;
1219 dev->release = tpm_dev_release;
1220 dev_set_drvdata(dev, chip);
1222 if (misc_register(&chip->vendor.miscdev)) {
1223 dev_err(chip->dev,
1224 "unable to misc_register %s, minor %d\n",
1225 chip->vendor.miscdev.name,
1226 chip->vendor.miscdev.minor);
1227 put_device(chip->dev);
1228 return NULL;
1231 if (sysfs_create_group(&dev->kobj, chip->vendor.attr_group)) {
1232 misc_deregister(&chip->vendor.miscdev);
1233 put_device(chip->dev);
1235 return NULL;
1238 chip->bios_dir = tpm_bios_log_setup(devname);
1240 /* Make chip available */
1241 spin_lock(&driver_lock);
1242 list_add_rcu(&chip->list, &tpm_chip_list);
1243 spin_unlock(&driver_lock);
1245 return chip;
1247 out_free:
1248 kfree(chip);
1249 kfree(devname);
1250 return NULL;
1252 EXPORT_SYMBOL_GPL(tpm_register_hardware);
1254 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1255 MODULE_DESCRIPTION("TPM Driver");
1256 MODULE_VERSION("2.0");
1257 MODULE_LICENSE("GPL");