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=%zd, 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=%zd, 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
);
310 return CRQ_RES_BUF_SIZE
+ ibmvtpm
->rtce_size
;
314 * tpm_ibmvtpm_suspend - Suspend
315 * @dev: device struct
320 static int tpm_ibmvtpm_suspend(struct device
*dev
)
322 struct ibmvtpm_dev
*ibmvtpm
= ibmvtpm_get_data(dev
);
323 struct ibmvtpm_crq crq
;
324 u64
*buf
= (u64
*) &crq
;
327 crq
.valid
= (u8
)IBMVTPM_VALID_CMD
;
328 crq
.msg
= (u8
)VTPM_PREPARE_TO_SUSPEND
;
330 rc
= ibmvtpm_send_crq(ibmvtpm
->vdev
, buf
[0], buf
[1]);
332 dev_err(ibmvtpm
->dev
,
333 "tpm_ibmvtpm_suspend failed rc=%d\n", rc
);
339 * ibmvtpm_reset_crq - Reset CRQ
340 * @ibmvtpm: ibm vtpm struct
346 static int ibmvtpm_reset_crq(struct ibmvtpm_dev
*ibmvtpm
)
353 rc
= plpar_hcall_norets(H_FREE_CRQ
,
354 ibmvtpm
->vdev
->unit_address
);
355 } while (rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
357 memset(ibmvtpm
->crq_queue
.crq_addr
, 0, CRQ_RES_BUF_SIZE
);
358 ibmvtpm
->crq_queue
.index
= 0;
360 return plpar_hcall_norets(H_REG_CRQ
, ibmvtpm
->vdev
->unit_address
,
361 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
365 * tpm_ibmvtpm_resume - Resume from suspend
366 * @dev: device struct
371 static int tpm_ibmvtpm_resume(struct device
*dev
)
373 struct ibmvtpm_dev
*ibmvtpm
= ibmvtpm_get_data(dev
);
379 rc
= plpar_hcall_norets(H_ENABLE_CRQ
,
380 ibmvtpm
->vdev
->unit_address
);
381 } while (rc
== H_IN_PROGRESS
|| rc
== H_BUSY
|| H_IS_LONG_BUSY(rc
));
384 dev_err(dev
, "Error enabling ibmvtpm rc=%d\n", rc
);
388 rc
= vio_enable_interrupts(ibmvtpm
->vdev
);
390 dev_err(dev
, "Error vio_enable_interrupts rc=%d\n", rc
);
394 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
396 dev_err(dev
, "Error send_init rc=%d\n", rc
);
401 static bool tpm_ibmvtpm_req_canceled(struct tpm_chip
*chip
, u8 status
)
403 return (status
== 0);
406 static const struct tpm_class_ops tpm_ibmvtpm
= {
407 .recv
= tpm_ibmvtpm_recv
,
408 .send
= tpm_ibmvtpm_send
,
409 .cancel
= tpm_ibmvtpm_cancel
,
410 .status
= tpm_ibmvtpm_status
,
411 .req_complete_mask
= 0,
412 .req_complete_val
= 0,
413 .req_canceled
= tpm_ibmvtpm_req_canceled
,
416 static const struct dev_pm_ops tpm_ibmvtpm_pm_ops
= {
417 .suspend
= tpm_ibmvtpm_suspend
,
418 .resume
= tpm_ibmvtpm_resume
,
422 * ibmvtpm_crq_get_next - Get next responded crq
423 * @ibmvtpm vtpm device struct
428 static struct ibmvtpm_crq
*ibmvtpm_crq_get_next(struct ibmvtpm_dev
*ibmvtpm
)
430 struct ibmvtpm_crq_queue
*crq_q
= &ibmvtpm
->crq_queue
;
431 struct ibmvtpm_crq
*crq
= &crq_q
->crq_addr
[crq_q
->index
];
433 if (crq
->valid
& VTPM_MSG_RES
) {
434 if (++crq_q
->index
== crq_q
->num_entry
)
443 * ibmvtpm_crq_process - Process responded crq
444 * @crq crq to be processed
445 * @ibmvtpm vtpm device struct
450 static void ibmvtpm_crq_process(struct ibmvtpm_crq
*crq
,
451 struct ibmvtpm_dev
*ibmvtpm
)
455 switch (crq
->valid
) {
459 dev_info(ibmvtpm
->dev
, "CRQ initialized\n");
460 rc
= ibmvtpm_crq_send_init_complete(ibmvtpm
);
462 dev_err(ibmvtpm
->dev
, "Unable to send CRQ init complete rc=%d\n", rc
);
464 case INIT_CRQ_COMP_RES
:
465 dev_info(ibmvtpm
->dev
,
466 "CRQ initialization completed\n");
469 dev_err(ibmvtpm
->dev
, "Unknown crq message type: %d\n", crq
->msg
);
472 case IBMVTPM_VALID_CMD
:
474 case VTPM_GET_RTCE_BUFFER_SIZE_RES
:
476 dev_err(ibmvtpm
->dev
, "Invalid rtce size\n");
479 ibmvtpm
->rtce_size
= crq
->len
;
480 ibmvtpm
->rtce_buf
= kmalloc(ibmvtpm
->rtce_size
,
482 if (!ibmvtpm
->rtce_buf
) {
483 dev_err(ibmvtpm
->dev
, "Failed to allocate memory for rtce buffer\n");
487 ibmvtpm
->rtce_dma_handle
= dma_map_single(ibmvtpm
->dev
,
488 ibmvtpm
->rtce_buf
, ibmvtpm
->rtce_size
,
491 if (dma_mapping_error(ibmvtpm
->dev
,
492 ibmvtpm
->rtce_dma_handle
)) {
493 kfree(ibmvtpm
->rtce_buf
);
494 ibmvtpm
->rtce_buf
= NULL
;
495 dev_err(ibmvtpm
->dev
, "Failed to dma map rtce buffer\n");
499 case VTPM_GET_VERSION_RES
:
500 ibmvtpm
->vtpm_version
= crq
->data
;
502 case VTPM_TPM_COMMAND_RES
:
503 /* len of the data in rtce buffer */
504 ibmvtpm
->res_len
= crq
->len
;
505 wake_up_interruptible(&ibmvtpm
->wq
);
515 * ibmvtpm_interrupt - Interrupt handler
516 * @irq: irq number to handle
517 * @vtpm_instance: vtpm that received interrupt
522 static irqreturn_t
ibmvtpm_interrupt(int irq
, void *vtpm_instance
)
524 struct ibmvtpm_dev
*ibmvtpm
= (struct ibmvtpm_dev
*) vtpm_instance
;
525 struct ibmvtpm_crq
*crq
;
527 /* while loop is needed for initial setup (get version and
528 * get rtce_size). There should be only one tpm request at any
531 while ((crq
= ibmvtpm_crq_get_next(ibmvtpm
)) != NULL
) {
532 ibmvtpm_crq_process(crq
, ibmvtpm
);
541 * tpm_ibmvtpm_probe - ibm vtpm initialize entry point
542 * @vio_dev: vio device struct
543 * @id: vio device id struct
549 static int tpm_ibmvtpm_probe(struct vio_dev
*vio_dev
,
550 const struct vio_device_id
*id
)
552 struct ibmvtpm_dev
*ibmvtpm
;
553 struct device
*dev
= &vio_dev
->dev
;
554 struct ibmvtpm_crq_queue
*crq_q
;
555 struct tpm_chip
*chip
;
556 int rc
= -ENOMEM
, rc1
;
558 chip
= tpm_register_hardware(dev
, &tpm_ibmvtpm
);
560 dev_err(dev
, "tpm_register_hardware failed\n");
564 ibmvtpm
= kzalloc(sizeof(struct ibmvtpm_dev
), GFP_KERNEL
);
566 dev_err(dev
, "kzalloc for ibmvtpm failed\n");
570 crq_q
= &ibmvtpm
->crq_queue
;
571 crq_q
->crq_addr
= (struct ibmvtpm_crq
*)get_zeroed_page(GFP_KERNEL
);
572 if (!crq_q
->crq_addr
) {
573 dev_err(dev
, "Unable to allocate memory for crq_addr\n");
577 crq_q
->num_entry
= CRQ_RES_BUF_SIZE
/ sizeof(*crq_q
->crq_addr
);
578 ibmvtpm
->crq_dma_handle
= dma_map_single(dev
, crq_q
->crq_addr
,
582 if (dma_mapping_error(dev
, ibmvtpm
->crq_dma_handle
)) {
583 dev_err(dev
, "dma mapping failed\n");
587 rc
= plpar_hcall_norets(H_REG_CRQ
, vio_dev
->unit_address
,
588 ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
);
589 if (rc
== H_RESOURCE
)
590 rc
= ibmvtpm_reset_crq(ibmvtpm
);
593 dev_err(dev
, "Unable to register CRQ rc=%d\n", rc
);
594 goto reg_crq_cleanup
;
597 rc
= request_irq(vio_dev
->irq
, ibmvtpm_interrupt
, 0,
598 tpm_ibmvtpm_driver_name
, ibmvtpm
);
600 dev_err(dev
, "Error %d register irq 0x%x\n", rc
, vio_dev
->irq
);
601 goto init_irq_cleanup
;
604 rc
= vio_enable_interrupts(vio_dev
);
606 dev_err(dev
, "Error %d enabling interrupts\n", rc
);
607 goto init_irq_cleanup
;
610 init_waitqueue_head(&ibmvtpm
->wq
);
615 ibmvtpm
->vdev
= vio_dev
;
616 TPM_VPRIV(chip
) = (void *)ibmvtpm
;
618 spin_lock_init(&ibmvtpm
->rtce_lock
);
620 rc
= ibmvtpm_crq_send_init(ibmvtpm
);
622 goto init_irq_cleanup
;
624 rc
= ibmvtpm_crq_get_version(ibmvtpm
);
626 goto init_irq_cleanup
;
628 rc
= ibmvtpm_crq_get_rtce_size(ibmvtpm
);
630 goto init_irq_cleanup
;
635 rc1
= plpar_hcall_norets(H_FREE_CRQ
, vio_dev
->unit_address
);
636 } while (rc1
== H_BUSY
|| H_IS_LONG_BUSY(rc1
));
638 dma_unmap_single(dev
, ibmvtpm
->crq_dma_handle
, CRQ_RES_BUF_SIZE
,
643 free_page((unsigned long)crq_q
->crq_addr
);
647 tpm_remove_hardware(dev
);
652 static struct vio_driver ibmvtpm_driver
= {
653 .id_table
= tpm_ibmvtpm_device_table
,
654 .probe
= tpm_ibmvtpm_probe
,
655 .remove
= tpm_ibmvtpm_remove
,
656 .get_desired_dma
= tpm_ibmvtpm_get_desired_dma
,
657 .name
= tpm_ibmvtpm_driver_name
,
658 .pm
= &tpm_ibmvtpm_pm_ops
,
662 * ibmvtpm_module_init - Initialize ibm vtpm module
668 static int __init
ibmvtpm_module_init(void)
670 return vio_register_driver(&ibmvtpm_driver
);
674 * ibmvtpm_module_exit - Teardown ibm vtpm module
679 static void __exit
ibmvtpm_module_exit(void)
681 vio_unregister_driver(&ibmvtpm_driver
);
684 module_init(ibmvtpm_module_init
);
685 module_exit(ibmvtpm_module_exit
);
687 MODULE_AUTHOR("adlai@us.ibm.com");
688 MODULE_DESCRIPTION("IBM vTPM Driver");
689 MODULE_VERSION("1.0");
690 MODULE_LICENSE("GPL");