tests/avocado/boot_linux_console.py: Add Rpi4b boot tests
[qemu/kevin.git] / qapi / misc-target.json
blob542a3e42f242f4ec80e306f6cc8a24c44ea7f718
1 # -*- Mode: Python -*-
2 # vim: filetype=python
5 ##
6 # @rtc-reset-reinjection:
8 # This command will reset the RTC interrupt reinjection backlog.  Can
9 # be used if another mechanism to synchronize guest time is in effect,
10 # for example QEMU guest agent's guest-set-time command.
12 # Since: 2.1
14 # Example:
16 #     -> { "execute": "rtc-reset-reinjection" }
17 #     <- { "return": {} }
19 { 'command': 'rtc-reset-reinjection',
20   'if': 'TARGET_I386' }
23 # @SevState:
25 # An enumeration of SEV state information used during @query-sev.
27 # @uninit: The guest is uninitialized.
29 # @launch-update: The guest is currently being launched; plaintext
30 #     data and register state is being imported.
32 # @launch-secret: The guest is currently being launched; ciphertext
33 #     data is being imported.
35 # @running: The guest is fully launched or migrated in.
37 # @send-update: The guest is currently being migrated out to another
38 #     machine.
40 # @receive-update: The guest is currently being migrated from another
41 #     machine.
43 # Since: 2.12
45 { 'enum': 'SevState',
46   'data': ['uninit', 'launch-update', 'launch-secret', 'running',
47            'send-update', 'receive-update' ],
48   'if': 'TARGET_I386' }
51 # @SevInfo:
53 # Information about Secure Encrypted Virtualization (SEV) support
55 # @enabled: true if SEV is active
57 # @api-major: SEV API major version
59 # @api-minor: SEV API minor version
61 # @build-id: SEV FW build id
63 # @policy: SEV policy value
65 # @state: SEV guest state
67 # @handle: SEV firmware handle
69 # Since: 2.12
71 { 'struct': 'SevInfo',
72     'data': { 'enabled': 'bool',
73               'api-major': 'uint8',
74               'api-minor' : 'uint8',
75               'build-id' : 'uint8',
76               'policy' : 'uint32',
77               'state' : 'SevState',
78               'handle' : 'uint32'
79             },
80   'if': 'TARGET_I386'
84 # @query-sev:
86 # Returns information about SEV
88 # Returns: @SevInfo
90 # Since: 2.12
92 # Example:
94 #     -> { "execute": "query-sev" }
95 #     <- { "return": { "enabled": true, "api-major" : 0, "api-minor" : 0,
96 #                      "build-id" : 0, "policy" : 0, "state" : "running",
97 #                      "handle" : 1 } }
99 { 'command': 'query-sev', 'returns': 'SevInfo',
100   'if': 'TARGET_I386' }
103 # @SevLaunchMeasureInfo:
105 # SEV Guest Launch measurement information
107 # @data: the measurement value encoded in base64
109 # Since: 2.12
111 { 'struct': 'SevLaunchMeasureInfo', 'data': {'data': 'str'},
112   'if': 'TARGET_I386' }
115 # @query-sev-launch-measure:
117 # Query the SEV guest launch information.
119 # Returns: The @SevLaunchMeasureInfo for the guest
121 # Since: 2.12
123 # Example:
125 #     -> { "execute": "query-sev-launch-measure" }
126 #     <- { "return": { "data": "4l8LXeNlSPUDlXPJG5966/8%YZ" } }
128 { 'command': 'query-sev-launch-measure', 'returns': 'SevLaunchMeasureInfo',
129   'if': 'TARGET_I386' }
132 # @SevCapability:
134 # The struct describes capability for a Secure Encrypted
135 # Virtualization feature.
137 # @pdh: Platform Diffie-Hellman key (base64 encoded)
139 # @cert-chain: PDH certificate chain (base64 encoded)
141 # @cpu0-id: Unique ID of CPU0 (base64 encoded) (since 7.1)
143 # @cbitpos: C-bit location in page table entry
145 # @reduced-phys-bits: Number of physical Address bit reduction when
146 #     SEV is enabled
148 # Since: 2.12
150 { 'struct': 'SevCapability',
151   'data': { 'pdh': 'str',
152             'cert-chain': 'str',
153             'cpu0-id': 'str',
154             'cbitpos': 'int',
155             'reduced-phys-bits': 'int'},
156   'if': 'TARGET_I386' }
159 # @query-sev-capabilities:
161 # This command is used to get the SEV capabilities, and is supported
162 # on AMD X86 platforms only.
164 # Returns: SevCapability objects.
166 # Since: 2.12
168 # Example:
170 #     -> { "execute": "query-sev-capabilities" }
171 #     <- { "return": { "pdh": "8CCDD8DDD", "cert-chain": "888CCCDDDEE",
172 #                      "cpu0-id": "2lvmGwo+...61iEinw==",
173 #                      "cbitpos": 47, "reduced-phys-bits": 1}}
175 { 'command': 'query-sev-capabilities', 'returns': 'SevCapability',
176   'if': 'TARGET_I386' }
179 # @sev-inject-launch-secret:
181 # This command injects a secret blob into memory of SEV guest.
183 # @packet-header: the launch secret packet header encoded in base64
185 # @secret: the launch secret data to be injected encoded in base64
187 # @gpa: the guest physical address where secret will be injected.
189 # Since: 6.0
191 { 'command': 'sev-inject-launch-secret',
192   'data': { 'packet-header': 'str', 'secret': 'str', '*gpa': 'uint64' },
193   'if': 'TARGET_I386' }
196 # @SevAttestationReport:
198 # The struct describes attestation report for a Secure Encrypted
199 # Virtualization feature.
201 # @data: guest attestation report (base64 encoded)
203 # Since: 6.1
205 { 'struct': 'SevAttestationReport',
206   'data': { 'data': 'str'},
207   'if': 'TARGET_I386' }
210 # @query-sev-attestation-report:
212 # This command is used to get the SEV attestation report, and is
213 # supported on AMD X86 platforms only.
215 # @mnonce: a random 16 bytes value encoded in base64 (it will be
216 #     included in report)
218 # Returns: SevAttestationReport objects.
220 # Since: 6.1
222 # Example:
224 #     -> { "execute" : "query-sev-attestation-report",
225 #                      "arguments": { "mnonce": "aaaaaaa" } }
226 #     <- { "return" : { "data": "aaaaaaaabbbddddd"} }
228 { 'command': 'query-sev-attestation-report',
229   'data': { 'mnonce': 'str' },
230   'returns': 'SevAttestationReport',
231   'if': 'TARGET_I386' }
234 # @dump-skeys:
236 # Dump guest's storage keys
238 # @filename: the path to the file to dump to
240 # Since: 2.5
242 # Example:
244 #     -> { "execute": "dump-skeys",
245 #          "arguments": { "filename": "/tmp/skeys" } }
246 #     <- { "return": {} }
248 { 'command': 'dump-skeys',
249   'data': { 'filename': 'str' },
250   'if': 'TARGET_S390X' }
253 # @GICCapability:
255 # The struct describes capability for a specific GIC (Generic
256 # Interrupt Controller) version.  These bits are not only decided by
257 # QEMU/KVM software version, but also decided by the hardware that the
258 # program is running upon.
260 # @version: version of GIC to be described.  Currently, only 2 and 3
261 #     are supported.
263 # @emulated: whether current QEMU/hardware supports emulated GIC
264 #     device in user space.
266 # @kernel: whether current QEMU/hardware supports hardware accelerated
267 #     GIC device in kernel.
269 # Since: 2.6
271 { 'struct': 'GICCapability',
272   'data': { 'version': 'int',
273             'emulated': 'bool',
274             'kernel': 'bool' },
275   'if': 'TARGET_ARM' }
278 # @query-gic-capabilities:
280 # This command is ARM-only.  It will return a list of GICCapability
281 # objects that describe its capability bits.
283 # Returns: a list of GICCapability objects.
285 # Since: 2.6
287 # Example:
289 #     -> { "execute": "query-gic-capabilities" }
290 #     <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
291 #                     { "version": 3, "emulated": false, "kernel": true } ] }
293 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'],
294   'if': 'TARGET_ARM' }
297 # @SGXEPCSection:
299 # Information about intel SGX EPC section info
301 # @node: the numa node
303 # @size: the size of EPC section
305 # Since: 7.0
307 { 'struct': 'SGXEPCSection',
308   'data': { 'node': 'int',
309             'size': 'uint64'}}
312 # @SGXInfo:
314 # Information about intel Safe Guard eXtension (SGX) support
316 # @sgx: true if SGX is supported
318 # @sgx1: true if SGX1 is supported
320 # @sgx2: true if SGX2 is supported
322 # @flc: true if FLC is supported
324 # @sections: The EPC sections info for guest (Since: 7.0)
326 # Since: 6.2
328 { 'struct': 'SGXInfo',
329   'data': { 'sgx': 'bool',
330             'sgx1': 'bool',
331             'sgx2': 'bool',
332             'flc': 'bool',
333             'sections': ['SGXEPCSection']},
334    'if': 'TARGET_I386' }
337 # @query-sgx:
339 # Returns information about SGX
341 # Returns: @SGXInfo
343 # Since: 6.2
345 # Example:
347 #     -> { "execute": "query-sgx" }
348 #     <- { "return": { "sgx": true, "sgx1" : true, "sgx2" : true,
349 #                      "flc": true,
350 #                      "sections": [{"node": 0, "size": 67108864},
351 #                      {"node": 1, "size": 29360128}]} }
353 { 'command': 'query-sgx', 'returns': 'SGXInfo', 'if': 'TARGET_I386' }
356 # @query-sgx-capabilities:
358 # Returns information from host SGX capabilities
360 # Returns: @SGXInfo
362 # Since: 6.2
364 # Example:
366 #     -> { "execute": "query-sgx-capabilities" }
367 #     <- { "return": { "sgx": true, "sgx1" : true, "sgx2" : true,
368 #                      "flc": true,
369 #                      "section" : [{"node": 0, "size": 67108864},
370 #                      {"node": 1, "size": 29360128}]} }
372 { 'command': 'query-sgx-capabilities', 'returns': 'SGXInfo', 'if': 'TARGET_I386' }
376 # @EvtchnPortType:
378 # An enumeration of Xen event channel port types.
380 # @closed: The port is unused.
382 # @unbound: The port is allocated and ready to be bound.
384 # @interdomain: The port is connected as an interdomain interrupt.
386 # @pirq: The port is bound to a physical IRQ (PIRQ).
388 # @virq: The port is bound to a virtual IRQ (VIRQ).
390 # @ipi: The post is an inter-processor interrupt (IPI).
392 # Since: 8.0
394 { 'enum': 'EvtchnPortType',
395   'data': ['closed', 'unbound', 'interdomain', 'pirq', 'virq', 'ipi'],
396   'if': 'TARGET_I386' }
399 # @EvtchnInfo:
401 # Information about a Xen event channel port
403 # @port: the port number
405 # @vcpu: target vCPU for this port
407 # @type: the port type
409 # @remote-domain: remote domain for interdomain ports
411 # @target: remote port ID, or virq/pirq number
413 # @pending: port is currently active pending delivery
415 # @masked: port is masked
417 # Since: 8.0
419 { 'struct': 'EvtchnInfo',
420   'data': {'port': 'uint16',
421            'vcpu': 'uint32',
422            'type': 'EvtchnPortType',
423            'remote-domain': 'str',
424            'target': 'uint16',
425            'pending': 'bool',
426            'masked': 'bool'},
427   'if': 'TARGET_I386' }
431 # @xen-event-list:
433 # Query the Xen event channels opened by the guest.
435 # Returns: list of open event channel ports.
437 # Since: 8.0
439 # Example:
441 #     -> { "execute": "xen-event-list" }
442 #     <- { "return": [
443 #             {
444 #                 "pending": false,
445 #                 "port": 1,
446 #                 "vcpu": 1,
447 #                 "remote-domain": "qemu",
448 #                 "masked": false,
449 #                 "type": "interdomain",
450 #                 "target": 1
451 #             },
452 #             {
453 #                 "pending": false,
454 #                 "port": 2,
455 #                 "vcpu": 0,
456 #                 "remote-domain": "",
457 #                 "masked": false,
458 #                 "type": "virq",
459 #                 "target": 0
460 #             }
461 #          ]
462 #        }
464 { 'command': 'xen-event-list',
465   'returns': ['EvtchnInfo'],
466   'if': 'TARGET_I386' }
469 # @xen-event-inject:
471 # Inject a Xen event channel port (interrupt) to the guest.
473 # @port: The port number
475 # Returns:
476 #     - Nothing on success.
478 # Since: 8.0
480 # Example:
482 #     -> { "execute": "xen-event-inject", "arguments": { "port": 1 } }
483 #     <- { "return": { } }
485 { 'command': 'xen-event-inject',
486   'data': { 'port': 'uint32' },
487   'if': 'TARGET_I386' }