Add vTPM emulator support for ppc64 platform
v6 cover Add vTPM emulator support for ppc64 platform
The following series of patches adds vTPM emulator support for the ppc64 platform (pSeries).
It can be tested as follows with swtpm/libtpms:
mkdir /tmp/mytpm1
swtpm socket --tpmstate dir=/tmp/mytpm1 \
--ctrl type=unixio,path=/tmp/mytpm1/swtpm-sock \
--log level=20
If TPM 2 is desired, add --tpm2 as parameter to the above.
In another terminal start QEMU:
sudo ./ppc64-softmmu/qemu-system-ppc64 -display sdl \ -machine pseries,accel=kvm \ -m 1024 -bios slof.bin -boot menu=on \ -nodefaults -device VGA -device pci-ohci -device usb-kbd \ -chardev socket,id=chrtpm,path=/tmp/mytpm1/swtpm-sock \ -tpmdev emulator,id=tpm0,chardev=chrtpm \ -device tpm-spapr,tpmdev=tpm0 \ -device spapr-vscsi,id=scsi0,reg=0x00002000 \ -device virtio-blk-pci,scsi=off,bus=pci.0,addr=0x3,drive=drive-virtio-disk0,id=virtio-disk0 \ -drive file=test.img,format=raw,if=none,id=drive-virtio-disk0
Links:
- libtpms: https://github.com/stefanberger/libtpms/wiki
- swtpm: https://github.com/stefanberger/swtpm/wiki
Changes:
v5->v6:
- adjusted names of structures and simplified
- only transmitting min. necessary bytes to pass to VM after resume
- addressed other issues pointed out by D. Gibson
v4->v5:
- use runstate_check(RUN_STATE_FINISH_MIGRATE) to check whether devices are suspending; ditch 3 patches in this series that tried to do similar
v3->v4:
- addressed comments to v3
- reworked suspend/resume support that requires extensions to backends
v2->v3:
- patch 1: a TPM 2 is identified by IBM,vtpm20 in the compatible node
- patch 1: convert to tracing to display Tx and Rx buffers
- added documentation patch
- added patch to enable TPM device as part of pSeries
v1->v2:
- followed Cedric Le Goater's suggestions to patch 1
- send appropriate CRQ error responses if DMA read or write fails
- renamed tpm_spapr_got_payload to tpm_spapr_process_cmd and pass endianess-adjusted data pointer from CRQ to it
Regards,
Stefan
Stefan Berger (4):
tpm_spapr: Support TPM for ppc64 using CRQ based interface
tpm_spapr: Support suspend and resume hw/ppc/Kconfig: Enable TPM_SPAPR as part of PSERIES config
docs: tpm: Add example command line for ppc64 and tpm-spapr
docs/specs/tpm.txt | 20 +- hw/ppc/Kconfig | 1 + hw/tpm/Kconfig | 6 + hw/tpm/Makefile.objs | 1 + hw/tpm/tpm_spapr.c | 470 +++++++++++++++++++++++++++++++++++++++++++ hw/tpm/trace-events | 14 ++ include/sysemu/tpm.h | 3 + qapi/tpm.json | 6 +- 8 files changed, 517 insertions(+), 4 deletions(-) create mode 100644 hw/tpm/tpm_spapr.c
Signature · 1 line
2.21.0
PATCH v6 1/4 tpm_spapr: Support TPM for ppc64 using CRQ based interface
Implement support for TPM on ppc64 by implementing the vTPM CRQ interface as a frontend. It can use the tpm_emulator driver backend with the external swtpm.
The Linux vTPM driver for ppc64 works with this emulation.
This TPM emulator also handles the TPM 2 case.
--- hw/tpm/Kconfig | 6 + hw/tpm/Makefile.objs | 1 + hw/tpm/tpm_spapr.c | 405 +++++++++++++++++++++++++++++++++++++++++++ hw/tpm/trace-events | 12 ++ include/sysemu/tpm.h | 3 + qapi/tpm.json | 6 +- 6 files changed, 430 insertions(+), 3 deletions(-) create mode 100644 hw/tpm/tpm_spapr.c
hw/tpm/Kconfig +6 -0
@@ -22,3 +22,9 @@ config TPM_EMULATOR bool default y depends on TPMDEV + +config TPM_SPAPR + bool + default n + select TPMDEV + depends on PSERIES
hw/tpm/Makefile.objs +1 -0
@@ -4,3 +4,4 @@ common-obj-$(CONFIG_TPM_TIS) += tpm_tis.o common-obj-$(CONFIG_TPM_CRB) += tpm_crb.o common-obj-$(CONFIG_TPM_PASSTHROUGH) += tpm_passthrough.o common-obj-$(CONFIG_TPM_EMULATOR) += tpm_emulator.o +obj-$(CONFIG_TPM_SPAPR) += tpm_spapr.o
hw/tpm/tpm_spapr.c new file +405 -0
405 lines not on this page · raw message
hw/tpm/trace-events +12 -0
@@ -55,3 +55,15 @@ tpm_tis_pre_save(uint8_t locty, uint32_t rw_offset) "locty: %d, rw_offset = %u" # tpm_ppi.c tpm_ppi_memset(uint8_t *ptr, size_t size) "memset: %p %zu" + +# hw/tpm/tpm_spapr.c +tpm_spapr_show_buffer(const char *direction, size_t len, const char *buf) "direction: %s len: %zu\n%s" +tpm_spapr_do_crq(uint8_t raw1, uint8_t raw2) "1st 2 bytes in CRQ: 0x%02x 0x%02x" +tpm_spapr_do_crq_crq_result(void) "SPAPR_VTPM_INIT_CRQ_RESULT" +tpm_spapr_do_crq_crq_complete_result(void) "SPAPR_VTPM_INIT_CRQ_COMP_RESULT" +tpm_spapr_do_crq_tpm_command(void) "got TPM command payload" +tpm_spapr_do_crq_tpm_get_rtce_buffer_size(size_t buffersize) "response: buffer size is %zu" +tpm_spapr_do_crq_get_version(uint32_t version) "response: version %u" +tpm_spapr_do_crq_prepare_to_suspend(void) "response: preparing to suspend" +tpm_spapr_do_crq_unknown_msg_type(uint8_t type) "Unknown message type 0x%02x" +tpm_spapr_do_crq_unknown_crq(uint8_t raw1, uint8_t raw2) "unknown CRQ 0x%02x 0x%02x ..."
include/sysemu/tpm.h +3 -0
@@ -45,11 +45,14 @@ typedef struct TPMIfClass {#define TYPE_TPM_TIS "tpm-tis"#define TYPE_TPM_CRB "tpm-crb" +#define TYPE_TPM_SPAPR "tpm-spapr"#define TPM_IS_TIS (chr) \ object_dynamic_cast(OBJECT(chr), TYPE_TPM_TIS)#define TPM_IS_CRB (chr) \ object_dynamic_cast(OBJECT(chr), TYPE_TPM_CRB) +#define TPM_IS_SPAPR (chr) \ + object_dynamic_cast(OBJECT(chr), TYPE_TPM_SPAPR)/* returns NULL unless there is exactly one TPM device */ static inline TPMIf *tpm_find (void )
qapi/tpm.json +3 -3
@@ -12,11 +12,11 @@ # # @tpm-tis: TPM TIS model # @tpm-crb: TPM CRB model (since 2.12) +# @tpm-spapr: TPM SPAPR model (since 5.0) # # Since: 1.5 ## -{ 'enum': 'TpmModel', 'data': [ 'tpm-tis', 'tpm-crb' ] } - +{ 'enum': 'TpmModel', 'data': [ 'tpm-tis', 'tpm-crb', 'tpm-spapr' ] } ## # @query-tpm-models: #
@@ -29,7 +29,7 @@ # Example: # # -> { "execute": "query-tpm-models" } -# <- { "return": [ "tpm-tis", "tpm-crb" ] } +# <- { "return": [ "tpm-tis", "tpm-crb", "tpm-spapr" ] } # ## { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
Signature · 1 line
2.21.0
PATCH v6 2/4 tpm_spapr: Support suspend and resume
In reply to Stefan BergerExtend the tpm_spapr frontend with VM suspend and resume support.
--- hw/tpm/tpm_spapr.c | 67 ++++++++++++++++++++++++++++++++++++++++++++- hw/tpm/trace-events | 2 ++ 2 files changed, 68 insertions(+), 1 deletion(-)
hw/tpm/tpm_spapr.c +66 -1
@@ -76,6 +76,9 @@ typedef struct {unsigned char buffer[TPM_SPAPR_BUFFER_MAX ]; +uint32_t numbytes;/* number of bytes in suspend_buffer */ +unsigned char *suspend_buffer; +TPMBackendCmd cmd;TPMBackend *be_driver;
@@ -263,6 +266,13 @@ static void tpm_spapr_request_completed(TPMIf *ti, int ret)/* a max. of be_buffer_size bytes can be transported */ len =MIN (tpm_cmd_get_size (s->buffer), s->be_buffer_size); + +if (runstate_check (RUN_STATE_FINISH_MIGRATE )) { +/* defer delivery of response until .post_load */ + s->numbytes = len; +return ; + } + rc =spapr_vio_dma_write (&s->vdev,be32_to_cpu (crq->data), s->buffer, len);
@@ -315,12 +325,14 @@ static void tpm_spapr_reset(SpaprVioDevice *dev)SpaprTpmState *s =VIO_SPAPR_VTPM (dev); s->state =SPAPR_VTPM_STATE_NONE ; + s->numbytes =0 ; s->be_tpm_version =tpm_backend_get_tpm_version (s->be_driver);tpm_spapr_update_deviceclass (dev); s->be_buffer_size =MIN (tpm_backend_get_buffer_size (s->be_driver),TPM_SPAPR_BUFFER_MAX ); + s->suspend_buffer =g_realloc (s->suspend_buffer, s->be_buffer_size);tpm_backend_reset (s->be_driver);tpm_spapr_do_startup_tpm (s, s->be_buffer_size);
@@ -337,9 +349,62 @@ static enum TPMVersion tpm_spapr_get_version(TPMIf *ti)return tpm_backend_get_tpm_version (s->be_driver); } +/* persistent state handling */ + +static int tpm_spapr_pre_save (void *opaque) +{ +SpaprTpmState *s = opaque; + +tpm_backend_finish_sync (s->be_driver); + +if (s->numbytes) { +memcpy (s->suspend_buffer, s->buffer, s->numbytes); + } + +trace_tpm_spapr_pre_save (s->numbytes); +/* +* we cannot deliver the results to the VM since DMA would touch VM memory +*/ + +return 0 ; +} + +static int tpm_spapr_post_load (void *opaque,int version_id) +{ +SpaprTpmState *s = opaque; + +if (s->numbytes) { +trace_tpm_spapr_post_load (); + +memcpy (s->buffer, s->suspend_buffer, +MIN (s->numbytes, s->be_buffer_size)); +/* deliver the results to the VM via DMA */ +tpm_spapr_request_completed (TPM_IF (s),0 ); + s->numbytes =0 ; + } + +return 0 ; +} +static const VMStateDescription vmstate_spapr_vtpm = { .name ="tpm-spapr" , - .unmigratable =1 , + .version_id =1 , + .minimum_version_id =0 , + .minimum_version_id_old =0 , + .pre_save = tpm_spapr_pre_save, + .post_load = tpm_spapr_post_load, + .fields = (VMStateField []) { +VMSTATE_SPAPR_VIO (vdev, SpaprTpmState), + +VMSTATE_UINT8 (state, SpaprTpmState), +VMSTATE_UINT32 (numbytes, SpaprTpmState), +VMSTATE_VBUFFER_ALLOC_UINT32 (suspend_buffer, + SpaprTpmState,0 ,NULL , + numbytes), +/* remember DMA address */ +VMSTATE_UINT32 (crq.data, SpaprTpmState), +VMSTATE_END_OF_LIST (), + } };static Property tpm_spapr_properties[] = {
hw/tpm/trace-events +2 -0
@@ -67,3 +67,5 @@ tpm_spapr_do_crq_get_version(uint32_t version) "response: version %u" tpm_spapr_do_crq_prepare_to_suspend(void) "response: preparing to suspend" tpm_spapr_do_crq_unknown_msg_type(uint8_t type) "Unknown message type 0x%02x" tpm_spapr_do_crq_unknown_crq(uint8_t raw1, uint8_t raw2) "unknown CRQ 0x%02x 0x%02x ..." +tpm_spapr_pre_save(uint32_t v) "Number of TPM response bytes to deliver after resume: %u" +tpm_spapr_post_load(void) "Delivering TPM response after resume"
Signature · 1 line
2.21.0
PATCH v6 3/4 hw/ppc/Kconfig: Enable TPM_SPAPR as part of PSERIES config
In reply to Stefan Berger--- hw/ppc/Kconfig | 1 + 1 file changed, 1 insertion(+)
hw/ppc/Kconfig +1 -0
@@ -10,6 +10,7 @@ config PSERIES select XICS_SPAPR select XIVE_SPAPR select MSI_NONBROKEN + select TPM_SPAPR config SPAPR_RNG bool
Signature · 1 line
2.21.0
PATCH v6 4/4 docs: tpm: Add example command line for ppc64 and tpm-spapr
In reply to Stefan BergerAdd an example to the TPM docs for how to add a TPM SPAPR device model to a QEMU VM emulating a pSeries machine.
--- docs/specs/tpm.txt | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-)
docs/specs/tpm.txt +19 -1
@@ -34,6 +34,12 @@ The CRB interface makes a memory mapped IO region in the area 0xfed40000 - QEMU files related to TPM CRB interface: - hw/tpm/tpm_crb.c + +pSeries (ppc64) machines offer a tpm-spapr device model. + +QEMU files related to the SPAPR interface: + - hw/tpm/tpm_spapr.c + = fw_cfg interface = The bios/firmware may read the "etc/tpm/config" fw_cfg entry for
@@ -281,7 +287,7 @@ swtpm socket --tpmstate dir=/tmp/mytpm1 \ --log level=20 Command line to start QEMU with the TPM emulator device communicating with -the swtpm: +the swtpm (x86): qemu-system-x86_64 -display sdl -accel kvm \ -m 1024 -boot d -bios bios-256k.bin -boot menu=on \
@@ -289,6 +295,18 @@ qemu-system-x86_64 -display sdl -accel kvm \ -tpmdev emulator,id=tpm0,chardev=chrtpm \ -device tpm-tis,tpmdev=tpm0 test.img +In case a pSeries machine is emulated, use the following command line: + +qemu-system-ppc64 -display sdl -machine pseries,accel=kvm \ + -m 1024 -bios slof.bin -boot menu=on \ + -nodefaults -device VGA -device pci-ohci -device usb-kbd \ + -chardev socket,id=chrtpm,path=/tmp/mytpm1/swtpm-sock \ + -tpmdev emulator,id=tpm0,chardev=chrtpm \ + -device tpm-spapr,tpmdev=tpm0 \ + -device spapr-vscsi,id=scsi0,reg=0x00002000 \ + -device virtio-blk-pci,scsi=off,bus=pci.0,addr=0x3,drive=drive-virtio-disk0,id=virtio-disk0 \ + -drive file=test.img,format=raw,if=none,id=drive-virtio-disk0 + In case SeaBIOS is used as firmware, it should show the TPM menu item after entering the menu with 'ESC'.
Signature · 1 line
2.21.0