Merge remote-tracking branch 'remotes/rth/tags/pull-tcg-20210921' into staging
[qemu.git] / qapi / ui.json
1 # -*- Mode: Python -*-
2 # vim: filetype=python
3 #
4
5 ##
6 # = Remote desktop
7 ##
8
9 { 'include': 'common.json' }
10 { 'include': 'sockets.json' }
11
12 ##
13 # @set_password:
14 #
15 # Sets the password of a remote display session.
16 #
17 # @protocol: - 'vnc' to modify the VNC server password
18 #            - 'spice' to modify the Spice server password
19 #
20 # @password: the new password
21 #
22 # @connected: how to handle existing clients when changing the
23 #             password.  If nothing is specified, defaults to 'keep'
24 #             'fail' to fail the command if clients are connected
25 #             'disconnect' to disconnect existing clients
26 #             'keep' to maintain existing clients
27 #
28 # Returns: - Nothing on success
29 #          - If Spice is not enabled, DeviceNotFound
30 #
31 # Since: 0.14
32 #
33 # Example:
34 #
35 # -> { "execute": "set_password", "arguments": { "protocol": "vnc",
36 #                                                "password": "secret" } }
37 # <- { "return": {} }
38 #
39 ##
40 { 'command': 'set_password',
41   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
42
43 ##
44 # @expire_password:
45 #
46 # Expire the password of a remote display server.
47 #
48 # @protocol: the name of the remote display protocol 'vnc' or 'spice'
49 #
50 # @time: when to expire the password.
51 #
52 #        - 'now' to expire the password immediately
53 #        - 'never' to cancel password expiration
54 #        - '+INT' where INT is the number of seconds from now (integer)
55 #        - 'INT' where INT is the absolute time in seconds
56 #
57 # Returns: - Nothing on success
58 #          - If @protocol is 'spice' and Spice is not active, DeviceNotFound
59 #
60 # Since: 0.14
61 #
62 # Notes: Time is relative to the server and currently there is no way to
63 #        coordinate server time with client time.  It is not recommended to
64 #        use the absolute time version of the @time parameter unless you're
65 #        sure you are on the same machine as the QEMU instance.
66 #
67 # Example:
68 #
69 # -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
70 #                                                   "time": "+60" } }
71 # <- { "return": {} }
72 #
73 ##
74 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
75
76 ##
77 # @screendump:
78 #
79 # Write a PPM of the VGA screen to a file.
80 #
81 # @filename: the path of a new PPM file to store the image
82 #
83 # @device: ID of the display device that should be dumped. If this parameter
84 #          is missing, the primary display will be used. (Since 2.12)
85 #
86 # @head: head to use in case the device supports multiple heads. If this
87 #        parameter is missing, head #0 will be used. Also note that the head
88 #        can only be specified in conjunction with the device ID. (Since 2.12)
89 #
90 # Returns: Nothing on success
91 #
92 # Since: 0.14
93 #
94 # Example:
95 #
96 # -> { "execute": "screendump",
97 #      "arguments": { "filename": "/tmp/image" } }
98 # <- { "return": {} }
99 #
100 ##
101 { 'command': 'screendump',
102   'data': {'filename': 'str', '*device': 'str', '*head': 'int'},
103   'coroutine': true }
104
105 ##
106 # == Spice
107 ##
108
109 ##
110 # @SpiceBasicInfo:
111 #
112 # The basic information for SPICE network connection
113 #
114 # @host: IP address
115 #
116 # @port: port number
117 #
118 # @family: address family
119 #
120 # Since: 2.1
121 ##
122 { 'struct': 'SpiceBasicInfo',
123   'data': { 'host': 'str',
124             'port': 'str',
125             'family': 'NetworkAddressFamily' },
126   'if': 'defined(CONFIG_SPICE)' }
127
128 ##
129 # @SpiceServerInfo:
130 #
131 # Information about a SPICE server
132 #
133 # @auth: authentication method
134 #
135 # Since: 2.1
136 ##
137 { 'struct': 'SpiceServerInfo',
138   'base': 'SpiceBasicInfo',
139   'data': { '*auth': 'str' },
140   'if': 'defined(CONFIG_SPICE)' }
141
142 ##
143 # @SpiceChannel:
144 #
145 # Information about a SPICE client channel.
146 #
147 # @connection-id: SPICE connection id number.  All channels with the same id
148 #                 belong to the same SPICE session.
149 #
150 # @channel-type: SPICE channel type number.  "1" is the main control
151 #                channel, filter for this one if you want to track spice
152 #                sessions only
153 #
154 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
155 #              multiple channels of the same type exist, such as multiple
156 #              display channels in a multihead setup
157 #
158 # @tls: true if the channel is encrypted, false otherwise.
159 #
160 # Since: 0.14
161 ##
162 { 'struct': 'SpiceChannel',
163   'base': 'SpiceBasicInfo',
164   'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
165            'tls': 'bool'},
166   'if': 'defined(CONFIG_SPICE)' }
167
168 ##
169 # @SpiceQueryMouseMode:
170 #
171 # An enumeration of Spice mouse states.
172 #
173 # @client: Mouse cursor position is determined by the client.
174 #
175 # @server: Mouse cursor position is determined by the server.
176 #
177 # @unknown: No information is available about mouse mode used by
178 #           the spice server.
179 #
180 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
181 #
182 # Since: 1.1
183 ##
184 { 'enum': 'SpiceQueryMouseMode',
185   'data': [ 'client', 'server', 'unknown' ],
186   'if': 'defined(CONFIG_SPICE)' }
187
188 ##
189 # @SpiceInfo:
190 #
191 # Information about the SPICE session.
192 #
193 # @enabled: true if the SPICE server is enabled, false otherwise
194 #
195 # @migrated: true if the last guest migration completed and spice
196 #            migration had completed as well. false otherwise. (since 1.4)
197 #
198 # @host: The hostname the SPICE server is bound to.  This depends on
199 #        the name resolution on the host and may be an IP address.
200 #
201 # @port: The SPICE server's port number.
202 #
203 # @compiled-version: SPICE server version.
204 #
205 # @tls-port: The SPICE server's TLS port number.
206 #
207 # @auth: the current authentication type used by the server
208 #
209 #        - 'none'  if no authentication is being used
210 #        - 'spice' uses SASL or direct TLS authentication, depending on command
211 #          line options
212 #
213 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
214 #              be determined by the client or the server, or unknown if spice
215 #              server doesn't provide this information. (since: 1.1)
216 #
217 # @channels: a list of @SpiceChannel for each active spice channel
218 #
219 # Since: 0.14
220 ##
221 { 'struct': 'SpiceInfo',
222   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
223            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
224            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']},
225   'if': 'defined(CONFIG_SPICE)' }
226
227 ##
228 # @query-spice:
229 #
230 # Returns information about the current SPICE server
231 #
232 # Returns: @SpiceInfo
233 #
234 # Since: 0.14
235 #
236 # Example:
237 #
238 # -> { "execute": "query-spice" }
239 # <- { "return": {
240 #          "enabled": true,
241 #          "auth": "spice",
242 #          "port": 5920,
243 #          "tls-port": 5921,
244 #          "host": "0.0.0.0",
245 #          "channels": [
246 #             {
247 #                "port": "54924",
248 #                "family": "ipv4",
249 #                "channel-type": 1,
250 #                "connection-id": 1804289383,
251 #                "host": "127.0.0.1",
252 #                "channel-id": 0,
253 #                "tls": true
254 #             },
255 #             {
256 #                "port": "36710",
257 #                "family": "ipv4",
258 #                "channel-type": 4,
259 #                "connection-id": 1804289383,
260 #                "host": "127.0.0.1",
261 #                "channel-id": 0,
262 #                "tls": false
263 #             },
264 #             [ ... more channels follow ... ]
265 #          ]
266 #       }
267 #    }
268 #
269 ##
270 { 'command': 'query-spice', 'returns': 'SpiceInfo',
271   'if': 'defined(CONFIG_SPICE)' }
272
273 ##
274 # @SPICE_CONNECTED:
275 #
276 # Emitted when a SPICE client establishes a connection
277 #
278 # @server: server information
279 #
280 # @client: client information
281 #
282 # Since: 0.14
283 #
284 # Example:
285 #
286 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
287 #      "event": "SPICE_CONNECTED",
288 #      "data": {
289 #        "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
290 #        "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
291 #    }}
292 #
293 ##
294 { 'event': 'SPICE_CONNECTED',
295   'data': { 'server': 'SpiceBasicInfo',
296             'client': 'SpiceBasicInfo' },
297   'if': 'defined(CONFIG_SPICE)' }
298
299 ##
300 # @SPICE_INITIALIZED:
301 #
302 # Emitted after initial handshake and authentication takes place (if any)
303 # and the SPICE channel is up and running
304 #
305 # @server: server information
306 #
307 # @client: client information
308 #
309 # Since: 0.14
310 #
311 # Example:
312 #
313 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
314 #      "event": "SPICE_INITIALIZED",
315 #      "data": {"server": {"auth": "spice", "port": "5921",
316 #                          "family": "ipv4", "host": "127.0.0.1"},
317 #               "client": {"port": "49004", "family": "ipv4", "channel-type": 3,
318 #                          "connection-id": 1804289383, "host": "127.0.0.1",
319 #                          "channel-id": 0, "tls": true}
320 #    }}
321 #
322 ##
323 { 'event': 'SPICE_INITIALIZED',
324   'data': { 'server': 'SpiceServerInfo',
325             'client': 'SpiceChannel' },
326   'if': 'defined(CONFIG_SPICE)' }
327
328 ##
329 # @SPICE_DISCONNECTED:
330 #
331 # Emitted when the SPICE connection is closed
332 #
333 # @server: server information
334 #
335 # @client: client information
336 #
337 # Since: 0.14
338 #
339 # Example:
340 #
341 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
342 #      "event": "SPICE_DISCONNECTED",
343 #      "data": {
344 #        "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
345 #        "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
346 #    }}
347 #
348 ##
349 { 'event': 'SPICE_DISCONNECTED',
350   'data': { 'server': 'SpiceBasicInfo',
351             'client': 'SpiceBasicInfo' },
352   'if': 'defined(CONFIG_SPICE)' }
353
354 ##
355 # @SPICE_MIGRATE_COMPLETED:
356 #
357 # Emitted when SPICE migration has completed
358 #
359 # Since: 1.3
360 #
361 # Example:
362 #
363 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
364 #      "event": "SPICE_MIGRATE_COMPLETED" }
365 #
366 ##
367 { 'event': 'SPICE_MIGRATE_COMPLETED',
368   'if': 'defined(CONFIG_SPICE)' }
369
370 ##
371 # == VNC
372 ##
373
374 ##
375 # @VncBasicInfo:
376 #
377 # The basic information for vnc network connection
378 #
379 # @host: IP address
380 #
381 # @service: The service name of the vnc port. This may depend on the host
382 #           system's service database so symbolic names should not be relied
383 #           on.
384 #
385 # @family: address family
386 #
387 # @websocket: true in case the socket is a websocket (since 2.3).
388 #
389 # Since: 2.1
390 ##
391 { 'struct': 'VncBasicInfo',
392   'data': { 'host': 'str',
393             'service': 'str',
394             'family': 'NetworkAddressFamily',
395             'websocket': 'bool' },
396   'if': 'defined(CONFIG_VNC)' }
397
398 ##
399 # @VncServerInfo:
400 #
401 # The network connection information for server
402 #
403 # @auth: authentication method used for
404 #        the plain (non-websocket) VNC server
405 #
406 # Since: 2.1
407 ##
408 { 'struct': 'VncServerInfo',
409   'base': 'VncBasicInfo',
410   'data': { '*auth': 'str' },
411   'if': 'defined(CONFIG_VNC)' }
412
413 ##
414 # @VncClientInfo:
415 #
416 # Information about a connected VNC client.
417 #
418 # @x509_dname: If x509 authentication is in use, the Distinguished
419 #              Name of the client.
420 #
421 # @sasl_username: If SASL authentication is in use, the SASL username
422 #                 used for authentication.
423 #
424 # Since: 0.14
425 ##
426 { 'struct': 'VncClientInfo',
427   'base': 'VncBasicInfo',
428   'data': { '*x509_dname': 'str', '*sasl_username': 'str' },
429   'if': 'defined(CONFIG_VNC)' }
430
431 ##
432 # @VncInfo:
433 #
434 # Information about the VNC session.
435 #
436 # @enabled: true if the VNC server is enabled, false otherwise
437 #
438 # @host: The hostname the VNC server is bound to.  This depends on
439 #        the name resolution on the host and may be an IP address.
440 #
441 # @family: - 'ipv6' if the host is listening for IPv6 connections
442 #          - 'ipv4' if the host is listening for IPv4 connections
443 #          - 'unix' if the host is listening on a unix domain socket
444 #          - 'unknown' otherwise
445 #
446 # @service: The service name of the server's port.  This may depends
447 #           on the host system's service database so symbolic names should not
448 #           be relied on.
449 #
450 # @auth: the current authentication type used by the server
451 #
452 #        - 'none' if no authentication is being used
453 #        - 'vnc' if VNC authentication is being used
454 #        - 'vencrypt+plain' if VEncrypt is used with plain text authentication
455 #        - 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
456 #        - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
457 #        - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
458 #        - 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
459 #        - 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
460 #        - 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
461 #        - 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
462 #        - 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
463 #
464 # @clients: a list of @VncClientInfo of all currently connected clients
465 #
466 # Since: 0.14
467 ##
468 { 'struct': 'VncInfo',
469   'data': {'enabled': 'bool', '*host': 'str',
470            '*family': 'NetworkAddressFamily',
471            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']},
472   'if': 'defined(CONFIG_VNC)' }
473
474 ##
475 # @VncPrimaryAuth:
476 #
477 # vnc primary authentication method.
478 #
479 # Since: 2.3
480 ##
481 { 'enum': 'VncPrimaryAuth',
482   'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
483             'tls', 'vencrypt', 'sasl' ],
484   'if': 'defined(CONFIG_VNC)' }
485
486 ##
487 # @VncVencryptSubAuth:
488 #
489 # vnc sub authentication method with vencrypt.
490 #
491 # Since: 2.3
492 ##
493 { 'enum': 'VncVencryptSubAuth',
494   'data': [ 'plain',
495             'tls-none',  'x509-none',
496             'tls-vnc',   'x509-vnc',
497             'tls-plain', 'x509-plain',
498             'tls-sasl',  'x509-sasl' ],
499   'if': 'defined(CONFIG_VNC)' }
500
501 ##
502 # @VncServerInfo2:
503 #
504 # The network connection information for server
505 #
506 # @auth: The current authentication type used by the servers
507 #
508 # @vencrypt: The vencrypt sub authentication type used by the
509 #            servers, only specified in case auth == vencrypt.
510 #
511 # Since: 2.9
512 ##
513 { 'struct': 'VncServerInfo2',
514   'base': 'VncBasicInfo',
515   'data': { 'auth'      : 'VncPrimaryAuth',
516             '*vencrypt' : 'VncVencryptSubAuth' },
517   'if': 'defined(CONFIG_VNC)' }
518
519 ##
520 # @VncInfo2:
521 #
522 # Information about a vnc server
523 #
524 # @id: vnc server name.
525 #
526 # @server: A list of @VncBasincInfo describing all listening sockets.
527 #          The list can be empty (in case the vnc server is disabled).
528 #          It also may have multiple entries: normal + websocket,
529 #          possibly also ipv4 + ipv6 in the future.
530 #
531 # @clients: A list of @VncClientInfo of all currently connected clients.
532 #           The list can be empty, for obvious reasons.
533 #
534 # @auth: The current authentication type used by the non-websockets servers
535 #
536 # @vencrypt: The vencrypt authentication type used by the servers,
537 #            only specified in case auth == vencrypt.
538 #
539 # @display: The display device the vnc server is linked to.
540 #
541 # Since: 2.3
542 ##
543 { 'struct': 'VncInfo2',
544   'data': { 'id'        : 'str',
545             'server'    : ['VncServerInfo2'],
546             'clients'   : ['VncClientInfo'],
547             'auth'      : 'VncPrimaryAuth',
548             '*vencrypt' : 'VncVencryptSubAuth',
549             '*display'  : 'str' },
550   'if': 'defined(CONFIG_VNC)' }
551
552 ##
553 # @query-vnc:
554 #
555 # Returns information about the current VNC server
556 #
557 # Returns: @VncInfo
558 #
559 # Since: 0.14
560 #
561 # Example:
562 #
563 # -> { "execute": "query-vnc" }
564 # <- { "return": {
565 #          "enabled":true,
566 #          "host":"0.0.0.0",
567 #          "service":"50402",
568 #          "auth":"vnc",
569 #          "family":"ipv4",
570 #          "clients":[
571 #             {
572 #                "host":"127.0.0.1",
573 #                "service":"50401",
574 #                "family":"ipv4"
575 #             }
576 #          ]
577 #       }
578 #    }
579 #
580 ##
581 { 'command': 'query-vnc', 'returns': 'VncInfo',
582   'if': 'defined(CONFIG_VNC)' }
583 ##
584 # @query-vnc-servers:
585 #
586 # Returns a list of vnc servers.  The list can be empty.
587 #
588 # Returns: a list of @VncInfo2
589 #
590 # Since: 2.3
591 ##
592 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'],
593   'if': 'defined(CONFIG_VNC)' }
594
595 ##
596 # @change-vnc-password:
597 #
598 # Change the VNC server password.
599 #
600 # @password: the new password to use with VNC authentication
601 #
602 # Since: 1.1
603 #
604 # Notes: An empty password in this command will set the password to the empty
605 #        string.  Existing clients are unaffected by executing this command.
606 ##
607 { 'command': 'change-vnc-password',
608   'data': { 'password': 'str' },
609   'if': 'defined(CONFIG_VNC)' }
610
611 ##
612 # @VNC_CONNECTED:
613 #
614 # Emitted when a VNC client establishes a connection
615 #
616 # @server: server information
617 #
618 # @client: client information
619 #
620 # Note: This event is emitted before any authentication takes place, thus
621 #       the authentication ID is not provided
622 #
623 # Since: 0.13
624 #
625 # Example:
626 #
627 # <- { "event": "VNC_CONNECTED",
628 #      "data": {
629 #            "server": { "auth": "sasl", "family": "ipv4",
630 #                        "service": "5901", "host": "0.0.0.0" },
631 #            "client": { "family": "ipv4", "service": "58425",
632 #                        "host": "127.0.0.1" } },
633 #      "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
634 #
635 ##
636 { 'event': 'VNC_CONNECTED',
637   'data': { 'server': 'VncServerInfo',
638             'client': 'VncBasicInfo' },
639   'if': 'defined(CONFIG_VNC)' }
640
641 ##
642 # @VNC_INITIALIZED:
643 #
644 # Emitted after authentication takes place (if any) and the VNC session is
645 # made active
646 #
647 # @server: server information
648 #
649 # @client: client information
650 #
651 # Since: 0.13
652 #
653 # Example:
654 #
655 # <-  { "event": "VNC_INITIALIZED",
656 #       "data": {
657 #            "server": { "auth": "sasl", "family": "ipv4",
658 #                        "service": "5901", "host": "0.0.0.0"},
659 #            "client": { "family": "ipv4", "service": "46089",
660 #                        "host": "127.0.0.1", "sasl_username": "luiz" } },
661 #       "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
662 #
663 ##
664 { 'event': 'VNC_INITIALIZED',
665   'data': { 'server': 'VncServerInfo',
666             'client': 'VncClientInfo' },
667   'if': 'defined(CONFIG_VNC)' }
668
669 ##
670 # @VNC_DISCONNECTED:
671 #
672 # Emitted when the connection is closed
673 #
674 # @server: server information
675 #
676 # @client: client information
677 #
678 # Since: 0.13
679 #
680 # Example:
681 #
682 # <- { "event": "VNC_DISCONNECTED",
683 #      "data": {
684 #            "server": { "auth": "sasl", "family": "ipv4",
685 #                        "service": "5901", "host": "0.0.0.0" },
686 #            "client": { "family": "ipv4", "service": "58425",
687 #                        "host": "127.0.0.1", "sasl_username": "luiz" } },
688 #      "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
689 #
690 ##
691 { 'event': 'VNC_DISCONNECTED',
692   'data': { 'server': 'VncServerInfo',
693             'client': 'VncClientInfo' },
694   'if': 'defined(CONFIG_VNC)' }
695
696 ##
697 # = Input
698 ##
699
700 ##
701 # @MouseInfo:
702 #
703 # Information about a mouse device.
704 #
705 # @name: the name of the mouse device
706 #
707 # @index: the index of the mouse device
708 #
709 # @current: true if this device is currently receiving mouse events
710 #
711 # @absolute: true if this device supports absolute coordinates as input
712 #
713 # Since: 0.14
714 ##
715 { 'struct': 'MouseInfo',
716   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
717            'absolute': 'bool'} }
718
719 ##
720 # @query-mice:
721 #
722 # Returns information about each active mouse device
723 #
724 # Returns: a list of @MouseInfo for each device
725 #
726 # Since: 0.14
727 #
728 # Example:
729 #
730 # -> { "execute": "query-mice" }
731 # <- { "return": [
732 #          {
733 #             "name":"QEMU Microsoft Mouse",
734 #             "index":0,
735 #             "current":false,
736 #             "absolute":false
737 #          },
738 #          {
739 #             "name":"QEMU PS/2 Mouse",
740 #             "index":1,
741 #             "current":true,
742 #             "absolute":true
743 #          }
744 #       ]
745 #    }
746 #
747 ##
748 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
749
750 ##
751 # @QKeyCode:
752 #
753 # An enumeration of key name.
754 #
755 # This is used by the @send-key command.
756 #
757 # @unmapped: since 2.0
758 # @pause: since 2.0
759 # @ro: since 2.4
760 # @kp_comma: since 2.4
761 # @kp_equals: since 2.6
762 # @power: since 2.6
763 # @hiragana: since 2.9
764 # @henkan: since 2.9
765 # @yen: since 2.9
766 #
767 # @sleep: since 2.10
768 # @wake: since 2.10
769 # @audionext: since 2.10
770 # @audioprev: since 2.10
771 # @audiostop: since 2.10
772 # @audioplay: since 2.10
773 # @audiomute: since 2.10
774 # @volumeup: since 2.10
775 # @volumedown: since 2.10
776 # @mediaselect: since 2.10
777 # @mail: since 2.10
778 # @calculator: since 2.10
779 # @computer: since 2.10
780 # @ac_home: since 2.10
781 # @ac_back: since 2.10
782 # @ac_forward: since 2.10
783 # @ac_refresh: since 2.10
784 # @ac_bookmarks: since 2.10
785 #
786 # @muhenkan: since 2.12
787 # @katakanahiragana: since 2.12
788 #
789 # 'sysrq' was mistakenly added to hack around the fact that
790 # the ps2 driver was not generating correct scancodes sequences
791 # when 'alt+print' was pressed. This flaw is now fixed and the
792 # 'sysrq' key serves no further purpose. Any further use of
793 # 'sysrq' will be transparently changed to 'print', so they
794 # are effectively synonyms.
795 #
796 # Since: 1.3
797 #
798 ##
799 { 'enum': 'QKeyCode',
800   'data': [ 'unmapped',
801             'shift', 'shift_r', 'alt', 'alt_r', 'ctrl',
802             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
803             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
804             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
805             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
806             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
807             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
808             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
809             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
810             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
811             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
812             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
813             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
814             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
815             'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause',
816             'ro', 'hiragana', 'henkan', 'yen', 'muhenkan', 'katakanahiragana',
817             'kp_comma', 'kp_equals', 'power', 'sleep', 'wake',
818             'audionext', 'audioprev', 'audiostop', 'audioplay', 'audiomute',
819             'volumeup', 'volumedown', 'mediaselect',
820             'mail', 'calculator', 'computer',
821             'ac_home', 'ac_back', 'ac_forward', 'ac_refresh', 'ac_bookmarks' ] }
822
823 ##
824 # @KeyValue:
825 #
826 # Represents a keyboard key.
827 #
828 # Since: 1.3
829 ##
830 { 'union': 'KeyValue',
831   'data': {
832     'number': 'int',
833     'qcode': 'QKeyCode' } }
834
835 ##
836 # @send-key:
837 #
838 # Send keys to guest.
839 #
840 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
841 #        simultaneously sent to the guest. A @KeyValue.number value is sent
842 #        directly to the guest, while @KeyValue.qcode must be a valid
843 #        @QKeyCode value
844 #
845 # @hold-time: time to delay key up events, milliseconds. Defaults
846 #             to 100
847 #
848 # Returns: - Nothing on success
849 #          - If key is unknown or redundant, InvalidParameter
850 #
851 # Since: 1.3
852 #
853 # Example:
854 #
855 # -> { "execute": "send-key",
856 #      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
857 #                               { "type": "qcode", "data": "alt" },
858 #                               { "type": "qcode", "data": "delete" } ] } }
859 # <- { "return": {} }
860 #
861 ##
862 { 'command': 'send-key',
863   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
864
865 ##
866 # @InputButton:
867 #
868 # Button of a pointer input device (mouse, tablet).
869 #
870 # @side: front side button of a 5-button mouse (since 2.9)
871 #
872 # @extra: rear side button of a 5-button mouse (since 2.9)
873 #
874 # Since: 2.0
875 ##
876 { 'enum'  : 'InputButton',
877   'data'  : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side',
878   'extra' ] }
879
880 ##
881 # @InputAxis:
882 #
883 # Position axis of a pointer input device (mouse, tablet).
884 #
885 # Since: 2.0
886 ##
887 { 'enum'  : 'InputAxis',
888   'data'  : [ 'x', 'y' ] }
889
890 ##
891 # @InputKeyEvent:
892 #
893 # Keyboard input event.
894 #
895 # @key:    Which key this event is for.
896 # @down:   True for key-down and false for key-up events.
897 #
898 # Since: 2.0
899 ##
900 { 'struct'  : 'InputKeyEvent',
901   'data'  : { 'key'     : 'KeyValue',
902               'down'    : 'bool' } }
903
904 ##
905 # @InputBtnEvent:
906 #
907 # Pointer button input event.
908 #
909 # @button: Which button this event is for.
910 # @down:   True for key-down and false for key-up events.
911 #
912 # Since: 2.0
913 ##
914 { 'struct'  : 'InputBtnEvent',
915   'data'  : { 'button'  : 'InputButton',
916               'down'    : 'bool' } }
917
918 ##
919 # @InputMoveEvent:
920 #
921 # Pointer motion input event.
922 #
923 # @axis: Which axis is referenced by @value.
924 # @value: Pointer position.  For absolute coordinates the
925 #         valid range is 0 -> 0x7ffff
926 #
927 # Since: 2.0
928 ##
929 { 'struct'  : 'InputMoveEvent',
930   'data'  : { 'axis'    : 'InputAxis',
931               'value'   : 'int' } }
932
933 ##
934 # @InputEvent:
935 #
936 # Input event union.
937 #
938 # @type: the input type, one of:
939 #
940 #        - 'key': Input event of Keyboard
941 #        - 'btn': Input event of pointer buttons
942 #        - 'rel': Input event of relative pointer motion
943 #        - 'abs': Input event of absolute pointer motion
944 #
945 # Since: 2.0
946 ##
947 { 'union' : 'InputEvent',
948   'data'  : { 'key'     : 'InputKeyEvent',
949               'btn'     : 'InputBtnEvent',
950               'rel'     : 'InputMoveEvent',
951               'abs'     : 'InputMoveEvent' } }
952
953 ##
954 # @input-send-event:
955 #
956 # Send input event(s) to guest.
957 #
958 # The @device and @head parameters can be used to send the input event
959 # to specific input devices in case (a) multiple input devices of the
960 # same kind are added to the virtual machine and (b) you have
961 # configured input routing (see docs/multiseat.txt) for those input
962 # devices.  The parameters work exactly like the device and head
963 # properties of input devices.  If @device is missing, only devices
964 # that have no input routing config are admissible.  If @device is
965 # specified, both input devices with and without input routing config
966 # are admissible, but devices with input routing config take
967 # precedence.
968 #
969 # @device: display device to send event(s) to.
970 # @head: head to send event(s) to, in case the
971 #        display device supports multiple scanouts.
972 # @events: List of InputEvent union.
973 #
974 # Returns: Nothing on success.
975 #
976 # Since: 2.6
977 #
978 # Note: The consoles are visible in the qom tree, under
979 #       /backend/console[$index]. They have a device link and head property,
980 #       so it is possible to map which console belongs to which device and
981 #       display.
982 #
983 # Example:
984 #
985 # 1. Press left mouse button.
986 #
987 # -> { "execute": "input-send-event",
988 #     "arguments": { "device": "video0",
989 #                    "events": [ { "type": "btn",
990 #                    "data" : { "down": true, "button": "left" } } ] } }
991 # <- { "return": {} }
992 #
993 # -> { "execute": "input-send-event",
994 #     "arguments": { "device": "video0",
995 #                    "events": [ { "type": "btn",
996 #                    "data" : { "down": false, "button": "left" } } ] } }
997 # <- { "return": {} }
998 #
999 # 2. Press ctrl-alt-del.
1000 #
1001 # -> { "execute": "input-send-event",
1002 #      "arguments": { "events": [
1003 #         { "type": "key", "data" : { "down": true,
1004 #           "key": {"type": "qcode", "data": "ctrl" } } },
1005 #         { "type": "key", "data" : { "down": true,
1006 #           "key": {"type": "qcode", "data": "alt" } } },
1007 #         { "type": "key", "data" : { "down": true,
1008 #           "key": {"type": "qcode", "data": "delete" } } } ] } }
1009 # <- { "return": {} }
1010 #
1011 # 3. Move mouse pointer to absolute coordinates (20000, 400).
1012 #
1013 # -> { "execute": "input-send-event" ,
1014 #   "arguments": { "events": [
1015 #                { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
1016 #                { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
1017 # <- { "return": {} }
1018 #
1019 ##
1020 { 'command': 'input-send-event',
1021   'data': { '*device': 'str',
1022             '*head'  : 'int',
1023             'events' : [ 'InputEvent' ] } }
1024
1025 ##
1026 # @DisplayGTK:
1027 #
1028 # GTK display options.
1029 #
1030 # @grab-on-hover: Grab keyboard input on mouse hover.
1031 # @zoom-to-fit: Zoom guest display to fit into the host window.  When
1032 #               turned off the host window will be resized instead.
1033 #               In case the display device can notify the guest on
1034 #               window resizes (virtio-gpu) this will default to "on",
1035 #               assuming the guest will resize the display to match
1036 #               the window size then.  Otherwise it defaults to "off".
1037 #               Since 3.1
1038 #
1039 # Since: 2.12
1040 #
1041 ##
1042 { 'struct'  : 'DisplayGTK',
1043   'data'    : { '*grab-on-hover' : 'bool',
1044                 '*zoom-to-fit'   : 'bool'  } }
1045
1046 ##
1047 # @DisplayEGLHeadless:
1048 #
1049 # EGL headless display options.
1050 #
1051 # @rendernode: Which DRM render node should be used. Default is the first
1052 #              available node on the host.
1053 #
1054 # Since: 3.1
1055 #
1056 ##
1057 { 'struct'  : 'DisplayEGLHeadless',
1058   'data'    : { '*rendernode' : 'str' } }
1059
1060  ##
1061  # @DisplayGLMode:
1062  #
1063  # Display OpenGL mode.
1064  #
1065  # @off: Disable OpenGL (default).
1066  # @on: Use OpenGL, pick context type automatically.
1067  #      Would better be named 'auto' but is called 'on' for backward
1068  #      compatibility with bool type.
1069  # @core: Use OpenGL with Core (desktop) Context.
1070  # @es: Use OpenGL with ES (embedded systems) Context.
1071  #
1072  # Since: 3.0
1073  #
1074  ##
1075 { 'enum'    : 'DisplayGLMode',
1076   'data'    : [ 'off', 'on', 'core', 'es' ] }
1077
1078 ##
1079 # @DisplayCurses:
1080 #
1081 # Curses display options.
1082 #
1083 # @charset:       Font charset used by guest (default: CP437).
1084 #
1085 # Since: 4.0
1086 #
1087 ##
1088 { 'struct'  : 'DisplayCurses',
1089   'data'    : { '*charset'       : 'str' } }
1090
1091 ##
1092 # @DisplayType:
1093 #
1094 # Display (user interface) type.
1095 #
1096 # @default: The default user interface, selecting from the first available
1097 #           of gtk, sdl, cocoa, and vnc.
1098 #
1099 # @none: No user interface or video output display. The guest will
1100 #        still see an emulated graphics card, but its output will not
1101 #        be displayed to the QEMU user.
1102 #
1103 # @gtk: The GTK user interface.
1104 #
1105 # @sdl: The SDL user interface.
1106 #
1107 # @egl-headless: No user interface, offload GL operations to a local
1108 #                DRI device. Graphical display need to be paired with
1109 #                VNC or Spice. (Since 3.1)
1110 #
1111 # @curses: Display video output via curses.  For graphics device
1112 #          models which support a text mode, QEMU can display this
1113 #          output using a curses/ncurses interface. Nothing is
1114 #          displayed when the graphics device is in graphical mode or
1115 #          if the graphics device does not support a text
1116 #          mode. Generally only the VGA device models support text
1117 #          mode.
1118 #
1119 # @cocoa: The Cocoa user interface.
1120 #
1121 # @spice-app: Set up a Spice server and run the default associated
1122 #             application to connect to it. The server will redirect
1123 #             the serial console and QEMU monitors. (Since 4.0)
1124 #
1125 # Since: 2.12
1126 #
1127 ##
1128 { 'enum'    : 'DisplayType',
1129   'data'    : [ 'default', 'none', 'gtk', 'sdl',
1130                 'egl-headless', 'curses', 'cocoa',
1131                 'spice-app'] }
1132
1133 ##
1134 # @DisplayOptions:
1135 #
1136 # Display (user interface) options.
1137 #
1138 # @type:          Which DisplayType qemu should use.
1139 # @full-screen:   Start user interface in fullscreen mode (default: off).
1140 # @window-close:  Allow to quit qemu with window close button (default: on).
1141 # @show-cursor:   Force showing the mouse cursor (default: off).
1142 #                 (since: 5.0)
1143 # @gl:            Enable OpenGL support (default: off).
1144 #
1145 # Since: 2.12
1146 #
1147 ##
1148 { 'union'   : 'DisplayOptions',
1149   'base'    : { 'type'           : 'DisplayType',
1150                 '*full-screen'   : 'bool',
1151                 '*window-close'  : 'bool',
1152                 '*show-cursor'   : 'bool',
1153                 '*gl'            : 'DisplayGLMode' },
1154   'discriminator' : 'type',
1155   'data'    : { 'gtk'            : 'DisplayGTK',
1156                 'curses'         : 'DisplayCurses',
1157                 'egl-headless'   : 'DisplayEGLHeadless'} }
1158
1159 ##
1160 # @query-display-options:
1161 #
1162 # Returns information about display configuration
1163 #
1164 # Returns: @DisplayOptions
1165 #
1166 # Since: 3.1
1167 #
1168 ##
1169 { 'command': 'query-display-options',
1170   'returns': 'DisplayOptions' }
1171
1172 ##
1173 # @DisplayReloadType:
1174 #
1175 # Available DisplayReload types.
1176 #
1177 # @vnc: VNC display
1178 #
1179 # Since: 6.0
1180 #
1181 ##
1182 { 'enum': 'DisplayReloadType',
1183   'data': ['vnc'] }
1184
1185 ##
1186 # @DisplayReloadOptionsVNC:
1187 #
1188 # Specify the VNC reload options.
1189 #
1190 # @tls-certs: reload tls certs or not.
1191 #
1192 # Since: 6.0
1193 #
1194 ##
1195 { 'struct': 'DisplayReloadOptionsVNC',
1196   'data': { '*tls-certs': 'bool' } }
1197
1198 ##
1199 # @DisplayReloadOptions:
1200 #
1201 # Options of the display configuration reload.
1202 #
1203 # @type: Specify the display type.
1204 #
1205 # Since: 6.0
1206 #
1207 ##
1208 { 'union': 'DisplayReloadOptions',
1209   'base': {'type': 'DisplayReloadType'},
1210   'discriminator': 'type',
1211   'data': { 'vnc': 'DisplayReloadOptionsVNC' } }
1212
1213 ##
1214 # @display-reload:
1215 #
1216 # Reload display configuration.
1217 #
1218 # Returns: Nothing on success.
1219 #
1220 # Since: 6.0
1221 #
1222 # Example:
1223 #
1224 # -> { "execute": "display-reload",
1225 #      "arguments": { "type": "vnc", "tls-certs": true  } }
1226 # <- { "return": {} }
1227 #
1228 ##
1229 { 'command': 'display-reload',
1230   'data': 'DisplayReloadOptions',
1231   'boxed' : true }