]>
Commit | Line | Data |
---|---|---|
dbeee392 | 1 | # -*- Mode: Python -*- |
f7160f32 | 2 | # vim: filetype=python |
dbeee392 MA |
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 | # | |
a937b6aa MA |
20 | # @frontend-open: shows whether the frontend device attached to this |
21 | # backend (eg. with the chardev=... option) is in open or closed | |
22 | # state (since 2.1) | |
dbeee392 | 23 | # |
a937b6aa MA |
24 | # Notes: @filename is encoded using the QEMU command line character |
25 | # device encoding. See the QEMU man page for details. | |
dbeee392 | 26 | # |
9bc6e893 | 27 | # Since: 0.14 |
dbeee392 | 28 | ## |
b0ddeba2 MAL |
29 | { 'struct': 'ChardevInfo', |
30 | 'data': { 'label': 'str', | |
31 | 'filename': 'str', | |
32 | 'frontend-open': 'bool' } } | |
dbeee392 MA |
33 | |
34 | ## | |
35 | # @query-chardev: | |
36 | # | |
37 | # Returns information about current character devices. | |
38 | # | |
39 | # Returns: a list of @ChardevInfo | |
40 | # | |
9bc6e893 | 41 | # Since: 0.14 |
dbeee392 MA |
42 | # |
43 | # Example: | |
44 | # | |
45 | # -> { "execute": "query-chardev" } | |
46 | # <- { | |
47 | # "return": [ | |
48 | # { | |
49 | # "label": "charchannel0", | |
9d902d51 | 50 | # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server=on", |
dbeee392 MA |
51 | # "frontend-open": false |
52 | # }, | |
53 | # { | |
54 | # "label": "charmonitor", | |
9d902d51 | 55 | # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server=on", |
dbeee392 MA |
56 | # "frontend-open": true |
57 | # }, | |
58 | # { | |
59 | # "label": "charserial0", | |
60 | # "filename": "pty:/dev/pts/2", | |
61 | # "frontend-open": true | |
62 | # } | |
63 | # ] | |
64 | # } | |
dbeee392 | 65 | ## |
a87706c8 IM |
66 | { 'command': 'query-chardev', 'returns': ['ChardevInfo'], |
67 | 'allow-preconfig': true } | |
dbeee392 MA |
68 | |
69 | ## | |
70 | # @ChardevBackendInfo: | |
71 | # | |
72 | # Information about a character device backend | |
73 | # | |
74 | # @name: The backend name | |
75 | # | |
76 | # Since: 2.0 | |
77 | ## | |
78 | { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} } | |
79 | ||
80 | ## | |
81 | # @query-chardev-backends: | |
82 | # | |
83 | # Returns information about character device backends. | |
84 | # | |
85 | # Returns: a list of @ChardevBackendInfo | |
86 | # | |
87 | # Since: 2.0 | |
88 | # | |
89 | # Example: | |
90 | # | |
91 | # -> { "execute": "query-chardev-backends" } | |
92 | # <- { | |
93 | # "return":[ | |
94 | # { | |
95 | # "name":"udp" | |
96 | # }, | |
97 | # { | |
98 | # "name":"tcp" | |
99 | # }, | |
100 | # { | |
101 | # "name":"unix" | |
102 | # }, | |
103 | # { | |
104 | # "name":"spiceport" | |
105 | # } | |
106 | # ] | |
107 | # } | |
dbeee392 MA |
108 | ## |
109 | { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] } | |
110 | ||
111 | ## | |
112 | # @DataFormat: | |
113 | # | |
114 | # An enumeration of data format. | |
115 | # | |
116 | # @utf8: Data is a UTF-8 string (RFC 3629) | |
117 | # | |
118 | # @base64: Data is Base64 encoded binary (RFC 3548) | |
119 | # | |
120 | # Since: 1.4 | |
121 | ## | |
122 | { 'enum': 'DataFormat', | |
123 | 'data': [ 'utf8', 'base64' ] } | |
124 | ||
125 | ## | |
126 | # @ringbuf-write: | |
127 | # | |
128 | # Write to a ring buffer character device. | |
129 | # | |
130 | # @device: the ring buffer character device name | |
131 | # | |
132 | # @data: data to write | |
133 | # | |
134 | # @format: data encoding (default 'utf8'). | |
100cc4fe | 135 | # |
a937b6aa MA |
136 | # - base64: data must be base64 encoded text. Its binary decoding |
137 | # gets written. | |
138 | # - utf8: data's UTF-8 encoding is written | |
139 | # - data itself is always Unicode regardless of format, like any | |
140 | # other string. | |
dbeee392 MA |
141 | # |
142 | # Returns: Nothing on success | |
143 | # | |
144 | # Since: 1.4 | |
145 | # | |
146 | # Example: | |
147 | # | |
148 | # -> { "execute": "ringbuf-write", | |
149 | # "arguments": { "device": "foo", | |
150 | # "data": "abcdefgh", | |
151 | # "format": "utf8" } } | |
152 | # <- { "return": {} } | |
dbeee392 MA |
153 | ## |
154 | { 'command': 'ringbuf-write', | |
b0ddeba2 MAL |
155 | 'data': { 'device': 'str', |
156 | 'data': 'str', | |
dbeee392 MA |
157 | '*format': 'DataFormat'} } |
158 | ||
159 | ## | |
160 | # @ringbuf-read: | |
161 | # | |
162 | # Read from a ring buffer character device. | |
163 | # | |
164 | # @device: the ring buffer character device name | |
165 | # | |
166 | # @size: how many bytes to read at most | |
167 | # | |
168 | # @format: data encoding (default 'utf8'). | |
100cc4fe | 169 | # |
a937b6aa MA |
170 | # - base64: the data read is returned in base64 encoding. |
171 | # - utf8: the data read is interpreted as UTF-8. | |
172 | # Bug: can screw up when the buffer contains invalid UTF-8 | |
173 | # sequences, NUL characters, after the ring buffer lost data, | |
174 | # and when reading stops because the size limit is reached. | |
175 | # - The return value is always Unicode regardless of format, like | |
176 | # any other string. | |
dbeee392 MA |
177 | # |
178 | # Returns: data read from the device | |
179 | # | |
180 | # Since: 1.4 | |
181 | # | |
182 | # Example: | |
183 | # | |
184 | # -> { "execute": "ringbuf-read", | |
185 | # "arguments": { "device": "foo", | |
186 | # "size": 1000, | |
187 | # "format": "utf8" } } | |
188 | # <- { "return": "abcdefgh" } | |
dbeee392 MA |
189 | ## |
190 | { 'command': 'ringbuf-read', | |
191 | 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'}, | |
192 | 'returns': 'str' } | |
193 | ||
194 | ## | |
195 | # @ChardevCommon: | |
196 | # | |
197 | # Configuration shared across all chardev backends | |
198 | # | |
199 | # @logfile: The name of a logfile to save output | |
a937b6aa MA |
200 | # |
201 | # @logappend: true to append instead of truncate (default to false to | |
202 | # truncate) | |
dbeee392 MA |
203 | # |
204 | # Since: 2.6 | |
205 | ## | |
b0ddeba2 MAL |
206 | { 'struct': 'ChardevCommon', |
207 | 'data': { '*logfile': 'str', | |
208 | '*logappend': 'bool' } } | |
dbeee392 MA |
209 | |
210 | ## | |
211 | # @ChardevFile: | |
212 | # | |
213 | # Configuration info for file chardevs. | |
214 | # | |
23e46452 | 215 | # @in: The name of the input file |
a937b6aa | 216 | # |
dbeee392 | 217 | # @out: The name of the output file |
a937b6aa MA |
218 | # |
219 | # @append: Open the file in append mode (default false to truncate) | |
220 | # (Since 2.6) | |
dbeee392 MA |
221 | # |
222 | # Since: 1.4 | |
223 | ## | |
b0ddeba2 MAL |
224 | { 'struct': 'ChardevFile', |
225 | 'data': { '*in': 'str', | |
226 | 'out': 'str', | |
227 | '*append': 'bool' }, | |
dbeee392 MA |
228 | 'base': 'ChardevCommon' } |
229 | ||
230 | ## | |
231 | # @ChardevHostdev: | |
232 | # | |
233 | # Configuration info for device and pipe chardevs. | |
234 | # | |
a937b6aa MA |
235 | # @device: The name of the special file for the device, i.e. |
236 | # /dev/ttyS0 on Unix or COM1: on Windows | |
dbeee392 MA |
237 | # |
238 | # Since: 1.4 | |
239 | ## | |
b0ddeba2 MAL |
240 | { 'struct': 'ChardevHostdev', |
241 | 'data': { 'device': 'str' }, | |
dbeee392 MA |
242 | 'base': 'ChardevCommon' } |
243 | ||
244 | ## | |
245 | # @ChardevSocket: | |
246 | # | |
247 | # Configuration info for (stream) socket chardevs. | |
248 | # | |
a937b6aa MA |
249 | # @addr: socket address to listen on (server=true) or connect to |
250 | # (server=false) | |
251 | # | |
dbeee392 | 252 | # @tls-creds: the ID of the TLS credentials object (since 2.6) |
a937b6aa | 253 | # |
fd4a5fd4 | 254 | # @tls-authz: the ID of the QAuthZ authorization object against which |
a937b6aa MA |
255 | # the client's x509 distinguished name will be validated. This |
256 | # object is only resolved at time of use, so can be deleted and | |
257 | # recreated on the fly while the chardev server is active. If | |
258 | # missing, it will default to denying access (since 4.0) | |
259 | # | |
dbeee392 | 260 | # @server: create server socket (default: true) |
a937b6aa MA |
261 | # |
262 | # @wait: wait for incoming connection on server sockets (default: | |
263 | # false). Silently ignored with server: false. This use is | |
264 | # deprecated. | |
265 | # | |
dbeee392 | 266 | # @nodelay: set TCP_NODELAY socket option (default: false) |
a937b6aa MA |
267 | # |
268 | # @telnet: enable telnet protocol on server sockets (default: false) | |
269 | # | |
270 | # @tn3270: enable tn3270 protocol on server sockets (default: false) | |
271 | # (Since: 2.10) | |
272 | # | |
273 | # @websocket: enable websocket protocol on server sockets | |
274 | # (default: false) (Since: 3.1) | |
275 | # | |
276 | # @reconnect: For a client socket, if a socket is disconnected, then | |
277 | # attempt a reconnect after the given number of seconds. Setting | |
278 | # this to zero disables this function. (default: 0) (Since: 2.2) | |
dbeee392 MA |
279 | # |
280 | # Since: 1.4 | |
281 | ## | |
b0ddeba2 MAL |
282 | { 'struct': 'ChardevSocket', |
283 | 'data': { 'addr': 'SocketAddressLegacy', | |
284 | '*tls-creds': 'str', | |
fd4a5fd4 | 285 | '*tls-authz' : 'str', |
b0ddeba2 MAL |
286 | '*server': 'bool', |
287 | '*wait': 'bool', | |
288 | '*nodelay': 'bool', | |
289 | '*telnet': 'bool', | |
290 | '*tn3270': 'bool', | |
291 | '*websocket': 'bool', | |
292 | '*reconnect': 'int' }, | |
dbeee392 MA |
293 | 'base': 'ChardevCommon' } |
294 | ||
295 | ## | |
296 | # @ChardevUdp: | |
297 | # | |
298 | # Configuration info for datagram socket chardevs. | |
299 | # | |
300 | # @remote: remote address | |
a937b6aa | 301 | # |
dbeee392 MA |
302 | # @local: local address |
303 | # | |
304 | # Since: 1.5 | |
305 | ## | |
b0ddeba2 MAL |
306 | { 'struct': 'ChardevUdp', |
307 | 'data': { 'remote': 'SocketAddressLegacy', | |
308 | '*local': 'SocketAddressLegacy' }, | |
dbeee392 MA |
309 | 'base': 'ChardevCommon' } |
310 | ||
311 | ## | |
312 | # @ChardevMux: | |
313 | # | |
314 | # Configuration info for mux chardevs. | |
315 | # | |
316 | # @chardev: name of the base chardev. | |
317 | # | |
318 | # Since: 1.5 | |
319 | ## | |
b0ddeba2 MAL |
320 | { 'struct': 'ChardevMux', |
321 | 'data': { 'chardev': 'str' }, | |
dbeee392 MA |
322 | 'base': 'ChardevCommon' } |
323 | ||
324 | ## | |
325 | # @ChardevStdio: | |
326 | # | |
327 | # Configuration info for stdio chardevs. | |
328 | # | |
a937b6aa MA |
329 | # @signal: Allow signals (such as SIGINT triggered by ^C) be delivered |
330 | # to qemu. Default: true. | |
dbeee392 MA |
331 | # |
332 | # Since: 1.5 | |
333 | ## | |
b0ddeba2 MAL |
334 | { 'struct': 'ChardevStdio', |
335 | 'data': { '*signal': 'bool' }, | |
dbeee392 MA |
336 | 'base': 'ChardevCommon' } |
337 | ||
dbeee392 MA |
338 | ## |
339 | # @ChardevSpiceChannel: | |
340 | # | |
341 | # Configuration info for spice vm channel chardevs. | |
342 | # | |
343 | # @type: kind of channel (for example vdagent). | |
344 | # | |
345 | # Since: 1.5 | |
346 | ## | |
b0ddeba2 MAL |
347 | { 'struct': 'ChardevSpiceChannel', |
348 | 'data': { 'type': 'str' }, | |
fd9dda3b | 349 | 'base': 'ChardevCommon', |
8a9f1e1d | 350 | 'if': 'CONFIG_SPICE' } |
dbeee392 MA |
351 | |
352 | ## | |
353 | # @ChardevSpicePort: | |
354 | # | |
355 | # Configuration info for spice port chardevs. | |
356 | # | |
357 | # @fqdn: name of the channel (see docs/spice-port-fqdn.txt) | |
358 | # | |
359 | # Since: 1.5 | |
360 | ## | |
b0ddeba2 MAL |
361 | { 'struct': 'ChardevSpicePort', |
362 | 'data': { 'fqdn': 'str' }, | |
fd9dda3b | 363 | 'base': 'ChardevCommon', |
8a9f1e1d | 364 | 'if': 'CONFIG_SPICE' } |
dbeee392 | 365 | |
3e301c8d MAL |
366 | ## |
367 | # @ChardevDBus: | |
368 | # | |
369 | # Configuration info for DBus chardevs. | |
370 | # | |
371 | # @name: name of the channel (following docs/spice-port-fqdn.txt) | |
372 | # | |
373 | # Since: 7.0 | |
374 | ## | |
375 | { 'struct': 'ChardevDBus', | |
376 | 'data': { 'name': 'str' }, | |
377 | 'base': 'ChardevCommon', | |
378 | 'if': 'CONFIG_DBUS_DISPLAY' } | |
379 | ||
dbeee392 MA |
380 | ## |
381 | # @ChardevVC: | |
382 | # | |
383 | # Configuration info for virtual console chardevs. | |
384 | # | |
c0ac533b | 385 | # @width: console width, in pixels |
a937b6aa | 386 | # |
dbeee392 | 387 | # @height: console height, in pixels |
a937b6aa | 388 | # |
c0ac533b | 389 | # @cols: console width, in chars |
a937b6aa | 390 | # |
c0ac533b | 391 | # @rows: console height, in chars |
dbeee392 MA |
392 | # |
393 | # Since: 1.5 | |
394 | ## | |
b0ddeba2 MAL |
395 | { 'struct': 'ChardevVC', |
396 | 'data': { '*width': 'int', | |
397 | '*height': 'int', | |
398 | '*cols': 'int', | |
399 | '*rows': 'int' }, | |
dbeee392 MA |
400 | 'base': 'ChardevCommon' } |
401 | ||
402 | ## | |
403 | # @ChardevRingbuf: | |
404 | # | |
405 | # Configuration info for ring buffer chardevs. | |
406 | # | |
407 | # @size: ring buffer size, must be power of two, default is 65536 | |
408 | # | |
409 | # Since: 1.5 | |
410 | ## | |
b0ddeba2 MAL |
411 | { 'struct': 'ChardevRingbuf', |
412 | 'data': { '*size': 'int' }, | |
dbeee392 MA |
413 | 'base': 'ChardevCommon' } |
414 | ||
de74a22c GH |
415 | ## |
416 | # @ChardevQemuVDAgent: | |
417 | # | |
418 | # Configuration info for qemu vdagent implementation. | |
419 | # | |
56081919 | 420 | # @mouse: enable/disable mouse, default is enabled. |
a937b6aa | 421 | # |
f0349f4d | 422 | # @clipboard: enable/disable clipboard, default is disabled. |
56081919 | 423 | # |
de74a22c | 424 | # Since: 6.1 |
de74a22c GH |
425 | ## |
426 | { 'struct': 'ChardevQemuVDAgent', | |
f0349f4d GH |
427 | 'data': { '*mouse': 'bool', |
428 | '*clipboard': 'bool' }, | |
de74a22c | 429 | 'base': 'ChardevCommon', |
8a9f1e1d | 430 | 'if': 'CONFIG_SPICE_PROTOCOL' } |
de74a22c | 431 | |
3218c0e9 MA |
432 | ## |
433 | # @ChardevBackendKind: | |
434 | # | |
435 | # @pipe: Since 1.5 | |
a937b6aa | 436 | # |
3218c0e9 | 437 | # @udp: Since 1.5 |
a937b6aa | 438 | # |
3218c0e9 | 439 | # @mux: Since 1.5 |
a937b6aa | 440 | # |
3218c0e9 | 441 | # @msmouse: Since 1.5 |
a937b6aa | 442 | # |
3218c0e9 | 443 | # @wctablet: Since 2.9 |
a937b6aa | 444 | # |
3218c0e9 | 445 | # @braille: Since 1.5 |
a937b6aa | 446 | # |
3218c0e9 | 447 | # @testdev: Since 2.2 |
a937b6aa | 448 | # |
3218c0e9 | 449 | # @stdio: Since 1.5 |
a937b6aa | 450 | # |
3218c0e9 | 451 | # @console: Since 1.5 |
a937b6aa | 452 | # |
3218c0e9 | 453 | # @spicevmc: Since 1.5 |
a937b6aa | 454 | # |
3218c0e9 | 455 | # @spiceport: Since 1.5 |
a937b6aa | 456 | # |
3218c0e9 | 457 | # @qemu-vdagent: Since 6.1 |
a937b6aa | 458 | # |
3e301c8d | 459 | # @dbus: Since 7.0 |
a937b6aa | 460 | # |
3218c0e9 | 461 | # @vc: v1.5 |
a937b6aa | 462 | # |
3218c0e9 | 463 | # @ringbuf: Since 1.6 |
a937b6aa | 464 | # |
3218c0e9 MA |
465 | # @memory: Since 1.5 |
466 | # | |
467 | # Since: 1.4 | |
468 | ## | |
469 | { 'enum': 'ChardevBackendKind', | |
470 | 'data': [ 'file', | |
471 | 'serial', | |
472 | 'parallel', | |
473 | 'pipe', | |
474 | 'socket', | |
475 | 'udp', | |
476 | 'pty', | |
477 | 'null', | |
478 | 'mux', | |
479 | 'msmouse', | |
480 | 'wctablet', | |
481 | 'braille', | |
482 | 'testdev', | |
483 | 'stdio', | |
484 | 'console', | |
485 | { 'name': 'spicevmc', 'if': 'CONFIG_SPICE' }, | |
486 | { 'name': 'spiceport', 'if': 'CONFIG_SPICE' }, | |
487 | { 'name': 'qemu-vdagent', 'if': 'CONFIG_SPICE_PROTOCOL' }, | |
3e301c8d | 488 | { 'name': 'dbus', 'if': 'CONFIG_DBUS_DISPLAY' }, |
3218c0e9 MA |
489 | 'vc', |
490 | 'ringbuf', | |
491 | # next one is just for compatibility | |
492 | 'memory' ] } | |
493 | ||
494 | ## | |
495 | # @ChardevFileWrapper: | |
496 | # | |
497 | # Since: 1.4 | |
498 | ## | |
499 | { 'struct': 'ChardevFileWrapper', | |
500 | 'data': { 'data': 'ChardevFile' } } | |
501 | ||
502 | ## | |
503 | # @ChardevHostdevWrapper: | |
504 | # | |
505 | # Since: 1.4 | |
506 | ## | |
507 | { 'struct': 'ChardevHostdevWrapper', | |
508 | 'data': { 'data': 'ChardevHostdev' } } | |
509 | ||
510 | ## | |
511 | # @ChardevSocketWrapper: | |
512 | # | |
513 | # Since: 1.4 | |
514 | ## | |
515 | { 'struct': 'ChardevSocketWrapper', | |
516 | 'data': { 'data': 'ChardevSocket' } } | |
517 | ||
518 | ## | |
519 | # @ChardevUdpWrapper: | |
520 | # | |
521 | # Since: 1.5 | |
522 | ## | |
523 | { 'struct': 'ChardevUdpWrapper', | |
524 | 'data': { 'data': 'ChardevUdp' } } | |
525 | ||
526 | ## | |
527 | # @ChardevCommonWrapper: | |
528 | # | |
529 | # Since: 2.6 | |
530 | ## | |
531 | { 'struct': 'ChardevCommonWrapper', | |
532 | 'data': { 'data': 'ChardevCommon' } } | |
533 | ||
534 | ## | |
535 | # @ChardevMuxWrapper: | |
536 | # | |
537 | # Since: 1.5 | |
538 | ## | |
539 | { 'struct': 'ChardevMuxWrapper', | |
540 | 'data': { 'data': 'ChardevMux' } } | |
541 | ||
542 | ## | |
543 | # @ChardevStdioWrapper: | |
544 | # | |
545 | # Since: 1.5 | |
546 | ## | |
547 | { 'struct': 'ChardevStdioWrapper', | |
548 | 'data': { 'data': 'ChardevStdio' } } | |
549 | ||
550 | ## | |
551 | # @ChardevSpiceChannelWrapper: | |
552 | # | |
553 | # Since: 1.5 | |
554 | ## | |
555 | { 'struct': 'ChardevSpiceChannelWrapper', | |
556 | 'data': { 'data': 'ChardevSpiceChannel' }, | |
557 | 'if': 'CONFIG_SPICE' } | |
558 | ||
559 | ## | |
560 | # @ChardevSpicePortWrapper: | |
561 | # | |
562 | # Since: 1.5 | |
563 | ## | |
564 | { 'struct': 'ChardevSpicePortWrapper', | |
565 | 'data': { 'data': 'ChardevSpicePort' }, | |
566 | 'if': 'CONFIG_SPICE' } | |
567 | ||
568 | ## | |
569 | # @ChardevQemuVDAgentWrapper: | |
570 | # | |
571 | # Since: 6.1 | |
572 | ## | |
573 | { 'struct': 'ChardevQemuVDAgentWrapper', | |
574 | 'data': { 'data': 'ChardevQemuVDAgent' }, | |
575 | 'if': 'CONFIG_SPICE_PROTOCOL' } | |
576 | ||
3e301c8d MAL |
577 | ## |
578 | # @ChardevDBusWrapper: | |
579 | # | |
580 | # Since: 7.0 | |
581 | ## | |
582 | { 'struct': 'ChardevDBusWrapper', | |
583 | 'data': { 'data': 'ChardevDBus' }, | |
584 | 'if': 'CONFIG_DBUS_DISPLAY' } | |
585 | ||
3218c0e9 MA |
586 | ## |
587 | # @ChardevVCWrapper: | |
588 | # | |
589 | # Since: 1.5 | |
590 | ## | |
591 | { 'struct': 'ChardevVCWrapper', | |
592 | 'data': { 'data': 'ChardevVC' } } | |
593 | ||
594 | ## | |
595 | # @ChardevRingbufWrapper: | |
596 | # | |
597 | # Since: 1.5 | |
598 | ## | |
599 | { 'struct': 'ChardevRingbufWrapper', | |
600 | 'data': { 'data': 'ChardevRingbuf' } } | |
601 | ||
dbeee392 MA |
602 | ## |
603 | # @ChardevBackend: | |
604 | # | |
605 | # Configuration info for the new chardev backend. | |
606 | # | |
3218c0e9 | 607 | # Since: 1.4 |
dbeee392 | 608 | ## |
b0ddeba2 | 609 | { 'union': 'ChardevBackend', |
3218c0e9 MA |
610 | 'base': { 'type': 'ChardevBackendKind' }, |
611 | 'discriminator': 'type', | |
612 | 'data': { 'file': 'ChardevFileWrapper', | |
613 | 'serial': 'ChardevHostdevWrapper', | |
614 | 'parallel': 'ChardevHostdevWrapper', | |
615 | 'pipe': 'ChardevHostdevWrapper', | |
616 | 'socket': 'ChardevSocketWrapper', | |
617 | 'udp': 'ChardevUdpWrapper', | |
618 | 'pty': 'ChardevCommonWrapper', | |
619 | 'null': 'ChardevCommonWrapper', | |
620 | 'mux': 'ChardevMuxWrapper', | |
621 | 'msmouse': 'ChardevCommonWrapper', | |
622 | 'wctablet': 'ChardevCommonWrapper', | |
623 | 'braille': 'ChardevCommonWrapper', | |
624 | 'testdev': 'ChardevCommonWrapper', | |
625 | 'stdio': 'ChardevStdioWrapper', | |
626 | 'console': 'ChardevCommonWrapper', | |
627 | 'spicevmc': { 'type': 'ChardevSpiceChannelWrapper', | |
8a9f1e1d | 628 | 'if': 'CONFIG_SPICE' }, |
3218c0e9 | 629 | 'spiceport': { 'type': 'ChardevSpicePortWrapper', |
8a9f1e1d | 630 | 'if': 'CONFIG_SPICE' }, |
3218c0e9 | 631 | 'qemu-vdagent': { 'type': 'ChardevQemuVDAgentWrapper', |
8a9f1e1d | 632 | 'if': 'CONFIG_SPICE_PROTOCOL' }, |
3e301c8d MAL |
633 | 'dbus': { 'type': 'ChardevDBusWrapper', |
634 | 'if': 'CONFIG_DBUS_DISPLAY' }, | |
3218c0e9 MA |
635 | 'vc': 'ChardevVCWrapper', |
636 | 'ringbuf': 'ChardevRingbufWrapper', | |
b0ddeba2 | 637 | # next one is just for compatibility |
3218c0e9 | 638 | 'memory': 'ChardevRingbufWrapper' } } |
dbeee392 MA |
639 | |
640 | ## | |
641 | # @ChardevReturn: | |
642 | # | |
643 | # Return info about the chardev backend just created. | |
644 | # | |
a937b6aa MA |
645 | # @pty: name of the slave pseudoterminal device, present if and only |
646 | # if a chardev of type 'pty' was created | |
dbeee392 MA |
647 | # |
648 | # Since: 1.4 | |
649 | ## | |
b0ddeba2 MAL |
650 | { 'struct' : 'ChardevReturn', |
651 | 'data': { '*pty': 'str' } } | |
dbeee392 MA |
652 | |
653 | ## | |
654 | # @chardev-add: | |
655 | # | |
656 | # Add a character device backend | |
657 | # | |
658 | # @id: the chardev's ID, must be unique | |
a937b6aa | 659 | # |
dbeee392 MA |
660 | # @backend: backend type and parameters |
661 | # | |
662 | # Returns: ChardevReturn. | |
663 | # | |
664 | # Since: 1.4 | |
665 | # | |
37fa48a4 | 666 | # Examples: |
dbeee392 MA |
667 | # |
668 | # -> { "execute" : "chardev-add", | |
669 | # "arguments" : { "id" : "foo", | |
670 | # "backend" : { "type" : "null", "data" : {} } } } | |
671 | # <- { "return": {} } | |
672 | # | |
673 | # -> { "execute" : "chardev-add", | |
674 | # "arguments" : { "id" : "bar", | |
675 | # "backend" : { "type" : "file", | |
676 | # "data" : { "out" : "/tmp/bar.log" } } } } | |
677 | # <- { "return": {} } | |
678 | # | |
679 | # -> { "execute" : "chardev-add", | |
680 | # "arguments" : { "id" : "baz", | |
681 | # "backend" : { "type" : "pty", "data" : {} } } } | |
682 | # <- { "return": { "pty" : "/dev/pty/42" } } | |
dbeee392 | 683 | ## |
b0ddeba2 MAL |
684 | { 'command': 'chardev-add', |
685 | 'data': { 'id': 'str', | |
686 | 'backend': 'ChardevBackend' }, | |
dbeee392 MA |
687 | 'returns': 'ChardevReturn' } |
688 | ||
689 | ## | |
690 | # @chardev-change: | |
691 | # | |
692 | # Change a character device backend | |
693 | # | |
694 | # @id: the chardev's ID, must exist | |
a937b6aa | 695 | # |
dbeee392 MA |
696 | # @backend: new backend type and parameters |
697 | # | |
698 | # Returns: ChardevReturn. | |
699 | # | |
700 | # Since: 2.10 | |
701 | # | |
37fa48a4 | 702 | # Examples: |
dbeee392 MA |
703 | # |
704 | # -> { "execute" : "chardev-change", | |
705 | # "arguments" : { "id" : "baz", | |
706 | # "backend" : { "type" : "pty", "data" : {} } } } | |
707 | # <- { "return": { "pty" : "/dev/pty/42" } } | |
708 | # | |
709 | # -> {"execute" : "chardev-change", | |
710 | # "arguments" : { | |
711 | # "id" : "charchannel2", | |
712 | # "backend" : { | |
713 | # "type" : "socket", | |
714 | # "data" : { | |
715 | # "addr" : { | |
716 | # "type" : "unix" , | |
717 | # "data" : { | |
718 | # "path" : "/tmp/charchannel2.socket" | |
719 | # } | |
720 | # }, | |
721 | # "server" : true, | |
722 | # "wait" : false }}}} | |
723 | # <- {"return": {}} | |
dbeee392 | 724 | ## |
b0ddeba2 MAL |
725 | { 'command': 'chardev-change', |
726 | 'data': { 'id': 'str', | |
727 | 'backend': 'ChardevBackend' }, | |
dbeee392 MA |
728 | 'returns': 'ChardevReturn' } |
729 | ||
730 | ## | |
731 | # @chardev-remove: | |
732 | # | |
733 | # Remove a character device backend | |
734 | # | |
735 | # @id: the chardev's ID, must exist and not be in use | |
736 | # | |
737 | # Returns: Nothing on success | |
738 | # | |
739 | # Since: 1.4 | |
740 | # | |
741 | # Example: | |
742 | # | |
743 | # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } } | |
744 | # <- { "return": {} } | |
dbeee392 | 745 | ## |
b0ddeba2 MAL |
746 | { 'command': 'chardev-remove', |
747 | 'data': { 'id': 'str' } } | |
dbeee392 MA |
748 | |
749 | ## | |
750 | # @chardev-send-break: | |
751 | # | |
752 | # Send a break to a character device | |
753 | # | |
754 | # @id: the chardev's ID, must exist | |
755 | # | |
756 | # Returns: Nothing on success | |
757 | # | |
758 | # Since: 2.10 | |
759 | # | |
760 | # Example: | |
761 | # | |
762 | # -> { "execute": "chardev-send-break", "arguments": { "id" : "foo" } } | |
763 | # <- { "return": {} } | |
dbeee392 | 764 | ## |
b0ddeba2 MAL |
765 | { 'command': 'chardev-send-break', |
766 | 'data': { 'id': 'str' } } | |
dbeee392 MA |
767 | |
768 | ## | |
769 | # @VSERPORT_CHANGE: | |
770 | # | |
771 | # Emitted when the guest opens or closes a virtio-serial port. | |
772 | # | |
773 | # @id: device identifier of the virtio-serial port | |
774 | # | |
775 | # @open: true if the guest has opened the virtio-serial port | |
776 | # | |
382bd1cb MA |
777 | # Note: This event is rate-limited. |
778 | # | |
dbeee392 MA |
779 | # Since: 2.1 |
780 | # | |
781 | # Example: | |
782 | # | |
783 | # <- { "event": "VSERPORT_CHANGE", | |
784 | # "data": { "id": "channel0", "open": true }, | |
785 | # "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } | |
dbeee392 MA |
786 | ## |
787 | { 'event': 'VSERPORT_CHANGE', | |
b0ddeba2 MAL |
788 | 'data': { 'id': 'str', |
789 | 'open': 'bool' } } |