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 u64
*word
= (u64
*) &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
= (u16
)count
;
149 crq
.data
= ibmvtpm
->rtce_dma_handle
;
151 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, word
[0], word
[1]);
152 if (rc
!= H_SUCCESS
) {
153 dev_err(ibmvtpm
->dev
, "tpm_ibmvtpm_send failed rc=%d\n", rc
);
158 spin_unlock(&ibmvtpm
->rtce_lock
);
162 static void tpm_ibmvtpm_cancel(struct tpm_chip
*chip
)
167 static u8
tpm_ibmvtpm_status(struct tpm_chip
*chip
)
173 * ibmvtpm_crq_get_rtce_size - Send a CRQ request to get rtce size
174 * @ibmvtpm: vtpm device struct
180 static int ibmvtpm_crq_get_rtce_size(struct ibmvtpm_dev
*ibmvtpm
)
182 struct ibmvtpm_crq crq
;
183 u64
*buf
= (u64
*) &crq
;
186 crq
.valid
= (u8
)IBMVTPM_VALID_CMD
;
187 crq
.msg
= (u8
)VTPM_GET_RTCE_BUFFER_SIZE
;
189 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, buf
[0], buf
[1]);
191 dev_err(ibmvtpm
->dev
,
192 "ibmvtpm_crq_get_rtce_size failed rc=%d\n", rc
);
198 * ibmvtpm_crq_get_version - Send a CRQ request to get vtpm version
199 * - Note that this is vtpm version and not tpm version
200 * @ibmvtpm: vtpm device struct
206 static int ibmvtpm_crq_get_version(struct ibmvtpm_dev
*ibmvtpm
)
208 struct ibmvtpm_crq crq
;
209 u64
*buf
= (u64
*) &crq
;
212 crq
.valid
= (u8
)IBMVTPM_VALID_CMD
;
213 crq
.msg
= (u8
)VTPM_GET_VERSION
;
215 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, buf
[0], buf
[1]);
217 dev_err(ibmvtpm
->dev
,
218 "ibmvtpm_crq_get_version failed rc=%d\n", rc
);
224 * ibmvtpm_crq_send_init_complete - Send a CRQ initialize complete message
225 * @ibmvtpm: vtpm device struct
231 static int ibmvtpm_crq_send_init_complete(struct ibmvtpm_dev
*ibmvtpm
)
235 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, INIT_CRQ_COMP_CMD
, 0);
237 dev_err(ibmvtpm
->dev
,
238 "ibmvtpm_crq_send_init_complete failed rc=%d\n", rc
);
244 * ibmvtpm_crq_send_init - Send a CRQ initialize message
245 * @ibmvtpm: vtpm device struct
251 static int ibmvtpm_crq_send_init(struct ibmvtpm_dev
*ibmvtpm
)
255 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, INIT_CRQ_CMD
, 0);
257 dev_err(ibmvtpm
->dev
,
258 "ibmvtpm_crq_send_init failed rc=%d\n", rc
);
264 * tpm_ibmvtpm_remove - ibm vtpm remove entry point
265 * @vdev: vio device struct
270 static int tpm_ibmvtpm_remove(struct vio_dev
*vdev
)
272 struct ibmvtpm_dev
*ibmvtpm
= ibmvtpm_get_data(&vdev
->dev
);
275 free_irq(vdev
->irq
, ibmvtpm
);
280 rc
= plpar_hcall_norets(H_FREE_CRQ
, vdev
->unit_address
);
281 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
283 dma_unmap_single(ibmvtpm
->dev
, ibmvtpm
->crq_dma_handle
,
284 CRQ_RES_BUF_SIZE
, DMA_BIDIRECTIONAL
);
285 free_page((unsigned long)ibmvtpm
->crq_queue
.crq_addr
);
287 if (ibmvtpm
->rtce_buf
) {
288 dma_unmap_single(ibmvtpm
->dev
, ibmvtpm
->rtce_dma_handle
,
289 ibmvtpm
->rtce_size
, DMA_BIDIRECTIONAL
);
290 kfree(ibmvtpm
->rtce_buf
);
293 tpm_remove_hardware(ibmvtpm
->dev
);
301 * tpm_ibmvtpm_get_desired_dma - Get DMA size needed by this driver
302 * @vdev: vio device struct
305 * Number of bytes the driver needs to DMA map
307 static unsigned long tpm_ibmvtpm_get_desired_dma(struct vio_dev
*vdev
)
309 struct ibmvtpm_dev
*ibmvtpm
= ibmvtpm_get_data(&vdev
->dev
);
311 /* ibmvtpm initializes at probe time, so the data we are
312 * asking for may not be set yet. Estimate that 4K required
313 * for TCE-mapped buffer in addition to CRQ.
316 return CRQ_RES_BUF_SIZE
+ PAGE_SIZE
;
318 return CRQ_RES_BUF_SIZE
+ ibmvtpm
->rtce_size
;
322 * tpm_ibmvtpm_suspend - Suspend
323 * @dev: device struct
328 static int tpm_ibmvtpm_suspend(struct device
*dev
)
330 struct ibmvtpm_dev
*ibmvtpm
= ibmvtpm_get_data(dev
);
331 struct ibmvtpm_crq crq
;
332 u64
*buf
= (u64
*) &crq
;
335 crq
.valid
= (u8
)IBMVTPM_VALID_CMD
;
336 crq
.msg
= (u8
)VTPM_PREPARE_TO_SUSPEND
;
338 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, buf
[0], buf
[1]);
340 dev_err(ibmvtpm
->dev
,
341 "tpm_ibmvtpm_suspend failed rc=%d\n", rc
);
347 * ibmvtpm_reset_crq - Reset CRQ
348 * @ibmvtpm: ibm vtpm struct
354 static int ibmvtpm_reset_crq(struct ibmvtpm_dev
*ibmvtpm
)
361 rc
= plpar_hcall_norets(H_FREE_CRQ
,
362 ibmvtpm
->vdev
->unit_address
);
363 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
365 memset(ibmvtpm
->crq_queue
.crq_addr
, 0, CRQ_RES_BUF_SIZE
);
366 ibmvtpm
->crq_queue
.index
= 0;
368 return plpar_hcall_norets(H_REG_CRQ
, ibmvtpm
->vdev
->unit_address
,
369 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
373 * tpm_ibmvtpm_resume - Resume from suspend
374 * @dev: device struct
379 static int tpm_ibmvtpm_resume(struct device
*dev
)
381 struct ibmvtpm_dev
*ibmvtpm
= ibmvtpm_get_data(dev
);
387 rc
= plpar_hcall_norets(H_ENABLE_CRQ
,
388 ibmvtpm
->vdev
->unit_address
);
389 } while (rc
== H_IN_PROGRESS
|| rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
392 dev_err(dev
, "Error enabling ibmvtpm rc=%d\n", rc
);
396 rc
= vio_enable_interrupts(ibmvtpm
->vdev
);
398 dev_err(dev
, "Error vio_enable_interrupts rc=%d\n", rc
);
402 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
404 dev_err(dev
, "Error send_init rc=%d\n", rc
);
409 static bool tpm_ibmvtpm_req_canceled(struct tpm_chip
*chip
, u8 status
)
411 return (status
== 0);
414 static const struct file_operations ibmvtpm_ops
= {
415 .owner
= THIS_MODULE
,
420 .release
= tpm_release
,
423 static DEVICE_ATTR(pubek
, S_IRUGO
, tpm_show_pubek
, NULL
);
424 static DEVICE_ATTR(pcrs
, S_IRUGO
, tpm_show_pcrs
, NULL
);
425 static DEVICE_ATTR(enabled
, S_IRUGO
, tpm_show_enabled
, NULL
);
426 static DEVICE_ATTR(active
, S_IRUGO
, tpm_show_active
, NULL
);
427 static DEVICE_ATTR(owned
, S_IRUGO
, tpm_show_owned
, NULL
);
428 static DEVICE_ATTR(temp_deactivated
, S_IRUGO
, tpm_show_temp_deactivated
,
430 static DEVICE_ATTR(caps
, S_IRUGO
, tpm_show_caps_1_2
, NULL
);
431 static DEVICE_ATTR(cancel
, S_IWUSR
| S_IWGRP
, NULL
, tpm_store_cancel
);
432 static DEVICE_ATTR(durations
, S_IRUGO
, tpm_show_durations
, NULL
);
433 static DEVICE_ATTR(timeouts
, S_IRUGO
, tpm_show_timeouts
, NULL
);
435 static struct attribute
*ibmvtpm_attrs
[] = {
436 &dev_attr_pubek
.attr
,
438 &dev_attr_enabled
.attr
,
439 &dev_attr_active
.attr
,
440 &dev_attr_owned
.attr
,
441 &dev_attr_temp_deactivated
.attr
,
443 &dev_attr_cancel
.attr
,
444 &dev_attr_durations
.attr
,
445 &dev_attr_timeouts
.attr
, NULL
,
448 static struct attribute_group ibmvtpm_attr_grp
= { .attrs
= ibmvtpm_attrs
};
450 static const struct tpm_vendor_specific tpm_ibmvtpm
= {
451 .recv
= tpm_ibmvtpm_recv
,
452 .send
= tpm_ibmvtpm_send
,
453 .cancel
= tpm_ibmvtpm_cancel
,
454 .status
= tpm_ibmvtpm_status
,
455 .req_complete_mask
= 0,
456 .req_complete_val
= 0,
457 .req_canceled
= tpm_ibmvtpm_req_canceled
,
458 .attr_group
= &ibmvtpm_attr_grp
,
459 .miscdev
= { .fops
= &ibmvtpm_ops
, },
462 static const struct dev_pm_ops tpm_ibmvtpm_pm_ops
= {
463 .suspend
= tpm_ibmvtpm_suspend
,
464 .resume
= tpm_ibmvtpm_resume
,
468 * ibmvtpm_crq_get_next - Get next responded crq
469 * @ibmvtpm vtpm device struct
474 static struct ibmvtpm_crq
*ibmvtpm_crq_get_next(struct ibmvtpm_dev
*ibmvtpm
)
476 struct ibmvtpm_crq_queue
*crq_q
= &ibmvtpm
->crq_queue
;
477 struct ibmvtpm_crq
*crq
= &crq_q
->crq_addr
[crq_q
->index
];
479 if (crq
->valid
& VTPM_MSG_RES
) {
480 if (++crq_q
->index
== crq_q
->num_entry
)
489 * ibmvtpm_crq_process - Process responded crq
490 * @crq crq to be processed
491 * @ibmvtpm vtpm device struct
496 static void ibmvtpm_crq_process(struct ibmvtpm_crq
*crq
,
497 struct ibmvtpm_dev
*ibmvtpm
)
501 switch (crq
->valid
) {
505 dev_info(ibmvtpm
->dev
, "CRQ initialized\n");
506 rc
= ibmvtpm_crq_send_init_complete(ibmvtpm
);
508 dev_err(ibmvtpm
->dev
, "Unable to send CRQ init complete rc=%d\n", rc
);
510 case INIT_CRQ_COMP_RES
:
511 dev_info(ibmvtpm
->dev
,
512 "CRQ initialization completed\n");
515 dev_err(ibmvtpm
->dev
, "Unknown crq message type: %d\n", crq
->msg
);
519 case IBMVTPM_VALID_CMD
:
521 case VTPM_GET_RTCE_BUFFER_SIZE_RES
:
523 dev_err(ibmvtpm
->dev
, "Invalid rtce size\n");
526 ibmvtpm
->rtce_size
= crq
->len
;
527 ibmvtpm
->rtce_buf
= kmalloc(ibmvtpm
->rtce_size
,
529 if (!ibmvtpm
->rtce_buf
) {
530 dev_err(ibmvtpm
->dev
, "Failed to allocate memory for rtce buffer\n");
534 ibmvtpm
->rtce_dma_handle
= dma_map_single(ibmvtpm
->dev
,
535 ibmvtpm
->rtce_buf
, ibmvtpm
->rtce_size
,
538 if (dma_mapping_error(ibmvtpm
->dev
,
539 ibmvtpm
->rtce_dma_handle
)) {
540 kfree(ibmvtpm
->rtce_buf
);
541 ibmvtpm
->rtce_buf
= NULL
;
542 dev_err(ibmvtpm
->dev
, "Failed to dma map rtce buffer\n");
546 case VTPM_GET_VERSION_RES
:
547 ibmvtpm
->vtpm_version
= crq
->data
;
549 case VTPM_TPM_COMMAND_RES
:
550 /* len of the data in rtce buffer */
551 ibmvtpm
->res_len
= crq
->len
;
552 wake_up_interruptible(&ibmvtpm
->wq
);
562 * ibmvtpm_interrupt - Interrupt handler
563 * @irq: irq number to handle
564 * @vtpm_instance: vtpm that received interrupt
569 static irqreturn_t
ibmvtpm_interrupt(int irq
, void *vtpm_instance
)
571 struct ibmvtpm_dev
*ibmvtpm
= (struct ibmvtpm_dev
*) vtpm_instance
;
572 struct ibmvtpm_crq
*crq
;
574 /* while loop is needed for initial setup (get version and
575 * get rtce_size). There should be only one tpm request at any
578 while ((crq
= ibmvtpm_crq_get_next(ibmvtpm
)) != NULL
) {
579 ibmvtpm_crq_process(crq
, ibmvtpm
);
588 * tpm_ibmvtpm_probe - ibm vtpm initialize entry point
589 * @vio_dev: vio device struct
590 * @id: vio device id struct
596 static int tpm_ibmvtpm_probe(struct vio_dev
*vio_dev
,
597 const struct vio_device_id
*id
)
599 struct ibmvtpm_dev
*ibmvtpm
;
600 struct device
*dev
= &vio_dev
->dev
;
601 struct ibmvtpm_crq_queue
*crq_q
;
602 struct tpm_chip
*chip
;
603 int rc
= -ENOMEM
, rc1
;
605 chip
= tpm_register_hardware(dev
, &tpm_ibmvtpm
);
607 dev_err(dev
, "tpm_register_hardware failed\n");
611 ibmvtpm
= kzalloc(sizeof(struct ibmvtpm_dev
), GFP_KERNEL
);
613 dev_err(dev
, "kzalloc for ibmvtpm failed\n");
617 crq_q
= &ibmvtpm
->crq_queue
;
618 crq_q
->crq_addr
= (struct ibmvtpm_crq
*)get_zeroed_page(GFP_KERNEL
);
619 if (!crq_q
->crq_addr
) {
620 dev_err(dev
, "Unable to allocate memory for crq_addr\n");
624 crq_q
->num_entry
= CRQ_RES_BUF_SIZE
/ sizeof(*crq_q
->crq_addr
);
625 ibmvtpm
->crq_dma_handle
= dma_map_single(dev
, crq_q
->crq_addr
,
629 if (dma_mapping_error(dev
, ibmvtpm
->crq_dma_handle
)) {
630 dev_err(dev
, "dma mapping failed\n");
634 rc
= plpar_hcall_norets(H_REG_CRQ
, vio_dev
->unit_address
,
635 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
636 if (rc
== H_RESOURCE
)
637 rc
= ibmvtpm_reset_crq(ibmvtpm
);
640 dev_err(dev
, "Unable to register CRQ rc=%d\n", rc
);
641 goto reg_crq_cleanup
;
644 rc
= request_irq(vio_dev
->irq
, ibmvtpm_interrupt
, 0,
645 tpm_ibmvtpm_driver_name
, ibmvtpm
);
647 dev_err(dev
, "Error %d register irq 0x%x\n", rc
, vio_dev
->irq
);
648 goto init_irq_cleanup
;
651 rc
= vio_enable_interrupts(vio_dev
);
653 dev_err(dev
, "Error %d enabling interrupts\n", rc
);
654 goto init_irq_cleanup
;
657 init_waitqueue_head(&ibmvtpm
->wq
);
662 ibmvtpm
->vdev
= vio_dev
;
663 TPM_VPRIV(chip
) = (void *)ibmvtpm
;
665 spin_lock_init(&ibmvtpm
->rtce_lock
);
667 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
669 goto init_irq_cleanup
;
671 rc
= ibmvtpm_crq_get_version(ibmvtpm
);
673 goto init_irq_cleanup
;
675 rc
= ibmvtpm_crq_get_rtce_size(ibmvtpm
);
677 goto init_irq_cleanup
;
682 rc1
= plpar_hcall_norets(H_FREE_CRQ
, vio_dev
->unit_address
);
683 } while (rc1
== H_BUSY
|| H_IS_LONG_BUSY(rc1
));
685 dma_unmap_single(dev
, ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
,
690 free_page((unsigned long)crq_q
->crq_addr
);
694 tpm_remove_hardware(dev
);
699 static struct vio_driver ibmvtpm_driver
= {
700 .id_table
= tpm_ibmvtpm_device_table
,
701 .probe
= tpm_ibmvtpm_probe
,
702 .remove
= tpm_ibmvtpm_remove
,
703 .get_desired_dma
= tpm_ibmvtpm_get_desired_dma
,
704 .name
= tpm_ibmvtpm_driver_name
,
705 .pm
= &tpm_ibmvtpm_pm_ops
,
709 * ibmvtpm_module_init - Initialize ibm vtpm module
715 static int __init
ibmvtpm_module_init(void)
717 return vio_register_driver(&ibmvtpm_driver
);
721 * ibmvtpm_module_exit - Teardown ibm vtpm module
726 static void __exit
ibmvtpm_module_exit(void)
728 vio_unregister_driver(&ibmvtpm_driver
);
731 module_init(ibmvtpm_module_init
);
732 module_exit(ibmvtpm_module_exit
);
734 MODULE_AUTHOR("adlai@us.ibm.com");
735 MODULE_DESCRIPTION("IBM vTPM Driver");
736 MODULE_VERSION("1.0");
737 MODULE_LICENSE("GPL");