4622c70689
In the QEMU QMP Reference Manual, subsection "Block core (VM unrelated)" is empty. Its contents is at the end of subsection "Background jobs" instead. That's because qapi/job.json is included first from qapi/block-core.json, which makes qapi/job.json's documentation go between qapi/block-core.json's subsection heading and contents. In the QEMU Storage Daemon QMP Reference Manual, section "Block Devices" contains nothing but an empty subsection "Block core (VM unrelated)". The latter's contents is at the end section "Socket data types", along with subsection "Block device exports". Subsection "Background jobs" is at the end of section "Cryptography". All this is because storage-daemon/qapi/qapi-schema.json includes modules in a confused order. Fix both as follows. Turn subsection "Background jobs" into a section. Move it before section "Block devices" in the QEMU QMP Reference Manual, by including qapi/jobs.json right before qapi/block.json. Reorder include directives in storage-daemon/qapi/qapi-schema.json to match the order in qapi/qapi-schema.json, so that the QEMU Storage Daemon QMP Reference Manual's section structure the QEMU QMP Reference Manual's. In the QEMU QMP Reference Manual, qapi/cryptodev.json's documentation is at the end of section "Virtio devices". That's because it lacks a section heading, and therefore gets squashed into whatever section happens to precede it. Add section heading so it's in section "Cryptography devices". Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Acked-by: zhenwei pi <pizhenwei@bytedance.com> Message-Id: <20230425064223.820979-17-armbru@redhat.com>
94 lines
1.9 KiB
Python
94 lines
1.9 KiB
Python
# -*- Mode: Python -*-
|
|
# vim: filetype=python
|
|
#
|
|
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
# See the COPYING file in the top-level directory.
|
|
|
|
##
|
|
# = Cryptography devices
|
|
##
|
|
|
|
##
|
|
# @QCryptodevBackendAlgType:
|
|
#
|
|
# The supported algorithm types of a crypto device.
|
|
#
|
|
# @sym: symmetric encryption
|
|
# @asym: asymmetric Encryption
|
|
#
|
|
# Since: 8.0
|
|
##
|
|
{ 'enum': 'QCryptodevBackendAlgType',
|
|
'prefix': 'QCRYPTODEV_BACKEND_ALG',
|
|
'data': ['sym', 'asym']}
|
|
|
|
##
|
|
# @QCryptodevBackendServiceType:
|
|
#
|
|
# The supported service types of a crypto device.
|
|
#
|
|
# Since: 8.0
|
|
##
|
|
{ 'enum': 'QCryptodevBackendServiceType',
|
|
'prefix': 'QCRYPTODEV_BACKEND_SERVICE',
|
|
'data': ['cipher', 'hash', 'mac', 'aead', 'akcipher']}
|
|
|
|
##
|
|
# @QCryptodevBackendType:
|
|
#
|
|
# The crypto device backend type
|
|
#
|
|
# @builtin: the QEMU builtin support
|
|
# @vhost-user: vhost-user
|
|
# @lkcf: Linux kernel cryptographic framework
|
|
#
|
|
# Since: 8.0
|
|
##
|
|
{ 'enum': 'QCryptodevBackendType',
|
|
'prefix': 'QCRYPTODEV_BACKEND_TYPE',
|
|
'data': ['builtin', 'vhost-user', 'lkcf']}
|
|
|
|
##
|
|
# @QCryptodevBackendClient:
|
|
#
|
|
# Information about a queue of crypto device.
|
|
#
|
|
# @queue: the queue index of the crypto device
|
|
#
|
|
# @type: the type of the crypto device
|
|
#
|
|
# Since: 8.0
|
|
##
|
|
{ 'struct': 'QCryptodevBackendClient',
|
|
'data': { 'queue': 'uint32',
|
|
'type': 'QCryptodevBackendType' } }
|
|
|
|
##
|
|
# @QCryptodevInfo:
|
|
#
|
|
# Information about a crypto device.
|
|
#
|
|
# @id: the id of the crypto device
|
|
#
|
|
# @service: supported service types of a crypto device
|
|
#
|
|
# @client: the additional infomation of the crypto device
|
|
#
|
|
# Since: 8.0
|
|
##
|
|
{ 'struct': 'QCryptodevInfo',
|
|
'data': { 'id': 'str',
|
|
'service': ['QCryptodevBackendServiceType'],
|
|
'client': ['QCryptodevBackendClient'] } }
|
|
|
|
##
|
|
# @query-cryptodev:
|
|
#
|
|
# Returns information about current crypto devices.
|
|
#
|
|
# Returns: a list of @QCryptodevInfo
|
|
#
|
|
# Since: 8.0
|
|
##
|
|
{ 'command': 'query-cryptodev', 'returns': ['QCryptodevInfo']}
|