2 * Copyright (C) 2012-2020 IBM Corporation
4 * Author: Ashley Lai <ashleydlai@gmail.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 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 * ibmvtpm_crq_send_init - Send a CRQ initialize message
145 * @ibmvtpm: vtpm device struct
149 * Non-zero on failure.
151 static int ibmvtpm_crq_send_init(struct ibmvtpm_dev
*ibmvtpm
)
155 rc
= ibmvtpm_send_crq_word(ibmvtpm
->vdev
, INIT_CRQ_CMD
);
157 dev_err(ibmvtpm
->dev
,
158 "%s failed rc=%d\n", __func__
, rc
);
164 * tpm_ibmvtpm_resume - Resume from suspend
166 * @dev: device struct
170 static int tpm_ibmvtpm_resume(struct device
*dev
)
172 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
173 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
179 rc
= plpar_hcall_norets(H_ENABLE_CRQ
,
180 ibmvtpm
->vdev
->unit_address
);
181 } while (rc
== H_IN_PROGRESS
|| rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
184 dev_err(dev
, "Error enabling ibmvtpm rc=%d\n", rc
);
188 rc
= vio_enable_interrupts(ibmvtpm
->vdev
);
190 dev_err(dev
, "Error vio_enable_interrupts rc=%d\n", rc
);
194 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
196 dev_err(dev
, "Error send_init rc=%d\n", rc
);
202 * tpm_ibmvtpm_send() - Send a TPM command
203 * @chip: tpm chip struct
204 * @buf: buffer contains data to send
205 * @count: size of buffer
211 static int tpm_ibmvtpm_send(struct tpm_chip
*chip
, u8
*buf
, size_t count
)
213 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
217 if (!ibmvtpm
->rtce_buf
) {
218 dev_err(ibmvtpm
->dev
, "ibmvtpm device is not ready\n");
222 if (count
> ibmvtpm
->rtce_size
) {
223 dev_err(ibmvtpm
->dev
,
224 "Invalid size in send: count=%zd, rtce_size=%d\n",
225 count
, ibmvtpm
->rtce_size
);
229 if (ibmvtpm
->tpm_processing_cmd
) {
230 dev_info(ibmvtpm
->dev
,
231 "Need to wait for TPM to finish\n");
232 /* wait for previous command to finish */
233 sig
= wait_event_interruptible(ibmvtpm
->wq
, !ibmvtpm
->tpm_processing_cmd
);
238 spin_lock(&ibmvtpm
->rtce_lock
);
239 ibmvtpm
->res_len
= 0;
240 memcpy((void *)ibmvtpm
->rtce_buf
, (void *)buf
, count
);
243 * set the processing flag before the Hcall, since we may get the
244 * result (interrupt) before even being able to check rc.
246 ibmvtpm
->tpm_processing_cmd
= true;
249 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
250 IBMVTPM_VALID_CMD
, VTPM_TPM_COMMAND
,
251 count
, ibmvtpm
->rtce_dma_handle
);
252 if (rc
!= H_SUCCESS
) {
254 * H_CLOSED can be returned after LPM resume. Call
255 * tpm_ibmvtpm_resume() to re-enable the CRQ then retry
256 * ibmvtpm_send_crq() once before failing.
258 if (rc
== H_CLOSED
&& retry
) {
259 tpm_ibmvtpm_resume(ibmvtpm
->dev
);
263 dev_err(ibmvtpm
->dev
, "tpm_ibmvtpm_send failed rc=%d\n", rc
);
264 ibmvtpm
->tpm_processing_cmd
= false;
267 spin_unlock(&ibmvtpm
->rtce_lock
);
271 static void tpm_ibmvtpm_cancel(struct tpm_chip
*chip
)
276 static u8
tpm_ibmvtpm_status(struct tpm_chip
*chip
)
282 * ibmvtpm_crq_get_rtce_size - Send a CRQ request to get rtce size
284 * @ibmvtpm: vtpm device struct
288 * Non-zero on failure.
290 static int ibmvtpm_crq_get_rtce_size(struct ibmvtpm_dev
*ibmvtpm
)
294 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
295 IBMVTPM_VALID_CMD
, VTPM_GET_RTCE_BUFFER_SIZE
, 0, 0);
297 dev_err(ibmvtpm
->dev
,
298 "ibmvtpm_crq_get_rtce_size failed rc=%d\n", rc
);
304 * ibmvtpm_crq_get_version - Send a CRQ request to get vtpm version
305 * - Note that this is vtpm version and not tpm version
307 * @ibmvtpm: vtpm device struct
311 * Non-zero on failure.
313 static int ibmvtpm_crq_get_version(struct ibmvtpm_dev
*ibmvtpm
)
317 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
318 IBMVTPM_VALID_CMD
, VTPM_GET_VERSION
, 0, 0);
320 dev_err(ibmvtpm
->dev
,
321 "ibmvtpm_crq_get_version failed rc=%d\n", rc
);
327 * ibmvtpm_crq_send_init_complete - Send a CRQ initialize complete message
328 * @ibmvtpm: vtpm device struct
332 * Non-zero on failure.
334 static int ibmvtpm_crq_send_init_complete(struct ibmvtpm_dev
*ibmvtpm
)
338 rc
= ibmvtpm_send_crq_word(ibmvtpm
->vdev
, INIT_CRQ_COMP_CMD
);
340 dev_err(ibmvtpm
->dev
,
341 "ibmvtpm_crq_send_init_complete failed rc=%d\n", rc
);
347 * tpm_ibmvtpm_remove - ibm vtpm remove entry point
348 * @vdev: vio device struct
352 static int tpm_ibmvtpm_remove(struct vio_dev
*vdev
)
354 struct tpm_chip
*chip
= dev_get_drvdata(&vdev
->dev
);
355 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
358 tpm_chip_unregister(chip
);
360 free_irq(vdev
->irq
, ibmvtpm
);
365 rc
= plpar_hcall_norets(H_FREE_CRQ
, vdev
->unit_address
);
366 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
368 dma_unmap_single(ibmvtpm
->dev
, ibmvtpm
->crq_dma_handle
,
369 CRQ_RES_BUF_SIZE
, DMA_BIDIRECTIONAL
);
370 free_page((unsigned long)ibmvtpm
->crq_queue
.crq_addr
);
372 if (ibmvtpm
->rtce_buf
) {
373 dma_unmap_single(ibmvtpm
->dev
, ibmvtpm
->rtce_dma_handle
,
374 ibmvtpm
->rtce_size
, DMA_BIDIRECTIONAL
);
375 kfree(ibmvtpm
->rtce_buf
);
379 /* For tpm_ibmvtpm_get_desired_dma */
380 dev_set_drvdata(&vdev
->dev
, NULL
);
386 * tpm_ibmvtpm_get_desired_dma - Get DMA size needed by this driver
387 * @vdev: vio device struct
390 * Number of bytes the driver needs to DMA map.
392 static unsigned long tpm_ibmvtpm_get_desired_dma(struct vio_dev
*vdev
)
394 struct tpm_chip
*chip
= dev_get_drvdata(&vdev
->dev
);
395 struct ibmvtpm_dev
*ibmvtpm
;
398 * ibmvtpm initializes at probe time, so the data we are
399 * asking for may not be set yet. Estimate that 4K required
400 * for TCE-mapped buffer in addition to CRQ.
403 ibmvtpm
= dev_get_drvdata(&chip
->dev
);
405 return CRQ_RES_BUF_SIZE
+ PAGE_SIZE
;
407 return CRQ_RES_BUF_SIZE
+ ibmvtpm
->rtce_size
;
411 * tpm_ibmvtpm_suspend - Suspend
412 * @dev: device struct
416 static int tpm_ibmvtpm_suspend(struct device
*dev
)
418 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
419 struct ibmvtpm_dev
*ibmvtpm
= dev_get_drvdata(&chip
->dev
);
422 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
,
423 IBMVTPM_VALID_CMD
, VTPM_PREPARE_TO_SUSPEND
, 0, 0);
425 dev_err(ibmvtpm
->dev
,
426 "tpm_ibmvtpm_suspend failed rc=%d\n", rc
);
432 * ibmvtpm_reset_crq - Reset CRQ
434 * @ibmvtpm: ibm vtpm struct
438 * Non-zero on failure.
440 static int ibmvtpm_reset_crq(struct ibmvtpm_dev
*ibmvtpm
)
447 rc
= plpar_hcall_norets(H_FREE_CRQ
,
448 ibmvtpm
->vdev
->unit_address
);
449 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
451 memset(ibmvtpm
->crq_queue
.crq_addr
, 0, CRQ_RES_BUF_SIZE
);
452 ibmvtpm
->crq_queue
.index
= 0;
454 return plpar_hcall_norets(H_REG_CRQ
, ibmvtpm
->vdev
->unit_address
,
455 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
458 static bool tpm_ibmvtpm_req_canceled(struct tpm_chip
*chip
, u8 status
)
460 return (status
== 0);
463 static const struct tpm_class_ops tpm_ibmvtpm
= {
464 .recv
= tpm_ibmvtpm_recv
,
465 .send
= tpm_ibmvtpm_send
,
466 .cancel
= tpm_ibmvtpm_cancel
,
467 .status
= tpm_ibmvtpm_status
,
468 .req_complete_mask
= 0,
469 .req_complete_val
= 0,
470 .req_canceled
= tpm_ibmvtpm_req_canceled
,
473 static const struct dev_pm_ops tpm_ibmvtpm_pm_ops
= {
474 .suspend
= tpm_ibmvtpm_suspend
,
475 .resume
= tpm_ibmvtpm_resume
,
479 * ibmvtpm_crq_get_next - Get next responded crq
481 * @ibmvtpm: vtpm device struct
483 * Return: vtpm crq pointer or NULL.
485 static struct ibmvtpm_crq
*ibmvtpm_crq_get_next(struct ibmvtpm_dev
*ibmvtpm
)
487 struct ibmvtpm_crq_queue
*crq_q
= &ibmvtpm
->crq_queue
;
488 struct ibmvtpm_crq
*crq
= &crq_q
->crq_addr
[crq_q
->index
];
490 if (crq
->valid
& VTPM_MSG_RES
) {
491 if (++crq_q
->index
== crq_q
->num_entry
)
500 * ibmvtpm_crq_process - Process responded crq
502 * @crq: crq to be processed
503 * @ibmvtpm: vtpm device struct
506 static void ibmvtpm_crq_process(struct ibmvtpm_crq
*crq
,
507 struct ibmvtpm_dev
*ibmvtpm
)
511 switch (crq
->valid
) {
515 dev_info(ibmvtpm
->dev
, "CRQ initialized\n");
516 rc
= ibmvtpm_crq_send_init_complete(ibmvtpm
);
518 dev_err(ibmvtpm
->dev
, "Unable to send CRQ init complete rc=%d\n", rc
);
520 case INIT_CRQ_COMP_RES
:
521 dev_info(ibmvtpm
->dev
,
522 "CRQ initialization completed\n");
525 dev_err(ibmvtpm
->dev
, "Unknown crq message type: %d\n", crq
->msg
);
528 case IBMVTPM_VALID_CMD
:
530 case VTPM_GET_RTCE_BUFFER_SIZE_RES
:
531 if (be16_to_cpu(crq
->len
) <= 0) {
532 dev_err(ibmvtpm
->dev
, "Invalid rtce size\n");
535 ibmvtpm
->rtce_size
= be16_to_cpu(crq
->len
);
536 ibmvtpm
->rtce_buf
= kmalloc(ibmvtpm
->rtce_size
,
538 if (!ibmvtpm
->rtce_buf
) {
539 dev_err(ibmvtpm
->dev
, "Failed to allocate memory for rtce buffer\n");
543 ibmvtpm
->rtce_dma_handle
= dma_map_single(ibmvtpm
->dev
,
544 ibmvtpm
->rtce_buf
, ibmvtpm
->rtce_size
,
547 if (dma_mapping_error(ibmvtpm
->dev
,
548 ibmvtpm
->rtce_dma_handle
)) {
549 kfree(ibmvtpm
->rtce_buf
);
550 ibmvtpm
->rtce_buf
= NULL
;
551 dev_err(ibmvtpm
->dev
, "Failed to dma map rtce buffer\n");
555 case VTPM_GET_VERSION_RES
:
556 ibmvtpm
->vtpm_version
= be32_to_cpu(crq
->data
);
558 case VTPM_TPM_COMMAND_RES
:
559 /* len of the data in rtce buffer */
560 ibmvtpm
->res_len
= be16_to_cpu(crq
->len
);
561 ibmvtpm
->tpm_processing_cmd
= false;
562 wake_up_interruptible(&ibmvtpm
->wq
);
572 * ibmvtpm_interrupt - Interrupt handler
574 * @irq: irq number to handle
575 * @vtpm_instance: vtpm that received interrupt
580 static irqreturn_t
ibmvtpm_interrupt(int irq
, void *vtpm_instance
)
582 struct ibmvtpm_dev
*ibmvtpm
= (struct ibmvtpm_dev
*) vtpm_instance
;
583 struct ibmvtpm_crq
*crq
;
585 /* while loop is needed for initial setup (get version and
586 * get rtce_size). There should be only one tpm request at any
589 while ((crq
= ibmvtpm_crq_get_next(ibmvtpm
)) != NULL
) {
590 ibmvtpm_crq_process(crq
, ibmvtpm
);
599 * tpm_ibmvtpm_probe - ibm vtpm initialize entry point
601 * @vio_dev: vio device struct
602 * @id: vio device id struct
606 * Non-zero on failure.
608 static int tpm_ibmvtpm_probe(struct vio_dev
*vio_dev
,
609 const struct vio_device_id
*id
)
611 struct ibmvtpm_dev
*ibmvtpm
;
612 struct device
*dev
= &vio_dev
->dev
;
613 struct ibmvtpm_crq_queue
*crq_q
;
614 struct tpm_chip
*chip
;
615 int rc
= -ENOMEM
, rc1
;
617 chip
= tpmm_chip_alloc(dev
, &tpm_ibmvtpm
);
619 return PTR_ERR(chip
);
621 ibmvtpm
= kzalloc(sizeof(struct ibmvtpm_dev
), GFP_KERNEL
);
623 dev_err(dev
, "kzalloc for ibmvtpm failed\n");
628 ibmvtpm
->vdev
= vio_dev
;
630 crq_q
= &ibmvtpm
->crq_queue
;
631 crq_q
->crq_addr
= (struct ibmvtpm_crq
*)get_zeroed_page(GFP_KERNEL
);
632 if (!crq_q
->crq_addr
) {
633 dev_err(dev
, "Unable to allocate memory for crq_addr\n");
637 crq_q
->num_entry
= CRQ_RES_BUF_SIZE
/ sizeof(*crq_q
->crq_addr
);
638 ibmvtpm
->crq_dma_handle
= dma_map_single(dev
, crq_q
->crq_addr
,
642 if (dma_mapping_error(dev
, ibmvtpm
->crq_dma_handle
)) {
643 dev_err(dev
, "dma mapping failed\n");
647 rc
= plpar_hcall_norets(H_REG_CRQ
, vio_dev
->unit_address
,
648 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
649 if (rc
== H_RESOURCE
)
650 rc
= ibmvtpm_reset_crq(ibmvtpm
);
653 dev_err(dev
, "Unable to register CRQ rc=%d\n", rc
);
654 goto reg_crq_cleanup
;
657 rc
= request_irq(vio_dev
->irq
, ibmvtpm_interrupt
, 0,
658 tpm_ibmvtpm_driver_name
, ibmvtpm
);
660 dev_err(dev
, "Error %d register irq 0x%x\n", rc
, vio_dev
->irq
);
661 goto init_irq_cleanup
;
664 rc
= vio_enable_interrupts(vio_dev
);
666 dev_err(dev
, "Error %d enabling interrupts\n", rc
);
667 goto init_irq_cleanup
;
670 init_waitqueue_head(&ibmvtpm
->wq
);
674 dev_set_drvdata(&chip
->dev
, ibmvtpm
);
676 spin_lock_init(&ibmvtpm
->rtce_lock
);
678 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
680 goto init_irq_cleanup
;
682 rc
= ibmvtpm_crq_get_version(ibmvtpm
);
684 goto init_irq_cleanup
;
686 rc
= ibmvtpm_crq_get_rtce_size(ibmvtpm
);
688 goto init_irq_cleanup
;
690 return tpm_chip_register(chip
);
693 rc1
= plpar_hcall_norets(H_FREE_CRQ
, vio_dev
->unit_address
);
694 } while (rc1
== H_BUSY
|| H_IS_LONG_BUSY(rc1
));
696 dma_unmap_single(dev
, ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
,
701 free_page((unsigned long)crq_q
->crq_addr
);
708 static struct vio_driver ibmvtpm_driver
= {
709 .id_table
= tpm_ibmvtpm_device_table
,
710 .probe
= tpm_ibmvtpm_probe
,
711 .remove
= tpm_ibmvtpm_remove
,
712 .get_desired_dma
= tpm_ibmvtpm_get_desired_dma
,
713 .name
= tpm_ibmvtpm_driver_name
,
714 .pm
= &tpm_ibmvtpm_pm_ops
,
718 * ibmvtpm_module_init - Initialize ibm vtpm module.
723 * Non-zero on failure.
725 static int __init
ibmvtpm_module_init(void)
727 return vio_register_driver(&ibmvtpm_driver
);
731 * ibmvtpm_module_exit - Tear down ibm vtpm module.
733 static void __exit
ibmvtpm_module_exit(void)
735 vio_unregister_driver(&ibmvtpm_driver
);
738 module_init(ibmvtpm_module_init
);
739 module_exit(ibmvtpm_module_exit
);
741 MODULE_AUTHOR("adlai@us.ibm.com");
742 MODULE_DESCRIPTION("IBM vTPM Driver");
743 MODULE_VERSION("1.0");
744 MODULE_LICENSE("GPL");