3 * Device Driver for the Infineon Technologies
4 * SLD 9630 TT 1.1 and SLB 9635 TT 1.2 Trusted Platform Module
5 * Specifications at www.trustedcomputinggroup.org
7 * Copyright (C) 2005, Marcel Selhorst <selhorst@crypto.rub.de>
8 * Applied Data Security Group, Ruhr-University Bochum, Germany
9 * Project-Homepage: http://www.prosec.rub.de/tpm
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation, version 2 of the
17 #include <linux/pnp.h>
20 /* Infineon specific definitions */
21 /* maximum number of WTX-packages */
22 #define TPM_MAX_WTX_PACKAGES 50
23 /* msleep-Time for WTX-packages */
24 #define TPM_WTX_MSLEEP_TIME 20
25 /* msleep-Time --> Interval to check status register */
26 #define TPM_MSLEEP_TIME 3
27 /* gives number of max. msleep()-calls before throwing timeout */
28 #define TPM_MAX_TRIES 5000
29 #define TPM_INFINEON_DEV_VEN_VALUE 0x15D1
31 /* These values will be filled after PnP-call */
32 static int TPM_INF_DATA = 0;
33 static int TPM_INF_ADDR = 0;
34 static int pnp_registered = 0;
36 /* TPM header definitions */
37 enum infineon_tpm_header {
39 TPM_VL_CHANNEL_CONTROL = 0x07,
40 TPM_VL_CHANNEL_PERSONALISATION = 0x0A,
41 TPM_VL_CHANNEL_TPM = 0x0B,
42 TPM_VL_CONTROL = 0x00,
45 TPM_CTRL_WTX_ABORT = 0x18,
46 TPM_CTRL_WTX_ABORT_ACK = 0x18,
47 TPM_CTRL_ERROR = 0x20,
48 TPM_CTRL_CHAININGACK = 0x40,
49 TPM_CTRL_CHAINING = 0x80,
51 TPM_CTRL_DATA_CHA = 0x84,
52 TPM_CTRL_DATA_CHA_ACK = 0xC4
55 enum infineon_tpm_register {
62 enum infineon_tpm_command_bits {
69 enum infineon_tpm_status_bits {
78 /* some outgoing values */
79 enum infineon_tpm_values {
83 RESET_LP_IRQC_DISABLE = 0x41,
84 ENABLE_REGISTER_PAIR = 0x55,
87 DISABLE_REGISTER_PAIR = 0xAA,
94 static int number_of_wtx;
96 static int empty_fifo(struct tpm_chip *chip, int clear_wrfifo)
103 for (i = 0; i < 4096; i++) {
104 status = inb(chip->vendor->base + WRFIFO);
105 if (status == 0xff) {
113 /* Note: The values which are currently in the FIFO of the TPM
114 are thrown away since there is no usage for them. Usually,
115 this has nothing to say, since the TPM will give its answer
116 immediately or will be aborted anyway, so the data here is
117 usually garbage and useless.
118 We have to clean this, because the next communication with
119 the TPM would be rubbish, if there is still some old data
124 status = inb(chip->vendor->base + RDFIFO);
125 status = inb(chip->vendor->base + STAT);
127 if (i == TPM_MAX_TRIES)
129 } while ((status & (1 << STAT_RDA)) != 0);
133 static int wait(struct tpm_chip *chip, int wait_for_bit)
137 for (i = 0; i < TPM_MAX_TRIES; i++) {
138 status = inb(chip->vendor->base + STAT);
139 /* check the status-register if wait_for_bit is set */
140 if (status & 1 << wait_for_bit)
142 msleep(TPM_MSLEEP_TIME);
144 if (i == TPM_MAX_TRIES) { /* timeout occurs */
145 if (wait_for_bit == STAT_XFE)
146 dev_err(&chip->pci_dev->dev,
147 "Timeout in wait(STAT_XFE)\n");
148 if (wait_for_bit == STAT_RDA)
149 dev_err(&chip->pci_dev->dev,
150 "Timeout in wait(STAT_RDA)\n");
156 static void wait_and_send(struct tpm_chip *chip, u8 sendbyte)
158 wait(chip, STAT_XFE);
159 outb(sendbyte, chip->vendor->base + WRFIFO);
162 /* Note: WTX means Waiting-Time-Extension. Whenever the TPM needs more
163 calculation time, it sends a WTX-package, which has to be acknowledged
164 or aborted. This usually occurs if you are hammering the TPM with key
165 creation. Set the maximum number of WTX-packages in the definitions
166 above, if the number is reached, the waiting-time will be denied
167 and the TPM command has to be resend.
170 static void tpm_wtx(struct tpm_chip *chip)
173 dev_info(&chip->pci_dev->dev, "Granting WTX (%02d / %02d)\n",
174 number_of_wtx, TPM_MAX_WTX_PACKAGES);
175 wait_and_send(chip, TPM_VL_VER);
176 wait_and_send(chip, TPM_CTRL_WTX);
177 wait_and_send(chip, 0x00);
178 wait_and_send(chip, 0x00);
179 msleep(TPM_WTX_MSLEEP_TIME);
182 static void tpm_wtx_abort(struct tpm_chip *chip)
184 dev_info(&chip->pci_dev->dev, "Aborting WTX\n");
185 wait_and_send(chip, TPM_VL_VER);
186 wait_and_send(chip, TPM_CTRL_WTX_ABORT);
187 wait_and_send(chip, 0x00);
188 wait_and_send(chip, 0x00);
190 msleep(TPM_WTX_MSLEEP_TIME);
193 static int tpm_inf_recv(struct tpm_chip *chip, u8 * buf, size_t count)
200 /* start receiving header */
201 for (i = 0; i < 4; i++) {
202 ret = wait(chip, STAT_RDA);
205 buf[i] = inb(chip->vendor->base + RDFIFO);
208 if (buf[0] != TPM_VL_VER) {
209 dev_err(&chip->pci_dev->dev,
210 "Wrong transport protocol implementation!\n");
214 if (buf[1] == TPM_CTRL_DATA) {
215 /* size of the data received */
216 size = ((buf[2] << 8) | buf[3]);
218 for (i = 0; i < size; i++) {
219 wait(chip, STAT_RDA);
220 buf[i] = inb(chip->vendor->base + RDFIFO);
223 if ((size == 0x6D00) && (buf[1] == 0x80)) {
224 dev_err(&chip->pci_dev->dev,
225 "Error handling on vendor layer!\n");
229 for (i = 0; i < size; i++)
236 if (buf[1] == TPM_CTRL_WTX) {
237 dev_info(&chip->pci_dev->dev, "WTX-package received\n");
238 if (number_of_wtx < TPM_MAX_WTX_PACKAGES) {
247 if (buf[1] == TPM_CTRL_WTX_ABORT_ACK) {
248 dev_info(&chip->pci_dev->dev, "WTX-abort acknowledged\n");
252 if (buf[1] == TPM_CTRL_ERROR) {
253 dev_err(&chip->pci_dev->dev, "ERROR-package received:\n");
254 if (buf[4] == TPM_INF_NAK)
255 dev_err(&chip->pci_dev->dev,
256 "-> Negative acknowledgement"
257 " - retransmit command!\n");
263 static int tpm_inf_send(struct tpm_chip *chip, u8 * buf, size_t count)
267 u8 count_high, count_low, count_4, count_3, count_2, count_1;
269 /* Disabling Reset, LP and IRQC */
270 outb(RESET_LP_IRQC_DISABLE, chip->vendor->base + CMD);
272 ret = empty_fifo(chip, 1);
274 dev_err(&chip->pci_dev->dev, "Timeout while clearing FIFO\n");
278 ret = wait(chip, STAT_XFE);
282 count_4 = (count & 0xff000000) >> 24;
283 count_3 = (count & 0x00ff0000) >> 16;
284 count_2 = (count & 0x0000ff00) >> 8;
285 count_1 = (count & 0x000000ff);
286 count_high = ((count + 6) & 0xffffff00) >> 8;
287 count_low = ((count + 6) & 0x000000ff);
290 wait_and_send(chip, TPM_VL_VER);
291 wait_and_send(chip, TPM_CTRL_DATA);
292 wait_and_send(chip, count_high);
293 wait_and_send(chip, count_low);
295 /* Sending Data Header */
296 wait_and_send(chip, TPM_VL_VER);
297 wait_and_send(chip, TPM_VL_CHANNEL_TPM);
298 wait_and_send(chip, count_4);
299 wait_and_send(chip, count_3);
300 wait_and_send(chip, count_2);
301 wait_and_send(chip, count_1);
304 for (i = 0; i < count; i++) {
305 wait_and_send(chip, buf[i]);
310 static void tpm_inf_cancel(struct tpm_chip *chip)
313 Since we are using the legacy mode to communicate
314 with the TPM, we have no cancel functions, but have
315 a workaround for interrupting the TPM through WTX.
319 static DEVICE_ATTR(pubek, S_IRUGO, tpm_show_pubek, NULL);
320 static DEVICE_ATTR(pcrs, S_IRUGO, tpm_show_pcrs, NULL);
321 static DEVICE_ATTR(caps, S_IRUGO, tpm_show_caps, NULL);
322 static DEVICE_ATTR(cancel, S_IWUSR | S_IWGRP, NULL, tpm_store_cancel);
324 static struct attribute *inf_attrs[] = {
325 &dev_attr_pubek.attr,
328 &dev_attr_cancel.attr,
332 static struct attribute_group inf_attr_grp = {.attrs = inf_attrs };
334 static struct file_operations inf_ops = {
335 .owner = THIS_MODULE,
340 .release = tpm_release,
343 static struct tpm_vendor_specific tpm_inf = {
344 .recv = tpm_inf_recv,
345 .send = tpm_inf_send,
346 .cancel = tpm_inf_cancel,
347 .req_complete_mask = 0,
348 .req_complete_val = 0,
349 .attr_group = &inf_attr_grp,
350 .miscdev = {.fops = &inf_ops,},
353 static const struct pnp_device_id tpm_pnp_tbl[] = {
359 MODULE_DEVICE_TABLE(pnp, tpm_pnp_tbl);
361 static int __devinit tpm_inf_pnp_probe(struct pnp_dev *dev,
362 const struct pnp_device_id *dev_id)
364 if (pnp_port_valid(dev, 0)) {
365 TPM_INF_ADDR = (pnp_port_start(dev, 0) & 0xff);
366 TPM_INF_DATA = ((TPM_INF_ADDR + 1) & 0xff);
367 tpm_inf.base = pnp_port_start(dev, 1);
368 dev_info(&dev->dev, "Found %s with ID %s\n",
369 dev->name, dev_id->id);
375 static struct pnp_driver tpm_inf_pnp = {
376 .name = "tpm_inf_pnp",
377 .id_table = tpm_pnp_tbl,
378 .probe = tpm_inf_pnp_probe,
381 static int __devinit tpm_inf_probe(struct pci_dev *pci_dev,
382 const struct pci_device_id *pci_id)
391 rc = pci_enable_device(pci_dev);
395 dev_info(&pci_dev->dev, "LPC-bus found at 0x%x\n", pci_id->device);
397 /* read IO-ports from PnP */
398 rc = pnp_register_driver(&tpm_inf_pnp);
400 dev_err(&pci_dev->dev,
401 "Error %x from pnp_register_driver!\n",rc);
405 dev_info(&pci_dev->dev, "No Infineon TPM found!\n");
411 /* Make sure, we have received valid config ports */
413 dev_err(&pci_dev->dev, "No valid IO-ports received!\n");
417 /* query chip for its vendor, its version number a.s.o. */
418 outb(ENABLE_REGISTER_PAIR, TPM_INF_ADDR);
419 outb(IDVENL, TPM_INF_ADDR);
420 vendorid[1] = inb(TPM_INF_DATA);
421 outb(IDVENH, TPM_INF_ADDR);
422 vendorid[0] = inb(TPM_INF_DATA);
423 outb(IDPDL, TPM_INF_ADDR);
424 productid[1] = inb(TPM_INF_DATA);
425 outb(IDPDH, TPM_INF_ADDR);
426 productid[0] = inb(TPM_INF_DATA);
427 outb(CHIP_ID1, TPM_INF_ADDR);
428 version[1] = inb(TPM_INF_DATA);
429 outb(CHIP_ID2, TPM_INF_ADDR);
430 version[0] = inb(TPM_INF_DATA);
432 switch ((productid[0] << 8) | productid[1]) {
434 snprintf(chipname, sizeof(chipname), " (SLD 9630 TT 1.1)");
437 snprintf(chipname, sizeof(chipname), " (SLB 9635 TT 1.2)");
440 snprintf(chipname, sizeof(chipname), " (unknown chip)");
444 if ((vendorid[0] << 8 | vendorid[1]) == (TPM_INFINEON_DEV_VEN_VALUE)) {
446 if (tpm_inf.base == 0) {
447 dev_err(&pci_dev->dev, "No IO-ports found!\n");
450 /* configure TPM with IO-ports */
451 outb(IOLIMH, TPM_INF_ADDR);
452 outb(((tpm_inf.base >> 8) & 0xff), TPM_INF_DATA);
453 outb(IOLIML, TPM_INF_ADDR);
454 outb((tpm_inf.base & 0xff), TPM_INF_DATA);
456 /* control if IO-ports are set correctly */
457 outb(IOLIMH, TPM_INF_ADDR);
458 ioh = inb(TPM_INF_DATA);
459 outb(IOLIML, TPM_INF_ADDR);
460 iol = inb(TPM_INF_DATA);
462 if ((ioh << 8 | iol) != tpm_inf.base) {
463 dev_err(&pci_dev->dev,
464 "Could not set IO-ports to %04x\n",
469 /* activate register */
470 outb(TPM_DAR, TPM_INF_ADDR);
471 outb(0x01, TPM_INF_DATA);
472 outb(DISABLE_REGISTER_PAIR, TPM_INF_ADDR);
474 /* disable RESET, LP and IRQC */
475 outb(RESET_LP_IRQC_DISABLE, tpm_inf.base + CMD);
477 /* Finally, we're done, print some infos */
478 dev_info(&pci_dev->dev, "TPM found: "
481 "chip version %02x%02x, "
482 "vendor id %x%x (Infineon), "
483 "product id %02x%02x"
487 version[0], version[1],
488 vendorid[0], vendorid[1],
489 productid[0], productid[1], chipname);
491 rc = tpm_register_hardware(pci_dev, &tpm_inf);
496 dev_info(&pci_dev->dev, "No Infineon TPM found!\n");
498 pnp_unregister_driver(&tpm_inf_pnp);
500 pci_disable_device(pci_dev);
506 static struct pci_device_id tpm_pci_tbl[] __devinitdata = {
507 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_0)},
508 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_12)},
509 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_0)},
510 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_12)},
511 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_0)},
512 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_0)},
513 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_1)},
514 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_2)},
518 MODULE_DEVICE_TABLE(pci, tpm_pci_tbl);
520 static struct pci_driver inf_pci_driver = {
522 .id_table = tpm_pci_tbl,
523 .probe = tpm_inf_probe,
524 .remove = __devexit_p(tpm_remove),
525 .suspend = tpm_pm_suspend,
526 .resume = tpm_pm_resume,
529 static int __init init_inf(void)
531 return pci_register_driver(&inf_pci_driver);
534 static void __exit cleanup_inf(void)
537 pnp_unregister_driver(&tpm_inf_pnp);
538 pci_unregister_driver(&inf_pci_driver);
541 module_init(init_inf);
542 module_exit(cleanup_inf);
544 MODULE_AUTHOR("Marcel Selhorst <selhorst@crypto.rub.de>");
545 MODULE_DESCRIPTION("Driver for Infineon TPM SLD 9630 TT 1.1 / SLB 9635 TT 1.2");
546 MODULE_VERSION("1.5");
547 MODULE_LICENSE("GPL");