Hello Stefan,
Some comments below. How do we populate the device tree ?
Thanks,
C.
On 12/05/2017 09:35 PM, Stefan Berger wrote:
> Implement support for TPM on ppc64 by implementing the vTPM CRQ
> interface as a frontend.
>
> The Linux vTPM driver for ppc64 works with this emulation.
>
> This emualtor also handles the TPM 2 case.
>
> Signed-off-by: Stefan Berger <stef...@linux.vnet.ibm.com>
> ---
> hw/tpm/Makefile.objs | 1 +
> hw/tpm/tpm_spapr.c | 380
> +++++++++++++++++++++++++++++++++++++++++++++++++++
> include/sysemu/tpm.h | 3 +
> qapi/tpm.json | 5 +-
> 4 files changed, 387 insertions(+), 2 deletions(-)
> create mode 100644 hw/tpm/tpm_spapr.c
>
> diff --git a/hw/tpm/Makefile.objs b/hw/tpm/Makefile.objs
> index 41f0b7a..71ea63e 100644
> --- a/hw/tpm/Makefile.objs
> +++ b/hw/tpm/Makefile.objs
> @@ -1,3 +1,4 @@
> common-obj-$(CONFIG_TPM_TIS) += tpm_tis.o
> common-obj-$(CONFIG_TPM_PASSTHROUGH) += tpm_passthrough.o tpm_util.o
> common-obj-$(CONFIG_TPM_EMULATOR) += tpm_emulator.o tpm_util.o
> +obj-$(CONFIG_PSERIES) += tpm_spapr.o
> diff --git a/hw/tpm/tpm_spapr.c b/hw/tpm/tpm_spapr.c
> new file mode 100644
> index 0000000..909aeeb
> --- /dev/null
> +++ b/hw/tpm/tpm_spapr.c
> @@ -0,0 +1,380 @@
> +/*
> + * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System
> Emulator
> + *
> + * PAPR Virtual TPM
> + *
> + * Copyright (c) 2015, 2017 IBM Corporation.
> + *
> + * Authors:
> + * Stefan Berger <stef...@linux.vnet.ibm.com>
> + *
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> copy
> + * of this software and associated documentation files (the "Software"), to
> deal
> + * in the Software without restriction, including without limitation the
> rights
> + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> + * copies of the Software, and to permit persons to whom the Software is
> + * furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included in
> + * all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> FROM,
> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> + * THE SOFTWARE.
May be reduce a bit the header.
> + */
> +
> +#include "qemu/osdep.h"
> +#include "qapi/error.h"
> +
> +#include "sysemu/tpm_backend.h"
> +#include "tpm_int.h"
> +#include "tpm_util.h"
> +
> +#include "hw/ppc/spapr.h"
> +#include "hw/ppc/spapr_vio.h"
> +
> +#define DEBUG_SPAPR_VTPM 0
> +
> +#define DPRINTF(fmt, ...) do { \
> + if (DEBUG_SPAPR_VTPM) { \
> + printf(fmt, ## __VA_ARGS__); \
> + } \
> +} while (0)
traces are prefered over printfs
> +#define VIO_SPAPR_VTPM_DEVICE(obj) \
I think you can trim the _DEVICE.
> + OBJECT_CHECK(SPAPRvTPMState, (obj), TYPE_TPM_SPAPR)
> +
> +typedef struct vio_crq {
type definitions should always use CamelCase.
> + uint8_t valid; /* 0x80: cmd; 0xc0: init crq
> + 0x81-0x83: CRQ message response */
> + uint8_t msg; /* see below */
> + uint16_t len; /* len of TPM request; len of TPM response */
> + uint32_t data; /* rtce_dma_handle when sending TPM request */
> + uint64_t reserved;
> +} vio_crq;
> +
> +typedef union tpm_spapr_crq {
ditto.
> + vio_crq s;
> + uint8_t raw[sizeof(vio_crq)];
> +} tpm_spapr_crq;
> +
> +#define SPAPR_VTPM_VALID_INIT_CRQ_COMMAND 0xC0
> +#define SPAPR_VTPM_VALID_COMMAND 0x80
> +#define SPAPR_VTPM_MSG_RESULT 0x80
> +
> +/* msg types for valid = SPAPR_VTPM_VALID_INIT_CRQ */
> +#define SPAPR_VTPM_INIT_CRQ_RESULT 0x1
> +#define SPAPR_VTPM_INIT_CRQ_COMPLETE_RESULT 0x2
> +
> +/* msg types for valid = SPAPR_VTPM_VALID_CMD */
> +#define SPAPR_VTPM_GET_VERSION 0x1
> +#define SPAPR_VTPM_TPM_COMMAND 0x2
> +#define SPAPR_VTPM_GET_RTCE_BUFFER_SIZE 0x3
> +#define SPAPR_VTPM_PREPARE_TO_SUSPEND 0x4
> +
> +#define MAX_BUFFER_SIZE TARGET_PAGE_SIZE
> +
> +typedef struct {
> + VIOsPAPRDevice vdev;
> +
> + tpm_spapr_crq crq; /* track single TPM command */
> +
> + uint8_t state;
> +#define SPAPR_VTPM_STATE_NONE 0
> +#define SPAPR_VTPM_STATE_EXECUTION 1
> +#define SPAPR_VTPM_STATE_COMPLETION 2
> +
> + unsigned char buffer[MAX_BUFFER_SIZE];
> +
> + TPMBackendCmd cmd;
> +
> + TPMBackend *be_driver;
> + TPMVersion be_tpm_version;
> +
> + size_t be_buffer_size;
> +} SPAPRvTPMState;
> +
> +static void tpm_spapr_show_buffer(const unsigned char *buffer,
> + size_t buffer_len, const char *string)
> +{
> +#if DEBUG_SPAPR_VTPM
> + size_t i, len;
> +
> + len = MIN(tpm_cmd_get_size(buffer), buffer_len);
> + printf("spapr_vtpm: %s length = %zu\n", string, len);
> + for (i = 0; i < len; i++) {
> + if (i && !(i % 16)) {
> + printf("\n");
> + }
> + printf("%.2X ", buffer[i]);
> + }
> + printf("\n");
> +#endif
> +}
> +
> +/*
> + * Send a request to the TPM.
> + */
> +static void tpm_spapr_tpm_send(SPAPRvTPMState *s)
> +{
> + tpm_spapr_show_buffer(s->buffer, sizeof(s->buffer), "spapr_vtpm: Tx
> TPM");
> +
> + s->state = SPAPR_VTPM_STATE_EXECUTION;
> + s->cmd = (TPMBackendCmd) {
> + .locty = 0,
> + .in = s->buffer,
> + .in_len = MIN(tpm_cmd_get_size(s->buffer), sizeof(s->buffer)),
> + .out = s->buffer,
> + .out_len = sizeof(s->buffer),
> + };
> +
> + tpm_backend_deliver_request(s->be_driver, &s->cmd);
> +}
> +
> +static void tpm_spapr_got_payload(SPAPRvTPMState *s, tpm_spapr_crq *crq)
> +{
> + long rc;
> + DPRINTF("tpm_spapr_got_payload: crq->s.data = 0x%x crq->s.len = %d\n",
> + crq->s.data, crq->s.len);
> +
> + /* a max. of be_buffer_size bytes can be transported */
> + rc = spapr_vio_dma_read(&s->vdev, crq->s.data,
> + s->buffer, s->be_buffer_size);
> + if (rc) {
> + fprintf(stderr, "tpm_spapr_got_payload: DMA read failure !\n");
may be use error_report ? or error_setg()
> + }
> +
> + /* let vTPM handle any malformed request */
> + tpm_spapr_tpm_send(s);
why not return rc ? tpm_spapr_do_crq() is a VIO 'crq.SendFunc' handler
which returns hcall errors.
> +}
> +
> +static int tpm_spapr_do_crq(struct VIOsPAPRDevice *dev, uint8_t *crq_data)
> +{
> + SPAPRvTPMState *s = VIO_SPAPR_VTPM_DEVICE(dev);
> + tpm_spapr_crq local_crq;
> + tpm_spapr_crq *crq = &s->crq; /* requests only */
> +
> + memcpy(&local_crq.raw, crq_data, sizeof(local_crq.raw));
> +
> + DPRINTF("VTPM: do_crq %02x %02x ...\n",
> + local_crq.raw[0], local_crq.raw[1]);
> +
> + switch (local_crq.s.valid) {
> + case SPAPR_VTPM_VALID_INIT_CRQ_COMMAND: /* Init command/response */
> +
> + /* Respond to initialization request */
> + switch (local_crq.s.msg) {
> + case SPAPR_VTPM_INIT_CRQ_RESULT:
> + DPRINTF("vtpm_do_crq: SPAPR_VTPM_INIT_CRQ_RESULT\n");
> + memset(local_crq.raw, 0, sizeof(local_crq.raw));
> + local_crq.s.valid = SPAPR_VTPM_VALID_INIT_CRQ_COMMAND;
> + local_crq.s.msg = SPAPR_VTPM_INIT_CRQ_RESULT;
> + spapr_vio_send_crq(dev, local_crq.raw);
> + break;
> +
> + case SPAPR_VTPM_INIT_CRQ_COMPLETE_RESULT:
> + DPRINTF("vtpm_do_crq: SPAPR_VTPM_INIT_CRQ_COMP_RESULT\n");
> + memset(local_crq.raw, 0, sizeof(local_crq.raw));
> + local_crq.s.valid = SPAPR_VTPM_VALID_INIT_CRQ_COMMAND;
> + local_crq.s.msg = SPAPR_VTPM_INIT_CRQ_COMPLETE_RESULT;
> + spapr_vio_send_crq(dev, local_crq.raw);
> + break;
> + }
> +
> + break;
> + case SPAPR_VTPM_VALID_COMMAND: /* Payloads */
> + switch (local_crq.s.msg) {
> + case SPAPR_VTPM_TPM_COMMAND:
> + DPRINTF("vtpm_do_crq: got TPM command payload!\n");
> + if (s->state == SPAPR_VTPM_STATE_EXECUTION)
> + return H_BUSY;
> + /* this crq is tracked */
> + memcpy(crq->raw, crq_data, sizeof(crq->raw));
> + crq->s.valid = be16_to_cpu(0);
> + crq->s.len = be16_to_cpu(crq->s.len);
> + crq->s.data = be32_to_cpu(crq->s.data);
> + tpm_spapr_got_payload(s, crq);
> + break;
> +
> + case SPAPR_VTPM_GET_RTCE_BUFFER_SIZE:
> + DPRINTF("vtpm_do_crq: resp: buffer size is %zu\n",
> + s->be_buffer_size);
> + local_crq.s.msg |= SPAPR_VTPM_MSG_RESULT;
> + local_crq.s.len = cpu_to_be16(s->be_buffer_size);
> + spapr_vio_send_crq(dev, local_crq.raw);
> + break;
> +
> + case SPAPR_VTPM_GET_VERSION:
> + local_crq.s.msg |= SPAPR_VTPM_MSG_RESULT;
> + local_crq.s.len = cpu_to_be16(0);
> + switch (s->be_tpm_version) {
> + case TPM_VERSION_UNSPEC:
> + local_crq.s.data = cpu_to_be32(0);
> + break;
> + case TPM_VERSION_1_2:
> + local_crq.s.data = cpu_to_be32(1);
> + break;
> + case TPM_VERSION_2_0:
> + local_crq.s.data = cpu_to_be32(2);
> + break;
> + }
> + DPRINTF("vtpm_do_crq: resp: version %u\n",
> + local_crq.s.data);
> + spapr_vio_send_crq(dev, local_crq.raw);
> + break;
> +
> + case SPAPR_VTPM_PREPARE_TO_SUSPEND:
> + DPRINTF("vtpm_do_crq: resp: prep to suspend\n");
> + local_crq.s.msg |= SPAPR_VTPM_MSG_RESULT;
> + spapr_vio_send_crq(dev, local_crq.raw);
> + break;
> +
> + default:
> + DPRINTF("vtpm_do_crq: Unknown message type %02x\n",
> + crq->s.msg);
> + }
> + break;
> + default:
> + DPRINTF("vtpm_do_crq: unknown CRQ %02x %02x ...\n",
> + local_crq.raw[0], local_crq.raw[1]);
> + };
> +
> + return 0;
shouldn't it be H_SUCCESS.
> +}
> +
> +static void tpm_spapr_request_completed(TPMIf *ti)
> +{
> + SPAPRvTPMState *s = VIO_SPAPR_VTPM_DEVICE(ti);
> + tpm_spapr_crq *crq = &s->crq;
> + uint32_t len;
> + int rc;
> +
> + tpm_spapr_show_buffer(s->buffer, sizeof(s->buffer), "spapr_vtpm: Rx
> TPM");
> +
> + s->state = SPAPR_VTPM_STATE_COMPLETION;
> +
> + /* a max. of be_buffer_size bytes can be transported */
> + len = MIN(tpm_cmd_get_size(s->buffer), s->be_buffer_size);
> + rc = spapr_vio_dma_write(&s->vdev, crq->s.data, s->buffer, len);
> +
> + crq->s.valid = SPAPR_VTPM_MSG_RESULT;
> + crq->s.msg = SPAPR_VTPM_TPM_COMMAND | SPAPR_VTPM_MSG_RESULT;
> + crq->s.len = cpu_to_be16(len);
> + crq->s.data = cpu_to_be32(crq->s.data);
> +
> + if (rc == 0) {
> + rc = spapr_vio_send_crq(&s->vdev, crq->raw);
> + if (rc) {
> + DPRINTF("%s: Error sending response\n", __func__);
> + }
> + } else {
> + DPRINTF("%s: Error with DMA write\n", __func__);
> + }
These DPRINTF look like errors to me.
> +}
> +
> +static int tpm_spapr_do_startup_tpm(SPAPRvTPMState *s, size_t buffersize)
> +{
> + return tpm_backend_startup_tpm(s->be_driver, buffersize);
> +}
> +
> +static void tpm_spapr_reset(VIOsPAPRDevice *dev)
> +{
> + SPAPRvTPMState *s = VIO_SPAPR_VTPM_DEVICE(dev);
> +
> + s->state = SPAPR_VTPM_STATE_NONE;
> +
> + s->be_tpm_version = tpm_backend_get_tpm_version(s->be_driver);
> +
> + s->be_buffer_size =
> MAX(ROUND_UP(tpm_backend_get_buffer_size(s->be_driver),
> + TARGET_PAGE_SIZE),
> + sizeof(s->buffer));
> +
> + tpm_backend_reset(s->be_driver);
> + tpm_spapr_do_startup_tpm(s, s->be_buffer_size);
> +}
> +
> +static enum TPMVersion tpm_spapr_get_version(TPMIf *ti)
> +{
> + SPAPRvTPMState *s = VIO_SPAPR_VTPM_DEVICE(ti);
> +
> + if (tpm_backend_had_startup_error(s->be_driver)) {
> + return TPM_VERSION_UNSPEC;
> + }
> +
> + return tpm_backend_get_tpm_version(s->be_driver);
> +}
> +
> +static const VMStateDescription vmstate_spapr_vtpm = {
> + .name = "tpm_spapr",
> + .unmigratable = 1,
> +};
> +
> +static Property tpm_spapr_properties[] = {
> + DEFINE_SPAPR_PROPERTIES(SPAPRvTPMState, vdev),
> + DEFINE_PROP_TPMBE("tpmdev", SPAPRvTPMState, be_driver),
> + DEFINE_PROP_END_OF_LIST(),
> +};
> +
> +static void tpm_spapr_realizefn(VIOsPAPRDevice *dev, Error **errp)
> +{
> + SPAPRvTPMState *s = VIO_SPAPR_VTPM_DEVICE(dev);
> +
> + if (!tpm_find()) {
> + error_setg(errp, "at most one TPM device is permitted");
> + return;
> + }
>
tpm_find() does not exist anymore. It was replaced by tpm_get_version()
AFAICT in commit 5cb18b3d7bff.
> + dev->crq.SendFunc = tpm_spapr_do_crq;
> +
> + if (!s->be_driver) {
> + error_setg(errp, "'tpmdev' property is required");
> + return;
> + }
> +
> +}
> +
> +static void tpm_spapr_class_init(ObjectClass *klass, void *data)
> +{
> + DeviceClass *dc = DEVICE_CLASS(klass);
> + VIOsPAPRDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
> + TPMIfClass *tc = TPM_IF_CLASS(klass);
> +
> + k->realize = tpm_spapr_realizefn;
> + k->reset = tpm_spapr_reset;
> + //k->devnode = tpm_spapr_devnode;
> + k->dt_name = "vtpm";
> + k->dt_type = "IBM,vtpm";
> + k->dt_compatible = "IBM,vtpm";
> + k->signal_mask = 0x00000001;
> + set_bit(DEVICE_CATEGORY_MISC, dc->categories);
> + dc->props = tpm_spapr_properties;
> + k->rtce_window_size = 0x10000000;
> + dc->vmsd = &vmstate_spapr_vtpm;
> +
> + tc->model = TPM_MODEL_TPM_SPAPR;
> + tc->get_version = tpm_spapr_get_version;
> + tc->request_completed = tpm_spapr_request_completed;
> +}
> +
> +static const TypeInfo tpm_spapr_info = {
> + .name = TYPE_TPM_SPAPR,
> + .parent = TYPE_VIO_SPAPR_DEVICE,
> + .instance_size = sizeof(SPAPRvTPMState),
> + .class_init = tpm_spapr_class_init,
> + .interfaces = (InterfaceInfo[]) {
> + { TYPE_TPM_IF },
> + { }
> + }
> +};
> +
> +static void tpm_spapr_register_types(void)
> +{
> + type_register_static(&tpm_spapr_info);
> +}
> +
> +type_init(tpm_spapr_register_types)
> diff --git a/include/sysemu/tpm.h b/include/sysemu/tpm.h
> index 852e026..afefadd 100644
> --- a/include/sysemu/tpm.h
> +++ b/include/sysemu/tpm.h
> @@ -46,9 +46,12 @@ typedef struct TPMIfClass {
> } TPMIfClass;
>
> #define TYPE_TPM_TIS "tpm-tis"
> +#define TYPE_TPM_SPAPR "tpm-spapr"
>
> #define TPM_IS_TIS(chr) \
> object_dynamic_cast(OBJECT(chr), TYPE_TPM_TIS)
> +#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)
> diff --git a/qapi/tpm.json b/qapi/tpm.json
> index 7093f26..dfa6a32 100644
> --- a/qapi/tpm.json
> +++ b/qapi/tpm.json
> @@ -11,10 +11,11 @@
> # An enumeration of TPM models
> #
> # @tpm-tis: TPM TIS model
> +# @tpm-spapr: TPM PAPR model (since 2.12)
> #
> # Since: 1.5
> ##
> -{ 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
> +{ 'enum': 'TpmModel', 'data': [ 'tpm-tis', 'tpm-spapr' ] }
>
> ##
> # @query-tpm-models:
> @@ -28,7 +29,7 @@
> # Example:
> #
> # -> { "execute": "query-tpm-models" }
> -# <- { "return": [ "tpm-tis" ] }
> +# <- { "return": [ "tpm-tis", "tpm-spapr" ] }
> #
> ##
> { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
>
