2 * Copyright (C) 2012 IBM Corporation
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 const struct vio_device_id tpm_ibmvtpm_device_table[] = {
36 { "IBM,vtpm", "IBM,vtpm"},
39 MODULE_DEVICE_TABLE(vio, tpm_ibmvtpm_device_table);
43 * ibmvtpm_send_crq_word - Send a CRQ request
44 * @vdev: vio device struct
45 * @w1: pre-constructed first word of tpm crq (second word is reserved)
51 static int ibmvtpm_send_crq_word(struct vio_dev *vdev, u64 w1)
53 return plpar_hcall_norets(H_SEND_CRQ, vdev->unit_address, w1, 0);
58 * ibmvtpm_send_crq - Send a CRQ request
60 * @vdev: vio device struct
66 * The ibmvtpm crq is defined as follows:
68 * Byte | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
69 * -----------------------------------------------------------------------
70 * Word0 | Valid | Type | Length | Data
71 * -----------------------------------------------------------------------
73 * -----------------------------------------------------------------------
75 * Which matches the following structure (on bigendian host):
77 * struct ibmvtpm_crq {
83 * } __attribute__((packed, aligned(8)));
85 * However, the value is passed in a register so just compute the numeric value
86 * to load into the register avoiding byteswap altogether. Endian only affects
87 * memory loads and stores - registers are internally represented the same.
90 * 0 (H_SUCCESS) - Success
93 static int ibmvtpm_send_crq(struct vio_dev *vdev,
94 u8 valid, u8 msg, u16 len, u32 data)
96 u64 w1 = ((u64)valid << 56) | ((u64)msg << 48) | ((u64)len << 32) |
98 return ibmvtpm_send_crq_word(vdev, w1);
102 * tpm_ibmvtpm_recv - Receive data after send
104 * @chip: tpm chip struct
105 * @buf: buffer to read
106 * @count: size of buffer
109 * Number of bytes read
111 static int tpm_ibmvtpm_recv(struct tpm_chip *chip, u8 *buf, size_t count)
113 struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
117 if (!ibmvtpm->rtce_buf) {
118 dev_err(ibmvtpm->dev, "ibmvtpm device is not ready\n");
122 sig = wait_event_interruptible(ibmvtpm->wq, !ibmvtpm->tpm_processing_cmd);
126 len = ibmvtpm->res_len;
129 dev_err(ibmvtpm->dev,
130 "Invalid size in recv: count=%zd, crq_size=%d\n",
135 spin_lock(&ibmvtpm->rtce_lock);
136 memcpy((void *)buf, (void *)ibmvtpm->rtce_buf, len);
137 memset(ibmvtpm->rtce_buf, 0, len);
138 ibmvtpm->res_len = 0;
139 spin_unlock(&ibmvtpm->rtce_lock);
144 * tpm_ibmvtpm_send - Send tpm request
146 * @chip: tpm chip struct
147 * @buf: buffer contains data to send
148 * @count: size of buffer
151 * Number of bytes sent or < 0 on error.
153 static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
155 struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
158 if (!ibmvtpm->rtce_buf) {
159 dev_err(ibmvtpm->dev, "ibmvtpm device is not ready\n");
163 if (count > ibmvtpm->rtce_size) {
164 dev_err(ibmvtpm->dev,
165 "Invalid size in send: count=%zd, rtce_size=%d\n",
166 count, ibmvtpm->rtce_size);
170 if (ibmvtpm->tpm_processing_cmd) {
171 dev_info(ibmvtpm->dev,
172 "Need to wait for TPM to finish\n");
173 /* wait for previous command to finish */
174 sig = wait_event_interruptible(ibmvtpm->wq, !ibmvtpm->tpm_processing_cmd);
179 spin_lock(&ibmvtpm->rtce_lock);
180 ibmvtpm->res_len = 0;
181 memcpy((void *)ibmvtpm->rtce_buf, (void *)buf, count);
184 * set the processing flag before the Hcall, since we may get the
185 * result (interrupt) before even being able to check rc.
187 ibmvtpm->tpm_processing_cmd = true;
189 rc = ibmvtpm_send_crq(ibmvtpm->vdev,
190 IBMVTPM_VALID_CMD, VTPM_TPM_COMMAND,
191 count, ibmvtpm->rtce_dma_handle);
192 if (rc != H_SUCCESS) {
193 dev_err(ibmvtpm->dev, "tpm_ibmvtpm_send failed rc=%d\n", rc);
195 ibmvtpm->tpm_processing_cmd = false;
199 spin_unlock(&ibmvtpm->rtce_lock);
203 static void tpm_ibmvtpm_cancel(struct tpm_chip *chip)
208 static u8 tpm_ibmvtpm_status(struct tpm_chip *chip)
214 * ibmvtpm_crq_get_rtce_size - Send a CRQ request to get rtce size
216 * @ibmvtpm: vtpm device struct
220 * Non-zero on failure.
222 static int ibmvtpm_crq_get_rtce_size(struct ibmvtpm_dev *ibmvtpm)
226 rc = ibmvtpm_send_crq(ibmvtpm->vdev,
227 IBMVTPM_VALID_CMD, VTPM_GET_RTCE_BUFFER_SIZE, 0, 0);
229 dev_err(ibmvtpm->dev,
230 "ibmvtpm_crq_get_rtce_size failed rc=%d\n", rc);
236 * ibmvtpm_crq_get_version - Send a CRQ request to get vtpm version
237 * - Note that this is vtpm version and not tpm version
239 * @ibmvtpm: vtpm device struct
243 * Non-zero on failure.
245 static int ibmvtpm_crq_get_version(struct ibmvtpm_dev *ibmvtpm)
249 rc = ibmvtpm_send_crq(ibmvtpm->vdev,
250 IBMVTPM_VALID_CMD, VTPM_GET_VERSION, 0, 0);
252 dev_err(ibmvtpm->dev,
253 "ibmvtpm_crq_get_version failed rc=%d\n", rc);
259 * ibmvtpm_crq_send_init_complete - Send a CRQ initialize complete message
260 * @ibmvtpm: vtpm device struct
264 * Non-zero on failure.
266 static int ibmvtpm_crq_send_init_complete(struct ibmvtpm_dev *ibmvtpm)
270 rc = ibmvtpm_send_crq_word(ibmvtpm->vdev, INIT_CRQ_COMP_CMD);
272 dev_err(ibmvtpm->dev,
273 "ibmvtpm_crq_send_init_complete failed rc=%d\n", rc);
279 * ibmvtpm_crq_send_init - Send a CRQ initialize message
280 * @ibmvtpm: vtpm device struct
284 * Non-zero on failure.
286 static int ibmvtpm_crq_send_init(struct ibmvtpm_dev *ibmvtpm)
290 rc = ibmvtpm_send_crq_word(ibmvtpm->vdev, INIT_CRQ_CMD);
292 dev_err(ibmvtpm->dev,
293 "ibmvtpm_crq_send_init failed rc=%d\n", rc);
299 * tpm_ibmvtpm_remove - ibm vtpm remove entry point
300 * @vdev: vio device struct
304 static int tpm_ibmvtpm_remove(struct vio_dev *vdev)
306 struct tpm_chip *chip = dev_get_drvdata(&vdev->dev);
307 struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
310 tpm_chip_unregister(chip);
312 free_irq(vdev->irq, ibmvtpm);
317 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
318 } while (rc == H_BUSY || H_IS_LONG_BUSY(rc));
320 dma_unmap_single(ibmvtpm->dev, ibmvtpm->crq_dma_handle,
321 CRQ_RES_BUF_SIZE, DMA_BIDIRECTIONAL);
322 free_page((unsigned long)ibmvtpm->crq_queue.crq_addr);
324 if (ibmvtpm->rtce_buf) {
325 dma_unmap_single(ibmvtpm->dev, ibmvtpm->rtce_dma_handle,
326 ibmvtpm->rtce_size, DMA_BIDIRECTIONAL);
327 kfree(ibmvtpm->rtce_buf);
331 /* For tpm_ibmvtpm_get_desired_dma */
332 dev_set_drvdata(&vdev->dev, NULL);
338 * tpm_ibmvtpm_get_desired_dma - Get DMA size needed by this driver
339 * @vdev: vio device struct
342 * Number of bytes the driver needs to DMA map.
344 static unsigned long tpm_ibmvtpm_get_desired_dma(struct vio_dev *vdev)
346 struct tpm_chip *chip = dev_get_drvdata(&vdev->dev);
347 struct ibmvtpm_dev *ibmvtpm;
350 * ibmvtpm initializes at probe time, so the data we are
351 * asking for may not be set yet. Estimate that 4K required
352 * for TCE-mapped buffer in addition to CRQ.
355 ibmvtpm = dev_get_drvdata(&chip->dev);
357 return CRQ_RES_BUF_SIZE + PAGE_SIZE;
359 return CRQ_RES_BUF_SIZE + ibmvtpm->rtce_size;
363 * tpm_ibmvtpm_suspend - Suspend
364 * @dev: device struct
368 static int tpm_ibmvtpm_suspend(struct device *dev)
370 struct tpm_chip *chip = dev_get_drvdata(dev);
371 struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
374 rc = ibmvtpm_send_crq(ibmvtpm->vdev,
375 IBMVTPM_VALID_CMD, VTPM_PREPARE_TO_SUSPEND, 0, 0);
377 dev_err(ibmvtpm->dev,
378 "tpm_ibmvtpm_suspend failed rc=%d\n", rc);
384 * ibmvtpm_reset_crq - Reset CRQ
386 * @ibmvtpm: ibm vtpm struct
390 * Non-zero on failure.
392 static int ibmvtpm_reset_crq(struct ibmvtpm_dev *ibmvtpm)
399 rc = plpar_hcall_norets(H_FREE_CRQ,
400 ibmvtpm->vdev->unit_address);
401 } while (rc == H_BUSY || H_IS_LONG_BUSY(rc));
403 memset(ibmvtpm->crq_queue.crq_addr, 0, CRQ_RES_BUF_SIZE);
404 ibmvtpm->crq_queue.index = 0;
406 return plpar_hcall_norets(H_REG_CRQ, ibmvtpm->vdev->unit_address,
407 ibmvtpm->crq_dma_handle, CRQ_RES_BUF_SIZE);
411 * tpm_ibmvtpm_resume - Resume from suspend
413 * @dev: device struct
417 static int tpm_ibmvtpm_resume(struct device *dev)
419 struct tpm_chip *chip = dev_get_drvdata(dev);
420 struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
426 rc = plpar_hcall_norets(H_ENABLE_CRQ,
427 ibmvtpm->vdev->unit_address);
428 } while (rc == H_IN_PROGRESS || rc == H_BUSY || H_IS_LONG_BUSY(rc));
431 dev_err(dev, "Error enabling ibmvtpm rc=%d\n", rc);
435 rc = vio_enable_interrupts(ibmvtpm->vdev);
437 dev_err(dev, "Error vio_enable_interrupts rc=%d\n", rc);
441 rc = ibmvtpm_crq_send_init(ibmvtpm);
443 dev_err(dev, "Error send_init rc=%d\n", rc);
448 static bool tpm_ibmvtpm_req_canceled(struct tpm_chip *chip, u8 status)
450 return (status == 0);
453 static const struct tpm_class_ops tpm_ibmvtpm = {
454 .recv = tpm_ibmvtpm_recv,
455 .send = tpm_ibmvtpm_send,
456 .cancel = tpm_ibmvtpm_cancel,
457 .status = tpm_ibmvtpm_status,
458 .req_complete_mask = 0,
459 .req_complete_val = 0,
460 .req_canceled = tpm_ibmvtpm_req_canceled,
463 static const struct dev_pm_ops tpm_ibmvtpm_pm_ops = {
464 .suspend = tpm_ibmvtpm_suspend,
465 .resume = tpm_ibmvtpm_resume,
469 * ibmvtpm_crq_get_next - Get next responded crq
471 * @ibmvtpm: vtpm device struct
473 * Return: vtpm crq pointer or NULL.
475 static struct ibmvtpm_crq *ibmvtpm_crq_get_next(struct ibmvtpm_dev *ibmvtpm)
477 struct ibmvtpm_crq_queue *crq_q = &ibmvtpm->crq_queue;
478 struct ibmvtpm_crq *crq = &crq_q->crq_addr[crq_q->index];
480 if (crq->valid & VTPM_MSG_RES) {
481 if (++crq_q->index == crq_q->num_entry)
490 * ibmvtpm_crq_process - Process responded crq
492 * @crq: crq to be processed
493 * @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);
518 case IBMVTPM_VALID_CMD:
520 case VTPM_GET_RTCE_BUFFER_SIZE_RES:
521 if (be16_to_cpu(crq->len) <= 0) {
522 dev_err(ibmvtpm->dev, "Invalid rtce size\n");
525 ibmvtpm->rtce_size = be16_to_cpu(crq->len);
526 ibmvtpm->rtce_buf = kmalloc(ibmvtpm->rtce_size,
528 if (!ibmvtpm->rtce_buf) {
529 dev_err(ibmvtpm->dev, "Failed to allocate memory for rtce buffer\n");
533 ibmvtpm->rtce_dma_handle = dma_map_single(ibmvtpm->dev,
534 ibmvtpm->rtce_buf, ibmvtpm->rtce_size,
537 if (dma_mapping_error(ibmvtpm->dev,
538 ibmvtpm->rtce_dma_handle)) {
539 kfree(ibmvtpm->rtce_buf);
540 ibmvtpm->rtce_buf = NULL;
541 dev_err(ibmvtpm->dev, "Failed to dma map rtce buffer\n");
545 case VTPM_GET_VERSION_RES:
546 ibmvtpm->vtpm_version = be32_to_cpu(crq->data);
548 case VTPM_TPM_COMMAND_RES:
549 /* len of the data in rtce buffer */
550 ibmvtpm->res_len = be16_to_cpu(crq->len);
551 ibmvtpm->tpm_processing_cmd = false;
552 wake_up_interruptible(&ibmvtpm->wq);
562 * ibmvtpm_interrupt - Interrupt handler
564 * @irq: irq number to handle
565 * @vtpm_instance: vtpm that received interrupt
570 static irqreturn_t ibmvtpm_interrupt(int irq, void *vtpm_instance)
572 struct ibmvtpm_dev *ibmvtpm = (struct ibmvtpm_dev *) vtpm_instance;
573 struct ibmvtpm_crq *crq;
575 /* while loop is needed for initial setup (get version and
576 * get rtce_size). There should be only one tpm request at any
579 while ((crq = ibmvtpm_crq_get_next(ibmvtpm)) != NULL) {
580 ibmvtpm_crq_process(crq, ibmvtpm);
589 * tpm_ibmvtpm_probe - ibm vtpm initialize entry point
591 * @vio_dev: vio device struct
592 * @id: vio device id struct
596 * Non-zero on failure.
598 static int tpm_ibmvtpm_probe(struct vio_dev *vio_dev,
599 const struct vio_device_id *id)
601 struct ibmvtpm_dev *ibmvtpm;
602 struct device *dev = &vio_dev->dev;
603 struct ibmvtpm_crq_queue *crq_q;
604 struct tpm_chip *chip;
605 int rc = -ENOMEM, rc1;
607 chip = tpmm_chip_alloc(dev, &tpm_ibmvtpm);
609 return PTR_ERR(chip);
611 ibmvtpm = kzalloc(sizeof(struct ibmvtpm_dev), GFP_KERNEL);
613 dev_err(dev, "kzalloc for ibmvtpm failed\n");
618 ibmvtpm->vdev = vio_dev;
620 crq_q = &ibmvtpm->crq_queue;
621 crq_q->crq_addr = (struct ibmvtpm_crq *)get_zeroed_page(GFP_KERNEL);
622 if (!crq_q->crq_addr) {
623 dev_err(dev, "Unable to allocate memory for crq_addr\n");
627 crq_q->num_entry = CRQ_RES_BUF_SIZE / sizeof(*crq_q->crq_addr);
628 ibmvtpm->crq_dma_handle = dma_map_single(dev, crq_q->crq_addr,
632 if (dma_mapping_error(dev, ibmvtpm->crq_dma_handle)) {
633 dev_err(dev, "dma mapping failed\n");
637 rc = plpar_hcall_norets(H_REG_CRQ, vio_dev->unit_address,
638 ibmvtpm->crq_dma_handle, CRQ_RES_BUF_SIZE);
639 if (rc == H_RESOURCE)
640 rc = ibmvtpm_reset_crq(ibmvtpm);
643 dev_err(dev, "Unable to register CRQ rc=%d\n", rc);
644 goto reg_crq_cleanup;
647 rc = request_irq(vio_dev->irq, ibmvtpm_interrupt, 0,
648 tpm_ibmvtpm_driver_name, ibmvtpm);
650 dev_err(dev, "Error %d register irq 0x%x\n", rc, vio_dev->irq);
651 goto init_irq_cleanup;
654 rc = vio_enable_interrupts(vio_dev);
656 dev_err(dev, "Error %d enabling interrupts\n", rc);
657 goto init_irq_cleanup;
660 init_waitqueue_head(&ibmvtpm->wq);
664 dev_set_drvdata(&chip->dev, ibmvtpm);
666 spin_lock_init(&ibmvtpm->rtce_lock);
668 rc = ibmvtpm_crq_send_init(ibmvtpm);
670 goto init_irq_cleanup;
672 rc = ibmvtpm_crq_get_version(ibmvtpm);
674 goto init_irq_cleanup;
676 rc = ibmvtpm_crq_get_rtce_size(ibmvtpm);
678 goto init_irq_cleanup;
680 return tpm_chip_register(chip);
683 rc1 = plpar_hcall_norets(H_FREE_CRQ, vio_dev->unit_address);
684 } while (rc1 == H_BUSY || H_IS_LONG_BUSY(rc1));
686 dma_unmap_single(dev, ibmvtpm->crq_dma_handle, CRQ_RES_BUF_SIZE,
691 free_page((unsigned long)crq_q->crq_addr);
698 static struct vio_driver ibmvtpm_driver = {
699 .id_table = tpm_ibmvtpm_device_table,
700 .probe = tpm_ibmvtpm_probe,
701 .remove = tpm_ibmvtpm_remove,
702 .get_desired_dma = tpm_ibmvtpm_get_desired_dma,
703 .name = tpm_ibmvtpm_driver_name,
704 .pm = &tpm_ibmvtpm_pm_ops,
708 * ibmvtpm_module_init - Initialize ibm vtpm module.
713 * Non-zero on failure.
715 static int __init ibmvtpm_module_init(void)
717 return vio_register_driver(&ibmvtpm_driver);
721 * ibmvtpm_module_exit - Tear down ibm vtpm module.
723 static void __exit ibmvtpm_module_exit(void)
725 vio_unregister_driver(&ibmvtpm_driver);
728 module_init(ibmvtpm_module_init);
729 module_exit(ibmvtpm_module_exit);
732 MODULE_DESCRIPTION("IBM vTPM Driver");
733 MODULE_VERSION("1.0");
734 MODULE_LICENSE("GPL");