char/tpm: Fix unitialized usage of data buffer
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / char / tpm / tpm.c
blob4b6c3eac1e28a94c802921696de72af9924d6442
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/mutex.h>
28 #include <linux/spinlock.h>
30 #include "tpm.h"
32 enum tpm_const {
33 TPM_MINOR = 224, /* officially assigned */
34 TPM_BUFSIZE = 4096,
35 TPM_NUM_DEVICES = 256,
38 enum tpm_duration {
39 TPM_SHORT = 0,
40 TPM_MEDIUM = 1,
41 TPM_LONG = 2,
42 TPM_UNDEFINED,
45 #define TPM_MAX_ORDINAL 243
46 #define TPM_MAX_PROTECTED_ORDINAL 12
47 #define TPM_PROTECTED_ORDINAL_MASK 0xFF
49 static LIST_HEAD(tpm_chip_list);
50 static DEFINE_SPINLOCK(driver_lock);
51 static DECLARE_BITMAP(dev_mask, TPM_NUM_DEVICES);
54 * Array with one entry per ordinal defining the maximum amount
55 * of time the chip could take to return the result. The ordinal
56 * designation of short, medium or long is defined in a table in
57 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
58 * values of the SHORT, MEDIUM, and LONG durations are retrieved
59 * from the chip during initialization with a call to tpm_get_timeouts.
61 static const u8 tpm_protected_ordinal_duration[TPM_MAX_PROTECTED_ORDINAL] = {
62 TPM_UNDEFINED, /* 0 */
63 TPM_UNDEFINED,
64 TPM_UNDEFINED,
65 TPM_UNDEFINED,
66 TPM_UNDEFINED,
67 TPM_UNDEFINED, /* 5 */
68 TPM_UNDEFINED,
69 TPM_UNDEFINED,
70 TPM_UNDEFINED,
71 TPM_UNDEFINED,
72 TPM_SHORT, /* 10 */
73 TPM_SHORT,
76 static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
77 TPM_UNDEFINED, /* 0 */
78 TPM_UNDEFINED,
79 TPM_UNDEFINED,
80 TPM_UNDEFINED,
81 TPM_UNDEFINED,
82 TPM_UNDEFINED, /* 5 */
83 TPM_UNDEFINED,
84 TPM_UNDEFINED,
85 TPM_UNDEFINED,
86 TPM_UNDEFINED,
87 TPM_SHORT, /* 10 */
88 TPM_SHORT,
89 TPM_MEDIUM,
90 TPM_LONG,
91 TPM_LONG,
92 TPM_MEDIUM, /* 15 */
93 TPM_SHORT,
94 TPM_SHORT,
95 TPM_MEDIUM,
96 TPM_LONG,
97 TPM_SHORT, /* 20 */
98 TPM_SHORT,
99 TPM_MEDIUM,
100 TPM_MEDIUM,
101 TPM_MEDIUM,
102 TPM_SHORT, /* 25 */
103 TPM_SHORT,
104 TPM_MEDIUM,
105 TPM_SHORT,
106 TPM_SHORT,
107 TPM_MEDIUM, /* 30 */
108 TPM_LONG,
109 TPM_MEDIUM,
110 TPM_SHORT,
111 TPM_SHORT,
112 TPM_SHORT, /* 35 */
113 TPM_MEDIUM,
114 TPM_MEDIUM,
115 TPM_UNDEFINED,
116 TPM_UNDEFINED,
117 TPM_MEDIUM, /* 40 */
118 TPM_LONG,
119 TPM_MEDIUM,
120 TPM_SHORT,
121 TPM_SHORT,
122 TPM_SHORT, /* 45 */
123 TPM_SHORT,
124 TPM_SHORT,
125 TPM_SHORT,
126 TPM_LONG,
127 TPM_MEDIUM, /* 50 */
128 TPM_MEDIUM,
129 TPM_UNDEFINED,
130 TPM_UNDEFINED,
131 TPM_UNDEFINED,
132 TPM_UNDEFINED, /* 55 */
133 TPM_UNDEFINED,
134 TPM_UNDEFINED,
135 TPM_UNDEFINED,
136 TPM_UNDEFINED,
137 TPM_MEDIUM, /* 60 */
138 TPM_MEDIUM,
139 TPM_MEDIUM,
140 TPM_SHORT,
141 TPM_SHORT,
142 TPM_MEDIUM, /* 65 */
143 TPM_UNDEFINED,
144 TPM_UNDEFINED,
145 TPM_UNDEFINED,
146 TPM_UNDEFINED,
147 TPM_SHORT, /* 70 */
148 TPM_SHORT,
149 TPM_UNDEFINED,
150 TPM_UNDEFINED,
151 TPM_UNDEFINED,
152 TPM_UNDEFINED, /* 75 */
153 TPM_UNDEFINED,
154 TPM_UNDEFINED,
155 TPM_UNDEFINED,
156 TPM_UNDEFINED,
157 TPM_LONG, /* 80 */
158 TPM_UNDEFINED,
159 TPM_MEDIUM,
160 TPM_LONG,
161 TPM_SHORT,
162 TPM_UNDEFINED, /* 85 */
163 TPM_UNDEFINED,
164 TPM_UNDEFINED,
165 TPM_UNDEFINED,
166 TPM_UNDEFINED,
167 TPM_SHORT, /* 90 */
168 TPM_SHORT,
169 TPM_SHORT,
170 TPM_SHORT,
171 TPM_SHORT,
172 TPM_UNDEFINED, /* 95 */
173 TPM_UNDEFINED,
174 TPM_UNDEFINED,
175 TPM_UNDEFINED,
176 TPM_UNDEFINED,
177 TPM_MEDIUM, /* 100 */
178 TPM_SHORT,
179 TPM_SHORT,
180 TPM_UNDEFINED,
181 TPM_UNDEFINED,
182 TPM_UNDEFINED, /* 105 */
183 TPM_UNDEFINED,
184 TPM_UNDEFINED,
185 TPM_UNDEFINED,
186 TPM_UNDEFINED,
187 TPM_SHORT, /* 110 */
188 TPM_SHORT,
189 TPM_SHORT,
190 TPM_SHORT,
191 TPM_SHORT,
192 TPM_SHORT, /* 115 */
193 TPM_SHORT,
194 TPM_SHORT,
195 TPM_UNDEFINED,
196 TPM_UNDEFINED,
197 TPM_LONG, /* 120 */
198 TPM_LONG,
199 TPM_MEDIUM,
200 TPM_UNDEFINED,
201 TPM_SHORT,
202 TPM_SHORT, /* 125 */
203 TPM_SHORT,
204 TPM_LONG,
205 TPM_SHORT,
206 TPM_SHORT,
207 TPM_SHORT, /* 130 */
208 TPM_MEDIUM,
209 TPM_UNDEFINED,
210 TPM_SHORT,
211 TPM_MEDIUM,
212 TPM_UNDEFINED, /* 135 */
213 TPM_UNDEFINED,
214 TPM_UNDEFINED,
215 TPM_UNDEFINED,
216 TPM_UNDEFINED,
217 TPM_SHORT, /* 140 */
218 TPM_SHORT,
219 TPM_UNDEFINED,
220 TPM_UNDEFINED,
221 TPM_UNDEFINED,
222 TPM_UNDEFINED, /* 145 */
223 TPM_UNDEFINED,
224 TPM_UNDEFINED,
225 TPM_UNDEFINED,
226 TPM_UNDEFINED,
227 TPM_SHORT, /* 150 */
228 TPM_MEDIUM,
229 TPM_MEDIUM,
230 TPM_SHORT,
231 TPM_SHORT,
232 TPM_UNDEFINED, /* 155 */
233 TPM_UNDEFINED,
234 TPM_UNDEFINED,
235 TPM_UNDEFINED,
236 TPM_UNDEFINED,
237 TPM_SHORT, /* 160 */
238 TPM_SHORT,
239 TPM_SHORT,
240 TPM_SHORT,
241 TPM_UNDEFINED,
242 TPM_UNDEFINED, /* 165 */
243 TPM_UNDEFINED,
244 TPM_UNDEFINED,
245 TPM_UNDEFINED,
246 TPM_UNDEFINED,
247 TPM_LONG, /* 170 */
248 TPM_UNDEFINED,
249 TPM_UNDEFINED,
250 TPM_UNDEFINED,
251 TPM_UNDEFINED,
252 TPM_UNDEFINED, /* 175 */
253 TPM_UNDEFINED,
254 TPM_UNDEFINED,
255 TPM_UNDEFINED,
256 TPM_UNDEFINED,
257 TPM_MEDIUM, /* 180 */
258 TPM_SHORT,
259 TPM_MEDIUM,
260 TPM_MEDIUM,
261 TPM_MEDIUM,
262 TPM_MEDIUM, /* 185 */
263 TPM_SHORT,
264 TPM_UNDEFINED,
265 TPM_UNDEFINED,
266 TPM_UNDEFINED,
267 TPM_UNDEFINED, /* 190 */
268 TPM_UNDEFINED,
269 TPM_UNDEFINED,
270 TPM_UNDEFINED,
271 TPM_UNDEFINED,
272 TPM_UNDEFINED, /* 195 */
273 TPM_UNDEFINED,
274 TPM_UNDEFINED,
275 TPM_UNDEFINED,
276 TPM_UNDEFINED,
277 TPM_SHORT, /* 200 */
278 TPM_UNDEFINED,
279 TPM_UNDEFINED,
280 TPM_UNDEFINED,
281 TPM_SHORT,
282 TPM_SHORT, /* 205 */
283 TPM_SHORT,
284 TPM_SHORT,
285 TPM_SHORT,
286 TPM_SHORT,
287 TPM_MEDIUM, /* 210 */
288 TPM_UNDEFINED,
289 TPM_MEDIUM,
290 TPM_MEDIUM,
291 TPM_MEDIUM,
292 TPM_UNDEFINED, /* 215 */
293 TPM_MEDIUM,
294 TPM_UNDEFINED,
295 TPM_UNDEFINED,
296 TPM_SHORT,
297 TPM_SHORT, /* 220 */
298 TPM_SHORT,
299 TPM_SHORT,
300 TPM_SHORT,
301 TPM_SHORT,
302 TPM_UNDEFINED, /* 225 */
303 TPM_UNDEFINED,
304 TPM_UNDEFINED,
305 TPM_UNDEFINED,
306 TPM_UNDEFINED,
307 TPM_SHORT, /* 230 */
308 TPM_LONG,
309 TPM_MEDIUM,
310 TPM_UNDEFINED,
311 TPM_UNDEFINED,
312 TPM_UNDEFINED, /* 235 */
313 TPM_UNDEFINED,
314 TPM_UNDEFINED,
315 TPM_UNDEFINED,
316 TPM_UNDEFINED,
317 TPM_SHORT, /* 240 */
318 TPM_UNDEFINED,
319 TPM_MEDIUM,
322 static void user_reader_timeout(unsigned long ptr)
324 struct tpm_chip *chip = (struct tpm_chip *) ptr;
326 schedule_work(&chip->work);
329 static void timeout_work(struct work_struct *work)
331 struct tpm_chip *chip = container_of(work, struct tpm_chip, work);
333 mutex_lock(&chip->buffer_mutex);
334 atomic_set(&chip->data_pending, 0);
335 memset(chip->data_buffer, 0, TPM_BUFSIZE);
336 mutex_unlock(&chip->buffer_mutex);
340 * Returns max number of jiffies to wait
342 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
343 u32 ordinal)
345 int duration_idx = TPM_UNDEFINED;
346 int duration = 0;
348 if (ordinal < TPM_MAX_ORDINAL)
349 duration_idx = tpm_ordinal_duration[ordinal];
350 else if ((ordinal & TPM_PROTECTED_ORDINAL_MASK) <
351 TPM_MAX_PROTECTED_ORDINAL)
352 duration_idx =
353 tpm_protected_ordinal_duration[ordinal &
354 TPM_PROTECTED_ORDINAL_MASK];
356 if (duration_idx != TPM_UNDEFINED) {
357 duration = chip->vendor.duration[duration_idx];
358 /* if duration is 0, it's because chip->vendor.duration wasn't */
359 /* filled yet, so we set the lowest timeout just to give enough */
360 /* time for tpm_get_timeouts() to succeed */
361 return (duration <= 0 ? HZ : duration);
362 } else
363 return 2 * 60 * HZ;
365 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
368 * Internal kernel interface to transmit TPM commands
370 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
371 size_t bufsiz)
373 ssize_t rc;
374 u32 count, ordinal;
375 unsigned long stop;
377 count = be32_to_cpu(*((__be32 *) (buf + 2)));
378 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
379 if (count == 0)
380 return -ENODATA;
381 if (count > bufsiz) {
382 dev_err(chip->dev,
383 "invalid count value %x %zx \n", count, bufsiz);
384 return -E2BIG;
387 mutex_lock(&chip->tpm_mutex);
389 if ((rc = chip->vendor.send(chip, (u8 *) buf, count)) < 0) {
390 dev_err(chip->dev,
391 "tpm_transmit: tpm_send: error %zd\n", rc);
392 goto out;
395 if (chip->vendor.irq)
396 goto out_recv;
398 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
399 do {
400 u8 status = chip->vendor.status(chip);
401 if ((status & chip->vendor.req_complete_mask) ==
402 chip->vendor.req_complete_val)
403 goto out_recv;
405 if ((status == chip->vendor.req_canceled)) {
406 dev_err(chip->dev, "Operation Canceled\n");
407 rc = -ECANCELED;
408 goto out;
411 msleep(TPM_TIMEOUT); /* CHECK */
412 rmb();
413 } while (time_before(jiffies, stop));
415 chip->vendor.cancel(chip);
416 dev_err(chip->dev, "Operation Timed out\n");
417 rc = -ETIME;
418 goto out;
420 out_recv:
421 rc = chip->vendor.recv(chip, (u8 *) buf, bufsiz);
422 if (rc < 0)
423 dev_err(chip->dev,
424 "tpm_transmit: tpm_recv: error %zd\n", rc);
425 out:
426 mutex_unlock(&chip->tpm_mutex);
427 return rc;
430 #define TPM_DIGEST_SIZE 20
431 #define TPM_ERROR_SIZE 10
432 #define TPM_RET_CODE_IDX 6
434 enum tpm_capabilities {
435 TPM_CAP_FLAG = cpu_to_be32(4),
436 TPM_CAP_PROP = cpu_to_be32(5),
437 CAP_VERSION_1_1 = cpu_to_be32(0x06),
438 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
441 enum tpm_sub_capabilities {
442 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
443 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
444 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
445 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
446 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
447 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
448 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
452 static ssize_t transmit_cmd(struct tpm_chip *chip, struct tpm_cmd_t *cmd,
453 int len, const char *desc)
455 int err;
457 len = tpm_transmit(chip,(u8 *) cmd, len);
458 if (len < 0)
459 return len;
460 if (len == TPM_ERROR_SIZE) {
461 err = be32_to_cpu(cmd->header.out.return_code);
462 dev_dbg(chip->dev, "A TPM error (%d) occurred %s\n", err, desc);
463 return err;
465 return 0;
468 #define TPM_INTERNAL_RESULT_SIZE 200
469 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
470 #define TPM_ORD_GET_CAP cpu_to_be32(101)
472 static const struct tpm_input_header tpm_getcap_header = {
473 .tag = TPM_TAG_RQU_COMMAND,
474 .length = cpu_to_be32(22),
475 .ordinal = TPM_ORD_GET_CAP
478 ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
479 const char *desc)
481 struct tpm_cmd_t tpm_cmd;
482 int rc;
483 struct tpm_chip *chip = dev_get_drvdata(dev);
485 tpm_cmd.header.in = tpm_getcap_header;
486 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
487 tpm_cmd.params.getcap_in.cap = subcap_id;
488 /*subcap field not necessary */
489 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
490 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
491 } else {
492 if (subcap_id == TPM_CAP_FLAG_PERM ||
493 subcap_id == TPM_CAP_FLAG_VOL)
494 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
495 else
496 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
497 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
498 tpm_cmd.params.getcap_in.subcap = subcap_id;
500 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
501 if (!rc)
502 *cap = tpm_cmd.params.getcap_out.cap;
503 return rc;
506 void tpm_gen_interrupt(struct tpm_chip *chip)
508 struct tpm_cmd_t tpm_cmd;
509 ssize_t rc;
511 tpm_cmd.header.in = tpm_getcap_header;
512 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
513 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
514 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
516 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
517 "attempting to determine the timeouts");
519 EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
521 void tpm_get_timeouts(struct tpm_chip *chip)
523 struct tpm_cmd_t tpm_cmd;
524 struct timeout_t *timeout_cap;
525 struct duration_t *duration_cap;
526 ssize_t rc;
527 u32 timeout;
529 tpm_cmd.header.in = tpm_getcap_header;
530 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
531 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
532 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
534 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
535 "attempting to determine the timeouts");
536 if (rc)
537 goto duration;
539 if (be32_to_cpu(tpm_cmd.header.out.length)
540 != 4 * sizeof(u32))
541 goto duration;
543 timeout_cap = &tpm_cmd.params.getcap_out.cap.timeout;
544 /* Don't overwrite default if value is 0 */
545 timeout = be32_to_cpu(timeout_cap->a);
546 if (timeout)
547 chip->vendor.timeout_a = usecs_to_jiffies(timeout);
548 timeout = be32_to_cpu(timeout_cap->b);
549 if (timeout)
550 chip->vendor.timeout_b = usecs_to_jiffies(timeout);
551 timeout = be32_to_cpu(timeout_cap->c);
552 if (timeout)
553 chip->vendor.timeout_c = usecs_to_jiffies(timeout);
554 timeout = be32_to_cpu(timeout_cap->d);
555 if (timeout)
556 chip->vendor.timeout_d = usecs_to_jiffies(timeout);
558 duration:
559 tpm_cmd.header.in = tpm_getcap_header;
560 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
561 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
562 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
564 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
565 "attempting to determine the durations");
566 if (rc)
567 return;
569 if (be32_to_cpu(tpm_cmd.header.out.return_code)
570 != 3 * sizeof(u32))
571 return;
572 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
573 chip->vendor.duration[TPM_SHORT] =
574 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
575 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
576 * value wrong and apparently reports msecs rather than usecs. So we
577 * fix up the resulting too-small TPM_SHORT value to make things work.
579 if (chip->vendor.duration[TPM_SHORT] < (HZ/100))
580 chip->vendor.duration[TPM_SHORT] = HZ;
582 chip->vendor.duration[TPM_MEDIUM] =
583 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
584 chip->vendor.duration[TPM_LONG] =
585 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
587 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
589 void tpm_continue_selftest(struct tpm_chip *chip)
591 u8 data[] = {
592 0, 193, /* TPM_TAG_RQU_COMMAND */
593 0, 0, 0, 10, /* length */
594 0, 0, 0, 83, /* TPM_ORD_GetCapability */
597 tpm_transmit(chip, data, sizeof(data));
599 EXPORT_SYMBOL_GPL(tpm_continue_selftest);
601 ssize_t tpm_show_enabled(struct device * dev, struct device_attribute * attr,
602 char *buf)
604 cap_t cap;
605 ssize_t rc;
607 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
608 "attempting to determine the permanent enabled state");
609 if (rc)
610 return 0;
612 rc = sprintf(buf, "%d\n", !cap.perm_flags.disable);
613 return rc;
615 EXPORT_SYMBOL_GPL(tpm_show_enabled);
617 ssize_t tpm_show_active(struct device * dev, struct device_attribute * attr,
618 char *buf)
620 cap_t cap;
621 ssize_t rc;
623 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
624 "attempting to determine the permanent active state");
625 if (rc)
626 return 0;
628 rc = sprintf(buf, "%d\n", !cap.perm_flags.deactivated);
629 return rc;
631 EXPORT_SYMBOL_GPL(tpm_show_active);
633 ssize_t tpm_show_owned(struct device * dev, struct device_attribute * attr,
634 char *buf)
636 cap_t cap;
637 ssize_t rc;
639 rc = tpm_getcap(dev, TPM_CAP_PROP_OWNER, &cap,
640 "attempting to determine the owner state");
641 if (rc)
642 return 0;
644 rc = sprintf(buf, "%d\n", cap.owned);
645 return rc;
647 EXPORT_SYMBOL_GPL(tpm_show_owned);
649 ssize_t tpm_show_temp_deactivated(struct device * dev,
650 struct device_attribute * attr, char *buf)
652 cap_t cap;
653 ssize_t rc;
655 rc = tpm_getcap(dev, TPM_CAP_FLAG_VOL, &cap,
656 "attempting to determine the temporary state");
657 if (rc)
658 return 0;
660 rc = sprintf(buf, "%d\n", cap.stclear_flags.deactivated);
661 return rc;
663 EXPORT_SYMBOL_GPL(tpm_show_temp_deactivated);
666 * tpm_chip_find_get - return tpm_chip for given chip number
668 static struct tpm_chip *tpm_chip_find_get(int chip_num)
670 struct tpm_chip *pos, *chip = NULL;
672 rcu_read_lock();
673 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
674 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
675 continue;
677 if (try_module_get(pos->dev->driver->owner)) {
678 chip = pos;
679 break;
682 rcu_read_unlock();
683 return chip;
686 #define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
687 #define READ_PCR_RESULT_SIZE 30
688 static struct tpm_input_header pcrread_header = {
689 .tag = TPM_TAG_RQU_COMMAND,
690 .length = cpu_to_be32(14),
691 .ordinal = TPM_ORDINAL_PCRREAD
694 int __tpm_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
696 int rc;
697 struct tpm_cmd_t cmd;
699 cmd.header.in = pcrread_header;
700 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
701 rc = transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
702 "attempting to read a pcr value");
704 if (rc == 0)
705 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
706 TPM_DIGEST_SIZE);
707 return rc;
711 * tpm_pcr_read - read a pcr value
712 * @chip_num: tpm idx # or ANY
713 * @pcr_idx: pcr idx to retrieve
714 * @res_buf: TPM_PCR value
715 * size of res_buf is 20 bytes (or NULL if you don't care)
717 * The TPM driver should be built-in, but for whatever reason it
718 * isn't, protect against the chip disappearing, by incrementing
719 * the module usage count.
721 int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
723 struct tpm_chip *chip;
724 int rc;
726 chip = tpm_chip_find_get(chip_num);
727 if (chip == NULL)
728 return -ENODEV;
729 rc = __tpm_pcr_read(chip, pcr_idx, res_buf);
730 module_put(chip->dev->driver->owner);
731 return rc;
733 EXPORT_SYMBOL_GPL(tpm_pcr_read);
736 * tpm_pcr_extend - extend pcr value with hash
737 * @chip_num: tpm idx # or AN&
738 * @pcr_idx: pcr idx to extend
739 * @hash: hash value used to extend pcr value
741 * The TPM driver should be built-in, but for whatever reason it
742 * isn't, protect against the chip disappearing, by incrementing
743 * the module usage count.
745 #define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
746 #define EXTEND_PCR_RESULT_SIZE 34
747 static struct tpm_input_header pcrextend_header = {
748 .tag = TPM_TAG_RQU_COMMAND,
749 .length = cpu_to_be32(34),
750 .ordinal = TPM_ORD_PCR_EXTEND
753 int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
755 struct tpm_cmd_t cmd;
756 int rc;
757 struct tpm_chip *chip;
759 chip = tpm_chip_find_get(chip_num);
760 if (chip == NULL)
761 return -ENODEV;
763 cmd.header.in = pcrextend_header;
764 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
765 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
766 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
767 "attempting extend a PCR value");
769 module_put(chip->dev->driver->owner);
770 return rc;
772 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
774 ssize_t tpm_show_pcrs(struct device *dev, struct device_attribute *attr,
775 char *buf)
777 cap_t cap;
778 u8 digest[TPM_DIGEST_SIZE];
779 ssize_t rc;
780 int i, j, num_pcrs;
781 char *str = buf;
782 struct tpm_chip *chip = dev_get_drvdata(dev);
784 rc = tpm_getcap(dev, TPM_CAP_PROP_PCR, &cap,
785 "attempting to determine the number of PCRS");
786 if (rc)
787 return 0;
789 num_pcrs = be32_to_cpu(cap.num_pcrs);
790 for (i = 0; i < num_pcrs; i++) {
791 rc = __tpm_pcr_read(chip, i, digest);
792 if (rc)
793 break;
794 str += sprintf(str, "PCR-%02d: ", i);
795 for (j = 0; j < TPM_DIGEST_SIZE; j++)
796 str += sprintf(str, "%02X ", digest[j]);
797 str += sprintf(str, "\n");
799 return str - buf;
801 EXPORT_SYMBOL_GPL(tpm_show_pcrs);
803 #define READ_PUBEK_RESULT_SIZE 314
804 #define TPM_ORD_READPUBEK cpu_to_be32(124)
805 struct tpm_input_header tpm_readpubek_header = {
806 .tag = TPM_TAG_RQU_COMMAND,
807 .length = cpu_to_be32(30),
808 .ordinal = TPM_ORD_READPUBEK
811 ssize_t tpm_show_pubek(struct device *dev, struct device_attribute *attr,
812 char *buf)
814 u8 *data;
815 struct tpm_cmd_t tpm_cmd;
816 ssize_t err;
817 int i, rc;
818 char *str = buf;
820 struct tpm_chip *chip = dev_get_drvdata(dev);
822 tpm_cmd.header.in = tpm_readpubek_header;
823 err = transmit_cmd(chip, &tpm_cmd, READ_PUBEK_RESULT_SIZE,
824 "attempting to read the PUBEK");
825 if (err)
826 goto out;
829 ignore header 10 bytes
830 algorithm 32 bits (1 == RSA )
831 encscheme 16 bits
832 sigscheme 16 bits
833 parameters (RSA 12->bytes: keybit, #primes, expbit)
834 keylenbytes 32 bits
835 256 byte modulus
836 ignore checksum 20 bytes
838 data = tpm_cmd.params.readpubek_out_buffer;
839 str +=
840 sprintf(str,
841 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
842 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
843 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
844 "Modulus length: %d\nModulus: \n",
845 data[10], data[11], data[12], data[13], data[14],
846 data[15], data[16], data[17], data[22], data[23],
847 data[24], data[25], data[26], data[27], data[28],
848 data[29], data[30], data[31], data[32], data[33],
849 be32_to_cpu(*((__be32 *) (data + 34))));
851 for (i = 0; i < 256; i++) {
852 str += sprintf(str, "%02X ", data[i + 38]);
853 if ((i + 1) % 16 == 0)
854 str += sprintf(str, "\n");
856 out:
857 rc = str - buf;
858 return rc;
860 EXPORT_SYMBOL_GPL(tpm_show_pubek);
863 ssize_t tpm_show_caps(struct device *dev, struct device_attribute *attr,
864 char *buf)
866 cap_t cap;
867 ssize_t rc;
868 char *str = buf;
870 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
871 "attempting to determine the manufacturer");
872 if (rc)
873 return 0;
874 str += sprintf(str, "Manufacturer: 0x%x\n",
875 be32_to_cpu(cap.manufacturer_id));
877 rc = tpm_getcap(dev, CAP_VERSION_1_1, &cap,
878 "attempting to determine the 1.1 version");
879 if (rc)
880 return 0;
881 str += sprintf(str,
882 "TCG version: %d.%d\nFirmware version: %d.%d\n",
883 cap.tpm_version.Major, cap.tpm_version.Minor,
884 cap.tpm_version.revMajor, cap.tpm_version.revMinor);
885 return str - buf;
887 EXPORT_SYMBOL_GPL(tpm_show_caps);
889 ssize_t tpm_show_caps_1_2(struct device * dev,
890 struct device_attribute * attr, char *buf)
892 cap_t cap;
893 ssize_t rc;
894 char *str = buf;
896 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
897 "attempting to determine the manufacturer");
898 if (rc)
899 return 0;
900 str += sprintf(str, "Manufacturer: 0x%x\n",
901 be32_to_cpu(cap.manufacturer_id));
902 rc = tpm_getcap(dev, CAP_VERSION_1_2, &cap,
903 "attempting to determine the 1.2 version");
904 if (rc)
905 return 0;
906 str += sprintf(str,
907 "TCG version: %d.%d\nFirmware version: %d.%d\n",
908 cap.tpm_version_1_2.Major, cap.tpm_version_1_2.Minor,
909 cap.tpm_version_1_2.revMajor,
910 cap.tpm_version_1_2.revMinor);
911 return str - buf;
913 EXPORT_SYMBOL_GPL(tpm_show_caps_1_2);
915 ssize_t tpm_store_cancel(struct device *dev, struct device_attribute *attr,
916 const char *buf, size_t count)
918 struct tpm_chip *chip = dev_get_drvdata(dev);
919 if (chip == NULL)
920 return 0;
922 chip->vendor.cancel(chip);
923 return count;
925 EXPORT_SYMBOL_GPL(tpm_store_cancel);
928 * Device file system interface to the TPM
930 * It's assured that the chip will be opened just once,
931 * by the check of is_open variable, which is protected
932 * by driver_lock.
934 int tpm_open(struct inode *inode, struct file *file)
936 int minor = iminor(inode);
937 struct tpm_chip *chip = NULL, *pos;
939 rcu_read_lock();
940 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
941 if (pos->vendor.miscdev.minor == minor) {
942 chip = pos;
943 get_device(chip->dev);
944 break;
947 rcu_read_unlock();
949 if (!chip)
950 return -ENODEV;
952 if (test_and_set_bit(0, &chip->is_open)) {
953 dev_dbg(chip->dev, "Another process owns this TPM\n");
954 put_device(chip->dev);
955 return -EBUSY;
958 chip->data_buffer = kzalloc(TPM_BUFSIZE, GFP_KERNEL);
959 if (chip->data_buffer == NULL) {
960 clear_bit(0, &chip->is_open);
961 put_device(chip->dev);
962 return -ENOMEM;
965 atomic_set(&chip->data_pending, 0);
967 file->private_data = chip;
968 return 0;
970 EXPORT_SYMBOL_GPL(tpm_open);
973 * Called on file close
975 int tpm_release(struct inode *inode, struct file *file)
977 struct tpm_chip *chip = file->private_data;
979 del_singleshot_timer_sync(&chip->user_read_timer);
980 flush_scheduled_work();
981 file->private_data = NULL;
982 atomic_set(&chip->data_pending, 0);
983 kfree(chip->data_buffer);
984 clear_bit(0, &chip->is_open);
985 put_device(chip->dev);
986 return 0;
988 EXPORT_SYMBOL_GPL(tpm_release);
990 ssize_t tpm_write(struct file *file, const char __user *buf,
991 size_t size, loff_t *off)
993 struct tpm_chip *chip = file->private_data;
994 size_t in_size = size, out_size;
996 /* cannot perform a write until the read has cleared
997 either via tpm_read or a user_read_timer timeout */
998 while (atomic_read(&chip->data_pending) != 0)
999 msleep(TPM_TIMEOUT);
1001 mutex_lock(&chip->buffer_mutex);
1003 if (in_size > TPM_BUFSIZE)
1004 in_size = TPM_BUFSIZE;
1006 if (copy_from_user
1007 (chip->data_buffer, (void __user *) buf, in_size)) {
1008 mutex_unlock(&chip->buffer_mutex);
1009 return -EFAULT;
1012 /* atomic tpm command send and result receive */
1013 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
1015 atomic_set(&chip->data_pending, out_size);
1016 mutex_unlock(&chip->buffer_mutex);
1018 /* Set a timeout by which the reader must come claim the result */
1019 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
1021 return in_size;
1023 EXPORT_SYMBOL_GPL(tpm_write);
1025 ssize_t tpm_read(struct file *file, char __user *buf,
1026 size_t size, loff_t *off)
1028 struct tpm_chip *chip = file->private_data;
1029 ssize_t ret_size;
1031 del_singleshot_timer_sync(&chip->user_read_timer);
1032 flush_scheduled_work();
1033 ret_size = atomic_read(&chip->data_pending);
1034 atomic_set(&chip->data_pending, 0);
1035 if (ret_size > 0) { /* relay data */
1036 if (size < ret_size)
1037 ret_size = size;
1039 mutex_lock(&chip->buffer_mutex);
1040 if (copy_to_user(buf, chip->data_buffer, ret_size))
1041 ret_size = -EFAULT;
1042 mutex_unlock(&chip->buffer_mutex);
1045 return ret_size;
1047 EXPORT_SYMBOL_GPL(tpm_read);
1049 void tpm_remove_hardware(struct device *dev)
1051 struct tpm_chip *chip = dev_get_drvdata(dev);
1053 if (chip == NULL) {
1054 dev_err(dev, "No device data found\n");
1055 return;
1058 spin_lock(&driver_lock);
1059 list_del_rcu(&chip->list);
1060 spin_unlock(&driver_lock);
1061 synchronize_rcu();
1063 misc_deregister(&chip->vendor.miscdev);
1064 sysfs_remove_group(&dev->kobj, chip->vendor.attr_group);
1065 tpm_bios_log_teardown(chip->bios_dir);
1067 /* write it this way to be explicit (chip->dev == dev) */
1068 put_device(chip->dev);
1070 EXPORT_SYMBOL_GPL(tpm_remove_hardware);
1073 * We are about to suspend. Save the TPM state
1074 * so that it can be restored.
1076 int tpm_pm_suspend(struct device *dev, pm_message_t pm_state)
1078 struct tpm_chip *chip = dev_get_drvdata(dev);
1079 u8 savestate[] = {
1080 0, 193, /* TPM_TAG_RQU_COMMAND */
1081 0, 0, 0, 10, /* blob length (in bytes) */
1082 0, 0, 0, 152 /* TPM_ORD_SaveState */
1085 if (chip == NULL)
1086 return -ENODEV;
1088 tpm_transmit(chip, savestate, sizeof(savestate));
1089 return 0;
1091 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1094 * Resume from a power safe. The BIOS already restored
1095 * the TPM state.
1097 int tpm_pm_resume(struct device *dev)
1099 struct tpm_chip *chip = dev_get_drvdata(dev);
1101 if (chip == NULL)
1102 return -ENODEV;
1104 return 0;
1106 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1108 /* In case vendor provided release function, call it too.*/
1110 void tpm_dev_vendor_release(struct tpm_chip *chip)
1112 if (chip->vendor.release)
1113 chip->vendor.release(chip->dev);
1115 clear_bit(chip->dev_num, dev_mask);
1116 kfree(chip->vendor.miscdev.name);
1118 EXPORT_SYMBOL_GPL(tpm_dev_vendor_release);
1122 * Once all references to platform device are down to 0,
1123 * release all allocated structures.
1125 void tpm_dev_release(struct device *dev)
1127 struct tpm_chip *chip = dev_get_drvdata(dev);
1129 tpm_dev_vendor_release(chip);
1131 chip->release(dev);
1132 kfree(chip);
1134 EXPORT_SYMBOL_GPL(tpm_dev_release);
1137 * Called from tpm_<specific>.c probe function only for devices
1138 * the driver has determined it should claim. Prior to calling
1139 * this function the specific probe function has called pci_enable_device
1140 * upon errant exit from this function specific probe function should call
1141 * pci_disable_device
1143 struct tpm_chip *tpm_register_hardware(struct device *dev,
1144 const struct tpm_vendor_specific *entry)
1146 #define DEVNAME_SIZE 7
1148 char *devname;
1149 struct tpm_chip *chip;
1151 /* Driver specific per-device data */
1152 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1153 devname = kmalloc(DEVNAME_SIZE, GFP_KERNEL);
1155 if (chip == NULL || devname == NULL)
1156 goto out_free;
1158 mutex_init(&chip->buffer_mutex);
1159 mutex_init(&chip->tpm_mutex);
1160 INIT_LIST_HEAD(&chip->list);
1162 INIT_WORK(&chip->work, timeout_work);
1164 setup_timer(&chip->user_read_timer, user_reader_timeout,
1165 (unsigned long)chip);
1167 memcpy(&chip->vendor, entry, sizeof(struct tpm_vendor_specific));
1169 chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
1171 if (chip->dev_num >= TPM_NUM_DEVICES) {
1172 dev_err(dev, "No available tpm device numbers\n");
1173 goto out_free;
1174 } else if (chip->dev_num == 0)
1175 chip->vendor.miscdev.minor = TPM_MINOR;
1176 else
1177 chip->vendor.miscdev.minor = MISC_DYNAMIC_MINOR;
1179 set_bit(chip->dev_num, dev_mask);
1181 scnprintf(devname, DEVNAME_SIZE, "%s%d", "tpm", chip->dev_num);
1182 chip->vendor.miscdev.name = devname;
1184 chip->vendor.miscdev.parent = dev;
1185 chip->dev = get_device(dev);
1186 chip->release = dev->release;
1187 dev->release = tpm_dev_release;
1188 dev_set_drvdata(dev, chip);
1190 if (misc_register(&chip->vendor.miscdev)) {
1191 dev_err(chip->dev,
1192 "unable to misc_register %s, minor %d\n",
1193 chip->vendor.miscdev.name,
1194 chip->vendor.miscdev.minor);
1195 put_device(chip->dev);
1196 return NULL;
1199 if (sysfs_create_group(&dev->kobj, chip->vendor.attr_group)) {
1200 misc_deregister(&chip->vendor.miscdev);
1201 put_device(chip->dev);
1203 return NULL;
1206 chip->bios_dir = tpm_bios_log_setup(devname);
1208 /* Make chip available */
1209 spin_lock(&driver_lock);
1210 list_add_rcu(&chip->list, &tpm_chip_list);
1211 spin_unlock(&driver_lock);
1213 return chip;
1215 out_free:
1216 kfree(chip);
1217 kfree(devname);
1218 return NULL;
1220 EXPORT_SYMBOL_GPL(tpm_register_hardware);
1222 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1223 MODULE_DESCRIPTION("TPM Driver");
1224 MODULE_VERSION("2.0");
1225 MODULE_LICENSE("GPL");