]> git.proxmox.com Git - mirror_qemu.git/blob - qapi/char.json
Merge remote-tracking branch 'remotes/bonzini-gitlab/tags/for-upstream' into staging
[mirror_qemu.git] / qapi / char.json
1 # -*- Mode: Python -*-
2 # vim: filetype=python
3 #
4
5 ##
6 # = Character devices
7 ##
8
9 { 'include': 'sockets.json' }
10
11 ##
12 # @ChardevInfo:
13 #
14 # Information about a character device.
15 #
16 # @label: the label of the character device
17 #
18 # @filename: the filename of the character device
19 #
20 # @frontend-open: shows whether the frontend device attached to this backend
21 # (eg. with the chardev=... option) is in open or closed state
22 # (since 2.1)
23 #
24 # Notes: @filename is encoded using the QEMU command line character device
25 # encoding. See the QEMU man page for details.
26 #
27 # Since: 0.14
28 ##
29 { 'struct': 'ChardevInfo',
30 'data': { 'label': 'str',
31 'filename': 'str',
32 'frontend-open': 'bool' } }
33
34 ##
35 # @query-chardev:
36 #
37 # Returns information about current character devices.
38 #
39 # Returns: a list of @ChardevInfo
40 #
41 # Since: 0.14
42 #
43 # Example:
44 #
45 # -> { "execute": "query-chardev" }
46 # <- {
47 # "return": [
48 # {
49 # "label": "charchannel0",
50 # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server=on",
51 # "frontend-open": false
52 # },
53 # {
54 # "label": "charmonitor",
55 # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server=on",
56 # "frontend-open": true
57 # },
58 # {
59 # "label": "charserial0",
60 # "filename": "pty:/dev/pts/2",
61 # "frontend-open": true
62 # }
63 # ]
64 # }
65 #
66 ##
67 { 'command': 'query-chardev', 'returns': ['ChardevInfo'],
68 'allow-preconfig': true }
69
70 ##
71 # @ChardevBackendInfo:
72 #
73 # Information about a character device backend
74 #
75 # @name: The backend name
76 #
77 # Since: 2.0
78 ##
79 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
80
81 ##
82 # @query-chardev-backends:
83 #
84 # Returns information about character device backends.
85 #
86 # Returns: a list of @ChardevBackendInfo
87 #
88 # Since: 2.0
89 #
90 # Example:
91 #
92 # -> { "execute": "query-chardev-backends" }
93 # <- {
94 # "return":[
95 # {
96 # "name":"udp"
97 # },
98 # {
99 # "name":"tcp"
100 # },
101 # {
102 # "name":"unix"
103 # },
104 # {
105 # "name":"spiceport"
106 # }
107 # ]
108 # }
109 #
110 ##
111 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
112
113 ##
114 # @DataFormat:
115 #
116 # An enumeration of data format.
117 #
118 # @utf8: Data is a UTF-8 string (RFC 3629)
119 #
120 # @base64: Data is Base64 encoded binary (RFC 3548)
121 #
122 # Since: 1.4
123 ##
124 { 'enum': 'DataFormat',
125 'data': [ 'utf8', 'base64' ] }
126
127 ##
128 # @ringbuf-write:
129 #
130 # Write to a ring buffer character device.
131 #
132 # @device: the ring buffer character device name
133 #
134 # @data: data to write
135 #
136 # @format: data encoding (default 'utf8').
137 #
138 # - base64: data must be base64 encoded text. Its binary
139 # decoding gets written.
140 # - utf8: data's UTF-8 encoding is written
141 # - data itself is always Unicode regardless of format, like
142 # any other string.
143 #
144 # Returns: Nothing on success
145 #
146 # Since: 1.4
147 #
148 # Example:
149 #
150 # -> { "execute": "ringbuf-write",
151 # "arguments": { "device": "foo",
152 # "data": "abcdefgh",
153 # "format": "utf8" } }
154 # <- { "return": {} }
155 #
156 ##
157 { 'command': 'ringbuf-write',
158 'data': { 'device': 'str',
159 'data': 'str',
160 '*format': 'DataFormat'} }
161
162 ##
163 # @ringbuf-read:
164 #
165 # Read from a ring buffer character device.
166 #
167 # @device: the ring buffer character device name
168 #
169 # @size: how many bytes to read at most
170 #
171 # @format: data encoding (default 'utf8').
172 #
173 # - base64: the data read is returned in base64 encoding.
174 # - utf8: the data read is interpreted as UTF-8.
175 # Bug: can screw up when the buffer contains invalid UTF-8
176 # sequences, NUL characters, after the ring buffer lost
177 # data, and when reading stops because the size limit is
178 # reached.
179 # - The return value is always Unicode regardless of format,
180 # like any other string.
181 #
182 # Returns: data read from the device
183 #
184 # Since: 1.4
185 #
186 # Example:
187 #
188 # -> { "execute": "ringbuf-read",
189 # "arguments": { "device": "foo",
190 # "size": 1000,
191 # "format": "utf8" } }
192 # <- { "return": "abcdefgh" }
193 #
194 ##
195 { 'command': 'ringbuf-read',
196 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
197 'returns': 'str' }
198
199 ##
200 # @ChardevCommon:
201 #
202 # Configuration shared across all chardev backends
203 #
204 # @logfile: The name of a logfile to save output
205 # @logappend: true to append instead of truncate
206 # (default to false to truncate)
207 #
208 # Since: 2.6
209 ##
210 { 'struct': 'ChardevCommon',
211 'data': { '*logfile': 'str',
212 '*logappend': 'bool' } }
213
214 ##
215 # @ChardevFile:
216 #
217 # Configuration info for file chardevs.
218 #
219 # @in: The name of the input file
220 # @out: The name of the output file
221 # @append: Open the file in append mode (default false to
222 # truncate) (Since 2.6)
223 #
224 # Since: 1.4
225 ##
226 { 'struct': 'ChardevFile',
227 'data': { '*in': 'str',
228 'out': 'str',
229 '*append': 'bool' },
230 'base': 'ChardevCommon' }
231
232 ##
233 # @ChardevHostdev:
234 #
235 # Configuration info for device and pipe chardevs.
236 #
237 # @device: The name of the special file for the device,
238 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
239 #
240 # Since: 1.4
241 ##
242 { 'struct': 'ChardevHostdev',
243 'data': { 'device': 'str' },
244 'base': 'ChardevCommon' }
245
246 ##
247 # @ChardevSocket:
248 #
249 # Configuration info for (stream) socket chardevs.
250 #
251 # @addr: socket address to listen on (server=true)
252 # or connect to (server=false)
253 # @tls-creds: the ID of the TLS credentials object (since 2.6)
254 # @tls-authz: the ID of the QAuthZ authorization object against which
255 # the client's x509 distinguished name will be validated. This
256 # object is only resolved at time of use, so can be deleted
257 # and recreated on the fly while the chardev server is active.
258 # If missing, it will default to denying access (since 4.0)
259 # @server: create server socket (default: true)
260 # @wait: wait for incoming connection on server
261 # sockets (default: false).
262 # Silently ignored with server: false. This use is deprecated.
263 # @nodelay: set TCP_NODELAY socket option (default: false)
264 # @telnet: enable telnet protocol on server
265 # sockets (default: false)
266 # @tn3270: enable tn3270 protocol on server
267 # sockets (default: false) (Since: 2.10)
268 # @websocket: enable websocket protocol on server
269 # sockets (default: false) (Since: 3.1)
270 # @reconnect: For a client socket, if a socket is disconnected,
271 # then attempt a reconnect after the given number of seconds.
272 # Setting this to zero disables this function. (default: 0)
273 # (Since: 2.2)
274 #
275 # Since: 1.4
276 ##
277 { 'struct': 'ChardevSocket',
278 'data': { 'addr': 'SocketAddressLegacy',
279 '*tls-creds': 'str',
280 '*tls-authz' : 'str',
281 '*server': 'bool',
282 '*wait': 'bool',
283 '*nodelay': 'bool',
284 '*telnet': 'bool',
285 '*tn3270': 'bool',
286 '*websocket': 'bool',
287 '*reconnect': 'int' },
288 'base': 'ChardevCommon' }
289
290 ##
291 # @ChardevUdp:
292 #
293 # Configuration info for datagram socket chardevs.
294 #
295 # @remote: remote address
296 # @local: local address
297 #
298 # Since: 1.5
299 ##
300 { 'struct': 'ChardevUdp',
301 'data': { 'remote': 'SocketAddressLegacy',
302 '*local': 'SocketAddressLegacy' },
303 'base': 'ChardevCommon' }
304
305 ##
306 # @ChardevMux:
307 #
308 # Configuration info for mux chardevs.
309 #
310 # @chardev: name of the base chardev.
311 #
312 # Since: 1.5
313 ##
314 { 'struct': 'ChardevMux',
315 'data': { 'chardev': 'str' },
316 'base': 'ChardevCommon' }
317
318 ##
319 # @ChardevStdio:
320 #
321 # Configuration info for stdio chardevs.
322 #
323 # @signal: Allow signals (such as SIGINT triggered by ^C)
324 # be delivered to qemu. Default: true.
325 #
326 # Since: 1.5
327 ##
328 { 'struct': 'ChardevStdio',
329 'data': { '*signal': 'bool' },
330 'base': 'ChardevCommon' }
331
332
333 ##
334 # @ChardevSpiceChannel:
335 #
336 # Configuration info for spice vm channel chardevs.
337 #
338 # @type: kind of channel (for example vdagent).
339 #
340 # Since: 1.5
341 ##
342 { 'struct': 'ChardevSpiceChannel',
343 'data': { 'type': 'str' },
344 'base': 'ChardevCommon',
345 'if': 'defined(CONFIG_SPICE)' }
346
347 ##
348 # @ChardevSpicePort:
349 #
350 # Configuration info for spice port chardevs.
351 #
352 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
353 #
354 # Since: 1.5
355 ##
356 { 'struct': 'ChardevSpicePort',
357 'data': { 'fqdn': 'str' },
358 'base': 'ChardevCommon',
359 'if': 'defined(CONFIG_SPICE)' }
360
361 ##
362 # @ChardevVC:
363 #
364 # Configuration info for virtual console chardevs.
365 #
366 # @width: console width, in pixels
367 # @height: console height, in pixels
368 # @cols: console width, in chars
369 # @rows: console height, in chars
370 #
371 # Since: 1.5
372 ##
373 { 'struct': 'ChardevVC',
374 'data': { '*width': 'int',
375 '*height': 'int',
376 '*cols': 'int',
377 '*rows': 'int' },
378 'base': 'ChardevCommon' }
379
380 ##
381 # @ChardevRingbuf:
382 #
383 # Configuration info for ring buffer chardevs.
384 #
385 # @size: ring buffer size, must be power of two, default is 65536
386 #
387 # Since: 1.5
388 ##
389 { 'struct': 'ChardevRingbuf',
390 'data': { '*size': 'int' },
391 'base': 'ChardevCommon' }
392
393 ##
394 # @ChardevBackend:
395 #
396 # Configuration info for the new chardev backend.
397 #
398 # Since: 1.4 (testdev since 2.2, wctablet since 2.9)
399 ##
400 { 'union': 'ChardevBackend',
401 'data': { 'file': 'ChardevFile',
402 'serial': 'ChardevHostdev',
403 'parallel': 'ChardevHostdev',
404 'pipe': 'ChardevHostdev',
405 'socket': 'ChardevSocket',
406 'udp': 'ChardevUdp',
407 'pty': 'ChardevCommon',
408 'null': 'ChardevCommon',
409 'mux': 'ChardevMux',
410 'msmouse': 'ChardevCommon',
411 'wctablet': 'ChardevCommon',
412 'braille': 'ChardevCommon',
413 'testdev': 'ChardevCommon',
414 'stdio': 'ChardevStdio',
415 'console': 'ChardevCommon',
416 'spicevmc': { 'type': 'ChardevSpiceChannel',
417 'if': 'defined(CONFIG_SPICE)' },
418 'spiceport': { 'type': 'ChardevSpicePort',
419 'if': 'defined(CONFIG_SPICE)' },
420 'vc': 'ChardevVC',
421 'ringbuf': 'ChardevRingbuf',
422 # next one is just for compatibility
423 'memory': 'ChardevRingbuf' } }
424
425 ##
426 # @ChardevReturn:
427 #
428 # Return info about the chardev backend just created.
429 #
430 # @pty: name of the slave pseudoterminal device, present if
431 # and only if a chardev of type 'pty' was created
432 #
433 # Since: 1.4
434 ##
435 { 'struct' : 'ChardevReturn',
436 'data': { '*pty': 'str' } }
437
438 ##
439 # @chardev-add:
440 #
441 # Add a character device backend
442 #
443 # @id: the chardev's ID, must be unique
444 # @backend: backend type and parameters
445 #
446 # Returns: ChardevReturn.
447 #
448 # Since: 1.4
449 #
450 # Example:
451 #
452 # -> { "execute" : "chardev-add",
453 # "arguments" : { "id" : "foo",
454 # "backend" : { "type" : "null", "data" : {} } } }
455 # <- { "return": {} }
456 #
457 # -> { "execute" : "chardev-add",
458 # "arguments" : { "id" : "bar",
459 # "backend" : { "type" : "file",
460 # "data" : { "out" : "/tmp/bar.log" } } } }
461 # <- { "return": {} }
462 #
463 # -> { "execute" : "chardev-add",
464 # "arguments" : { "id" : "baz",
465 # "backend" : { "type" : "pty", "data" : {} } } }
466 # <- { "return": { "pty" : "/dev/pty/42" } }
467 #
468 ##
469 { 'command': 'chardev-add',
470 'data': { 'id': 'str',
471 'backend': 'ChardevBackend' },
472 'returns': 'ChardevReturn' }
473
474 ##
475 # @chardev-change:
476 #
477 # Change a character device backend
478 #
479 # @id: the chardev's ID, must exist
480 # @backend: new backend type and parameters
481 #
482 # Returns: ChardevReturn.
483 #
484 # Since: 2.10
485 #
486 # Example:
487 #
488 # -> { "execute" : "chardev-change",
489 # "arguments" : { "id" : "baz",
490 # "backend" : { "type" : "pty", "data" : {} } } }
491 # <- { "return": { "pty" : "/dev/pty/42" } }
492 #
493 # -> {"execute" : "chardev-change",
494 # "arguments" : {
495 # "id" : "charchannel2",
496 # "backend" : {
497 # "type" : "socket",
498 # "data" : {
499 # "addr" : {
500 # "type" : "unix" ,
501 # "data" : {
502 # "path" : "/tmp/charchannel2.socket"
503 # }
504 # },
505 # "server" : true,
506 # "wait" : false }}}}
507 # <- {"return": {}}
508 #
509 ##
510 { 'command': 'chardev-change',
511 'data': { 'id': 'str',
512 'backend': 'ChardevBackend' },
513 'returns': 'ChardevReturn' }
514
515 ##
516 # @chardev-remove:
517 #
518 # Remove a character device backend
519 #
520 # @id: the chardev's ID, must exist and not be in use
521 #
522 # Returns: Nothing on success
523 #
524 # Since: 1.4
525 #
526 # Example:
527 #
528 # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
529 # <- { "return": {} }
530 #
531 ##
532 { 'command': 'chardev-remove',
533 'data': { 'id': 'str' } }
534
535 ##
536 # @chardev-send-break:
537 #
538 # Send a break to a character device
539 #
540 # @id: the chardev's ID, must exist
541 #
542 # Returns: Nothing on success
543 #
544 # Since: 2.10
545 #
546 # Example:
547 #
548 # -> { "execute": "chardev-send-break", "arguments": { "id" : "foo" } }
549 # <- { "return": {} }
550 #
551 ##
552 { 'command': 'chardev-send-break',
553 'data': { 'id': 'str' } }
554
555 ##
556 # @VSERPORT_CHANGE:
557 #
558 # Emitted when the guest opens or closes a virtio-serial port.
559 #
560 # @id: device identifier of the virtio-serial port
561 #
562 # @open: true if the guest has opened the virtio-serial port
563 #
564 # Note: This event is rate-limited.
565 #
566 # Since: 2.1
567 #
568 # Example:
569 #
570 # <- { "event": "VSERPORT_CHANGE",
571 # "data": { "id": "channel0", "open": true },
572 # "timestamp": { "seconds": 1401385907, "microseconds": 422329 } }
573 #
574 ##
575 { 'event': 'VSERPORT_CHANGE',
576 'data': { 'id': 'str',
577 'open': 'bool' } }