[PATCH] Fix RocketPort driver
[linux-2.6/verdex.git] / drivers / char / tpm / tpm.c
blob5a3870477ef182ddb815ab196fa321b93c42872a
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/sched.h>
27 #include <linux/poll.h>
28 #include <linux/spinlock.h>
29 #include "tpm.h"
31 enum tpm_const {
32 TPM_MINOR = 224, /* officially assigned */
33 TPM_BUFSIZE = 2048,
34 TPM_NUM_DEVICES = 256,
35 TPM_NUM_MASK_ENTRIES = TPM_NUM_DEVICES / (8 * sizeof(int))
38 static LIST_HEAD(tpm_chip_list);
39 static DEFINE_SPINLOCK(driver_lock);
40 static int dev_mask[TPM_NUM_MASK_ENTRIES];
42 static void user_reader_timeout(unsigned long ptr)
44 struct tpm_chip *chip = (struct tpm_chip *) ptr;
46 schedule_work(&chip->work);
49 static void timeout_work(void * ptr)
51 struct tpm_chip *chip = ptr;
53 down(&chip->buffer_mutex);
54 atomic_set(&chip->data_pending, 0);
55 memset(chip->data_buffer, 0, TPM_BUFSIZE);
56 up(&chip->buffer_mutex);
60 * Internal kernel interface to transmit TPM commands
62 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
63 size_t bufsiz)
65 ssize_t rc;
66 u32 count;
67 unsigned long stop;
69 count = be32_to_cpu(*((__be32 *) (buf + 2)));
71 if (count == 0)
72 return -ENODATA;
73 if (count > bufsiz) {
74 dev_err(chip->dev,
75 "invalid count value %x %zx \n", count, bufsiz);
76 return -E2BIG;
79 down(&chip->tpm_mutex);
81 if ((rc = chip->vendor->send(chip, (u8 *) buf, count)) < 0) {
82 dev_err(chip->dev,
83 "tpm_transmit: tpm_send: error %zd\n", rc);
84 goto out;
87 stop = jiffies + 2 * 60 * HZ;
88 do {
89 u8 status = chip->vendor->status(chip);
90 if ((status & chip->vendor->req_complete_mask) ==
91 chip->vendor->req_complete_val) {
92 goto out_recv;
95 if ((status == chip->vendor->req_canceled)) {
96 dev_err(chip->dev, "Operation Canceled\n");
97 rc = -ECANCELED;
98 goto out;
101 msleep(TPM_TIMEOUT); /* CHECK */
102 rmb();
103 } while (time_before(jiffies, stop));
106 chip->vendor->cancel(chip);
107 dev_err(chip->dev, "Operation Timed out\n");
108 rc = -ETIME;
109 goto out;
111 out_recv:
112 rc = chip->vendor->recv(chip, (u8 *) buf, bufsiz);
113 if (rc < 0)
114 dev_err(chip->dev,
115 "tpm_transmit: tpm_recv: error %zd\n", rc);
116 out:
117 up(&chip->tpm_mutex);
118 return rc;
121 #define TPM_DIGEST_SIZE 20
122 #define CAP_PCR_RESULT_SIZE 18
123 static const u8 cap_pcr[] = {
124 0, 193, /* TPM_TAG_RQU_COMMAND */
125 0, 0, 0, 22, /* length */
126 0, 0, 0, 101, /* TPM_ORD_GetCapability */
127 0, 0, 0, 5,
128 0, 0, 0, 4,
129 0, 0, 1, 1
132 #define READ_PCR_RESULT_SIZE 30
133 static const u8 pcrread[] = {
134 0, 193, /* TPM_TAG_RQU_COMMAND */
135 0, 0, 0, 14, /* length */
136 0, 0, 0, 21, /* TPM_ORD_PcrRead */
137 0, 0, 0, 0 /* PCR index */
140 ssize_t tpm_show_pcrs(struct device *dev, struct device_attribute *attr,
141 char *buf)
143 u8 data[READ_PCR_RESULT_SIZE];
144 ssize_t len;
145 int i, j, num_pcrs;
146 __be32 index;
147 char *str = buf;
149 struct tpm_chip *chip = dev_get_drvdata(dev);
150 if (chip == NULL)
151 return -ENODEV;
153 memcpy(data, cap_pcr, sizeof(cap_pcr));
154 if ((len = tpm_transmit(chip, data, sizeof(data)))
155 < CAP_PCR_RESULT_SIZE) {
156 dev_dbg(chip->dev, "A TPM error (%d) occurred "
157 "attempting to determine the number of PCRS\n",
158 be32_to_cpu(*((__be32 *) (data + 6))));
159 return 0;
162 num_pcrs = be32_to_cpu(*((__be32 *) (data + 14)));
164 for (i = 0; i < num_pcrs; i++) {
165 memcpy(data, pcrread, sizeof(pcrread));
166 index = cpu_to_be32(i);
167 memcpy(data + 10, &index, 4);
168 if ((len = tpm_transmit(chip, data, sizeof(data)))
169 < READ_PCR_RESULT_SIZE){
170 dev_dbg(chip->dev, "A TPM error (%d) occurred"
171 " attempting to read PCR %d of %d\n",
172 be32_to_cpu(*((__be32 *) (data + 6))),
173 i, num_pcrs);
174 goto out;
176 str += sprintf(str, "PCR-%02d: ", i);
177 for (j = 0; j < TPM_DIGEST_SIZE; j++)
178 str += sprintf(str, "%02X ", *(data + 10 + j));
179 str += sprintf(str, "\n");
181 out:
182 return str - buf;
184 EXPORT_SYMBOL_GPL(tpm_show_pcrs);
186 #define READ_PUBEK_RESULT_SIZE 314
187 static const u8 readpubek[] = {
188 0, 193, /* TPM_TAG_RQU_COMMAND */
189 0, 0, 0, 30, /* length */
190 0, 0, 0, 124, /* TPM_ORD_ReadPubek */
193 ssize_t tpm_show_pubek(struct device *dev, struct device_attribute *attr,
194 char *buf)
196 u8 *data;
197 ssize_t len;
198 int i, rc;
199 char *str = buf;
201 struct tpm_chip *chip = dev_get_drvdata(dev);
202 if (chip == NULL)
203 return -ENODEV;
205 data = kzalloc(READ_PUBEK_RESULT_SIZE, GFP_KERNEL);
206 if (!data)
207 return -ENOMEM;
209 memcpy(data, readpubek, sizeof(readpubek));
211 if ((len = tpm_transmit(chip, data, READ_PUBEK_RESULT_SIZE)) <
212 READ_PUBEK_RESULT_SIZE) {
213 dev_dbg(chip->dev, "A TPM error (%d) occurred "
214 "attempting to read the PUBEK\n",
215 be32_to_cpu(*((__be32 *) (data + 6))));
216 rc = 0;
217 goto out;
221 ignore header 10 bytes
222 algorithm 32 bits (1 == RSA )
223 encscheme 16 bits
224 sigscheme 16 bits
225 parameters (RSA 12->bytes: keybit, #primes, expbit)
226 keylenbytes 32 bits
227 256 byte modulus
228 ignore checksum 20 bytes
231 str +=
232 sprintf(str,
233 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
234 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
235 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
236 "Modulus length: %d\nModulus: \n",
237 data[10], data[11], data[12], data[13], data[14],
238 data[15], data[16], data[17], data[22], data[23],
239 data[24], data[25], data[26], data[27], data[28],
240 data[29], data[30], data[31], data[32], data[33],
241 be32_to_cpu(*((__be32 *) (data + 34))));
243 for (i = 0; i < 256; i++) {
244 str += sprintf(str, "%02X ", data[i + 38]);
245 if ((i + 1) % 16 == 0)
246 str += sprintf(str, "\n");
248 rc = str - buf;
249 out:
250 kfree(data);
251 return rc;
253 EXPORT_SYMBOL_GPL(tpm_show_pubek);
255 #define CAP_VER_RESULT_SIZE 18
256 static const u8 cap_version[] = {
257 0, 193, /* TPM_TAG_RQU_COMMAND */
258 0, 0, 0, 18, /* length */
259 0, 0, 0, 101, /* TPM_ORD_GetCapability */
260 0, 0, 0, 6,
261 0, 0, 0, 0
264 #define CAP_MANUFACTURER_RESULT_SIZE 18
265 static const u8 cap_manufacturer[] = {
266 0, 193, /* TPM_TAG_RQU_COMMAND */
267 0, 0, 0, 22, /* length */
268 0, 0, 0, 101, /* TPM_ORD_GetCapability */
269 0, 0, 0, 5,
270 0, 0, 0, 4,
271 0, 0, 1, 3
274 ssize_t tpm_show_caps(struct device *dev, struct device_attribute *attr,
275 char *buf)
277 u8 data[sizeof(cap_manufacturer)];
278 ssize_t len;
279 char *str = buf;
281 struct tpm_chip *chip = dev_get_drvdata(dev);
282 if (chip == NULL)
283 return -ENODEV;
285 memcpy(data, cap_manufacturer, sizeof(cap_manufacturer));
287 if ((len = tpm_transmit(chip, data, sizeof(data))) <
288 CAP_MANUFACTURER_RESULT_SIZE)
289 return len;
291 str += sprintf(str, "Manufacturer: 0x%x\n",
292 be32_to_cpu(*((__be32 *) (data + 14))));
294 memcpy(data, cap_version, sizeof(cap_version));
296 if ((len = tpm_transmit(chip, data, sizeof(data))) <
297 CAP_VER_RESULT_SIZE)
298 return len;
300 str +=
301 sprintf(str, "TCG version: %d.%d\nFirmware version: %d.%d\n",
302 (int) data[14], (int) data[15], (int) data[16],
303 (int) data[17]);
305 return str - buf;
307 EXPORT_SYMBOL_GPL(tpm_show_caps);
309 ssize_t tpm_store_cancel(struct device *dev, struct device_attribute *attr,
310 const char *buf, size_t count)
312 struct tpm_chip *chip = dev_get_drvdata(dev);
313 if (chip == NULL)
314 return 0;
316 chip->vendor->cancel(chip);
317 return count;
319 EXPORT_SYMBOL_GPL(tpm_store_cancel);
322 * Device file system interface to the TPM
324 int tpm_open(struct inode *inode, struct file *file)
326 int rc = 0, minor = iminor(inode);
327 struct tpm_chip *chip = NULL, *pos;
329 spin_lock(&driver_lock);
331 list_for_each_entry(pos, &tpm_chip_list, list) {
332 if (pos->vendor->miscdev.minor == minor) {
333 chip = pos;
334 break;
338 if (chip == NULL) {
339 rc = -ENODEV;
340 goto err_out;
343 if (chip->num_opens) {
344 dev_dbg(chip->dev, "Another process owns this TPM\n");
345 rc = -EBUSY;
346 goto err_out;
349 chip->num_opens++;
350 get_device(chip->dev);
352 spin_unlock(&driver_lock);
354 chip->data_buffer = kmalloc(TPM_BUFSIZE * sizeof(u8), GFP_KERNEL);
355 if (chip->data_buffer == NULL) {
356 chip->num_opens--;
357 put_device(chip->dev);
358 return -ENOMEM;
361 atomic_set(&chip->data_pending, 0);
363 file->private_data = chip;
364 return 0;
366 err_out:
367 spin_unlock(&driver_lock);
368 return rc;
370 EXPORT_SYMBOL_GPL(tpm_open);
372 int tpm_release(struct inode *inode, struct file *file)
374 struct tpm_chip *chip = file->private_data;
376 spin_lock(&driver_lock);
377 file->private_data = NULL;
378 chip->num_opens--;
379 del_singleshot_timer_sync(&chip->user_read_timer);
380 flush_scheduled_work();
381 atomic_set(&chip->data_pending, 0);
382 put_device(chip->dev);
383 kfree(chip->data_buffer);
384 spin_unlock(&driver_lock);
385 return 0;
387 EXPORT_SYMBOL_GPL(tpm_release);
389 ssize_t tpm_write(struct file *file, const char __user *buf,
390 size_t size, loff_t * off)
392 struct tpm_chip *chip = file->private_data;
393 int in_size = size, out_size;
395 /* cannot perform a write until the read has cleared
396 either via tpm_read or a user_read_timer timeout */
397 while (atomic_read(&chip->data_pending) != 0)
398 msleep(TPM_TIMEOUT);
400 down(&chip->buffer_mutex);
402 if (in_size > TPM_BUFSIZE)
403 in_size = TPM_BUFSIZE;
405 if (copy_from_user
406 (chip->data_buffer, (void __user *) buf, in_size)) {
407 up(&chip->buffer_mutex);
408 return -EFAULT;
411 /* atomic tpm command send and result receive */
412 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
414 atomic_set(&chip->data_pending, out_size);
415 up(&chip->buffer_mutex);
417 /* Set a timeout by which the reader must come claim the result */
418 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
420 return in_size;
423 EXPORT_SYMBOL_GPL(tpm_write);
425 ssize_t tpm_read(struct file * file, char __user *buf,
426 size_t size, loff_t * off)
428 struct tpm_chip *chip = file->private_data;
429 int ret_size;
431 del_singleshot_timer_sync(&chip->user_read_timer);
432 flush_scheduled_work();
433 ret_size = atomic_read(&chip->data_pending);
434 atomic_set(&chip->data_pending, 0);
435 if (ret_size > 0) { /* relay data */
436 if (size < ret_size)
437 ret_size = size;
439 down(&chip->buffer_mutex);
440 if (copy_to_user(buf, chip->data_buffer, ret_size))
441 ret_size = -EFAULT;
442 up(&chip->buffer_mutex);
445 return ret_size;
447 EXPORT_SYMBOL_GPL(tpm_read);
449 void tpm_remove_hardware(struct device *dev)
451 struct tpm_chip *chip = dev_get_drvdata(dev);
453 if (chip == NULL) {
454 dev_err(dev, "No device data found\n");
455 return;
458 spin_lock(&driver_lock);
460 list_del(&chip->list);
462 spin_unlock(&driver_lock);
464 dev_set_drvdata(dev, NULL);
465 misc_deregister(&chip->vendor->miscdev);
466 kfree(chip->vendor->miscdev.name);
468 sysfs_remove_group(&dev->kobj, chip->vendor->attr_group);
469 tpm_bios_log_teardown(chip->bios_dir);
471 dev_mask[chip->dev_num / TPM_NUM_MASK_ENTRIES ] &=
472 ~(1 << (chip->dev_num % TPM_NUM_MASK_ENTRIES));
474 kfree(chip);
476 put_device(dev);
478 EXPORT_SYMBOL_GPL(tpm_remove_hardware);
480 static u8 savestate[] = {
481 0, 193, /* TPM_TAG_RQU_COMMAND */
482 0, 0, 0, 10, /* blob length (in bytes) */
483 0, 0, 0, 152 /* TPM_ORD_SaveState */
487 * We are about to suspend. Save the TPM state
488 * so that it can be restored.
490 int tpm_pm_suspend(struct device *dev, pm_message_t pm_state)
492 struct tpm_chip *chip = dev_get_drvdata(dev);
493 if (chip == NULL)
494 return -ENODEV;
496 tpm_transmit(chip, savestate, sizeof(savestate));
497 return 0;
499 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
502 * Resume from a power safe. The BIOS already restored
503 * the TPM state.
505 int tpm_pm_resume(struct device *dev)
507 struct tpm_chip *chip = dev_get_drvdata(dev);
509 if (chip == NULL)
510 return -ENODEV;
512 return 0;
514 EXPORT_SYMBOL_GPL(tpm_pm_resume);
517 * Called from tpm_<specific>.c probe function only for devices
518 * the driver has determined it should claim. Prior to calling
519 * this function the specific probe function has called pci_enable_device
520 * upon errant exit from this function specific probe function should call
521 * pci_disable_device
523 int tpm_register_hardware(struct device *dev, struct tpm_vendor_specific *entry)
525 #define DEVNAME_SIZE 7
527 char *devname;
528 struct tpm_chip *chip;
529 int i, j;
531 /* Driver specific per-device data */
532 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
533 if (chip == NULL)
534 return -ENOMEM;
536 init_MUTEX(&chip->buffer_mutex);
537 init_MUTEX(&chip->tpm_mutex);
538 INIT_LIST_HEAD(&chip->list);
540 INIT_WORK(&chip->work, timeout_work, chip);
542 init_timer(&chip->user_read_timer);
543 chip->user_read_timer.function = user_reader_timeout;
544 chip->user_read_timer.data = (unsigned long) chip;
546 chip->vendor = entry;
548 chip->dev_num = -1;
550 for (i = 0; i < TPM_NUM_MASK_ENTRIES; i++)
551 for (j = 0; j < 8 * sizeof(int); j++)
552 if ((dev_mask[i] & (1 << j)) == 0) {
553 chip->dev_num =
554 i * TPM_NUM_MASK_ENTRIES + j;
555 dev_mask[i] |= 1 << j;
556 goto dev_num_search_complete;
559 dev_num_search_complete:
560 if (chip->dev_num < 0) {
561 dev_err(dev, "No available tpm device numbers\n");
562 kfree(chip);
563 return -ENODEV;
564 } else if (chip->dev_num == 0)
565 chip->vendor->miscdev.minor = TPM_MINOR;
566 else
567 chip->vendor->miscdev.minor = MISC_DYNAMIC_MINOR;
569 devname = kmalloc(DEVNAME_SIZE, GFP_KERNEL);
570 scnprintf(devname, DEVNAME_SIZE, "%s%d", "tpm", chip->dev_num);
571 chip->vendor->miscdev.name = devname;
573 chip->vendor->miscdev.dev = dev;
574 chip->dev = get_device(dev);
576 if (misc_register(&chip->vendor->miscdev)) {
577 dev_err(chip->dev,
578 "unable to misc_register %s, minor %d\n",
579 chip->vendor->miscdev.name,
580 chip->vendor->miscdev.minor);
581 put_device(dev);
582 kfree(chip);
583 dev_mask[i] &= !(1 << j);
584 return -ENODEV;
587 spin_lock(&driver_lock);
589 dev_set_drvdata(dev, chip);
591 list_add(&chip->list, &tpm_chip_list);
593 spin_unlock(&driver_lock);
595 sysfs_create_group(&dev->kobj, chip->vendor->attr_group);
597 chip->bios_dir = tpm_bios_log_setup(devname);
599 return 0;
601 EXPORT_SYMBOL_GPL(tpm_register_hardware);
603 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
604 MODULE_DESCRIPTION("TPM Driver");
605 MODULE_VERSION("2.0");
606 MODULE_LICENSE("GPL");