Loading...
1/*
2 * Copyright (C) 2004 IBM Corporation
3 * Copyright (C) 2014 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 * Note, the TPM chip is not interrupt driven (only polling)
22 * and can have very long timeouts (minutes!). Hence the unusual
23 * calls to msleep.
24 *
25 */
26
27#include <linux/poll.h>
28#include <linux/slab.h>
29#include <linux/mutex.h>
30#include <linux/spinlock.h>
31#include <linux/freezer.h>
32
33#include "tpm.h"
34#include "tpm_eventlog.h"
35
36#define TPM_MAX_ORDINAL 243
37#define TSC_MAX_ORDINAL 12
38#define TPM_PROTECTED_COMMAND 0x00
39#define TPM_CONNECTION_COMMAND 0x40
40
41/*
42 * Bug workaround - some TPM's don't flush the most
43 * recently changed pcr on suspend, so force the flush
44 * with an extend to the selected _unused_ non-volatile pcr.
45 */
46static int tpm_suspend_pcr;
47module_param_named(suspend_pcr, tpm_suspend_pcr, uint, 0644);
48MODULE_PARM_DESC(suspend_pcr,
49 "PCR to use for dummy writes to faciltate flush on suspend.");
50
51/*
52 * Array with one entry per ordinal defining the maximum amount
53 * of time the chip could take to return the result. The ordinal
54 * designation of short, medium or long is defined in a table in
55 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
56 * values of the SHORT, MEDIUM, and LONG durations are retrieved
57 * from the chip during initialization with a call to tpm_get_timeouts.
58 */
59static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
60 TPM_UNDEFINED, /* 0 */
61 TPM_UNDEFINED,
62 TPM_UNDEFINED,
63 TPM_UNDEFINED,
64 TPM_UNDEFINED,
65 TPM_UNDEFINED, /* 5 */
66 TPM_UNDEFINED,
67 TPM_UNDEFINED,
68 TPM_UNDEFINED,
69 TPM_UNDEFINED,
70 TPM_SHORT, /* 10 */
71 TPM_SHORT,
72 TPM_MEDIUM,
73 TPM_LONG,
74 TPM_LONG,
75 TPM_MEDIUM, /* 15 */
76 TPM_SHORT,
77 TPM_SHORT,
78 TPM_MEDIUM,
79 TPM_LONG,
80 TPM_SHORT, /* 20 */
81 TPM_SHORT,
82 TPM_MEDIUM,
83 TPM_MEDIUM,
84 TPM_MEDIUM,
85 TPM_SHORT, /* 25 */
86 TPM_SHORT,
87 TPM_MEDIUM,
88 TPM_SHORT,
89 TPM_SHORT,
90 TPM_MEDIUM, /* 30 */
91 TPM_LONG,
92 TPM_MEDIUM,
93 TPM_SHORT,
94 TPM_SHORT,
95 TPM_SHORT, /* 35 */
96 TPM_MEDIUM,
97 TPM_MEDIUM,
98 TPM_UNDEFINED,
99 TPM_UNDEFINED,
100 TPM_MEDIUM, /* 40 */
101 TPM_LONG,
102 TPM_MEDIUM,
103 TPM_SHORT,
104 TPM_SHORT,
105 TPM_SHORT, /* 45 */
106 TPM_SHORT,
107 TPM_SHORT,
108 TPM_SHORT,
109 TPM_LONG,
110 TPM_MEDIUM, /* 50 */
111 TPM_MEDIUM,
112 TPM_UNDEFINED,
113 TPM_UNDEFINED,
114 TPM_UNDEFINED,
115 TPM_UNDEFINED, /* 55 */
116 TPM_UNDEFINED,
117 TPM_UNDEFINED,
118 TPM_UNDEFINED,
119 TPM_UNDEFINED,
120 TPM_MEDIUM, /* 60 */
121 TPM_MEDIUM,
122 TPM_MEDIUM,
123 TPM_SHORT,
124 TPM_SHORT,
125 TPM_MEDIUM, /* 65 */
126 TPM_UNDEFINED,
127 TPM_UNDEFINED,
128 TPM_UNDEFINED,
129 TPM_UNDEFINED,
130 TPM_SHORT, /* 70 */
131 TPM_SHORT,
132 TPM_UNDEFINED,
133 TPM_UNDEFINED,
134 TPM_UNDEFINED,
135 TPM_UNDEFINED, /* 75 */
136 TPM_UNDEFINED,
137 TPM_UNDEFINED,
138 TPM_UNDEFINED,
139 TPM_UNDEFINED,
140 TPM_LONG, /* 80 */
141 TPM_UNDEFINED,
142 TPM_MEDIUM,
143 TPM_LONG,
144 TPM_SHORT,
145 TPM_UNDEFINED, /* 85 */
146 TPM_UNDEFINED,
147 TPM_UNDEFINED,
148 TPM_UNDEFINED,
149 TPM_UNDEFINED,
150 TPM_SHORT, /* 90 */
151 TPM_SHORT,
152 TPM_SHORT,
153 TPM_SHORT,
154 TPM_SHORT,
155 TPM_UNDEFINED, /* 95 */
156 TPM_UNDEFINED,
157 TPM_UNDEFINED,
158 TPM_UNDEFINED,
159 TPM_UNDEFINED,
160 TPM_MEDIUM, /* 100 */
161 TPM_SHORT,
162 TPM_SHORT,
163 TPM_UNDEFINED,
164 TPM_UNDEFINED,
165 TPM_UNDEFINED, /* 105 */
166 TPM_UNDEFINED,
167 TPM_UNDEFINED,
168 TPM_UNDEFINED,
169 TPM_UNDEFINED,
170 TPM_SHORT, /* 110 */
171 TPM_SHORT,
172 TPM_SHORT,
173 TPM_SHORT,
174 TPM_SHORT,
175 TPM_SHORT, /* 115 */
176 TPM_SHORT,
177 TPM_SHORT,
178 TPM_UNDEFINED,
179 TPM_UNDEFINED,
180 TPM_LONG, /* 120 */
181 TPM_LONG,
182 TPM_MEDIUM,
183 TPM_UNDEFINED,
184 TPM_SHORT,
185 TPM_SHORT, /* 125 */
186 TPM_SHORT,
187 TPM_LONG,
188 TPM_SHORT,
189 TPM_SHORT,
190 TPM_SHORT, /* 130 */
191 TPM_MEDIUM,
192 TPM_UNDEFINED,
193 TPM_SHORT,
194 TPM_MEDIUM,
195 TPM_UNDEFINED, /* 135 */
196 TPM_UNDEFINED,
197 TPM_UNDEFINED,
198 TPM_UNDEFINED,
199 TPM_UNDEFINED,
200 TPM_SHORT, /* 140 */
201 TPM_SHORT,
202 TPM_UNDEFINED,
203 TPM_UNDEFINED,
204 TPM_UNDEFINED,
205 TPM_UNDEFINED, /* 145 */
206 TPM_UNDEFINED,
207 TPM_UNDEFINED,
208 TPM_UNDEFINED,
209 TPM_UNDEFINED,
210 TPM_SHORT, /* 150 */
211 TPM_MEDIUM,
212 TPM_MEDIUM,
213 TPM_SHORT,
214 TPM_SHORT,
215 TPM_UNDEFINED, /* 155 */
216 TPM_UNDEFINED,
217 TPM_UNDEFINED,
218 TPM_UNDEFINED,
219 TPM_UNDEFINED,
220 TPM_SHORT, /* 160 */
221 TPM_SHORT,
222 TPM_SHORT,
223 TPM_SHORT,
224 TPM_UNDEFINED,
225 TPM_UNDEFINED, /* 165 */
226 TPM_UNDEFINED,
227 TPM_UNDEFINED,
228 TPM_UNDEFINED,
229 TPM_UNDEFINED,
230 TPM_LONG, /* 170 */
231 TPM_UNDEFINED,
232 TPM_UNDEFINED,
233 TPM_UNDEFINED,
234 TPM_UNDEFINED,
235 TPM_UNDEFINED, /* 175 */
236 TPM_UNDEFINED,
237 TPM_UNDEFINED,
238 TPM_UNDEFINED,
239 TPM_UNDEFINED,
240 TPM_MEDIUM, /* 180 */
241 TPM_SHORT,
242 TPM_MEDIUM,
243 TPM_MEDIUM,
244 TPM_MEDIUM,
245 TPM_MEDIUM, /* 185 */
246 TPM_SHORT,
247 TPM_UNDEFINED,
248 TPM_UNDEFINED,
249 TPM_UNDEFINED,
250 TPM_UNDEFINED, /* 190 */
251 TPM_UNDEFINED,
252 TPM_UNDEFINED,
253 TPM_UNDEFINED,
254 TPM_UNDEFINED,
255 TPM_UNDEFINED, /* 195 */
256 TPM_UNDEFINED,
257 TPM_UNDEFINED,
258 TPM_UNDEFINED,
259 TPM_UNDEFINED,
260 TPM_SHORT, /* 200 */
261 TPM_UNDEFINED,
262 TPM_UNDEFINED,
263 TPM_UNDEFINED,
264 TPM_SHORT,
265 TPM_SHORT, /* 205 */
266 TPM_SHORT,
267 TPM_SHORT,
268 TPM_SHORT,
269 TPM_SHORT,
270 TPM_MEDIUM, /* 210 */
271 TPM_UNDEFINED,
272 TPM_MEDIUM,
273 TPM_MEDIUM,
274 TPM_MEDIUM,
275 TPM_UNDEFINED, /* 215 */
276 TPM_MEDIUM,
277 TPM_UNDEFINED,
278 TPM_UNDEFINED,
279 TPM_SHORT,
280 TPM_SHORT, /* 220 */
281 TPM_SHORT,
282 TPM_SHORT,
283 TPM_SHORT,
284 TPM_SHORT,
285 TPM_UNDEFINED, /* 225 */
286 TPM_UNDEFINED,
287 TPM_UNDEFINED,
288 TPM_UNDEFINED,
289 TPM_UNDEFINED,
290 TPM_SHORT, /* 230 */
291 TPM_LONG,
292 TPM_MEDIUM,
293 TPM_UNDEFINED,
294 TPM_UNDEFINED,
295 TPM_UNDEFINED, /* 235 */
296 TPM_UNDEFINED,
297 TPM_UNDEFINED,
298 TPM_UNDEFINED,
299 TPM_UNDEFINED,
300 TPM_SHORT, /* 240 */
301 TPM_UNDEFINED,
302 TPM_MEDIUM,
303};
304
305/*
306 * Returns max number of jiffies to wait
307 */
308unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
309 u32 ordinal)
310{
311 int duration_idx = TPM_UNDEFINED;
312 int duration = 0;
313
314 /*
315 * We only have a duration table for protected commands, where the upper
316 * 16 bits are 0. For the few other ordinals the fallback will be used.
317 */
318 if (ordinal < TPM_MAX_ORDINAL)
319 duration_idx = tpm_ordinal_duration[ordinal];
320
321 if (duration_idx != TPM_UNDEFINED)
322 duration = chip->vendor.duration[duration_idx];
323 if (duration <= 0)
324 return 2 * 60 * HZ;
325 else
326 return duration;
327}
328EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
329
330/*
331 * Internal kernel interface to transmit TPM commands
332 */
333ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
334 size_t bufsiz)
335{
336 ssize_t rc;
337 u32 count, ordinal;
338 unsigned long stop;
339
340 if (bufsiz > TPM_BUFSIZE)
341 bufsiz = TPM_BUFSIZE;
342
343 count = be32_to_cpu(*((__be32 *) (buf + 2)));
344 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
345 if (count == 0)
346 return -ENODATA;
347 if (count > bufsiz) {
348 dev_err(chip->pdev,
349 "invalid count value %x %zx\n", count, bufsiz);
350 return -E2BIG;
351 }
352
353 mutex_lock(&chip->tpm_mutex);
354
355 rc = chip->ops->send(chip, (u8 *) buf, count);
356 if (rc < 0) {
357 dev_err(chip->pdev,
358 "tpm_transmit: tpm_send: error %zd\n", rc);
359 goto out;
360 }
361
362 if (chip->vendor.irq)
363 goto out_recv;
364
365 if (chip->flags & TPM_CHIP_FLAG_TPM2)
366 stop = jiffies + tpm2_calc_ordinal_duration(chip, ordinal);
367 else
368 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
369 do {
370 u8 status = chip->ops->status(chip);
371 if ((status & chip->ops->req_complete_mask) ==
372 chip->ops->req_complete_val)
373 goto out_recv;
374
375 if (chip->ops->req_canceled(chip, status)) {
376 dev_err(chip->pdev, "Operation Canceled\n");
377 rc = -ECANCELED;
378 goto out;
379 }
380
381 msleep(TPM_TIMEOUT); /* CHECK */
382 rmb();
383 } while (time_before(jiffies, stop));
384
385 chip->ops->cancel(chip);
386 dev_err(chip->pdev, "Operation Timed out\n");
387 rc = -ETIME;
388 goto out;
389
390out_recv:
391 rc = chip->ops->recv(chip, (u8 *) buf, bufsiz);
392 if (rc < 0)
393 dev_err(chip->pdev,
394 "tpm_transmit: tpm_recv: error %zd\n", rc);
395out:
396 mutex_unlock(&chip->tpm_mutex);
397 return rc;
398}
399
400#define TPM_DIGEST_SIZE 20
401#define TPM_RET_CODE_IDX 6
402
403ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd,
404 int len, const char *desc)
405{
406 struct tpm_output_header *header;
407 int err;
408
409 len = tpm_transmit(chip, (u8 *) cmd, len);
410 if (len < 0)
411 return len;
412 else if (len < TPM_HEADER_SIZE)
413 return -EFAULT;
414
415 header = cmd;
416
417 err = be32_to_cpu(header->return_code);
418 if (err != 0 && desc)
419 dev_err(chip->pdev, "A TPM error (%d) occurred %s\n", err,
420 desc);
421
422 return err;
423}
424
425#define TPM_INTERNAL_RESULT_SIZE 200
426#define TPM_ORD_GET_CAP cpu_to_be32(101)
427#define TPM_ORD_GET_RANDOM cpu_to_be32(70)
428
429static const struct tpm_input_header tpm_getcap_header = {
430 .tag = TPM_TAG_RQU_COMMAND,
431 .length = cpu_to_be32(22),
432 .ordinal = TPM_ORD_GET_CAP
433};
434
435ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
436 const char *desc)
437{
438 struct tpm_cmd_t tpm_cmd;
439 int rc;
440 struct tpm_chip *chip = dev_get_drvdata(dev);
441
442 tpm_cmd.header.in = tpm_getcap_header;
443 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
444 tpm_cmd.params.getcap_in.cap = subcap_id;
445 /*subcap field not necessary */
446 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
447 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
448 } else {
449 if (subcap_id == TPM_CAP_FLAG_PERM ||
450 subcap_id == TPM_CAP_FLAG_VOL)
451 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
452 else
453 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
454 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
455 tpm_cmd.params.getcap_in.subcap = subcap_id;
456 }
457 rc = tpm_transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
458 if (!rc)
459 *cap = tpm_cmd.params.getcap_out.cap;
460 return rc;
461}
462
463void tpm_gen_interrupt(struct tpm_chip *chip)
464{
465 struct tpm_cmd_t tpm_cmd;
466 ssize_t rc;
467
468 tpm_cmd.header.in = tpm_getcap_header;
469 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
470 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
471 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
472
473 rc = tpm_transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
474 "attempting to determine the timeouts");
475}
476EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
477
478#define TPM_ORD_STARTUP cpu_to_be32(153)
479#define TPM_ST_CLEAR cpu_to_be16(1)
480#define TPM_ST_STATE cpu_to_be16(2)
481#define TPM_ST_DEACTIVATED cpu_to_be16(3)
482static const struct tpm_input_header tpm_startup_header = {
483 .tag = TPM_TAG_RQU_COMMAND,
484 .length = cpu_to_be32(12),
485 .ordinal = TPM_ORD_STARTUP
486};
487
488static int tpm_startup(struct tpm_chip *chip, __be16 startup_type)
489{
490 struct tpm_cmd_t start_cmd;
491 start_cmd.header.in = tpm_startup_header;
492
493 start_cmd.params.startup_in.startup_type = startup_type;
494 return tpm_transmit_cmd(chip, &start_cmd, TPM_INTERNAL_RESULT_SIZE,
495 "attempting to start the TPM");
496}
497
498int tpm_get_timeouts(struct tpm_chip *chip)
499{
500 struct tpm_cmd_t tpm_cmd;
501 unsigned long new_timeout[4];
502 unsigned long old_timeout[4];
503 struct duration_t *duration_cap;
504 ssize_t rc;
505
506 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
507 /* Fixed timeouts for TPM2 */
508 chip->vendor.timeout_a = msecs_to_jiffies(TPM2_TIMEOUT_A);
509 chip->vendor.timeout_b = msecs_to_jiffies(TPM2_TIMEOUT_B);
510 chip->vendor.timeout_c = msecs_to_jiffies(TPM2_TIMEOUT_C);
511 chip->vendor.timeout_d = msecs_to_jiffies(TPM2_TIMEOUT_D);
512 chip->vendor.duration[TPM_SHORT] =
513 msecs_to_jiffies(TPM2_DURATION_SHORT);
514 chip->vendor.duration[TPM_MEDIUM] =
515 msecs_to_jiffies(TPM2_DURATION_MEDIUM);
516 chip->vendor.duration[TPM_LONG] =
517 msecs_to_jiffies(TPM2_DURATION_LONG);
518 return 0;
519 }
520
521 tpm_cmd.header.in = tpm_getcap_header;
522 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
523 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
524 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
525 rc = tpm_transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, NULL);
526
527 if (rc == TPM_ERR_INVALID_POSTINIT) {
528 /* The TPM is not started, we are the first to talk to it.
529 Execute a startup command. */
530 dev_info(chip->pdev, "Issuing TPM_STARTUP");
531 if (tpm_startup(chip, TPM_ST_CLEAR))
532 return rc;
533
534 tpm_cmd.header.in = tpm_getcap_header;
535 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
536 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
537 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
538 rc = tpm_transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
539 NULL);
540 }
541 if (rc) {
542 dev_err(chip->pdev,
543 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
544 rc);
545 goto duration;
546 }
547
548 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
549 be32_to_cpu(tpm_cmd.header.out.length)
550 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 4 * sizeof(u32))
551 return -EINVAL;
552
553 old_timeout[0] = be32_to_cpu(tpm_cmd.params.getcap_out.cap.timeout.a);
554 old_timeout[1] = be32_to_cpu(tpm_cmd.params.getcap_out.cap.timeout.b);
555 old_timeout[2] = be32_to_cpu(tpm_cmd.params.getcap_out.cap.timeout.c);
556 old_timeout[3] = be32_to_cpu(tpm_cmd.params.getcap_out.cap.timeout.d);
557 memcpy(new_timeout, old_timeout, sizeof(new_timeout));
558
559 /*
560 * Provide ability for vendor overrides of timeout values in case
561 * of misreporting.
562 */
563 if (chip->ops->update_timeouts != NULL)
564 chip->vendor.timeout_adjusted =
565 chip->ops->update_timeouts(chip, new_timeout);
566
567 if (!chip->vendor.timeout_adjusted) {
568 /* Don't overwrite default if value is 0 */
569 if (new_timeout[0] != 0 && new_timeout[0] < 1000) {
570 int i;
571
572 /* timeouts in msec rather usec */
573 for (i = 0; i != ARRAY_SIZE(new_timeout); i++)
574 new_timeout[i] *= 1000;
575 chip->vendor.timeout_adjusted = true;
576 }
577 }
578
579 /* Report adjusted timeouts */
580 if (chip->vendor.timeout_adjusted) {
581 dev_info(chip->pdev,
582 HW_ERR "Adjusting reported timeouts: A %lu->%luus B %lu->%luus C %lu->%luus D %lu->%luus\n",
583 old_timeout[0], new_timeout[0],
584 old_timeout[1], new_timeout[1],
585 old_timeout[2], new_timeout[2],
586 old_timeout[3], new_timeout[3]);
587 }
588
589 chip->vendor.timeout_a = usecs_to_jiffies(new_timeout[0]);
590 chip->vendor.timeout_b = usecs_to_jiffies(new_timeout[1]);
591 chip->vendor.timeout_c = usecs_to_jiffies(new_timeout[2]);
592 chip->vendor.timeout_d = usecs_to_jiffies(new_timeout[3]);
593
594duration:
595 tpm_cmd.header.in = tpm_getcap_header;
596 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
597 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
598 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
599
600 rc = tpm_transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
601 "attempting to determine the durations");
602 if (rc)
603 return rc;
604
605 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
606 be32_to_cpu(tpm_cmd.header.out.length)
607 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 3 * sizeof(u32))
608 return -EINVAL;
609
610 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
611 chip->vendor.duration[TPM_SHORT] =
612 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
613 chip->vendor.duration[TPM_MEDIUM] =
614 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
615 chip->vendor.duration[TPM_LONG] =
616 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
617
618 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
619 * value wrong and apparently reports msecs rather than usecs. So we
620 * fix up the resulting too-small TPM_SHORT value to make things work.
621 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
622 */
623 if (chip->vendor.duration[TPM_SHORT] < (HZ / 100)) {
624 chip->vendor.duration[TPM_SHORT] = HZ;
625 chip->vendor.duration[TPM_MEDIUM] *= 1000;
626 chip->vendor.duration[TPM_LONG] *= 1000;
627 chip->vendor.duration_adjusted = true;
628 dev_info(chip->pdev, "Adjusting TPM timeout parameters.");
629 }
630 return 0;
631}
632EXPORT_SYMBOL_GPL(tpm_get_timeouts);
633
634#define TPM_ORD_CONTINUE_SELFTEST 83
635#define CONTINUE_SELFTEST_RESULT_SIZE 10
636
637static struct tpm_input_header continue_selftest_header = {
638 .tag = TPM_TAG_RQU_COMMAND,
639 .length = cpu_to_be32(10),
640 .ordinal = cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST),
641};
642
643/**
644 * tpm_continue_selftest -- run TPM's selftest
645 * @chip: TPM chip to use
646 *
647 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
648 * a TPM error code.
649 */
650static int tpm_continue_selftest(struct tpm_chip *chip)
651{
652 int rc;
653 struct tpm_cmd_t cmd;
654
655 cmd.header.in = continue_selftest_header;
656 rc = tpm_transmit_cmd(chip, &cmd, CONTINUE_SELFTEST_RESULT_SIZE,
657 "continue selftest");
658 return rc;
659}
660
661#define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
662#define READ_PCR_RESULT_SIZE 30
663static struct tpm_input_header pcrread_header = {
664 .tag = TPM_TAG_RQU_COMMAND,
665 .length = cpu_to_be32(14),
666 .ordinal = TPM_ORDINAL_PCRREAD
667};
668
669int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
670{
671 int rc;
672 struct tpm_cmd_t cmd;
673
674 cmd.header.in = pcrread_header;
675 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
676 rc = tpm_transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
677 "attempting to read a pcr value");
678
679 if (rc == 0)
680 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
681 TPM_DIGEST_SIZE);
682 return rc;
683}
684
685/**
686 * tpm_is_tpm2 - is the chip a TPM2 chip?
687 * @chip_num: tpm idx # or ANY
688 *
689 * Returns < 0 on error, and 1 or 0 on success depending whether the chip
690 * is a TPM2 chip.
691 */
692int tpm_is_tpm2(u32 chip_num)
693{
694 struct tpm_chip *chip;
695 int rc;
696
697 chip = tpm_chip_find_get(chip_num);
698 if (chip == NULL)
699 return -ENODEV;
700
701 rc = (chip->flags & TPM_CHIP_FLAG_TPM2) != 0;
702
703 tpm_chip_put(chip);
704
705 return rc;
706}
707EXPORT_SYMBOL_GPL(tpm_is_tpm2);
708
709/**
710 * tpm_pcr_read - read a pcr value
711 * @chip_num: tpm idx # or ANY
712 * @pcr_idx: pcr idx to retrieve
713 * @res_buf: TPM_PCR value
714 * size of res_buf is 20 bytes (or NULL if you don't care)
715 *
716 * The TPM driver should be built-in, but for whatever reason it
717 * isn't, protect against the chip disappearing, by incrementing
718 * the module usage count.
719 */
720int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
721{
722 struct tpm_chip *chip;
723 int rc;
724
725 chip = tpm_chip_find_get(chip_num);
726 if (chip == NULL)
727 return -ENODEV;
728 if (chip->flags & TPM_CHIP_FLAG_TPM2)
729 rc = tpm2_pcr_read(chip, pcr_idx, res_buf);
730 else
731 rc = tpm_pcr_read_dev(chip, pcr_idx, res_buf);
732 tpm_chip_put(chip);
733 return rc;
734}
735EXPORT_SYMBOL_GPL(tpm_pcr_read);
736
737/**
738 * tpm_pcr_extend - extend pcr value with hash
739 * @chip_num: tpm idx # or AN&
740 * @pcr_idx: pcr idx to extend
741 * @hash: hash value used to extend pcr value
742 *
743 * The TPM driver should be built-in, but for whatever reason it
744 * isn't, protect against the chip disappearing, by incrementing
745 * the module usage count.
746 */
747#define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
748#define EXTEND_PCR_RESULT_SIZE 34
749static struct tpm_input_header pcrextend_header = {
750 .tag = TPM_TAG_RQU_COMMAND,
751 .length = cpu_to_be32(34),
752 .ordinal = TPM_ORD_PCR_EXTEND
753};
754
755int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
756{
757 struct tpm_cmd_t cmd;
758 int rc;
759 struct tpm_chip *chip;
760
761 chip = tpm_chip_find_get(chip_num);
762 if (chip == NULL)
763 return -ENODEV;
764
765 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
766 rc = tpm2_pcr_extend(chip, pcr_idx, hash);
767 tpm_chip_put(chip);
768 return rc;
769 }
770
771 cmd.header.in = pcrextend_header;
772 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
773 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
774 rc = tpm_transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
775 "attempting extend a PCR value");
776
777 tpm_chip_put(chip);
778 return rc;
779}
780EXPORT_SYMBOL_GPL(tpm_pcr_extend);
781
782/**
783 * tpm_do_selftest - have the TPM continue its selftest and wait until it
784 * can receive further commands
785 * @chip: TPM chip to use
786 *
787 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
788 * a TPM error code.
789 */
790int tpm_do_selftest(struct tpm_chip *chip)
791{
792 int rc;
793 unsigned int loops;
794 unsigned int delay_msec = 100;
795 unsigned long duration;
796 struct tpm_cmd_t cmd;
797
798 duration = tpm_calc_ordinal_duration(chip, TPM_ORD_CONTINUE_SELFTEST);
799
800 loops = jiffies_to_msecs(duration) / delay_msec;
801
802 rc = tpm_continue_selftest(chip);
803 /* This may fail if there was no TPM driver during a suspend/resume
804 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
805 */
806 if (rc)
807 return rc;
808
809 do {
810 /* Attempt to read a PCR value */
811 cmd.header.in = pcrread_header;
812 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(0);
813 rc = tpm_transmit(chip, (u8 *) &cmd, READ_PCR_RESULT_SIZE);
814 /* Some buggy TPMs will not respond to tpm_tis_ready() for
815 * around 300ms while the self test is ongoing, keep trying
816 * until the self test duration expires. */
817 if (rc == -ETIME) {
818 dev_info(chip->pdev, HW_ERR "TPM command timed out during continue self test");
819 msleep(delay_msec);
820 continue;
821 }
822
823 if (rc < TPM_HEADER_SIZE)
824 return -EFAULT;
825
826 rc = be32_to_cpu(cmd.header.out.return_code);
827 if (rc == TPM_ERR_DISABLED || rc == TPM_ERR_DEACTIVATED) {
828 dev_info(chip->pdev,
829 "TPM is disabled/deactivated (0x%X)\n", rc);
830 /* TPM is disabled and/or deactivated; driver can
831 * proceed and TPM does handle commands for
832 * suspend/resume correctly
833 */
834 return 0;
835 }
836 if (rc != TPM_WARN_DOING_SELFTEST)
837 return rc;
838 msleep(delay_msec);
839 } while (--loops > 0);
840
841 return rc;
842}
843EXPORT_SYMBOL_GPL(tpm_do_selftest);
844
845int tpm_send(u32 chip_num, void *cmd, size_t buflen)
846{
847 struct tpm_chip *chip;
848 int rc;
849
850 chip = tpm_chip_find_get(chip_num);
851 if (chip == NULL)
852 return -ENODEV;
853
854 rc = tpm_transmit_cmd(chip, cmd, buflen, "attempting tpm_cmd");
855
856 tpm_chip_put(chip);
857 return rc;
858}
859EXPORT_SYMBOL_GPL(tpm_send);
860
861static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask,
862 bool check_cancel, bool *canceled)
863{
864 u8 status = chip->ops->status(chip);
865
866 *canceled = false;
867 if ((status & mask) == mask)
868 return true;
869 if (check_cancel && chip->ops->req_canceled(chip, status)) {
870 *canceled = true;
871 return true;
872 }
873 return false;
874}
875
876int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
877 wait_queue_head_t *queue, bool check_cancel)
878{
879 unsigned long stop;
880 long rc;
881 u8 status;
882 bool canceled = false;
883
884 /* check current status */
885 status = chip->ops->status(chip);
886 if ((status & mask) == mask)
887 return 0;
888
889 stop = jiffies + timeout;
890
891 if (chip->vendor.irq) {
892again:
893 timeout = stop - jiffies;
894 if ((long)timeout <= 0)
895 return -ETIME;
896 rc = wait_event_interruptible_timeout(*queue,
897 wait_for_tpm_stat_cond(chip, mask, check_cancel,
898 &canceled),
899 timeout);
900 if (rc > 0) {
901 if (canceled)
902 return -ECANCELED;
903 return 0;
904 }
905 if (rc == -ERESTARTSYS && freezing(current)) {
906 clear_thread_flag(TIF_SIGPENDING);
907 goto again;
908 }
909 } else {
910 do {
911 msleep(TPM_TIMEOUT);
912 status = chip->ops->status(chip);
913 if ((status & mask) == mask)
914 return 0;
915 } while (time_before(jiffies, stop));
916 }
917 return -ETIME;
918}
919EXPORT_SYMBOL_GPL(wait_for_tpm_stat);
920
921#define TPM_ORD_SAVESTATE cpu_to_be32(152)
922#define SAVESTATE_RESULT_SIZE 10
923
924static struct tpm_input_header savestate_header = {
925 .tag = TPM_TAG_RQU_COMMAND,
926 .length = cpu_to_be32(10),
927 .ordinal = TPM_ORD_SAVESTATE
928};
929
930/*
931 * We are about to suspend. Save the TPM state
932 * so that it can be restored.
933 */
934int tpm_pm_suspend(struct device *dev)
935{
936 struct tpm_chip *chip = dev_get_drvdata(dev);
937 struct tpm_cmd_t cmd;
938 int rc, try;
939
940 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
941
942 if (chip == NULL)
943 return -ENODEV;
944
945 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
946 tpm2_shutdown(chip, TPM2_SU_STATE);
947 return 0;
948 }
949
950 /* for buggy tpm, flush pcrs with extend to selected dummy */
951 if (tpm_suspend_pcr) {
952 cmd.header.in = pcrextend_header;
953 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(tpm_suspend_pcr);
954 memcpy(cmd.params.pcrextend_in.hash, dummy_hash,
955 TPM_DIGEST_SIZE);
956 rc = tpm_transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
957 "extending dummy pcr before suspend");
958 }
959
960 /* now do the actual savestate */
961 for (try = 0; try < TPM_RETRY; try++) {
962 cmd.header.in = savestate_header;
963 rc = tpm_transmit_cmd(chip, &cmd, SAVESTATE_RESULT_SIZE, NULL);
964
965 /*
966 * If the TPM indicates that it is too busy to respond to
967 * this command then retry before giving up. It can take
968 * several seconds for this TPM to be ready.
969 *
970 * This can happen if the TPM has already been sent the
971 * SaveState command before the driver has loaded. TCG 1.2
972 * specification states that any communication after SaveState
973 * may cause the TPM to invalidate previously saved state.
974 */
975 if (rc != TPM_WARN_RETRY)
976 break;
977 msleep(TPM_TIMEOUT_RETRY);
978 }
979
980 if (rc)
981 dev_err(chip->pdev,
982 "Error (%d) sending savestate before suspend\n", rc);
983 else if (try > 0)
984 dev_warn(chip->pdev, "TPM savestate took %dms\n",
985 try * TPM_TIMEOUT_RETRY);
986
987 return rc;
988}
989EXPORT_SYMBOL_GPL(tpm_pm_suspend);
990
991/*
992 * Resume from a power safe. The BIOS already restored
993 * the TPM state.
994 */
995int tpm_pm_resume(struct device *dev)
996{
997 struct tpm_chip *chip = dev_get_drvdata(dev);
998
999 if (chip == NULL)
1000 return -ENODEV;
1001
1002 return 0;
1003}
1004EXPORT_SYMBOL_GPL(tpm_pm_resume);
1005
1006#define TPM_GETRANDOM_RESULT_SIZE 18
1007static struct tpm_input_header tpm_getrandom_header = {
1008 .tag = TPM_TAG_RQU_COMMAND,
1009 .length = cpu_to_be32(14),
1010 .ordinal = TPM_ORD_GET_RANDOM
1011};
1012
1013/**
1014 * tpm_get_random() - Get random bytes from the tpm's RNG
1015 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1016 * @out: destination buffer for the random bytes
1017 * @max: the max number of bytes to write to @out
1018 *
1019 * Returns < 0 on error and the number of bytes read on success
1020 */
1021int tpm_get_random(u32 chip_num, u8 *out, size_t max)
1022{
1023 struct tpm_chip *chip;
1024 struct tpm_cmd_t tpm_cmd;
1025 u32 recd, num_bytes = min_t(u32, max, TPM_MAX_RNG_DATA);
1026 int err, total = 0, retries = 5;
1027 u8 *dest = out;
1028
1029 if (!out || !num_bytes || max > TPM_MAX_RNG_DATA)
1030 return -EINVAL;
1031
1032 chip = tpm_chip_find_get(chip_num);
1033 if (chip == NULL)
1034 return -ENODEV;
1035
1036 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
1037 err = tpm2_get_random(chip, out, max);
1038 tpm_chip_put(chip);
1039 return err;
1040 }
1041
1042 do {
1043 tpm_cmd.header.in = tpm_getrandom_header;
1044 tpm_cmd.params.getrandom_in.num_bytes = cpu_to_be32(num_bytes);
1045
1046 err = tpm_transmit_cmd(chip, &tpm_cmd,
1047 TPM_GETRANDOM_RESULT_SIZE + num_bytes,
1048 "attempting get random");
1049 if (err)
1050 break;
1051
1052 recd = be32_to_cpu(tpm_cmd.params.getrandom_out.rng_data_len);
1053 memcpy(dest, tpm_cmd.params.getrandom_out.rng_data, recd);
1054
1055 dest += recd;
1056 total += recd;
1057 num_bytes -= recd;
1058 } while (retries-- && total < max);
1059
1060 tpm_chip_put(chip);
1061 return total ? total : -EIO;
1062}
1063EXPORT_SYMBOL_GPL(tpm_get_random);
1064
1065/**
1066 * tpm_seal_trusted() - seal a trusted key
1067 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1068 * @options: authentication values and other options
1069 * @payload: the key data in clear and encrypted form
1070 *
1071 * Returns < 0 on error and 0 on success. At the moment, only TPM 2.0 chips
1072 * are supported.
1073 */
1074int tpm_seal_trusted(u32 chip_num, struct trusted_key_payload *payload,
1075 struct trusted_key_options *options)
1076{
1077 struct tpm_chip *chip;
1078 int rc;
1079
1080 chip = tpm_chip_find_get(chip_num);
1081 if (chip == NULL || !(chip->flags & TPM_CHIP_FLAG_TPM2))
1082 return -ENODEV;
1083
1084 rc = tpm2_seal_trusted(chip, payload, options);
1085
1086 tpm_chip_put(chip);
1087 return rc;
1088}
1089EXPORT_SYMBOL_GPL(tpm_seal_trusted);
1090
1091/**
1092 * tpm_unseal_trusted() - unseal a trusted key
1093 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1094 * @options: authentication values and other options
1095 * @payload: the key data in clear and encrypted form
1096 *
1097 * Returns < 0 on error and 0 on success. At the moment, only TPM 2.0 chips
1098 * are supported.
1099 */
1100int tpm_unseal_trusted(u32 chip_num, struct trusted_key_payload *payload,
1101 struct trusted_key_options *options)
1102{
1103 struct tpm_chip *chip;
1104 int rc;
1105
1106 chip = tpm_chip_find_get(chip_num);
1107 if (chip == NULL || !(chip->flags & TPM_CHIP_FLAG_TPM2))
1108 return -ENODEV;
1109
1110 rc = tpm2_unseal_trusted(chip, payload, options);
1111
1112 tpm_chip_put(chip);
1113 return rc;
1114}
1115EXPORT_SYMBOL_GPL(tpm_unseal_trusted);
1116
1117static int __init tpm_init(void)
1118{
1119 int rc;
1120
1121 tpm_class = class_create(THIS_MODULE, "tpm");
1122 if (IS_ERR(tpm_class)) {
1123 pr_err("couldn't create tpm class\n");
1124 return PTR_ERR(tpm_class);
1125 }
1126
1127 rc = alloc_chrdev_region(&tpm_devt, 0, TPM_NUM_DEVICES, "tpm");
1128 if (rc < 0) {
1129 pr_err("tpm: failed to allocate char dev region\n");
1130 class_destroy(tpm_class);
1131 return rc;
1132 }
1133
1134 return 0;
1135}
1136
1137static void __exit tpm_exit(void)
1138{
1139 class_destroy(tpm_class);
1140 unregister_chrdev_region(tpm_devt, TPM_NUM_DEVICES);
1141}
1142
1143subsys_initcall(tpm_init);
1144module_exit(tpm_exit);
1145
1146MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1147MODULE_DESCRIPTION("TPM Driver");
1148MODULE_VERSION("2.0");
1149MODULE_LICENSE("GPL");
1/*
2 * Copyright (C) 2004 IBM Corporation
3 *
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>
9 *
10 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
11 *
12 * Device driver for TCG/TCPA TPM (trusted platform module).
13 * Specifications at www.trustedcomputinggroup.org
14 *
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.
19 *
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.
23 *
24 */
25
26#include <linux/poll.h>
27#include <linux/slab.h>
28#include <linux/mutex.h>
29#include <linux/spinlock.h>
30#include <linux/freezer.h>
31
32#include "tpm.h"
33#include "tpm_eventlog.h"
34
35#define TPM_MAX_ORDINAL 243
36#define TSC_MAX_ORDINAL 12
37#define TPM_PROTECTED_COMMAND 0x00
38#define TPM_CONNECTION_COMMAND 0x40
39
40/*
41 * Bug workaround - some TPM's don't flush the most
42 * recently changed pcr on suspend, so force the flush
43 * with an extend to the selected _unused_ non-volatile pcr.
44 */
45static int tpm_suspend_pcr;
46module_param_named(suspend_pcr, tpm_suspend_pcr, uint, 0644);
47MODULE_PARM_DESC(suspend_pcr,
48 "PCR to use for dummy writes to faciltate flush on suspend.");
49
50static LIST_HEAD(tpm_chip_list);
51static DEFINE_SPINLOCK(driver_lock);
52static DECLARE_BITMAP(dev_mask, TPM_NUM_DEVICES);
53
54/*
55 * Array with one entry per ordinal defining the maximum amount
56 * of time the chip could take to return the result. The ordinal
57 * designation of short, medium or long is defined in a table in
58 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
59 * values of the SHORT, MEDIUM, and LONG durations are retrieved
60 * from the chip during initialization with a call to tpm_get_timeouts.
61 */
62static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
63 TPM_UNDEFINED, /* 0 */
64 TPM_UNDEFINED,
65 TPM_UNDEFINED,
66 TPM_UNDEFINED,
67 TPM_UNDEFINED,
68 TPM_UNDEFINED, /* 5 */
69 TPM_UNDEFINED,
70 TPM_UNDEFINED,
71 TPM_UNDEFINED,
72 TPM_UNDEFINED,
73 TPM_SHORT, /* 10 */
74 TPM_SHORT,
75 TPM_MEDIUM,
76 TPM_LONG,
77 TPM_LONG,
78 TPM_MEDIUM, /* 15 */
79 TPM_SHORT,
80 TPM_SHORT,
81 TPM_MEDIUM,
82 TPM_LONG,
83 TPM_SHORT, /* 20 */
84 TPM_SHORT,
85 TPM_MEDIUM,
86 TPM_MEDIUM,
87 TPM_MEDIUM,
88 TPM_SHORT, /* 25 */
89 TPM_SHORT,
90 TPM_MEDIUM,
91 TPM_SHORT,
92 TPM_SHORT,
93 TPM_MEDIUM, /* 30 */
94 TPM_LONG,
95 TPM_MEDIUM,
96 TPM_SHORT,
97 TPM_SHORT,
98 TPM_SHORT, /* 35 */
99 TPM_MEDIUM,
100 TPM_MEDIUM,
101 TPM_UNDEFINED,
102 TPM_UNDEFINED,
103 TPM_MEDIUM, /* 40 */
104 TPM_LONG,
105 TPM_MEDIUM,
106 TPM_SHORT,
107 TPM_SHORT,
108 TPM_SHORT, /* 45 */
109 TPM_SHORT,
110 TPM_SHORT,
111 TPM_SHORT,
112 TPM_LONG,
113 TPM_MEDIUM, /* 50 */
114 TPM_MEDIUM,
115 TPM_UNDEFINED,
116 TPM_UNDEFINED,
117 TPM_UNDEFINED,
118 TPM_UNDEFINED, /* 55 */
119 TPM_UNDEFINED,
120 TPM_UNDEFINED,
121 TPM_UNDEFINED,
122 TPM_UNDEFINED,
123 TPM_MEDIUM, /* 60 */
124 TPM_MEDIUM,
125 TPM_MEDIUM,
126 TPM_SHORT,
127 TPM_SHORT,
128 TPM_MEDIUM, /* 65 */
129 TPM_UNDEFINED,
130 TPM_UNDEFINED,
131 TPM_UNDEFINED,
132 TPM_UNDEFINED,
133 TPM_SHORT, /* 70 */
134 TPM_SHORT,
135 TPM_UNDEFINED,
136 TPM_UNDEFINED,
137 TPM_UNDEFINED,
138 TPM_UNDEFINED, /* 75 */
139 TPM_UNDEFINED,
140 TPM_UNDEFINED,
141 TPM_UNDEFINED,
142 TPM_UNDEFINED,
143 TPM_LONG, /* 80 */
144 TPM_UNDEFINED,
145 TPM_MEDIUM,
146 TPM_LONG,
147 TPM_SHORT,
148 TPM_UNDEFINED, /* 85 */
149 TPM_UNDEFINED,
150 TPM_UNDEFINED,
151 TPM_UNDEFINED,
152 TPM_UNDEFINED,
153 TPM_SHORT, /* 90 */
154 TPM_SHORT,
155 TPM_SHORT,
156 TPM_SHORT,
157 TPM_SHORT,
158 TPM_UNDEFINED, /* 95 */
159 TPM_UNDEFINED,
160 TPM_UNDEFINED,
161 TPM_UNDEFINED,
162 TPM_UNDEFINED,
163 TPM_MEDIUM, /* 100 */
164 TPM_SHORT,
165 TPM_SHORT,
166 TPM_UNDEFINED,
167 TPM_UNDEFINED,
168 TPM_UNDEFINED, /* 105 */
169 TPM_UNDEFINED,
170 TPM_UNDEFINED,
171 TPM_UNDEFINED,
172 TPM_UNDEFINED,
173 TPM_SHORT, /* 110 */
174 TPM_SHORT,
175 TPM_SHORT,
176 TPM_SHORT,
177 TPM_SHORT,
178 TPM_SHORT, /* 115 */
179 TPM_SHORT,
180 TPM_SHORT,
181 TPM_UNDEFINED,
182 TPM_UNDEFINED,
183 TPM_LONG, /* 120 */
184 TPM_LONG,
185 TPM_MEDIUM,
186 TPM_UNDEFINED,
187 TPM_SHORT,
188 TPM_SHORT, /* 125 */
189 TPM_SHORT,
190 TPM_LONG,
191 TPM_SHORT,
192 TPM_SHORT,
193 TPM_SHORT, /* 130 */
194 TPM_MEDIUM,
195 TPM_UNDEFINED,
196 TPM_SHORT,
197 TPM_MEDIUM,
198 TPM_UNDEFINED, /* 135 */
199 TPM_UNDEFINED,
200 TPM_UNDEFINED,
201 TPM_UNDEFINED,
202 TPM_UNDEFINED,
203 TPM_SHORT, /* 140 */
204 TPM_SHORT,
205 TPM_UNDEFINED,
206 TPM_UNDEFINED,
207 TPM_UNDEFINED,
208 TPM_UNDEFINED, /* 145 */
209 TPM_UNDEFINED,
210 TPM_UNDEFINED,
211 TPM_UNDEFINED,
212 TPM_UNDEFINED,
213 TPM_SHORT, /* 150 */
214 TPM_MEDIUM,
215 TPM_MEDIUM,
216 TPM_SHORT,
217 TPM_SHORT,
218 TPM_UNDEFINED, /* 155 */
219 TPM_UNDEFINED,
220 TPM_UNDEFINED,
221 TPM_UNDEFINED,
222 TPM_UNDEFINED,
223 TPM_SHORT, /* 160 */
224 TPM_SHORT,
225 TPM_SHORT,
226 TPM_SHORT,
227 TPM_UNDEFINED,
228 TPM_UNDEFINED, /* 165 */
229 TPM_UNDEFINED,
230 TPM_UNDEFINED,
231 TPM_UNDEFINED,
232 TPM_UNDEFINED,
233 TPM_LONG, /* 170 */
234 TPM_UNDEFINED,
235 TPM_UNDEFINED,
236 TPM_UNDEFINED,
237 TPM_UNDEFINED,
238 TPM_UNDEFINED, /* 175 */
239 TPM_UNDEFINED,
240 TPM_UNDEFINED,
241 TPM_UNDEFINED,
242 TPM_UNDEFINED,
243 TPM_MEDIUM, /* 180 */
244 TPM_SHORT,
245 TPM_MEDIUM,
246 TPM_MEDIUM,
247 TPM_MEDIUM,
248 TPM_MEDIUM, /* 185 */
249 TPM_SHORT,
250 TPM_UNDEFINED,
251 TPM_UNDEFINED,
252 TPM_UNDEFINED,
253 TPM_UNDEFINED, /* 190 */
254 TPM_UNDEFINED,
255 TPM_UNDEFINED,
256 TPM_UNDEFINED,
257 TPM_UNDEFINED,
258 TPM_UNDEFINED, /* 195 */
259 TPM_UNDEFINED,
260 TPM_UNDEFINED,
261 TPM_UNDEFINED,
262 TPM_UNDEFINED,
263 TPM_SHORT, /* 200 */
264 TPM_UNDEFINED,
265 TPM_UNDEFINED,
266 TPM_UNDEFINED,
267 TPM_SHORT,
268 TPM_SHORT, /* 205 */
269 TPM_SHORT,
270 TPM_SHORT,
271 TPM_SHORT,
272 TPM_SHORT,
273 TPM_MEDIUM, /* 210 */
274 TPM_UNDEFINED,
275 TPM_MEDIUM,
276 TPM_MEDIUM,
277 TPM_MEDIUM,
278 TPM_UNDEFINED, /* 215 */
279 TPM_MEDIUM,
280 TPM_UNDEFINED,
281 TPM_UNDEFINED,
282 TPM_SHORT,
283 TPM_SHORT, /* 220 */
284 TPM_SHORT,
285 TPM_SHORT,
286 TPM_SHORT,
287 TPM_SHORT,
288 TPM_UNDEFINED, /* 225 */
289 TPM_UNDEFINED,
290 TPM_UNDEFINED,
291 TPM_UNDEFINED,
292 TPM_UNDEFINED,
293 TPM_SHORT, /* 230 */
294 TPM_LONG,
295 TPM_MEDIUM,
296 TPM_UNDEFINED,
297 TPM_UNDEFINED,
298 TPM_UNDEFINED, /* 235 */
299 TPM_UNDEFINED,
300 TPM_UNDEFINED,
301 TPM_UNDEFINED,
302 TPM_UNDEFINED,
303 TPM_SHORT, /* 240 */
304 TPM_UNDEFINED,
305 TPM_MEDIUM,
306};
307
308/*
309 * Returns max number of jiffies to wait
310 */
311unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
312 u32 ordinal)
313{
314 int duration_idx = TPM_UNDEFINED;
315 int duration = 0;
316 u8 category = (ordinal >> 24) & 0xFF;
317
318 if ((category == TPM_PROTECTED_COMMAND && ordinal < TPM_MAX_ORDINAL) ||
319 (category == TPM_CONNECTION_COMMAND && ordinal < TSC_MAX_ORDINAL))
320 duration_idx = tpm_ordinal_duration[ordinal];
321
322 if (duration_idx != TPM_UNDEFINED)
323 duration = chip->vendor.duration[duration_idx];
324 if (duration <= 0)
325 return 2 * 60 * HZ;
326 else
327 return duration;
328}
329EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
330
331/*
332 * Internal kernel interface to transmit TPM commands
333 */
334ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
335 size_t bufsiz)
336{
337 ssize_t rc;
338 u32 count, ordinal;
339 unsigned long stop;
340
341 if (bufsiz > TPM_BUFSIZE)
342 bufsiz = TPM_BUFSIZE;
343
344 count = be32_to_cpu(*((__be32 *) (buf + 2)));
345 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
346 if (count == 0)
347 return -ENODATA;
348 if (count > bufsiz) {
349 dev_err(chip->dev,
350 "invalid count value %x %zx\n", count, bufsiz);
351 return -E2BIG;
352 }
353
354 mutex_lock(&chip->tpm_mutex);
355
356 rc = chip->ops->send(chip, (u8 *) buf, count);
357 if (rc < 0) {
358 dev_err(chip->dev,
359 "tpm_transmit: tpm_send: error %zd\n", rc);
360 goto out;
361 }
362
363 if (chip->vendor.irq)
364 goto out_recv;
365
366 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
367 do {
368 u8 status = chip->ops->status(chip);
369 if ((status & chip->ops->req_complete_mask) ==
370 chip->ops->req_complete_val)
371 goto out_recv;
372
373 if (chip->ops->req_canceled(chip, status)) {
374 dev_err(chip->dev, "Operation Canceled\n");
375 rc = -ECANCELED;
376 goto out;
377 }
378
379 msleep(TPM_TIMEOUT); /* CHECK */
380 rmb();
381 } while (time_before(jiffies, stop));
382
383 chip->ops->cancel(chip);
384 dev_err(chip->dev, "Operation Timed out\n");
385 rc = -ETIME;
386 goto out;
387
388out_recv:
389 rc = chip->ops->recv(chip, (u8 *) buf, bufsiz);
390 if (rc < 0)
391 dev_err(chip->dev,
392 "tpm_transmit: tpm_recv: error %zd\n", rc);
393out:
394 mutex_unlock(&chip->tpm_mutex);
395 return rc;
396}
397
398#define TPM_DIGEST_SIZE 20
399#define TPM_RET_CODE_IDX 6
400
401static ssize_t transmit_cmd(struct tpm_chip *chip, struct tpm_cmd_t *cmd,
402 int len, const char *desc)
403{
404 int err;
405
406 len = tpm_transmit(chip, (u8 *) cmd, len);
407 if (len < 0)
408 return len;
409 else if (len < TPM_HEADER_SIZE)
410 return -EFAULT;
411
412 err = be32_to_cpu(cmd->header.out.return_code);
413 if (err != 0 && desc)
414 dev_err(chip->dev, "A TPM error (%d) occurred %s\n", err, desc);
415
416 return err;
417}
418
419#define TPM_INTERNAL_RESULT_SIZE 200
420#define TPM_ORD_GET_CAP cpu_to_be32(101)
421#define TPM_ORD_GET_RANDOM cpu_to_be32(70)
422
423static const struct tpm_input_header tpm_getcap_header = {
424 .tag = TPM_TAG_RQU_COMMAND,
425 .length = cpu_to_be32(22),
426 .ordinal = TPM_ORD_GET_CAP
427};
428
429ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
430 const char *desc)
431{
432 struct tpm_cmd_t tpm_cmd;
433 int rc;
434 struct tpm_chip *chip = dev_get_drvdata(dev);
435
436 tpm_cmd.header.in = tpm_getcap_header;
437 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
438 tpm_cmd.params.getcap_in.cap = subcap_id;
439 /*subcap field not necessary */
440 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
441 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
442 } else {
443 if (subcap_id == TPM_CAP_FLAG_PERM ||
444 subcap_id == TPM_CAP_FLAG_VOL)
445 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
446 else
447 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
448 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
449 tpm_cmd.params.getcap_in.subcap = subcap_id;
450 }
451 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
452 if (!rc)
453 *cap = tpm_cmd.params.getcap_out.cap;
454 return rc;
455}
456
457void tpm_gen_interrupt(struct tpm_chip *chip)
458{
459 struct tpm_cmd_t tpm_cmd;
460 ssize_t rc;
461
462 tpm_cmd.header.in = tpm_getcap_header;
463 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
464 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
465 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
466
467 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
468 "attempting to determine the timeouts");
469}
470EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
471
472#define TPM_ORD_STARTUP cpu_to_be32(153)
473#define TPM_ST_CLEAR cpu_to_be16(1)
474#define TPM_ST_STATE cpu_to_be16(2)
475#define TPM_ST_DEACTIVATED cpu_to_be16(3)
476static const struct tpm_input_header tpm_startup_header = {
477 .tag = TPM_TAG_RQU_COMMAND,
478 .length = cpu_to_be32(12),
479 .ordinal = TPM_ORD_STARTUP
480};
481
482static int tpm_startup(struct tpm_chip *chip, __be16 startup_type)
483{
484 struct tpm_cmd_t start_cmd;
485 start_cmd.header.in = tpm_startup_header;
486 start_cmd.params.startup_in.startup_type = startup_type;
487 return transmit_cmd(chip, &start_cmd, TPM_INTERNAL_RESULT_SIZE,
488 "attempting to start the TPM");
489}
490
491int tpm_get_timeouts(struct tpm_chip *chip)
492{
493 struct tpm_cmd_t tpm_cmd;
494 struct timeout_t *timeout_cap;
495 struct duration_t *duration_cap;
496 ssize_t rc;
497 u32 timeout;
498 unsigned int scale = 1;
499
500 tpm_cmd.header.in = tpm_getcap_header;
501 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
502 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
503 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
504 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, NULL);
505
506 if (rc == TPM_ERR_INVALID_POSTINIT) {
507 /* The TPM is not started, we are the first to talk to it.
508 Execute a startup command. */
509 dev_info(chip->dev, "Issuing TPM_STARTUP");
510 if (tpm_startup(chip, TPM_ST_CLEAR))
511 return rc;
512
513 tpm_cmd.header.in = tpm_getcap_header;
514 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
515 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
516 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
517 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
518 NULL);
519 }
520 if (rc) {
521 dev_err(chip->dev,
522 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
523 rc);
524 goto duration;
525 }
526
527 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
528 be32_to_cpu(tpm_cmd.header.out.length)
529 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 4 * sizeof(u32))
530 return -EINVAL;
531
532 timeout_cap = &tpm_cmd.params.getcap_out.cap.timeout;
533 /* Don't overwrite default if value is 0 */
534 timeout = be32_to_cpu(timeout_cap->a);
535 if (timeout && timeout < 1000) {
536 /* timeouts in msec rather usec */
537 scale = 1000;
538 chip->vendor.timeout_adjusted = true;
539 }
540 if (timeout)
541 chip->vendor.timeout_a = usecs_to_jiffies(timeout * scale);
542 timeout = be32_to_cpu(timeout_cap->b);
543 if (timeout)
544 chip->vendor.timeout_b = usecs_to_jiffies(timeout * scale);
545 timeout = be32_to_cpu(timeout_cap->c);
546 if (timeout)
547 chip->vendor.timeout_c = usecs_to_jiffies(timeout * scale);
548 timeout = be32_to_cpu(timeout_cap->d);
549 if (timeout)
550 chip->vendor.timeout_d = usecs_to_jiffies(timeout * scale);
551
552duration:
553 tpm_cmd.header.in = tpm_getcap_header;
554 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
555 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
556 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
557
558 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
559 "attempting to determine the durations");
560 if (rc)
561 return rc;
562
563 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
564 be32_to_cpu(tpm_cmd.header.out.length)
565 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 3 * sizeof(u32))
566 return -EINVAL;
567
568 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
569 chip->vendor.duration[TPM_SHORT] =
570 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
571 chip->vendor.duration[TPM_MEDIUM] =
572 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
573 chip->vendor.duration[TPM_LONG] =
574 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
575
576 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
577 * value wrong and apparently reports msecs rather than usecs. So we
578 * fix up the resulting too-small TPM_SHORT value to make things work.
579 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
580 */
581 if (chip->vendor.duration[TPM_SHORT] < (HZ / 100)) {
582 chip->vendor.duration[TPM_SHORT] = HZ;
583 chip->vendor.duration[TPM_MEDIUM] *= 1000;
584 chip->vendor.duration[TPM_LONG] *= 1000;
585 chip->vendor.duration_adjusted = true;
586 dev_info(chip->dev, "Adjusting TPM timeout parameters.");
587 }
588 return 0;
589}
590EXPORT_SYMBOL_GPL(tpm_get_timeouts);
591
592#define TPM_ORD_CONTINUE_SELFTEST 83
593#define CONTINUE_SELFTEST_RESULT_SIZE 10
594
595static struct tpm_input_header continue_selftest_header = {
596 .tag = TPM_TAG_RQU_COMMAND,
597 .length = cpu_to_be32(10),
598 .ordinal = cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST),
599};
600
601/**
602 * tpm_continue_selftest -- run TPM's selftest
603 * @chip: TPM chip to use
604 *
605 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
606 * a TPM error code.
607 */
608static int tpm_continue_selftest(struct tpm_chip *chip)
609{
610 int rc;
611 struct tpm_cmd_t cmd;
612
613 cmd.header.in = continue_selftest_header;
614 rc = transmit_cmd(chip, &cmd, CONTINUE_SELFTEST_RESULT_SIZE,
615 "continue selftest");
616 return rc;
617}
618
619/*
620 * tpm_chip_find_get - return tpm_chip for given chip number
621 */
622static struct tpm_chip *tpm_chip_find_get(int chip_num)
623{
624 struct tpm_chip *pos, *chip = NULL;
625
626 rcu_read_lock();
627 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
628 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
629 continue;
630
631 if (try_module_get(pos->dev->driver->owner)) {
632 chip = pos;
633 break;
634 }
635 }
636 rcu_read_unlock();
637 return chip;
638}
639
640#define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
641#define READ_PCR_RESULT_SIZE 30
642static struct tpm_input_header pcrread_header = {
643 .tag = TPM_TAG_RQU_COMMAND,
644 .length = cpu_to_be32(14),
645 .ordinal = TPM_ORDINAL_PCRREAD
646};
647
648int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
649{
650 int rc;
651 struct tpm_cmd_t cmd;
652
653 cmd.header.in = pcrread_header;
654 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
655 rc = transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
656 "attempting to read a pcr value");
657
658 if (rc == 0)
659 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
660 TPM_DIGEST_SIZE);
661 return rc;
662}
663
664/**
665 * tpm_pcr_read - read a pcr value
666 * @chip_num: tpm idx # or ANY
667 * @pcr_idx: pcr idx to retrieve
668 * @res_buf: TPM_PCR value
669 * size of res_buf is 20 bytes (or NULL if you don't care)
670 *
671 * The TPM driver should be built-in, but for whatever reason it
672 * isn't, protect against the chip disappearing, by incrementing
673 * the module usage count.
674 */
675int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
676{
677 struct tpm_chip *chip;
678 int rc;
679
680 chip = tpm_chip_find_get(chip_num);
681 if (chip == NULL)
682 return -ENODEV;
683 rc = tpm_pcr_read_dev(chip, pcr_idx, res_buf);
684 tpm_chip_put(chip);
685 return rc;
686}
687EXPORT_SYMBOL_GPL(tpm_pcr_read);
688
689/**
690 * tpm_pcr_extend - extend pcr value with hash
691 * @chip_num: tpm idx # or AN&
692 * @pcr_idx: pcr idx to extend
693 * @hash: hash value used to extend pcr value
694 *
695 * The TPM driver should be built-in, but for whatever reason it
696 * isn't, protect against the chip disappearing, by incrementing
697 * the module usage count.
698 */
699#define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
700#define EXTEND_PCR_RESULT_SIZE 34
701static struct tpm_input_header pcrextend_header = {
702 .tag = TPM_TAG_RQU_COMMAND,
703 .length = cpu_to_be32(34),
704 .ordinal = TPM_ORD_PCR_EXTEND
705};
706
707int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
708{
709 struct tpm_cmd_t cmd;
710 int rc;
711 struct tpm_chip *chip;
712
713 chip = tpm_chip_find_get(chip_num);
714 if (chip == NULL)
715 return -ENODEV;
716
717 cmd.header.in = pcrextend_header;
718 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
719 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
720 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
721 "attempting extend a PCR value");
722
723 tpm_chip_put(chip);
724 return rc;
725}
726EXPORT_SYMBOL_GPL(tpm_pcr_extend);
727
728/**
729 * tpm_do_selftest - have the TPM continue its selftest and wait until it
730 * can receive further commands
731 * @chip: TPM chip to use
732 *
733 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
734 * a TPM error code.
735 */
736int tpm_do_selftest(struct tpm_chip *chip)
737{
738 int rc;
739 unsigned int loops;
740 unsigned int delay_msec = 100;
741 unsigned long duration;
742 struct tpm_cmd_t cmd;
743
744 duration = tpm_calc_ordinal_duration(chip, TPM_ORD_CONTINUE_SELFTEST);
745
746 loops = jiffies_to_msecs(duration) / delay_msec;
747
748 rc = tpm_continue_selftest(chip);
749 /* This may fail if there was no TPM driver during a suspend/resume
750 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
751 */
752 if (rc)
753 return rc;
754
755 do {
756 /* Attempt to read a PCR value */
757 cmd.header.in = pcrread_header;
758 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(0);
759 rc = tpm_transmit(chip, (u8 *) &cmd, READ_PCR_RESULT_SIZE);
760 /* Some buggy TPMs will not respond to tpm_tis_ready() for
761 * around 300ms while the self test is ongoing, keep trying
762 * until the self test duration expires. */
763 if (rc == -ETIME) {
764 dev_info(chip->dev, HW_ERR "TPM command timed out during continue self test");
765 msleep(delay_msec);
766 continue;
767 }
768
769 if (rc < TPM_HEADER_SIZE)
770 return -EFAULT;
771
772 rc = be32_to_cpu(cmd.header.out.return_code);
773 if (rc == TPM_ERR_DISABLED || rc == TPM_ERR_DEACTIVATED) {
774 dev_info(chip->dev,
775 "TPM is disabled/deactivated (0x%X)\n", rc);
776 /* TPM is disabled and/or deactivated; driver can
777 * proceed and TPM does handle commands for
778 * suspend/resume correctly
779 */
780 return 0;
781 }
782 if (rc != TPM_WARN_DOING_SELFTEST)
783 return rc;
784 msleep(delay_msec);
785 } while (--loops > 0);
786
787 return rc;
788}
789EXPORT_SYMBOL_GPL(tpm_do_selftest);
790
791int tpm_send(u32 chip_num, void *cmd, size_t buflen)
792{
793 struct tpm_chip *chip;
794 int rc;
795
796 chip = tpm_chip_find_get(chip_num);
797 if (chip == NULL)
798 return -ENODEV;
799
800 rc = transmit_cmd(chip, cmd, buflen, "attempting tpm_cmd");
801
802 tpm_chip_put(chip);
803 return rc;
804}
805EXPORT_SYMBOL_GPL(tpm_send);
806
807static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask,
808 bool check_cancel, bool *canceled)
809{
810 u8 status = chip->ops->status(chip);
811
812 *canceled = false;
813 if ((status & mask) == mask)
814 return true;
815 if (check_cancel && chip->ops->req_canceled(chip, status)) {
816 *canceled = true;
817 return true;
818 }
819 return false;
820}
821
822int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
823 wait_queue_head_t *queue, bool check_cancel)
824{
825 unsigned long stop;
826 long rc;
827 u8 status;
828 bool canceled = false;
829
830 /* check current status */
831 status = chip->ops->status(chip);
832 if ((status & mask) == mask)
833 return 0;
834
835 stop = jiffies + timeout;
836
837 if (chip->vendor.irq) {
838again:
839 timeout = stop - jiffies;
840 if ((long)timeout <= 0)
841 return -ETIME;
842 rc = wait_event_interruptible_timeout(*queue,
843 wait_for_tpm_stat_cond(chip, mask, check_cancel,
844 &canceled),
845 timeout);
846 if (rc > 0) {
847 if (canceled)
848 return -ECANCELED;
849 return 0;
850 }
851 if (rc == -ERESTARTSYS && freezing(current)) {
852 clear_thread_flag(TIF_SIGPENDING);
853 goto again;
854 }
855 } else {
856 do {
857 msleep(TPM_TIMEOUT);
858 status = chip->ops->status(chip);
859 if ((status & mask) == mask)
860 return 0;
861 } while (time_before(jiffies, stop));
862 }
863 return -ETIME;
864}
865EXPORT_SYMBOL_GPL(wait_for_tpm_stat);
866
867void tpm_remove_hardware(struct device *dev)
868{
869 struct tpm_chip *chip = dev_get_drvdata(dev);
870
871 if (chip == NULL) {
872 dev_err(dev, "No device data found\n");
873 return;
874 }
875
876 spin_lock(&driver_lock);
877 list_del_rcu(&chip->list);
878 spin_unlock(&driver_lock);
879 synchronize_rcu();
880
881 tpm_dev_del_device(chip);
882 tpm_sysfs_del_device(chip);
883 tpm_remove_ppi(&dev->kobj);
884 tpm_bios_log_teardown(chip->bios_dir);
885
886 /* write it this way to be explicit (chip->dev == dev) */
887 put_device(chip->dev);
888}
889EXPORT_SYMBOL_GPL(tpm_remove_hardware);
890
891#define TPM_ORD_SAVESTATE cpu_to_be32(152)
892#define SAVESTATE_RESULT_SIZE 10
893
894static struct tpm_input_header savestate_header = {
895 .tag = TPM_TAG_RQU_COMMAND,
896 .length = cpu_to_be32(10),
897 .ordinal = TPM_ORD_SAVESTATE
898};
899
900/*
901 * We are about to suspend. Save the TPM state
902 * so that it can be restored.
903 */
904int tpm_pm_suspend(struct device *dev)
905{
906 struct tpm_chip *chip = dev_get_drvdata(dev);
907 struct tpm_cmd_t cmd;
908 int rc, try;
909
910 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
911
912 if (chip == NULL)
913 return -ENODEV;
914
915 /* for buggy tpm, flush pcrs with extend to selected dummy */
916 if (tpm_suspend_pcr) {
917 cmd.header.in = pcrextend_header;
918 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(tpm_suspend_pcr);
919 memcpy(cmd.params.pcrextend_in.hash, dummy_hash,
920 TPM_DIGEST_SIZE);
921 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
922 "extending dummy pcr before suspend");
923 }
924
925 /* now do the actual savestate */
926 for (try = 0; try < TPM_RETRY; try++) {
927 cmd.header.in = savestate_header;
928 rc = transmit_cmd(chip, &cmd, SAVESTATE_RESULT_SIZE, NULL);
929
930 /*
931 * If the TPM indicates that it is too busy to respond to
932 * this command then retry before giving up. It can take
933 * several seconds for this TPM to be ready.
934 *
935 * This can happen if the TPM has already been sent the
936 * SaveState command before the driver has loaded. TCG 1.2
937 * specification states that any communication after SaveState
938 * may cause the TPM to invalidate previously saved state.
939 */
940 if (rc != TPM_WARN_RETRY)
941 break;
942 msleep(TPM_TIMEOUT_RETRY);
943 }
944
945 if (rc)
946 dev_err(chip->dev,
947 "Error (%d) sending savestate before suspend\n", rc);
948 else if (try > 0)
949 dev_warn(chip->dev, "TPM savestate took %dms\n",
950 try * TPM_TIMEOUT_RETRY);
951
952 return rc;
953}
954EXPORT_SYMBOL_GPL(tpm_pm_suspend);
955
956/*
957 * Resume from a power safe. The BIOS already restored
958 * the TPM state.
959 */
960int tpm_pm_resume(struct device *dev)
961{
962 struct tpm_chip *chip = dev_get_drvdata(dev);
963
964 if (chip == NULL)
965 return -ENODEV;
966
967 return 0;
968}
969EXPORT_SYMBOL_GPL(tpm_pm_resume);
970
971#define TPM_GETRANDOM_RESULT_SIZE 18
972static struct tpm_input_header tpm_getrandom_header = {
973 .tag = TPM_TAG_RQU_COMMAND,
974 .length = cpu_to_be32(14),
975 .ordinal = TPM_ORD_GET_RANDOM
976};
977
978/**
979 * tpm_get_random() - Get random bytes from the tpm's RNG
980 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
981 * @out: destination buffer for the random bytes
982 * @max: the max number of bytes to write to @out
983 *
984 * Returns < 0 on error and the number of bytes read on success
985 */
986int tpm_get_random(u32 chip_num, u8 *out, size_t max)
987{
988 struct tpm_chip *chip;
989 struct tpm_cmd_t tpm_cmd;
990 u32 recd, num_bytes = min_t(u32, max, TPM_MAX_RNG_DATA);
991 int err, total = 0, retries = 5;
992 u8 *dest = out;
993
994 chip = tpm_chip_find_get(chip_num);
995 if (chip == NULL)
996 return -ENODEV;
997
998 if (!out || !num_bytes || max > TPM_MAX_RNG_DATA)
999 return -EINVAL;
1000
1001 do {
1002 tpm_cmd.header.in = tpm_getrandom_header;
1003 tpm_cmd.params.getrandom_in.num_bytes = cpu_to_be32(num_bytes);
1004
1005 err = transmit_cmd(chip, &tpm_cmd,
1006 TPM_GETRANDOM_RESULT_SIZE + num_bytes,
1007 "attempting get random");
1008 if (err)
1009 break;
1010
1011 recd = be32_to_cpu(tpm_cmd.params.getrandom_out.rng_data_len);
1012 memcpy(dest, tpm_cmd.params.getrandom_out.rng_data, recd);
1013
1014 dest += recd;
1015 total += recd;
1016 num_bytes -= recd;
1017 } while (retries-- && total < max);
1018
1019 return total ? total : -EIO;
1020}
1021EXPORT_SYMBOL_GPL(tpm_get_random);
1022
1023/* In case vendor provided release function, call it too.*/
1024
1025void tpm_dev_vendor_release(struct tpm_chip *chip)
1026{
1027 if (!chip)
1028 return;
1029
1030 clear_bit(chip->dev_num, dev_mask);
1031}
1032EXPORT_SYMBOL_GPL(tpm_dev_vendor_release);
1033
1034
1035/*
1036 * Once all references to platform device are down to 0,
1037 * release all allocated structures.
1038 */
1039static void tpm_dev_release(struct device *dev)
1040{
1041 struct tpm_chip *chip = dev_get_drvdata(dev);
1042
1043 if (!chip)
1044 return;
1045
1046 tpm_dev_vendor_release(chip);
1047
1048 chip->release(dev);
1049 kfree(chip);
1050}
1051
1052/*
1053 * Called from tpm_<specific>.c probe function only for devices
1054 * the driver has determined it should claim. Prior to calling
1055 * this function the specific probe function has called pci_enable_device
1056 * upon errant exit from this function specific probe function should call
1057 * pci_disable_device
1058 */
1059struct tpm_chip *tpm_register_hardware(struct device *dev,
1060 const struct tpm_class_ops *ops)
1061{
1062 struct tpm_chip *chip;
1063
1064 /* Driver specific per-device data */
1065 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1066
1067 if (chip == NULL)
1068 return NULL;
1069
1070 mutex_init(&chip->tpm_mutex);
1071 INIT_LIST_HEAD(&chip->list);
1072
1073 chip->ops = ops;
1074 chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
1075
1076 if (chip->dev_num >= TPM_NUM_DEVICES) {
1077 dev_err(dev, "No available tpm device numbers\n");
1078 goto out_free;
1079 }
1080
1081 set_bit(chip->dev_num, dev_mask);
1082
1083 scnprintf(chip->devname, sizeof(chip->devname), "%s%d", "tpm",
1084 chip->dev_num);
1085
1086 chip->dev = get_device(dev);
1087 chip->release = dev->release;
1088 dev->release = tpm_dev_release;
1089 dev_set_drvdata(dev, chip);
1090
1091 if (tpm_dev_add_device(chip))
1092 goto put_device;
1093
1094 if (tpm_sysfs_add_device(chip))
1095 goto del_misc;
1096
1097 if (tpm_add_ppi(&dev->kobj))
1098 goto del_misc;
1099
1100 chip->bios_dir = tpm_bios_log_setup(chip->devname);
1101
1102 /* Make chip available */
1103 spin_lock(&driver_lock);
1104 list_add_rcu(&chip->list, &tpm_chip_list);
1105 spin_unlock(&driver_lock);
1106
1107 return chip;
1108
1109del_misc:
1110 tpm_dev_del_device(chip);
1111put_device:
1112 put_device(chip->dev);
1113out_free:
1114 kfree(chip);
1115 return NULL;
1116}
1117EXPORT_SYMBOL_GPL(tpm_register_hardware);
1118
1119MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1120MODULE_DESCRIPTION("TPM Driver");
1121MODULE_VERSION("2.0");
1122MODULE_LICENSE("GPL");