2 * tpm_tis.c - QEMU's TPM TIS interface emulator
4 * Copyright (C) 2006,2010-2013 IBM Corporation
7 * Stefan Berger <stefanb@us.ibm.com>
8 * David Safford <safford@us.ibm.com>
10 * Xen 4 support: Andrease Niederl <andreas.niederl@iaik.tugraz.at>
12 * This work is licensed under the terms of the GNU GPL, version 2 or later.
13 * See the COPYING file in the top-level directory.
15 * Implementation of the TIS interface according to specs found at
16 * http://www.trustedcomputinggroup.org. This implementation currently
17 * supports version 1.3, 21 March 2013
18 * In the developers menu choose the PC Client section then find the TIS
21 * TPM TIS for TPM 2 implementation following TCG PC Client Platform
22 * TPM Profile (PTP) Specification, Familiy 2.0, Revision 00.43
25 #include "qemu/osdep.h"
26 #include "hw/isa/isa.h"
27 #include "qapi/error.h"
29 #include "hw/acpi/tpm.h"
30 #include "hw/pci/pci_ids.h"
31 #include "sysemu/tpm_backend.h"
37 #define TPM_TIS_NUM_LOCALITIES 5 /* per spec */
38 #define TPM_TIS_LOCALITY_SHIFT 12
39 #define TPM_TIS_NO_LOCALITY 0xff
41 #define TPM_TIS_IS_VALID_LOCTY(x) ((x) < TPM_TIS_NUM_LOCALITIES)
43 #define TPM_TIS_BUFFER_MAX 4096
46 TPM_TIS_STATE_IDLE
= 0,
48 TPM_TIS_STATE_COMPLETION
,
49 TPM_TIS_STATE_EXECUTION
,
50 TPM_TIS_STATE_RECEPTION
,
53 /* locality data -- all fields are persisted */
54 typedef struct TPMLocality
{
63 typedef struct TPMState
{
67 unsigned char buffer
[TPM_TIS_BUFFER_MAX
];
71 uint8_t aborting_locty
;
74 TPMLocality loc
[TPM_TIS_NUM_LOCALITIES
];
81 TPMBackend
*be_driver
;
82 TPMVersion be_tpm_version
;
84 size_t be_buffer_size
;
90 #define TPM(obj) OBJECT_CHECK(TPMState, (obj), TYPE_TPM_TIS)
94 /* local prototypes */
96 static uint64_t tpm_tis_mmio_read(void *opaque
, hwaddr addr
,
99 /* utility functions */
101 static uint8_t tpm_tis_locality_from_addr(hwaddr addr
)
103 return (uint8_t)((addr
>> TPM_TIS_LOCALITY_SHIFT
) & 0x7);
106 static void tpm_tis_show_buffer(const unsigned char *buffer
,
107 size_t buffer_size
, const char *string
)
111 len
= MIN(tpm_cmd_get_size(buffer
), buffer_size
);
112 printf("tpm_tis: %s length = %d\n", string
, len
);
113 for (i
= 0; i
< len
; i
++) {
114 if (i
&& !(i
% 16)) {
117 printf("%.2X ", buffer
[i
]);
123 * Set the given flags in the STS register by clearing the register but
124 * preserving the SELFTEST_DONE and TPM_FAMILY_MASK flags and then setting
127 * The SELFTEST_DONE flag is acquired from the backend that determines it by
128 * peeking into TPM commands.
130 * A VM suspend/resume will preserve the flag by storing it into the VM
131 * device state, but the backend will not remember it when QEMU is started
132 * again. Therefore, we cache the flag here. Once set, it will not be unset
135 static void tpm_tis_sts_set(TPMLocality
*l
, uint32_t flags
)
137 l
->sts
&= TPM_TIS_STS_SELFTEST_DONE
| TPM_TIS_STS_TPM_FAMILY_MASK
;
142 * Send a request to the TPM.
144 static void tpm_tis_tpm_send(TPMState
*s
, uint8_t locty
)
147 tpm_tis_show_buffer(s
->buffer
, s
->be_buffer_size
,
152 * rw_offset serves as length indicator for length of data;
153 * it's reset when the response comes back
155 s
->loc
[locty
].state
= TPM_TIS_STATE_EXECUTION
;
157 s
->cmd
= (TPMBackendCmd
) {
160 .in_len
= s
->rw_offset
,
162 .out_len
= s
->be_buffer_size
,
165 tpm_backend_deliver_request(s
->be_driver
, &s
->cmd
);
168 /* raise an interrupt if allowed */
169 static void tpm_tis_raise_irq(TPMState
*s
, uint8_t locty
, uint32_t irqmask
)
171 if (!TPM_TIS_IS_VALID_LOCTY(locty
)) {
175 if ((s
->loc
[locty
].inte
& TPM_TIS_INT_ENABLED
) &&
176 (s
->loc
[locty
].inte
& irqmask
)) {
177 trace_tpm_tis_raise_irq(irqmask
);
178 qemu_irq_raise(s
->irq
);
179 s
->loc
[locty
].ints
|= irqmask
;
183 static uint32_t tpm_tis_check_request_use_except(TPMState
*s
, uint8_t locty
)
187 for (l
= 0; l
< TPM_TIS_NUM_LOCALITIES
; l
++) {
191 if ((s
->loc
[l
].access
& TPM_TIS_ACCESS_REQUEST_USE
)) {
199 static void tpm_tis_new_active_locality(TPMState
*s
, uint8_t new_active_locty
)
201 bool change
= (s
->active_locty
!= new_active_locty
);
205 if (change
&& TPM_TIS_IS_VALID_LOCTY(s
->active_locty
)) {
206 is_seize
= TPM_TIS_IS_VALID_LOCTY(new_active_locty
) &&
207 s
->loc
[new_active_locty
].access
& TPM_TIS_ACCESS_SEIZE
;
210 mask
= ~(TPM_TIS_ACCESS_ACTIVE_LOCALITY
);
212 mask
= ~(TPM_TIS_ACCESS_ACTIVE_LOCALITY
|
213 TPM_TIS_ACCESS_REQUEST_USE
);
215 /* reset flags on the old active locality */
216 s
->loc
[s
->active_locty
].access
&= mask
;
219 s
->loc
[s
->active_locty
].access
|= TPM_TIS_ACCESS_BEEN_SEIZED
;
223 s
->active_locty
= new_active_locty
;
225 trace_tpm_tis_new_active_locality(s
->active_locty
);
227 if (TPM_TIS_IS_VALID_LOCTY(new_active_locty
)) {
228 /* set flags on the new active locality */
229 s
->loc
[new_active_locty
].access
|= TPM_TIS_ACCESS_ACTIVE_LOCALITY
;
230 s
->loc
[new_active_locty
].access
&= ~(TPM_TIS_ACCESS_REQUEST_USE
|
231 TPM_TIS_ACCESS_SEIZE
);
235 tpm_tis_raise_irq(s
, s
->active_locty
, TPM_TIS_INT_LOCALITY_CHANGED
);
239 /* abort -- this function switches the locality */
240 static void tpm_tis_abort(TPMState
*s
)
244 trace_tpm_tis_abort(s
->next_locty
);
247 * Need to react differently depending on who's aborting now and
248 * which locality will become active afterwards.
250 if (s
->aborting_locty
== s
->next_locty
) {
251 s
->loc
[s
->aborting_locty
].state
= TPM_TIS_STATE_READY
;
252 tpm_tis_sts_set(&s
->loc
[s
->aborting_locty
],
253 TPM_TIS_STS_COMMAND_READY
);
254 tpm_tis_raise_irq(s
, s
->aborting_locty
, TPM_TIS_INT_COMMAND_READY
);
257 /* locality after abort is another one than the current one */
258 tpm_tis_new_active_locality(s
, s
->next_locty
);
260 s
->next_locty
= TPM_TIS_NO_LOCALITY
;
261 /* nobody's aborting a command anymore */
262 s
->aborting_locty
= TPM_TIS_NO_LOCALITY
;
265 /* prepare aborting current command */
266 static void tpm_tis_prep_abort(TPMState
*s
, uint8_t locty
, uint8_t newlocty
)
270 assert(TPM_TIS_IS_VALID_LOCTY(newlocty
));
272 s
->aborting_locty
= locty
; /* may also be TPM_TIS_NO_LOCALITY */
273 s
->next_locty
= newlocty
; /* locality after successful abort */
276 * only abort a command using an interrupt if currently executing
277 * a command AND if there's a valid connection to the vTPM.
279 for (busy_locty
= 0; busy_locty
< TPM_TIS_NUM_LOCALITIES
; busy_locty
++) {
280 if (s
->loc
[busy_locty
].state
== TPM_TIS_STATE_EXECUTION
) {
282 * request the backend to cancel. Some backends may not
285 tpm_backend_cancel_cmd(s
->be_driver
);
294 * Callback from the TPM to indicate that the response was received.
296 static void tpm_tis_request_completed(TPMIf
*ti
, int ret
)
298 TPMState
*s
= TPM(ti
);
299 uint8_t locty
= s
->cmd
.locty
;
302 assert(TPM_TIS_IS_VALID_LOCTY(locty
));
304 if (s
->cmd
.selftest_done
) {
305 for (l
= 0; l
< TPM_TIS_NUM_LOCALITIES
; l
++) {
306 s
->loc
[l
].sts
|= TPM_TIS_STS_SELFTEST_DONE
;
310 /* FIXME: report error if ret != 0 */
311 tpm_tis_sts_set(&s
->loc
[locty
],
312 TPM_TIS_STS_VALID
| TPM_TIS_STS_DATA_AVAILABLE
);
313 s
->loc
[locty
].state
= TPM_TIS_STATE_COMPLETION
;
317 tpm_tis_show_buffer(s
->buffer
, s
->be_buffer_size
,
318 "tpm_tis: From TPM");
321 if (TPM_TIS_IS_VALID_LOCTY(s
->next_locty
)) {
325 tpm_tis_raise_irq(s
, locty
,
326 TPM_TIS_INT_DATA_AVAILABLE
| TPM_TIS_INT_STS_VALID
);
330 * Read a byte of response data
332 static uint32_t tpm_tis_data_read(TPMState
*s
, uint8_t locty
)
334 uint32_t ret
= TPM_TIS_NO_DATA_BYTE
;
337 if ((s
->loc
[locty
].sts
& TPM_TIS_STS_DATA_AVAILABLE
)) {
338 len
= MIN(tpm_cmd_get_size(&s
->buffer
),
341 ret
= s
->buffer
[s
->rw_offset
++];
342 if (s
->rw_offset
>= len
) {
344 tpm_tis_sts_set(&s
->loc
[locty
], TPM_TIS_STS_VALID
);
345 tpm_tis_raise_irq(s
, locty
, TPM_TIS_INT_STS_VALID
);
347 trace_tpm_tis_data_read(ret
, s
->rw_offset
- 1);
354 static void tpm_tis_dump_state(void *opaque
, hwaddr addr
)
356 static const unsigned regs
[] = {
358 TPM_TIS_REG_INT_ENABLE
,
359 TPM_TIS_REG_INT_VECTOR
,
360 TPM_TIS_REG_INT_STATUS
,
361 TPM_TIS_REG_INTF_CAPABILITY
,
367 uint8_t locty
= tpm_tis_locality_from_addr(addr
);
368 hwaddr base
= addr
& ~0xfff;
369 TPMState
*s
= opaque
;
371 printf("tpm_tis: active locality : %d\n"
372 "tpm_tis: state of locality %d : %d\n"
373 "tpm_tis: register dump:\n",
375 locty
, s
->loc
[locty
].state
);
377 for (idx
= 0; regs
[idx
] != 0xfff; idx
++) {
378 printf("tpm_tis: 0x%04x : 0x%08x\n", regs
[idx
],
379 (int)tpm_tis_mmio_read(opaque
, base
+ regs
[idx
], 4));
382 printf("tpm_tis: r/w offset : %d\n"
383 "tpm_tis: result buffer : ",
386 idx
< MIN(tpm_cmd_get_size(&s
->buffer
), s
->be_buffer_size
);
389 s
->rw_offset
== idx
? '>' : ' ',
391 ((idx
& 0xf) == 0xf) ? "\ntpm_tis: " : "");
398 * Read a register of the TIS interface
399 * See specs pages 33-63 for description of the registers
401 static uint64_t tpm_tis_mmio_read(void *opaque
, hwaddr addr
,
404 TPMState
*s
= opaque
;
405 uint16_t offset
= addr
& 0xffc;
406 uint8_t shift
= (addr
& 0x3) * 8;
407 uint32_t val
= 0xffffffff;
408 uint8_t locty
= tpm_tis_locality_from_addr(addr
);
412 if (tpm_backend_had_startup_error(s
->be_driver
)) {
417 case TPM_TIS_REG_ACCESS
:
418 /* never show the SEIZE flag even though we use it internally */
419 val
= s
->loc
[locty
].access
& ~TPM_TIS_ACCESS_SEIZE
;
420 /* the pending flag is always calculated */
421 if (tpm_tis_check_request_use_except(s
, locty
)) {
422 val
|= TPM_TIS_ACCESS_PENDING_REQUEST
;
424 val
|= !tpm_backend_get_tpm_established_flag(s
->be_driver
);
426 case TPM_TIS_REG_INT_ENABLE
:
427 val
= s
->loc
[locty
].inte
;
429 case TPM_TIS_REG_INT_VECTOR
:
432 case TPM_TIS_REG_INT_STATUS
:
433 val
= s
->loc
[locty
].ints
;
435 case TPM_TIS_REG_INTF_CAPABILITY
:
436 switch (s
->be_tpm_version
) {
437 case TPM_VERSION_UNSPEC
:
440 case TPM_VERSION_1_2
:
441 val
= TPM_TIS_CAPABILITIES_SUPPORTED1_3
;
443 case TPM_VERSION_2_0
:
444 val
= TPM_TIS_CAPABILITIES_SUPPORTED2_0
;
448 case TPM_TIS_REG_STS
:
449 if (s
->active_locty
== locty
) {
450 if ((s
->loc
[locty
].sts
& TPM_TIS_STS_DATA_AVAILABLE
)) {
451 val
= TPM_TIS_BURST_COUNT(
452 MIN(tpm_cmd_get_size(&s
->buffer
),
454 - s
->rw_offset
) | s
->loc
[locty
].sts
;
456 avail
= s
->be_buffer_size
- s
->rw_offset
;
458 * byte-sized reads should not return 0x00 for 0x100
461 if (size
== 1 && avail
> 0xff) {
464 val
= TPM_TIS_BURST_COUNT(avail
) | s
->loc
[locty
].sts
;
468 case TPM_TIS_REG_DATA_FIFO
:
469 case TPM_TIS_REG_DATA_XFIFO
... TPM_TIS_REG_DATA_XFIFO_END
:
470 if (s
->active_locty
== locty
) {
471 if (size
> 4 - (addr
& 0x3)) {
472 /* prevent access beyond FIFO */
473 size
= 4 - (addr
& 0x3);
478 switch (s
->loc
[locty
].state
) {
479 case TPM_TIS_STATE_COMPLETION
:
480 v
= tpm_tis_data_read(s
, locty
);
483 v
= TPM_TIS_NO_DATA_BYTE
;
490 shift
= 0; /* no more adjustments */
493 case TPM_TIS_REG_INTERFACE_ID
:
494 val
= s
->loc
[locty
].iface_id
;
496 case TPM_TIS_REG_DID_VID
:
497 val
= (TPM_TIS_TPM_DID
<< 16) | TPM_TIS_TPM_VID
;
499 case TPM_TIS_REG_RID
:
500 val
= TPM_TIS_TPM_RID
;
503 case TPM_TIS_REG_DEBUG
:
504 tpm_tis_dump_state(opaque
, addr
);
513 trace_tpm_tis_mmio_read(size
, addr
, val
);
519 * Write a value to a register of the TIS interface
520 * See specs pages 33-63 for description of the registers
522 static void tpm_tis_mmio_write(void *opaque
, hwaddr addr
,
523 uint64_t val
, unsigned size
)
525 TPMState
*s
= opaque
;
526 uint16_t off
= addr
& 0xffc;
527 uint8_t shift
= (addr
& 0x3) * 8;
528 uint8_t locty
= tpm_tis_locality_from_addr(addr
);
529 uint8_t active_locty
, l
;
530 int c
, set_new_locty
= 1;
532 uint32_t mask
= (size
== 1) ? 0xff : ((size
== 2) ? 0xffff : ~0);
534 trace_tpm_tis_mmio_write(size
, addr
, val
);
537 trace_tpm_tis_mmio_write_locty4();
541 if (tpm_backend_had_startup_error(s
->be_driver
)) {
555 case TPM_TIS_REG_ACCESS
:
557 if ((val
& TPM_TIS_ACCESS_SEIZE
)) {
558 val
&= ~(TPM_TIS_ACCESS_REQUEST_USE
|
559 TPM_TIS_ACCESS_ACTIVE_LOCALITY
);
562 active_locty
= s
->active_locty
;
564 if ((val
& TPM_TIS_ACCESS_ACTIVE_LOCALITY
)) {
565 /* give up locality if currently owned */
566 if (s
->active_locty
== locty
) {
567 trace_tpm_tis_mmio_write_release_locty(locty
);
569 uint8_t newlocty
= TPM_TIS_NO_LOCALITY
;
570 /* anybody wants the locality ? */
571 for (c
= TPM_TIS_NUM_LOCALITIES
- 1; c
>= 0; c
--) {
572 if ((s
->loc
[c
].access
& TPM_TIS_ACCESS_REQUEST_USE
)) {
573 trace_tpm_tis_mmio_write_locty_req_use(c
);
578 trace_tpm_tis_mmio_write_next_locty(newlocty
);
580 if (TPM_TIS_IS_VALID_LOCTY(newlocty
)) {
582 tpm_tis_prep_abort(s
, locty
, newlocty
);
584 active_locty
= TPM_TIS_NO_LOCALITY
;
587 /* not currently the owner; clear a pending request */
588 s
->loc
[locty
].access
&= ~TPM_TIS_ACCESS_REQUEST_USE
;
592 if ((val
& TPM_TIS_ACCESS_BEEN_SEIZED
)) {
593 s
->loc
[locty
].access
&= ~TPM_TIS_ACCESS_BEEN_SEIZED
;
596 if ((val
& TPM_TIS_ACCESS_SEIZE
)) {
598 * allow seize if a locality is active and the requesting
599 * locality is higher than the one that's active
601 * allow seize for requesting locality if no locality is
604 while ((TPM_TIS_IS_VALID_LOCTY(s
->active_locty
) &&
605 locty
> s
->active_locty
) ||
606 !TPM_TIS_IS_VALID_LOCTY(s
->active_locty
)) {
607 bool higher_seize
= FALSE
;
609 /* already a pending SEIZE ? */
610 if ((s
->loc
[locty
].access
& TPM_TIS_ACCESS_SEIZE
)) {
614 /* check for ongoing seize by a higher locality */
615 for (l
= locty
+ 1; l
< TPM_TIS_NUM_LOCALITIES
; l
++) {
616 if ((s
->loc
[l
].access
& TPM_TIS_ACCESS_SEIZE
)) {
626 /* cancel any seize by a lower locality */
627 for (l
= 0; l
< locty
- 1; l
++) {
628 s
->loc
[l
].access
&= ~TPM_TIS_ACCESS_SEIZE
;
631 s
->loc
[locty
].access
|= TPM_TIS_ACCESS_SEIZE
;
633 trace_tpm_tis_mmio_write_locty_seized(locty
, s
->active_locty
);
634 trace_tpm_tis_mmio_write_init_abort();
637 tpm_tis_prep_abort(s
, s
->active_locty
, locty
);
642 if ((val
& TPM_TIS_ACCESS_REQUEST_USE
)) {
643 if (s
->active_locty
!= locty
) {
644 if (TPM_TIS_IS_VALID_LOCTY(s
->active_locty
)) {
645 s
->loc
[locty
].access
|= TPM_TIS_ACCESS_REQUEST_USE
;
647 /* no locality active -> make this one active now */
648 active_locty
= locty
;
654 tpm_tis_new_active_locality(s
, active_locty
);
658 case TPM_TIS_REG_INT_ENABLE
:
659 if (s
->active_locty
!= locty
) {
663 s
->loc
[locty
].inte
&= mask
;
664 s
->loc
[locty
].inte
|= (val
& (TPM_TIS_INT_ENABLED
|
665 TPM_TIS_INT_POLARITY_MASK
|
666 TPM_TIS_INTERRUPTS_SUPPORTED
));
668 case TPM_TIS_REG_INT_VECTOR
:
669 /* hard wired -- ignore */
671 case TPM_TIS_REG_INT_STATUS
:
672 if (s
->active_locty
!= locty
) {
676 /* clearing of interrupt flags */
677 if (((val
& TPM_TIS_INTERRUPTS_SUPPORTED
)) &&
678 (s
->loc
[locty
].ints
& TPM_TIS_INTERRUPTS_SUPPORTED
)) {
679 s
->loc
[locty
].ints
&= ~val
;
680 if (s
->loc
[locty
].ints
== 0) {
681 qemu_irq_lower(s
->irq
);
682 trace_tpm_tis_mmio_write_lowering_irq();
685 s
->loc
[locty
].ints
&= ~(val
& TPM_TIS_INTERRUPTS_SUPPORTED
);
687 case TPM_TIS_REG_STS
:
688 if (s
->active_locty
!= locty
) {
692 if (s
->be_tpm_version
== TPM_VERSION_2_0
) {
693 /* some flags that are only supported for TPM 2 */
694 if (val
& TPM_TIS_STS_COMMAND_CANCEL
) {
695 if (s
->loc
[locty
].state
== TPM_TIS_STATE_EXECUTION
) {
697 * request the backend to cancel. Some backends may not
700 tpm_backend_cancel_cmd(s
->be_driver
);
704 if (val
& TPM_TIS_STS_RESET_ESTABLISHMENT_BIT
) {
705 if (locty
== 3 || locty
== 4) {
706 tpm_backend_reset_tpm_established_flag(s
->be_driver
, locty
);
711 val
&= (TPM_TIS_STS_COMMAND_READY
| TPM_TIS_STS_TPM_GO
|
712 TPM_TIS_STS_RESPONSE_RETRY
);
714 if (val
== TPM_TIS_STS_COMMAND_READY
) {
715 switch (s
->loc
[locty
].state
) {
717 case TPM_TIS_STATE_READY
:
721 case TPM_TIS_STATE_IDLE
:
722 tpm_tis_sts_set(&s
->loc
[locty
], TPM_TIS_STS_COMMAND_READY
);
723 s
->loc
[locty
].state
= TPM_TIS_STATE_READY
;
724 tpm_tis_raise_irq(s
, locty
, TPM_TIS_INT_COMMAND_READY
);
727 case TPM_TIS_STATE_EXECUTION
:
728 case TPM_TIS_STATE_RECEPTION
:
729 /* abort currently running command */
730 trace_tpm_tis_mmio_write_init_abort();
731 tpm_tis_prep_abort(s
, locty
, locty
);
734 case TPM_TIS_STATE_COMPLETION
:
736 /* shortcut to ready state with C/R set */
737 s
->loc
[locty
].state
= TPM_TIS_STATE_READY
;
738 if (!(s
->loc
[locty
].sts
& TPM_TIS_STS_COMMAND_READY
)) {
739 tpm_tis_sts_set(&s
->loc
[locty
],
740 TPM_TIS_STS_COMMAND_READY
);
741 tpm_tis_raise_irq(s
, locty
, TPM_TIS_INT_COMMAND_READY
);
743 s
->loc
[locty
].sts
&= ~(TPM_TIS_STS_DATA_AVAILABLE
);
747 } else if (val
== TPM_TIS_STS_TPM_GO
) {
748 switch (s
->loc
[locty
].state
) {
749 case TPM_TIS_STATE_RECEPTION
:
750 if ((s
->loc
[locty
].sts
& TPM_TIS_STS_EXPECT
) == 0) {
751 tpm_tis_tpm_send(s
, locty
);
758 } else if (val
== TPM_TIS_STS_RESPONSE_RETRY
) {
759 switch (s
->loc
[locty
].state
) {
760 case TPM_TIS_STATE_COMPLETION
:
762 tpm_tis_sts_set(&s
->loc
[locty
],
764 TPM_TIS_STS_DATA_AVAILABLE
);
772 case TPM_TIS_REG_DATA_FIFO
:
773 case TPM_TIS_REG_DATA_XFIFO
... TPM_TIS_REG_DATA_XFIFO_END
:
775 if (s
->active_locty
!= locty
) {
779 if (s
->loc
[locty
].state
== TPM_TIS_STATE_IDLE
||
780 s
->loc
[locty
].state
== TPM_TIS_STATE_EXECUTION
||
781 s
->loc
[locty
].state
== TPM_TIS_STATE_COMPLETION
) {
784 trace_tpm_tis_mmio_write_data2send(val
, size
);
785 if (s
->loc
[locty
].state
== TPM_TIS_STATE_READY
) {
786 s
->loc
[locty
].state
= TPM_TIS_STATE_RECEPTION
;
787 tpm_tis_sts_set(&s
->loc
[locty
],
788 TPM_TIS_STS_EXPECT
| TPM_TIS_STS_VALID
);
792 if (size
> 4 - (addr
& 0x3)) {
793 /* prevent access beyond FIFO */
794 size
= 4 - (addr
& 0x3);
797 while ((s
->loc
[locty
].sts
& TPM_TIS_STS_EXPECT
) && size
> 0) {
798 if (s
->rw_offset
< s
->be_buffer_size
) {
799 s
->buffer
[s
->rw_offset
++] =
804 tpm_tis_sts_set(&s
->loc
[locty
], TPM_TIS_STS_VALID
);
808 /* check for complete packet */
809 if (s
->rw_offset
> 5 &&
810 (s
->loc
[locty
].sts
& TPM_TIS_STS_EXPECT
)) {
811 /* we have a packet length - see if we have all of it */
812 bool need_irq
= !(s
->loc
[locty
].sts
& TPM_TIS_STS_VALID
);
814 len
= tpm_cmd_get_size(&s
->buffer
);
815 if (len
> s
->rw_offset
) {
816 tpm_tis_sts_set(&s
->loc
[locty
],
817 TPM_TIS_STS_EXPECT
| TPM_TIS_STS_VALID
);
819 /* packet complete */
820 tpm_tis_sts_set(&s
->loc
[locty
], TPM_TIS_STS_VALID
);
823 tpm_tis_raise_irq(s
, locty
, TPM_TIS_INT_STS_VALID
);
828 case TPM_TIS_REG_INTERFACE_ID
:
829 if (val
& TPM_TIS_IFACE_ID_INT_SEL_LOCK
) {
830 for (l
= 0; l
< TPM_TIS_NUM_LOCALITIES
; l
++) {
831 s
->loc
[l
].iface_id
|= TPM_TIS_IFACE_ID_INT_SEL_LOCK
;
838 static const MemoryRegionOps tpm_tis_memory_ops
= {
839 .read
= tpm_tis_mmio_read
,
840 .write
= tpm_tis_mmio_write
,
841 .endianness
= DEVICE_LITTLE_ENDIAN
,
843 .min_access_size
= 1,
844 .max_access_size
= 4,
849 * Get the TPMVersion of the backend device being used
851 static enum TPMVersion
tpm_tis_get_tpm_version(TPMIf
*ti
)
853 TPMState
*s
= TPM(ti
);
855 if (tpm_backend_had_startup_error(s
->be_driver
)) {
856 return TPM_VERSION_UNSPEC
;
859 return tpm_backend_get_tpm_version(s
->be_driver
);
863 * This function is called when the machine starts, resets or due to
866 static void tpm_tis_reset(DeviceState
*dev
)
868 TPMState
*s
= TPM(dev
);
871 s
->be_tpm_version
= tpm_backend_get_tpm_version(s
->be_driver
);
872 s
->be_buffer_size
= MIN(tpm_backend_get_buffer_size(s
->be_driver
),
875 if (s
->ppi_enabled
) {
876 tpm_ppi_reset(&s
->ppi
);
878 tpm_backend_reset(s
->be_driver
);
880 s
->active_locty
= TPM_TIS_NO_LOCALITY
;
881 s
->next_locty
= TPM_TIS_NO_LOCALITY
;
882 s
->aborting_locty
= TPM_TIS_NO_LOCALITY
;
884 for (c
= 0; c
< TPM_TIS_NUM_LOCALITIES
; c
++) {
885 s
->loc
[c
].access
= TPM_TIS_ACCESS_TPM_REG_VALID_STS
;
886 switch (s
->be_tpm_version
) {
887 case TPM_VERSION_UNSPEC
:
889 case TPM_VERSION_1_2
:
890 s
->loc
[c
].sts
= TPM_TIS_STS_TPM_FAMILY1_2
;
891 s
->loc
[c
].iface_id
= TPM_TIS_IFACE_ID_SUPPORTED_FLAGS1_3
;
893 case TPM_VERSION_2_0
:
894 s
->loc
[c
].sts
= TPM_TIS_STS_TPM_FAMILY2_0
;
895 s
->loc
[c
].iface_id
= TPM_TIS_IFACE_ID_SUPPORTED_FLAGS2_0
;
898 s
->loc
[c
].inte
= TPM_TIS_INT_POLARITY_LOW_LEVEL
;
900 s
->loc
[c
].state
= TPM_TIS_STATE_IDLE
;
905 tpm_backend_startup_tpm(s
->be_driver
, s
->be_buffer_size
);
908 /* persistent state handling */
910 static int tpm_tis_pre_save(void *opaque
)
912 TPMState
*s
= opaque
;
913 uint8_t locty
= s
->active_locty
;
915 trace_tpm_tis_pre_save(locty
, s
->rw_offset
);
918 tpm_tis_dump_state(opaque
, 0);
922 * Synchronize with backend completion.
924 tpm_backend_finish_sync(s
->be_driver
);
929 static const VMStateDescription vmstate_locty
= {
930 .name
= "tpm-tis/locty",
932 .fields
= (VMStateField
[]) {
933 VMSTATE_UINT32(state
, TPMLocality
),
934 VMSTATE_UINT32(inte
, TPMLocality
),
935 VMSTATE_UINT32(ints
, TPMLocality
),
936 VMSTATE_UINT8(access
, TPMLocality
),
937 VMSTATE_UINT32(sts
, TPMLocality
),
938 VMSTATE_UINT32(iface_id
, TPMLocality
),
939 VMSTATE_END_OF_LIST(),
943 static const VMStateDescription vmstate_tpm_tis
= {
946 .pre_save
= tpm_tis_pre_save
,
947 .fields
= (VMStateField
[]) {
948 VMSTATE_BUFFER(buffer
, TPMState
),
949 VMSTATE_UINT16(rw_offset
, TPMState
),
950 VMSTATE_UINT8(active_locty
, TPMState
),
951 VMSTATE_UINT8(aborting_locty
, TPMState
),
952 VMSTATE_UINT8(next_locty
, TPMState
),
954 VMSTATE_STRUCT_ARRAY(loc
, TPMState
, TPM_TIS_NUM_LOCALITIES
, 0,
955 vmstate_locty
, TPMLocality
),
957 VMSTATE_END_OF_LIST()
961 static Property tpm_tis_properties
[] = {
962 DEFINE_PROP_UINT32("irq", TPMState
, irq_num
, TPM_TIS_IRQ
),
963 DEFINE_PROP_TPMBE("tpmdev", TPMState
, be_driver
),
964 DEFINE_PROP_BOOL("ppi", TPMState
, ppi_enabled
, true),
965 DEFINE_PROP_END_OF_LIST(),
968 static void tpm_tis_realizefn(DeviceState
*dev
, Error
**errp
)
970 TPMState
*s
= TPM(dev
);
973 error_setg(errp
, "at most one TPM device is permitted");
978 error_setg(errp
, "'tpmdev' property is required");
981 if (s
->irq_num
> 15) {
982 error_setg(errp
, "IRQ %d is outside valid range of 0 to 15",
987 isa_init_irq(&s
->busdev
, &s
->irq
, s
->irq_num
);
989 memory_region_add_subregion(isa_address_space(ISA_DEVICE(dev
)),
990 TPM_TIS_ADDR_BASE
, &s
->mmio
);
992 if (s
->ppi_enabled
) {
993 tpm_ppi_init(&s
->ppi
, isa_address_space(ISA_DEVICE(dev
)),
994 TPM_PPI_ADDR_BASE
, OBJECT(s
));
998 static void tpm_tis_initfn(Object
*obj
)
1000 TPMState
*s
= TPM(obj
);
1002 memory_region_init_io(&s
->mmio
, OBJECT(s
), &tpm_tis_memory_ops
,
1004 TPM_TIS_NUM_LOCALITIES
<< TPM_TIS_LOCALITY_SHIFT
);
1007 static void tpm_tis_class_init(ObjectClass
*klass
, void *data
)
1009 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1010 TPMIfClass
*tc
= TPM_IF_CLASS(klass
);
1012 dc
->realize
= tpm_tis_realizefn
;
1013 dc
->props
= tpm_tis_properties
;
1014 dc
->reset
= tpm_tis_reset
;
1015 dc
->vmsd
= &vmstate_tpm_tis
;
1016 tc
->model
= TPM_MODEL_TPM_TIS
;
1017 tc
->get_version
= tpm_tis_get_tpm_version
;
1018 tc
->request_completed
= tpm_tis_request_completed
;
1021 static const TypeInfo tpm_tis_info
= {
1022 .name
= TYPE_TPM_TIS
,
1023 .parent
= TYPE_ISA_DEVICE
,
1024 .instance_size
= sizeof(TPMState
),
1025 .instance_init
= tpm_tis_initfn
,
1026 .class_init
= tpm_tis_class_init
,
1027 .interfaces
= (InterfaceInfo
[]) {
1033 static void tpm_tis_register(void)
1035 type_register_static(&tpm_tis_info
);
1038 type_init(tpm_tis_register
)