disas: Remove old libopcode arm disassembler
[qemu.git] / qapi / misc-target.json
blobed4a468aab9894bfb59c9ca880bbfa634e415927
1 # -*- Mode: Python -*-
2 # vim: filetype=python
5 ##
6 # @rtc-reset-reinjection:
8 # This command will reset the RTC interrupt reinjection backlog.
9 # Can be used if another mechanism to synchronize guest time
10 # is in effect, for example QEMU guest agent's guest-set-time
11 # command.
13 # Since: 2.1
15 # Example:
17 # -> { "execute": "rtc-reset-reinjection" }
18 # <- { "return": {} }
21 { 'command': 'rtc-reset-reinjection',
22   'if': 'TARGET_I386' }
26 # @SevState:
28 # An enumeration of SEV state information used during @query-sev.
30 # @uninit: The guest is uninitialized.
32 # @launch-update: The guest is currently being launched; plaintext data and
33 #                 register state is being imported.
35 # @launch-secret: The guest is currently being launched; ciphertext data
36 #                 is being imported.
38 # @running: The guest is fully launched or migrated in.
40 # @send-update: The guest is currently being migrated out to another machine.
42 # @receive-update: The guest is currently being migrated from another machine.
44 # Since: 2.12
46 { 'enum': 'SevState',
47   'data': ['uninit', 'launch-update', 'launch-secret', 'running',
48            'send-update', 'receive-update' ],
49   'if': 'TARGET_I386' }
52 # @SevInfo:
54 # Information about Secure Encrypted Virtualization (SEV) support
56 # @enabled: true if SEV is active
58 # @api-major: SEV API major version
60 # @api-minor: SEV API minor version
62 # @build-id: SEV FW build id
64 # @policy: SEV policy value
66 # @state: SEV guest state
68 # @handle: SEV firmware handle
70 # Since: 2.12
72 { 'struct': 'SevInfo',
73     'data': { 'enabled': 'bool',
74               'api-major': 'uint8',
75               'api-minor' : 'uint8',
76               'build-id' : 'uint8',
77               'policy' : 'uint32',
78               'state' : 'SevState',
79               'handle' : 'uint32'
80             },
81   'if': 'TARGET_I386'
85 # @query-sev:
87 # Returns information about SEV
89 # Returns: @SevInfo
91 # Since: 2.12
93 # Example:
95 # -> { "execute": "query-sev" }
96 # <- { "return": { "enabled": true, "api-major" : 0, "api-minor" : 0,
97 #                  "build-id" : 0, "policy" : 0, "state" : "running",
98 #                  "handle" : 1 } }
101 { 'command': 'query-sev', 'returns': 'SevInfo',
102   'if': 'TARGET_I386' }
106 # @SevLaunchMeasureInfo:
108 # SEV Guest Launch measurement information
110 # @data: the measurement value encoded in base64
112 # Since: 2.12
115 { 'struct': 'SevLaunchMeasureInfo', 'data': {'data': 'str'},
116   'if': 'TARGET_I386' }
119 # @query-sev-launch-measure:
121 # Query the SEV guest launch information.
123 # Returns: The @SevLaunchMeasureInfo for the guest
125 # Since: 2.12
127 # Example:
129 # -> { "execute": "query-sev-launch-measure" }
130 # <- { "return": { "data": "4l8LXeNlSPUDlXPJG5966/8%YZ" } }
133 { 'command': 'query-sev-launch-measure', 'returns': 'SevLaunchMeasureInfo',
134   'if': 'TARGET_I386' }
138 # @SevCapability:
140 # The struct describes capability for a Secure Encrypted Virtualization
141 # feature.
143 # @pdh:  Platform Diffie-Hellman key (base64 encoded)
145 # @cert-chain:  PDH certificate chain (base64 encoded)
147 # @cpu0-id: Unique ID of CPU0 (base64 encoded) (since 7.1)
149 # @cbitpos: C-bit location in page table entry
151 # @reduced-phys-bits: Number of physical Address bit reduction when SEV is
152 #                     enabled
154 # Since: 2.12
156 { 'struct': 'SevCapability',
157   'data': { 'pdh': 'str',
158             'cert-chain': 'str',
159             'cpu0-id': 'str',
160             'cbitpos': 'int',
161             'reduced-phys-bits': 'int'},
162   'if': 'TARGET_I386' }
165 # @query-sev-capabilities:
167 # This command is used to get the SEV capabilities, and is supported on AMD
168 # X86 platforms only.
170 # Returns: SevCapability objects.
172 # Since: 2.12
174 # Example:
176 # -> { "execute": "query-sev-capabilities" }
177 # <- { "return": { "pdh": "8CCDD8DDD", "cert-chain": "888CCCDDDEE",
178 #                  "cpu0-id": "2lvmGwo+...61iEinw==",
179 #                  "cbitpos": 47, "reduced-phys-bits": 5}}
182 { 'command': 'query-sev-capabilities', 'returns': 'SevCapability',
183   'if': 'TARGET_I386' }
186 # @sev-inject-launch-secret:
188 # This command injects a secret blob into memory of SEV guest.
190 # @packet-header: the launch secret packet header encoded in base64
192 # @secret: the launch secret data to be injected encoded in base64
194 # @gpa: the guest physical address where secret will be injected.
196 # Since: 6.0
199 { 'command': 'sev-inject-launch-secret',
200   'data': { 'packet-header': 'str', 'secret': 'str', '*gpa': 'uint64' },
201   'if': 'TARGET_I386' }
204 # @SevAttestationReport:
206 # The struct describes attestation report for a Secure Encrypted
207 # Virtualization feature.
209 # @data:  guest attestation report (base64 encoded)
212 # Since: 6.1
214 { 'struct': 'SevAttestationReport',
215   'data': { 'data': 'str'},
216   'if': 'TARGET_I386' }
219 # @query-sev-attestation-report:
221 # This command is used to get the SEV attestation report, and is
222 # supported on AMD X86 platforms only.
224 # @mnonce: a random 16 bytes value encoded in base64 (it will be
225 #          included in report)
227 # Returns: SevAttestationReport objects.
229 # Since: 6.1
231 # Example:
233 # -> { "execute" : "query-sev-attestation-report",
234 #                  "arguments": { "mnonce": "aaaaaaa" } }
235 # <- { "return" : { "data": "aaaaaaaabbbddddd"} }
238 { 'command': 'query-sev-attestation-report',
239   'data': { 'mnonce': 'str' },
240   'returns': 'SevAttestationReport',
241   'if': 'TARGET_I386' }
244 # @dump-skeys:
246 # Dump guest's storage keys
248 # @filename: the path to the file to dump to
250 # This command is only supported on s390 architecture.
252 # Since: 2.5
254 # Example:
256 # -> { "execute": "dump-skeys",
257 #      "arguments": { "filename": "/tmp/skeys" } }
258 # <- { "return": {} }
261 { 'command': 'dump-skeys',
262   'data': { 'filename': 'str' },
263   'if': 'TARGET_S390X' }
266 # @GICCapability:
268 # The struct describes capability for a specific GIC (Generic
269 # Interrupt Controller) version. These bits are not only decided by
270 # QEMU/KVM software version, but also decided by the hardware that
271 # the program is running upon.
273 # @version: version of GIC to be described. Currently, only 2 and 3
274 #           are supported.
276 # @emulated: whether current QEMU/hardware supports emulated GIC
277 #            device in user space.
279 # @kernel: whether current QEMU/hardware supports hardware
280 #          accelerated GIC device in kernel.
282 # Since: 2.6
284 { 'struct': 'GICCapability',
285   'data': { 'version': 'int',
286             'emulated': 'bool',
287             'kernel': 'bool' },
288   'if': 'TARGET_ARM' }
291 # @query-gic-capabilities:
293 # This command is ARM-only. It will return a list of GICCapability
294 # objects that describe its capability bits.
296 # Returns: a list of GICCapability objects.
298 # Since: 2.6
300 # Example:
302 # -> { "execute": "query-gic-capabilities" }
303 # <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
304 #                 { "version": 3, "emulated": false, "kernel": true } ] }
307 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'],
308   'if': 'TARGET_ARM' }
312 # @SGXEPCSection:
314 # Information about intel SGX EPC section info
316 # @node: the numa node
318 # @size: the size of EPC section
320 # Since: 7.0
322 { 'struct': 'SGXEPCSection',
323   'data': { 'node': 'int',
324             'size': 'uint64'}}
327 # @SGXInfo:
329 # Information about intel Safe Guard eXtension (SGX) support
331 # @sgx: true if SGX is supported
333 # @sgx1: true if SGX1 is supported
335 # @sgx2: true if SGX2 is supported
337 # @flc: true if FLC is supported
339 # @section-size: The EPC section size for guest
340 #                Redundant with @sections.  Just for backward compatibility.
342 # @sections: The EPC sections info for guest (Since: 7.0)
344 # Features:
345 # @deprecated: Member @section-size is deprecated.  Use @sections instead.
347 # Since: 6.2
349 { 'struct': 'SGXInfo',
350   'data': { 'sgx': 'bool',
351             'sgx1': 'bool',
352             'sgx2': 'bool',
353             'flc': 'bool',
354             'section-size': { 'type': 'uint64',
355                     'features': [ 'deprecated' ] },
356             'sections': ['SGXEPCSection']},
357    'if': 'TARGET_I386' }
360 # @query-sgx:
362 # Returns information about SGX
364 # Returns: @SGXInfo
366 # Since: 6.2
368 # Example:
370 # -> { "execute": "query-sgx" }
371 # <- { "return": { "sgx": true, "sgx1" : true, "sgx2" : true,
372 #                  "flc": true,  "section-size" : 96468992,
373 #                  "sections": [{"node": 0, "size": 67108864},
374 #                  {"node": 1, "size": 29360128}]} }
377 { 'command': 'query-sgx', 'returns': 'SGXInfo', 'if': 'TARGET_I386' }
380 # @query-sgx-capabilities:
382 # Returns information from host SGX capabilities
384 # Returns: @SGXInfo
386 # Since: 6.2
388 # Example:
390 # -> { "execute": "query-sgx-capabilities" }
391 # <- { "return": { "sgx": true, "sgx1" : true, "sgx2" : true,
392 #                  "flc": true, "section-size" : 96468992,
393 #                  "section" : [{"node": 0, "size": 67108864},
394 #                  {"node": 1, "size": 29360128}]} }
397 { 'command': 'query-sgx-capabilities', 'returns': 'SGXInfo', 'if': 'TARGET_I386' }