2 * Copyright (C) 2012 IBM Corporation
4 * Author: Ashley Lai <adlai@us.ibm.com>
6 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
8 * Device driver for TCG/TCPA TPM (trusted platform module).
9 * Specifications at www.trustedcomputinggroup.org
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
18 #include <linux/dma-mapping.h>
19 #include <linux/dmapool.h>
20 #include <linux/slab.h>
23 #include <linux/types.h>
24 #include <linux/list.h>
25 #include <linux/spinlock.h>
26 #include <linux/interrupt.h>
27 #include <linux/wait.h>
31 #include "tpm_ibmvtpm.h"
33 static const char tpm_ibmvtpm_driver_name[] = "tpm_ibmvtpm";
35 static struct vio_device_id tpm_ibmvtpm_device_table[] = {
36 { "IBM,vtpm", "IBM,vtpm"},
39 MODULE_DEVICE_TABLE(vio, tpm_ibmvtpm_device_table);
42 * ibmvtpm_send_crq - Send a CRQ request
43 * @vdev: vio device struct
51 static int ibmvtpm_send_crq(struct vio_dev *vdev, u64 w1, u64 w2)
53 return plpar_hcall_norets(H_SEND_CRQ, vdev->unit_address, w1, w2);
57 * ibmvtpm_get_data - Retrieve ibm vtpm data
63 static struct ibmvtpm_dev *ibmvtpm_get_data(const struct device *dev)
65 struct tpm_chip *chip = dev_get_drvdata(dev);
67 return (struct ibmvtpm_dev *)TPM_VPRIV(chip);
72 * tpm_ibmvtpm_recv - Receive data after send
73 * @chip: tpm chip struct
74 * @buf: buffer to read
75 * count: size of buffer
78 * Number of bytes read
80 static int tpm_ibmvtpm_recv(struct tpm_chip *chip, u8 *buf, size_t count)
82 struct ibmvtpm_dev *ibmvtpm;
86 ibmvtpm = (struct ibmvtpm_dev *)TPM_VPRIV(chip);
88 if (!ibmvtpm->rtce_buf) {
89 dev_err(ibmvtpm->dev, "ibmvtpm device is not ready\n");
93 sig = wait_event_interruptible(ibmvtpm->wq, ibmvtpm->res_len != 0);
97 len = ibmvtpm->res_len;
100 dev_err(ibmvtpm->dev,
101 "Invalid size in recv: count=%ld, crq_size=%d\n",
106 spin_lock(&ibmvtpm->rtce_lock);
107 memcpy((void *)buf, (void *)ibmvtpm->rtce_buf, len);
108 memset(ibmvtpm->rtce_buf, 0, len);
109 ibmvtpm->res_len = 0;
110 spin_unlock(&ibmvtpm->rtce_lock);
115 * tpm_ibmvtpm_send - Send tpm request
116 * @chip: tpm chip struct
117 * @buf: buffer contains data to send
118 * count: size of buffer
121 * Number of bytes sent
123 static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
125 struct ibmvtpm_dev *ibmvtpm;
126 struct ibmvtpm_crq crq;
127 __be64 *word = (__be64 *)&crq;
130 ibmvtpm = (struct ibmvtpm_dev *)TPM_VPRIV(chip);
132 if (!ibmvtpm->rtce_buf) {
133 dev_err(ibmvtpm->dev, "ibmvtpm device is not ready\n");
137 if (count > ibmvtpm->rtce_size) {
138 dev_err(ibmvtpm->dev,
139 "Invalid size in send: count=%ld, rtce_size=%d\n",
140 count, ibmvtpm->rtce_size);
144 spin_lock(&ibmvtpm->rtce_lock);
145 memcpy((void *)ibmvtpm->rtce_buf, (void *)buf, count);
146 crq.valid = (u8)IBMVTPM_VALID_CMD;
147 crq.msg = (u8)VTPM_TPM_COMMAND;
148 crq.len = cpu_to_be16(count);
149 crq.data = cpu_to_be32(ibmvtpm->rtce_dma_handle);
151 rc = ibmvtpm_send_crq(ibmvtpm->vdev, be64_to_cpu(word[0]),
152 be64_to_cpu(word[1]));
153 if (rc != H_SUCCESS) {
154 dev_err(ibmvtpm->dev, "tpm_ibmvtpm_send failed rc=%d\n", rc);
159 spin_unlock(&ibmvtpm->rtce_lock);
163 static void tpm_ibmvtpm_cancel(struct tpm_chip *chip)
168 static u8 tpm_ibmvtpm_status(struct tpm_chip *chip)
174 * ibmvtpm_crq_get_rtce_size - Send a CRQ request to get rtce size
175 * @ibmvtpm: vtpm device struct
181 static int ibmvtpm_crq_get_rtce_size(struct ibmvtpm_dev *ibmvtpm)
183 struct ibmvtpm_crq crq;
184 u64 *buf = (u64 *) &crq;
187 crq.valid = (u8)IBMVTPM_VALID_CMD;
188 crq.msg = (u8)VTPM_GET_RTCE_BUFFER_SIZE;
190 rc = ibmvtpm_send_crq(ibmvtpm->vdev, cpu_to_be64(buf[0]),
191 cpu_to_be64(buf[1]));
193 dev_err(ibmvtpm->dev,
194 "ibmvtpm_crq_get_rtce_size failed rc=%d\n", rc);
200 * ibmvtpm_crq_get_version - Send a CRQ request to get vtpm version
201 * - Note that this is vtpm version and not tpm version
202 * @ibmvtpm: vtpm device struct
208 static int ibmvtpm_crq_get_version(struct ibmvtpm_dev *ibmvtpm)
210 struct ibmvtpm_crq crq;
211 u64 *buf = (u64 *) &crq;
214 crq.valid = (u8)IBMVTPM_VALID_CMD;
215 crq.msg = (u8)VTPM_GET_VERSION;
217 rc = ibmvtpm_send_crq(ibmvtpm->vdev, cpu_to_be64(buf[0]),
218 cpu_to_be64(buf[1]));
220 dev_err(ibmvtpm->dev,
221 "ibmvtpm_crq_get_version failed rc=%d\n", rc);
227 * ibmvtpm_crq_send_init_complete - Send a CRQ initialize complete message
228 * @ibmvtpm: vtpm device struct
234 static int ibmvtpm_crq_send_init_complete(struct ibmvtpm_dev *ibmvtpm)
238 rc = ibmvtpm_send_crq(ibmvtpm->vdev, INIT_CRQ_COMP_CMD, 0);
240 dev_err(ibmvtpm->dev,
241 "ibmvtpm_crq_send_init_complete failed rc=%d\n", rc);
247 * ibmvtpm_crq_send_init - Send a CRQ initialize message
248 * @ibmvtpm: vtpm device struct
254 static int ibmvtpm_crq_send_init(struct ibmvtpm_dev *ibmvtpm)
258 rc = ibmvtpm_send_crq(ibmvtpm->vdev, INIT_CRQ_CMD, 0);
260 dev_err(ibmvtpm->dev,
261 "ibmvtpm_crq_send_init failed rc=%d\n", rc);
267 * tpm_ibmvtpm_remove - ibm vtpm remove entry point
268 * @vdev: vio device struct
273 static int tpm_ibmvtpm_remove(struct vio_dev *vdev)
275 struct ibmvtpm_dev *ibmvtpm = ibmvtpm_get_data(&vdev->dev);
278 free_irq(vdev->irq, ibmvtpm);
283 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
284 } while (rc == H_BUSY || H_IS_LONG_BUSY(rc));
286 dma_unmap_single(ibmvtpm->dev, ibmvtpm->crq_dma_handle,
287 CRQ_RES_BUF_SIZE, DMA_BIDIRECTIONAL);
288 free_page((unsigned long)ibmvtpm->crq_queue.crq_addr);
290 if (ibmvtpm->rtce_buf) {
291 dma_unmap_single(ibmvtpm->dev, ibmvtpm->rtce_dma_handle,
292 ibmvtpm->rtce_size, DMA_BIDIRECTIONAL);
293 kfree(ibmvtpm->rtce_buf);
296 tpm_remove_hardware(ibmvtpm->dev);
304 * tpm_ibmvtpm_get_desired_dma - Get DMA size needed by this driver
305 * @vdev: vio device struct
308 * Number of bytes the driver needs to DMA map
310 static unsigned long tpm_ibmvtpm_get_desired_dma(struct vio_dev *vdev)
312 struct ibmvtpm_dev *ibmvtpm = ibmvtpm_get_data(&vdev->dev);
314 /* ibmvtpm initializes at probe time, so the data we are
315 * asking for may not be set yet. Estimate that 4K required
316 * for TCE-mapped buffer in addition to CRQ.
319 return CRQ_RES_BUF_SIZE + PAGE_SIZE;
321 return CRQ_RES_BUF_SIZE + ibmvtpm->rtce_size;
325 * tpm_ibmvtpm_suspend - Suspend
326 * @dev: device struct
331 static int tpm_ibmvtpm_suspend(struct device *dev)
333 struct ibmvtpm_dev *ibmvtpm = ibmvtpm_get_data(dev);
334 struct ibmvtpm_crq crq;
335 u64 *buf = (u64 *) &crq;
338 crq.valid = (u8)IBMVTPM_VALID_CMD;
339 crq.msg = (u8)VTPM_PREPARE_TO_SUSPEND;
341 rc = ibmvtpm_send_crq(ibmvtpm->vdev, cpu_to_be64(buf[0]),
342 cpu_to_be64(buf[1]));
344 dev_err(ibmvtpm->dev,
345 "tpm_ibmvtpm_suspend failed rc=%d\n", rc);
351 * ibmvtpm_reset_crq - Reset CRQ
352 * @ibmvtpm: ibm vtpm struct
358 static int ibmvtpm_reset_crq(struct ibmvtpm_dev *ibmvtpm)
365 rc = plpar_hcall_norets(H_FREE_CRQ,
366 ibmvtpm->vdev->unit_address);
367 } while (rc == H_BUSY || H_IS_LONG_BUSY(rc));
369 memset(ibmvtpm->crq_queue.crq_addr, 0, CRQ_RES_BUF_SIZE);
370 ibmvtpm->crq_queue.index = 0;
372 return plpar_hcall_norets(H_REG_CRQ, ibmvtpm->vdev->unit_address,
373 ibmvtpm->crq_dma_handle, CRQ_RES_BUF_SIZE);
377 * tpm_ibmvtpm_resume - Resume from suspend
378 * @dev: device struct
383 static int tpm_ibmvtpm_resume(struct device *dev)
385 struct ibmvtpm_dev *ibmvtpm = ibmvtpm_get_data(dev);
391 rc = plpar_hcall_norets(H_ENABLE_CRQ,
392 ibmvtpm->vdev->unit_address);
393 } while (rc == H_IN_PROGRESS || rc == H_BUSY || H_IS_LONG_BUSY(rc));
396 dev_err(dev, "Error enabling ibmvtpm rc=%d\n", rc);
400 rc = vio_enable_interrupts(ibmvtpm->vdev);
402 dev_err(dev, "Error vio_enable_interrupts rc=%d\n", rc);
406 rc = ibmvtpm_crq_send_init(ibmvtpm);
408 dev_err(dev, "Error send_init rc=%d\n", rc);
413 static bool tpm_ibmvtpm_req_canceled(struct tpm_chip *chip, u8 status)
415 return (status == 0);
418 static const struct file_operations ibmvtpm_ops = {
419 .owner = THIS_MODULE,
424 .release = tpm_release,
427 static DEVICE_ATTR(pubek, S_IRUGO, tpm_show_pubek, NULL);
428 static DEVICE_ATTR(pcrs, S_IRUGO, tpm_show_pcrs, NULL);
429 static DEVICE_ATTR(enabled, S_IRUGO, tpm_show_enabled, NULL);
430 static DEVICE_ATTR(active, S_IRUGO, tpm_show_active, NULL);
431 static DEVICE_ATTR(owned, S_IRUGO, tpm_show_owned, NULL);
432 static DEVICE_ATTR(temp_deactivated, S_IRUGO, tpm_show_temp_deactivated,
434 static DEVICE_ATTR(caps, S_IRUGO, tpm_show_caps_1_2, NULL);
435 static DEVICE_ATTR(cancel, S_IWUSR | S_IWGRP, NULL, tpm_store_cancel);
436 static DEVICE_ATTR(durations, S_IRUGO, tpm_show_durations, NULL);
437 static DEVICE_ATTR(timeouts, S_IRUGO, tpm_show_timeouts, NULL);
439 static struct attribute *ibmvtpm_attrs[] = {
440 &dev_attr_pubek.attr,
442 &dev_attr_enabled.attr,
443 &dev_attr_active.attr,
444 &dev_attr_owned.attr,
445 &dev_attr_temp_deactivated.attr,
447 &dev_attr_cancel.attr,
448 &dev_attr_durations.attr,
449 &dev_attr_timeouts.attr, NULL,
452 static struct attribute_group ibmvtpm_attr_grp = { .attrs = ibmvtpm_attrs };
454 static const struct tpm_vendor_specific tpm_ibmvtpm = {
455 .recv = tpm_ibmvtpm_recv,
456 .send = tpm_ibmvtpm_send,
457 .cancel = tpm_ibmvtpm_cancel,
458 .status = tpm_ibmvtpm_status,
459 .req_complete_mask = 0,
460 .req_complete_val = 0,
461 .req_canceled = tpm_ibmvtpm_req_canceled,
462 .attr_group = &ibmvtpm_attr_grp,
463 .miscdev = { .fops = &ibmvtpm_ops, },
466 static const struct dev_pm_ops tpm_ibmvtpm_pm_ops = {
467 .suspend = tpm_ibmvtpm_suspend,
468 .resume = tpm_ibmvtpm_resume,
472 * ibmvtpm_crq_get_next - Get next responded crq
473 * @ibmvtpm vtpm device struct
478 static struct ibmvtpm_crq *ibmvtpm_crq_get_next(struct ibmvtpm_dev *ibmvtpm)
480 struct ibmvtpm_crq_queue *crq_q = &ibmvtpm->crq_queue;
481 struct ibmvtpm_crq *crq = &crq_q->crq_addr[crq_q->index];
483 if (crq->valid & VTPM_MSG_RES) {
484 if (++crq_q->index == crq_q->num_entry)
493 * ibmvtpm_crq_process - Process responded crq
494 * @crq crq to be processed
495 * @ibmvtpm vtpm device struct
500 static void ibmvtpm_crq_process(struct ibmvtpm_crq *crq,
501 struct ibmvtpm_dev *ibmvtpm)
505 switch (crq->valid) {
509 dev_info(ibmvtpm->dev, "CRQ initialized\n");
510 rc = ibmvtpm_crq_send_init_complete(ibmvtpm);
512 dev_err(ibmvtpm->dev, "Unable to send CRQ init complete rc=%d\n", rc);
514 case INIT_CRQ_COMP_RES:
515 dev_info(ibmvtpm->dev,
516 "CRQ initialization completed\n");
519 dev_err(ibmvtpm->dev, "Unknown crq message type: %d\n", crq->msg);
523 case IBMVTPM_VALID_CMD:
525 case VTPM_GET_RTCE_BUFFER_SIZE_RES:
526 if (be16_to_cpu(crq->len) <= 0) {
527 dev_err(ibmvtpm->dev, "Invalid rtce size\n");
530 ibmvtpm->rtce_size = be16_to_cpu(crq->len);
531 ibmvtpm->rtce_buf = kmalloc(ibmvtpm->rtce_size,
533 if (!ibmvtpm->rtce_buf) {
534 dev_err(ibmvtpm->dev, "Failed to allocate memory for rtce buffer\n");
538 ibmvtpm->rtce_dma_handle = dma_map_single(ibmvtpm->dev,
539 ibmvtpm->rtce_buf, ibmvtpm->rtce_size,
542 if (dma_mapping_error(ibmvtpm->dev,
543 ibmvtpm->rtce_dma_handle)) {
544 kfree(ibmvtpm->rtce_buf);
545 ibmvtpm->rtce_buf = NULL;
546 dev_err(ibmvtpm->dev, "Failed to dma map rtce buffer\n");
550 case VTPM_GET_VERSION_RES:
551 ibmvtpm->vtpm_version = be32_to_cpu(crq->data);
553 case VTPM_TPM_COMMAND_RES:
554 /* len of the data in rtce buffer */
555 ibmvtpm->res_len = be16_to_cpu(crq->len);
556 wake_up_interruptible(&ibmvtpm->wq);
566 * ibmvtpm_interrupt - Interrupt handler
567 * @irq: irq number to handle
568 * @vtpm_instance: vtpm that received interrupt
573 static irqreturn_t ibmvtpm_interrupt(int irq, void *vtpm_instance)
575 struct ibmvtpm_dev *ibmvtpm = (struct ibmvtpm_dev *) vtpm_instance;
576 struct ibmvtpm_crq *crq;
578 /* while loop is needed for initial setup (get version and
579 * get rtce_size). There should be only one tpm request at any
582 while ((crq = ibmvtpm_crq_get_next(ibmvtpm)) != NULL) {
583 ibmvtpm_crq_process(crq, ibmvtpm);
592 * tpm_ibmvtpm_probe - ibm vtpm initialize entry point
593 * @vio_dev: vio device struct
594 * @id: vio device id struct
600 static int tpm_ibmvtpm_probe(struct vio_dev *vio_dev,
601 const struct vio_device_id *id)
603 struct ibmvtpm_dev *ibmvtpm;
604 struct device *dev = &vio_dev->dev;
605 struct ibmvtpm_crq_queue *crq_q;
606 struct tpm_chip *chip;
607 int rc = -ENOMEM, rc1;
609 chip = tpm_register_hardware(dev, &tpm_ibmvtpm);
611 dev_err(dev, "tpm_register_hardware failed\n");
615 ibmvtpm = kzalloc(sizeof(struct ibmvtpm_dev), GFP_KERNEL);
617 dev_err(dev, "kzalloc for ibmvtpm failed\n");
621 crq_q = &ibmvtpm->crq_queue;
622 crq_q->crq_addr = (struct ibmvtpm_crq *)get_zeroed_page(GFP_KERNEL);
623 if (!crq_q->crq_addr) {
624 dev_err(dev, "Unable to allocate memory for crq_addr\n");
628 crq_q->num_entry = CRQ_RES_BUF_SIZE / sizeof(*crq_q->crq_addr);
629 ibmvtpm->crq_dma_handle = dma_map_single(dev, crq_q->crq_addr,
633 if (dma_mapping_error(dev, ibmvtpm->crq_dma_handle)) {
634 dev_err(dev, "dma mapping failed\n");
638 rc = plpar_hcall_norets(H_REG_CRQ, vio_dev->unit_address,
639 ibmvtpm->crq_dma_handle, CRQ_RES_BUF_SIZE);
640 if (rc == H_RESOURCE)
641 rc = ibmvtpm_reset_crq(ibmvtpm);
644 dev_err(dev, "Unable to register CRQ rc=%d\n", rc);
645 goto reg_crq_cleanup;
648 rc = request_irq(vio_dev->irq, ibmvtpm_interrupt, 0,
649 tpm_ibmvtpm_driver_name, ibmvtpm);
651 dev_err(dev, "Error %d register irq 0x%x\n", rc, vio_dev->irq);
652 goto init_irq_cleanup;
655 rc = vio_enable_interrupts(vio_dev);
657 dev_err(dev, "Error %d enabling interrupts\n", rc);
658 goto init_irq_cleanup;
661 init_waitqueue_head(&ibmvtpm->wq);
666 ibmvtpm->vdev = vio_dev;
667 TPM_VPRIV(chip) = (void *)ibmvtpm;
669 spin_lock_init(&ibmvtpm->rtce_lock);
671 rc = ibmvtpm_crq_send_init(ibmvtpm);
673 goto init_irq_cleanup;
675 rc = ibmvtpm_crq_get_version(ibmvtpm);
677 goto init_irq_cleanup;
679 rc = ibmvtpm_crq_get_rtce_size(ibmvtpm);
681 goto init_irq_cleanup;
686 rc1 = plpar_hcall_norets(H_FREE_CRQ, vio_dev->unit_address);
687 } while (rc1 == H_BUSY || H_IS_LONG_BUSY(rc1));
689 dma_unmap_single(dev, ibmvtpm->crq_dma_handle, CRQ_RES_BUF_SIZE,
694 free_page((unsigned long)crq_q->crq_addr);
698 tpm_remove_hardware(dev);
703 static struct vio_driver ibmvtpm_driver = {
704 .id_table = tpm_ibmvtpm_device_table,
705 .probe = tpm_ibmvtpm_probe,
706 .remove = tpm_ibmvtpm_remove,
707 .get_desired_dma = tpm_ibmvtpm_get_desired_dma,
708 .name = tpm_ibmvtpm_driver_name,
709 .pm = &tpm_ibmvtpm_pm_ops,
713 * ibmvtpm_module_init - Initialize ibm vtpm module
719 static int __init ibmvtpm_module_init(void)
721 return vio_register_driver(&ibmvtpm_driver);
725 * ibmvtpm_module_exit - Teardown ibm vtpm module
730 static void __exit ibmvtpm_module_exit(void)
732 vio_unregister_driver(&ibmvtpm_driver);
735 module_init(ibmvtpm_module_init);
736 module_exit(ibmvtpm_module_exit);
738 MODULE_AUTHOR("adlai@us.ibm.com");
739 MODULE_DESCRIPTION("IBM vTPM Driver");
740 MODULE_VERSION("1.0");
741 MODULE_LICENSE("GPL");