qtest: Bump npcm7xx_watchdog_timer-test timeout to 2 minutes
[qemu/ar7.git] / qapi / misc-target.json
blob88291453ba476a26a4b5583f79a553857aa061f5
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 # This command is only supported on s390 architecture.
242 # Since: 2.5
244 # Example:
246 # -> { "execute": "dump-skeys",
247 #      "arguments": { "filename": "/tmp/skeys" } }
248 # <- { "return": {} }
250 { 'command': 'dump-skeys',
251   'data': { 'filename': 'str' },
252   'if': 'TARGET_S390X' }
255 # @GICCapability:
257 # The struct describes capability for a specific GIC (Generic
258 # Interrupt Controller) version.  These bits are not only decided by
259 # QEMU/KVM software version, but also decided by the hardware that the
260 # program is running upon.
262 # @version: version of GIC to be described.  Currently, only 2 and 3
263 #     are supported.
265 # @emulated: whether current QEMU/hardware supports emulated GIC
266 #     device in user space.
268 # @kernel: whether current QEMU/hardware supports hardware accelerated
269 #     GIC device in kernel.
271 # Since: 2.6
273 { 'struct': 'GICCapability',
274   'data': { 'version': 'int',
275             'emulated': 'bool',
276             'kernel': 'bool' },
277   'if': 'TARGET_ARM' }
280 # @query-gic-capabilities:
282 # This command is ARM-only.  It will return a list of GICCapability
283 # objects that describe its capability bits.
285 # Returns: a list of GICCapability objects.
287 # Since: 2.6
289 # Example:
291 # -> { "execute": "query-gic-capabilities" }
292 # <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
293 #                 { "version": 3, "emulated": false, "kernel": true } ] }
295 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'],
296   'if': 'TARGET_ARM' }
299 # @SGXEPCSection:
301 # Information about intel SGX EPC section info
303 # @node: the numa node
305 # @size: the size of EPC section
307 # Since: 7.0
309 { 'struct': 'SGXEPCSection',
310   'data': { 'node': 'int',
311             'size': 'uint64'}}
314 # @SGXInfo:
316 # Information about intel Safe Guard eXtension (SGX) support
318 # @sgx: true if SGX is supported
320 # @sgx1: true if SGX1 is supported
322 # @sgx2: true if SGX2 is supported
324 # @flc: true if FLC is supported
326 # @sections: The EPC sections info for guest (Since: 7.0)
328 # Since: 6.2
330 { 'struct': 'SGXInfo',
331   'data': { 'sgx': 'bool',
332             'sgx1': 'bool',
333             'sgx2': 'bool',
334             'flc': 'bool',
335             'sections': ['SGXEPCSection']},
336    'if': 'TARGET_I386' }
339 # @query-sgx:
341 # Returns information about SGX
343 # Returns: @SGXInfo
345 # Since: 6.2
347 # Example:
349 # -> { "execute": "query-sgx" }
350 # <- { "return": { "sgx": true, "sgx1" : true, "sgx2" : true,
351 #                  "flc": true,
352 #                  "sections": [{"node": 0, "size": 67108864},
353 #                  {"node": 1, "size": 29360128}]} }
355 { 'command': 'query-sgx', 'returns': 'SGXInfo', 'if': 'TARGET_I386' }
358 # @query-sgx-capabilities:
360 # Returns information from host SGX capabilities
362 # Returns: @SGXInfo
364 # Since: 6.2
366 # Example:
368 # -> { "execute": "query-sgx-capabilities" }
369 # <- { "return": { "sgx": true, "sgx1" : true, "sgx2" : true,
370 #                  "flc": true,
371 #                  "section" : [{"node": 0, "size": 67108864},
372 #                  {"node": 1, "size": 29360128}]} }
374 { 'command': 'query-sgx-capabilities', 'returns': 'SGXInfo', 'if': 'TARGET_I386' }
378 # @EvtchnPortType:
380 # An enumeration of Xen event channel port types.
382 # @closed: The port is unused.
384 # @unbound: The port is allocated and ready to be bound.
386 # @interdomain: The port is connected as an interdomain interrupt.
388 # @pirq: The port is bound to a physical IRQ (PIRQ).
390 # @virq: The port is bound to a virtual IRQ (VIRQ).
392 # @ipi: The post is an inter-processor interrupt (IPI).
394 # Since: 8.0
396 { 'enum': 'EvtchnPortType',
397   'data': ['closed', 'unbound', 'interdomain', 'pirq', 'virq', 'ipi'],
398   'if': 'TARGET_I386' }
401 # @EvtchnInfo:
403 # Information about a Xen event channel port
405 # @port: the port number
407 # @vcpu: target vCPU for this port
409 # @type: the port type
411 # @remote-domain: remote domain for interdomain ports
413 # @target: remote port ID, or virq/pirq number
415 # @pending: port is currently active pending delivery
417 # @masked: port is masked
419 # Since: 8.0
421 { 'struct': 'EvtchnInfo',
422   'data': {'port': 'uint16',
423            'vcpu': 'uint32',
424            'type': 'EvtchnPortType',
425            'remote-domain': 'str',
426            'target': 'uint16',
427            'pending': 'bool',
428            'masked': 'bool'},
429   'if': 'TARGET_I386' }
433 # @xen-event-list:
435 # Query the Xen event channels opened by the guest.
437 # Returns: list of open event channel ports.
439 # Since: 8.0
441 # Example:
443 # -> { "execute": "xen-event-list" }
444 # <- { "return": [
445 #         {
446 #             "pending": false,
447 #             "port": 1,
448 #             "vcpu": 1,
449 #             "remote-domain": "qemu",
450 #             "masked": false,
451 #             "type": "interdomain",
452 #             "target": 1
453 #         },
454 #         {
455 #             "pending": false,
456 #             "port": 2,
457 #             "vcpu": 0,
458 #             "remote-domain": "",
459 #             "masked": false,
460 #             "type": "virq",
461 #             "target": 0
462 #         }
463 #      ]
464 #    }
466 { 'command': 'xen-event-list',
467   'returns': ['EvtchnInfo'],
468   'if': 'TARGET_I386' }
471 # @xen-event-inject:
473 # Inject a Xen event channel port (interrupt) to the guest.
475 # @port: The port number
477 # Returns:
478 # - Nothing on success.
480 # Since: 8.0
482 # Example:
484 # -> { "execute": "xen-event-inject", "arguments": { "port": 1 } }
485 # <- { "return": { } }
487 { 'command': 'xen-event-inject',
488   'data': { 'port': 'uint32' },
489   'if': 'TARGET_I386' }