1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2012-2020 IBM Corporation
5 * Author: Ashley Lai <ashleydlai@gmail.com>
7 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
9 * Device driver for TCG/TCPA TPM (trusted platform module).
10 * Specifications at www.trustedcomputinggroup.org
13 #include <linux/dma-mapping.h>
14 #include <linux/dmapool.h>
15 #include <linux/slab.h>
18 #include <linux/types.h>
19 #include <linux/list.h>
20 #include <linux/spinlock.h>
21 #include <linux/interrupt.h>
22 #include <linux/wait.h>
26 #include "tpm_ibmvtpm.h"
28 static const char tpm_ibmvtpm_driver_name
[] = "tpm_ibmvtpm";
30 static const struct vio_device_id tpm_ibmvtpm_device_table
[] = {
31 { "IBM,vtpm", "IBM,vtpm"},
32 { "IBM,vtpm", "IBM,vtpm20"},
35 MODULE_DEVICE_TABLE(vio
, tpm_ibmvtpm_device_table
);
38 * ibmvtpm_send_crq_word() - Send a CRQ request
39 * @vdev: vio device struct
40 * @w1: pre-constructed first word of tpm crq (second word is reserved)
46 static int ibmvtpm_send_crq_word(struct vio_dev
*vdev
, u64 w1
)
48 return plpar_hcall_norets(H_SEND_CRQ
, vdev
->unit_address
, w1
, 0);
52 * ibmvtpm_send_crq() - Send a CRQ request
54 * @vdev: vio device struct
60 * The ibmvtpm crq is defined as follows:
62 * Byte | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
63 * -----------------------------------------------------------------------
64 * Word0 | Valid | Type | Length | Data
65 * -----------------------------------------------------------------------
67 * -----------------------------------------------------------------------
69 * Which matches the following structure (on bigendian host):
71 * struct ibmvtpm_crq {
77 * } __attribute__((packed, aligned(8)));
79 * However, the value is passed in a register so just compute the numeric value
80 * to load into the register avoiding byteswap altogether. Endian only affects
81 * memory loads and stores - registers are internally represented the same.
84 * 0 (H_SUCCESS) - Success
87 static int ibmvtpm_send_crq(struct vio_dev
*vdev
,
88 u8 valid
, u8 msg
, u16 len
, u32 data
)
90 u64 w1
= ((u64
)valid
<< 56) | ((u64
)msg
<< 48) | ((u64
)len
<< 32) |
92 return ibmvtpm_send_crq_word(vdev
, w1
);
96 * tpm_ibmvtpm_recv - Receive data after send
98 * @chip: tpm chip struct
99 * @buf: buffer to read
100 * @count: size of buffer
103 * Number of bytes read
105 static int tpm_ibmvtpm_recv(struct tpm_chip
*chip
, u8
*buf
, size_t count
)
107 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
111 if (!ibmvtpm
->rtce_buf
) {
112 dev_err(ibmvtpm
->dev
, "ibmvtpm device is not ready\n");
116 sig
= wait_event_interruptible(ibmvtpm
->wq
, !ibmvtpm
->tpm_processing_cmd
);
120 len
= ibmvtpm
->res_len
;
123 dev_err(ibmvtpm
->dev
,
124 "Invalid size in recv: count=%zd, crq_size=%d\n",
129 spin_lock(&ibmvtpm
->rtce_lock
);
130 memcpy((void *)buf
, (void *)ibmvtpm
->rtce_buf
, len
);
131 memset(ibmvtpm
->rtce_buf
, 0, len
);
132 ibmvtpm
->res_len
= 0;
133 spin_unlock(&ibmvtpm
->rtce_lock
);
138 * ibmvtpm_crq_send_init - Send a CRQ initialize message
139 * @ibmvtpm: vtpm device struct
143 * Non-zero on failure.
145 static int ibmvtpm_crq_send_init(struct ibmvtpm_dev
*ibmvtpm
)
149 rc
= ibmvtpm_send_crq_word(ibmvtpm
->vdev
, INIT_CRQ_CMD
);
151 dev_err(ibmvtpm
->dev
,
152 "%s failed rc=%d\n", __func__
, rc
);
158 * tpm_ibmvtpm_resume - Resume from suspend
160 * @dev: device struct
164 static int tpm_ibmvtpm_resume(struct device
*dev
)
166 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
167 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
173 rc
= plpar_hcall_norets(H_ENABLE_CRQ
,
174 ibmvtpm
->vdev
->unit_address
);
175 } while (rc
== H_IN_PROGRESS
|| rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
178 dev_err(dev
, "Error enabling ibmvtpm rc=%d\n", rc
);
182 rc
= vio_enable_interrupts(ibmvtpm
->vdev
);
184 dev_err(dev
, "Error vio_enable_interrupts rc=%d\n", rc
);
188 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
190 dev_err(dev
, "Error send_init rc=%d\n", rc
);
196 * tpm_ibmvtpm_send() - Send a TPM command
197 * @chip: tpm chip struct
198 * @buf: buffer contains data to send
199 * @count: size of buffer
205 static int tpm_ibmvtpm_send(struct tpm_chip
*chip
, u8
*buf
, size_t count
)
207 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
211 if (!ibmvtpm
->rtce_buf
) {
212 dev_err(ibmvtpm
->dev
, "ibmvtpm device is not ready\n");
216 if (count
> ibmvtpm
->rtce_size
) {
217 dev_err(ibmvtpm
->dev
,
218 "Invalid size in send: count=%zd, rtce_size=%d\n",
219 count
, ibmvtpm
->rtce_size
);
223 if (ibmvtpm
->tpm_processing_cmd
) {
224 dev_info(ibmvtpm
->dev
,
225 "Need to wait for TPM to finish\n");
226 /* wait for previous command to finish */
227 sig
= wait_event_interruptible(ibmvtpm
->wq
, !ibmvtpm
->tpm_processing_cmd
);
232 spin_lock(&ibmvtpm
->rtce_lock
);
233 ibmvtpm
->res_len
= 0;
234 memcpy((void *)ibmvtpm
->rtce_buf
, (void *)buf
, count
);
237 * set the processing flag before the Hcall, since we may get the
238 * result (interrupt) before even being able to check rc.
240 ibmvtpm
->tpm_processing_cmd
= true;
243 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
244 IBMVTPM_VALID_CMD
, VTPM_TPM_COMMAND
,
245 count
, ibmvtpm
->rtce_dma_handle
);
246 if (rc
!= H_SUCCESS
) {
248 * H_CLOSED can be returned after LPM resume. Call
249 * tpm_ibmvtpm_resume() to re-enable the CRQ then retry
250 * ibmvtpm_send_crq() once before failing.
252 if (rc
== H_CLOSED
&& retry
) {
253 tpm_ibmvtpm_resume(ibmvtpm
->dev
);
257 dev_err(ibmvtpm
->dev
, "tpm_ibmvtpm_send failed rc=%d\n", rc
);
258 ibmvtpm
->tpm_processing_cmd
= false;
261 spin_unlock(&ibmvtpm
->rtce_lock
);
265 static void tpm_ibmvtpm_cancel(struct tpm_chip
*chip
)
270 static u8
tpm_ibmvtpm_status(struct tpm_chip
*chip
)
276 * ibmvtpm_crq_get_rtce_size - Send a CRQ request to get rtce size
278 * @ibmvtpm: vtpm device struct
282 * Non-zero on failure.
284 static int ibmvtpm_crq_get_rtce_size(struct ibmvtpm_dev
*ibmvtpm
)
288 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
289 IBMVTPM_VALID_CMD
, VTPM_GET_RTCE_BUFFER_SIZE
, 0, 0);
291 dev_err(ibmvtpm
->dev
,
292 "ibmvtpm_crq_get_rtce_size failed rc=%d\n", rc
);
298 * ibmvtpm_crq_get_version - Send a CRQ request to get vtpm version
299 * - Note that this is vtpm version and not tpm version
301 * @ibmvtpm: vtpm device struct
305 * Non-zero on failure.
307 static int ibmvtpm_crq_get_version(struct ibmvtpm_dev
*ibmvtpm
)
311 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
312 IBMVTPM_VALID_CMD
, VTPM_GET_VERSION
, 0, 0);
314 dev_err(ibmvtpm
->dev
,
315 "ibmvtpm_crq_get_version failed rc=%d\n", rc
);
321 * ibmvtpm_crq_send_init_complete - Send a CRQ initialize complete message
322 * @ibmvtpm: vtpm device struct
326 * Non-zero on failure.
328 static int ibmvtpm_crq_send_init_complete(struct ibmvtpm_dev
*ibmvtpm
)
332 rc
= ibmvtpm_send_crq_word(ibmvtpm
->vdev
, INIT_CRQ_COMP_CMD
);
334 dev_err(ibmvtpm
->dev
,
335 "ibmvtpm_crq_send_init_complete failed rc=%d\n", rc
);
341 * tpm_ibmvtpm_remove - ibm vtpm remove entry point
342 * @vdev: vio device struct
346 static int tpm_ibmvtpm_remove(struct vio_dev
*vdev
)
348 struct tpm_chip
*chip
= dev_get_drvdata(&vdev
->dev
);
349 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
352 tpm_chip_unregister(chip
);
354 free_irq(vdev
->irq
, ibmvtpm
);
359 rc
= plpar_hcall_norets(H_FREE_CRQ
, vdev
->unit_address
);
360 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
362 dma_unmap_single(ibmvtpm
->dev
, ibmvtpm
->crq_dma_handle
,
363 CRQ_RES_BUF_SIZE
, DMA_BIDIRECTIONAL
);
364 free_page((unsigned long)ibmvtpm
->crq_queue
.crq_addr
);
366 if (ibmvtpm
->rtce_buf
) {
367 dma_unmap_single(ibmvtpm
->dev
, ibmvtpm
->rtce_dma_handle
,
368 ibmvtpm
->rtce_size
, DMA_BIDIRECTIONAL
);
369 kfree(ibmvtpm
->rtce_buf
);
373 /* For tpm_ibmvtpm_get_desired_dma */
374 dev_set_drvdata(&vdev
->dev
, NULL
);
380 * tpm_ibmvtpm_get_desired_dma - Get DMA size needed by this driver
381 * @vdev: vio device struct
384 * Number of bytes the driver needs to DMA map.
386 static unsigned long tpm_ibmvtpm_get_desired_dma(struct vio_dev
*vdev
)
388 struct tpm_chip
*chip
= dev_get_drvdata(&vdev
->dev
);
389 struct ibmvtpm_dev
*ibmvtpm
;
392 * ibmvtpm initializes at probe time, so the data we are
393 * asking for may not be set yet. Estimate that 4K required
394 * for TCE-mapped buffer in addition to CRQ.
397 ibmvtpm
= dev_get_drvdata(&chip
->dev
);
399 return CRQ_RES_BUF_SIZE
+ PAGE_SIZE
;
401 return CRQ_RES_BUF_SIZE
+ ibmvtpm
->rtce_size
;
405 * tpm_ibmvtpm_suspend - Suspend
406 * @dev: device struct
410 static int tpm_ibmvtpm_suspend(struct device
*dev
)
412 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
413 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
416 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
417 IBMVTPM_VALID_CMD
, VTPM_PREPARE_TO_SUSPEND
, 0, 0);
419 dev_err(ibmvtpm
->dev
,
420 "tpm_ibmvtpm_suspend failed rc=%d\n", rc
);
426 * ibmvtpm_reset_crq - Reset CRQ
428 * @ibmvtpm: ibm vtpm struct
432 * Non-zero on failure.
434 static int ibmvtpm_reset_crq(struct ibmvtpm_dev
*ibmvtpm
)
441 rc
= plpar_hcall_norets(H_FREE_CRQ
,
442 ibmvtpm
->vdev
->unit_address
);
443 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
445 memset(ibmvtpm
->crq_queue
.crq_addr
, 0, CRQ_RES_BUF_SIZE
);
446 ibmvtpm
->crq_queue
.index
= 0;
448 return plpar_hcall_norets(H_REG_CRQ
, ibmvtpm
->vdev
->unit_address
,
449 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
452 static bool tpm_ibmvtpm_req_canceled(struct tpm_chip
*chip
, u8 status
)
454 return (status
== 0);
457 static const struct tpm_class_ops tpm_ibmvtpm
= {
458 .recv
= tpm_ibmvtpm_recv
,
459 .send
= tpm_ibmvtpm_send
,
460 .cancel
= tpm_ibmvtpm_cancel
,
461 .status
= tpm_ibmvtpm_status
,
462 .req_complete_mask
= 0,
463 .req_complete_val
= 0,
464 .req_canceled
= tpm_ibmvtpm_req_canceled
,
467 static const struct dev_pm_ops tpm_ibmvtpm_pm_ops
= {
468 .suspend
= tpm_ibmvtpm_suspend
,
469 .resume
= tpm_ibmvtpm_resume
,
473 * ibmvtpm_crq_get_next - Get next responded crq
475 * @ibmvtpm: vtpm device struct
477 * Return: vtpm crq pointer or NULL.
479 static struct ibmvtpm_crq
*ibmvtpm_crq_get_next(struct ibmvtpm_dev
*ibmvtpm
)
481 struct ibmvtpm_crq_queue
*crq_q
= &ibmvtpm
->crq_queue
;
482 struct ibmvtpm_crq
*crq
= &crq_q
->crq_addr
[crq_q
->index
];
484 if (crq
->valid
& VTPM_MSG_RES
) {
485 if (++crq_q
->index
== crq_q
->num_entry
)
494 * ibmvtpm_crq_process - Process responded crq
496 * @crq: crq to be processed
497 * @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
);
522 case IBMVTPM_VALID_CMD
:
524 case VTPM_GET_RTCE_BUFFER_SIZE_RES
:
525 if (be16_to_cpu(crq
->len
) <= 0) {
526 dev_err(ibmvtpm
->dev
, "Invalid rtce size\n");
529 ibmvtpm
->rtce_size
= be16_to_cpu(crq
->len
);
530 ibmvtpm
->rtce_buf
= kmalloc(ibmvtpm
->rtce_size
,
532 if (!ibmvtpm
->rtce_buf
) {
533 dev_err(ibmvtpm
->dev
, "Failed to allocate memory for rtce buffer\n");
537 ibmvtpm
->rtce_dma_handle
= dma_map_single(ibmvtpm
->dev
,
538 ibmvtpm
->rtce_buf
, ibmvtpm
->rtce_size
,
541 if (dma_mapping_error(ibmvtpm
->dev
,
542 ibmvtpm
->rtce_dma_handle
)) {
543 kfree(ibmvtpm
->rtce_buf
);
544 ibmvtpm
->rtce_buf
= NULL
;
545 dev_err(ibmvtpm
->dev
, "Failed to dma map rtce buffer\n");
549 case VTPM_GET_VERSION_RES
:
550 ibmvtpm
->vtpm_version
= be32_to_cpu(crq
->data
);
552 case VTPM_TPM_COMMAND_RES
:
553 /* len of the data in rtce buffer */
554 ibmvtpm
->res_len
= be16_to_cpu(crq
->len
);
555 ibmvtpm
->tpm_processing_cmd
= false;
556 wake_up_interruptible(&ibmvtpm
->wq
);
566 * ibmvtpm_interrupt - Interrupt handler
568 * @irq: irq number to handle
569 * @vtpm_instance: vtpm that received interrupt
574 static irqreturn_t
ibmvtpm_interrupt(int irq
, void *vtpm_instance
)
576 struct ibmvtpm_dev
*ibmvtpm
= (struct ibmvtpm_dev
*) vtpm_instance
;
577 struct ibmvtpm_crq
*crq
;
579 /* while loop is needed for initial setup (get version and
580 * get rtce_size). There should be only one tpm request at any
583 while ((crq
= ibmvtpm_crq_get_next(ibmvtpm
)) != NULL
) {
584 ibmvtpm_crq_process(crq
, ibmvtpm
);
585 wake_up_interruptible(&ibmvtpm
->crq_queue
.wq
);
594 * tpm_ibmvtpm_probe - ibm vtpm initialize entry point
596 * @vio_dev: vio device struct
597 * @id: vio device id struct
601 * Non-zero on failure.
603 static int tpm_ibmvtpm_probe(struct vio_dev
*vio_dev
,
604 const struct vio_device_id
*id
)
606 struct ibmvtpm_dev
*ibmvtpm
;
607 struct device
*dev
= &vio_dev
->dev
;
608 struct ibmvtpm_crq_queue
*crq_q
;
609 struct tpm_chip
*chip
;
610 int rc
= -ENOMEM
, rc1
;
612 chip
= tpmm_chip_alloc(dev
, &tpm_ibmvtpm
);
614 return PTR_ERR(chip
);
616 ibmvtpm
= kzalloc(sizeof(struct ibmvtpm_dev
), GFP_KERNEL
);
618 dev_err(dev
, "kzalloc for ibmvtpm failed\n");
623 ibmvtpm
->vdev
= vio_dev
;
625 crq_q
= &ibmvtpm
->crq_queue
;
626 crq_q
->crq_addr
= (struct ibmvtpm_crq
*)get_zeroed_page(GFP_KERNEL
);
627 if (!crq_q
->crq_addr
) {
628 dev_err(dev
, "Unable to allocate memory for crq_addr\n");
632 crq_q
->num_entry
= CRQ_RES_BUF_SIZE
/ sizeof(*crq_q
->crq_addr
);
633 init_waitqueue_head(&crq_q
->wq
);
634 ibmvtpm
->crq_dma_handle
= dma_map_single(dev
, crq_q
->crq_addr
,
638 if (dma_mapping_error(dev
, ibmvtpm
->crq_dma_handle
)) {
639 dev_err(dev
, "dma mapping failed\n");
643 rc
= plpar_hcall_norets(H_REG_CRQ
, vio_dev
->unit_address
,
644 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
645 if (rc
== H_RESOURCE
)
646 rc
= ibmvtpm_reset_crq(ibmvtpm
);
649 dev_err(dev
, "Unable to register CRQ rc=%d\n", rc
);
650 goto reg_crq_cleanup
;
653 rc
= request_irq(vio_dev
->irq
, ibmvtpm_interrupt
, 0,
654 tpm_ibmvtpm_driver_name
, ibmvtpm
);
656 dev_err(dev
, "Error %d register irq 0x%x\n", rc
, vio_dev
->irq
);
657 goto init_irq_cleanup
;
660 rc
= vio_enable_interrupts(vio_dev
);
662 dev_err(dev
, "Error %d enabling interrupts\n", rc
);
663 goto init_irq_cleanup
;
666 init_waitqueue_head(&ibmvtpm
->wq
);
670 dev_set_drvdata(&chip
->dev
, ibmvtpm
);
672 spin_lock_init(&ibmvtpm
->rtce_lock
);
674 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
676 goto init_irq_cleanup
;
678 rc
= ibmvtpm_crq_get_version(ibmvtpm
);
680 goto init_irq_cleanup
;
682 rc
= ibmvtpm_crq_get_rtce_size(ibmvtpm
);
684 goto init_irq_cleanup
;
686 if (!wait_event_timeout(ibmvtpm
->crq_queue
.wq
,
687 ibmvtpm
->rtce_buf
!= NULL
,
689 dev_err(dev
, "CRQ response timed out\n");
690 goto init_irq_cleanup
;
693 if (!strcmp(id
->compat
, "IBM,vtpm20")) {
694 chip
->flags
|= TPM_CHIP_FLAG_TPM2
;
695 rc
= tpm2_get_cc_attrs_tbl(chip
);
697 goto init_irq_cleanup
;
700 return tpm_chip_register(chip
);
703 rc1
= plpar_hcall_norets(H_FREE_CRQ
, vio_dev
->unit_address
);
704 } while (rc1
== H_BUSY
|| H_IS_LONG_BUSY(rc1
));
706 dma_unmap_single(dev
, ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
,
711 free_page((unsigned long)crq_q
->crq_addr
);
718 static struct vio_driver ibmvtpm_driver
= {
719 .id_table
= tpm_ibmvtpm_device_table
,
720 .probe
= tpm_ibmvtpm_probe
,
721 .remove
= tpm_ibmvtpm_remove
,
722 .get_desired_dma
= tpm_ibmvtpm_get_desired_dma
,
723 .name
= tpm_ibmvtpm_driver_name
,
724 .pm
= &tpm_ibmvtpm_pm_ops
,
728 * ibmvtpm_module_init - Initialize ibm vtpm module.
733 * Non-zero on failure.
735 static int __init
ibmvtpm_module_init(void)
737 return vio_register_driver(&ibmvtpm_driver
);
741 * ibmvtpm_module_exit - Tear down ibm vtpm module.
743 static void __exit
ibmvtpm_module_exit(void)
745 vio_unregister_driver(&ibmvtpm_driver
);
748 module_init(ibmvtpm_module_init
);
749 module_exit(ibmvtpm_module_exit
);
751 MODULE_AUTHOR("adlai@us.ibm.com");
752 MODULE_DESCRIPTION("IBM vTPM Driver");
753 MODULE_VERSION("1.0");
754 MODULE_LICENSE("GPL");