]>
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 | # | |
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 | # | |
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 | # } | |
65 | # | |
66 | ## | |
a87706c8 IM |
67 | { 'command': 'query-chardev', 'returns': ['ChardevInfo'], |
68 | 'allow-preconfig': true } | |
dbeee392 MA |
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'). | |
100cc4fe | 137 | # |
dbeee392 MA |
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', | |
b0ddeba2 MAL |
158 | 'data': { 'device': 'str', |
159 | 'data': 'str', | |
dbeee392 MA |
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'). | |
100cc4fe | 172 | # |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
210 | { 'struct': 'ChardevCommon', |
211 | 'data': { '*logfile': 'str', | |
212 | '*logappend': 'bool' } } | |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
226 | { 'struct': 'ChardevFile', |
227 | 'data': { '*in': 'str', | |
228 | 'out': 'str', | |
229 | '*append': 'bool' }, | |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
242 | { 'struct': 'ChardevHostdev', |
243 | 'data': { 'device': 'str' }, | |
dbeee392 MA |
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) | |
fd4a5fd4 DB |
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) | |
dbeee392 MA |
259 | # @server: create server socket (default: true) |
260 | # @wait: wait for incoming connection on server | |
261 | # sockets (default: false). | |
0f365e33 | 262 | # Silently ignored with server: false. This use is deprecated. |
dbeee392 MA |
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) | |
981b06e7 | 268 | # @websocket: enable websocket protocol on server |
26ec4e53 | 269 | # sockets (default: false) (Since: 3.1) |
dbeee392 | 270 | # @reconnect: For a client socket, if a socket is disconnected, |
26ec4e53 PM |
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) | |
dbeee392 MA |
274 | # |
275 | # Since: 1.4 | |
276 | ## | |
b0ddeba2 MAL |
277 | { 'struct': 'ChardevSocket', |
278 | 'data': { 'addr': 'SocketAddressLegacy', | |
279 | '*tls-creds': 'str', | |
fd4a5fd4 | 280 | '*tls-authz' : 'str', |
b0ddeba2 MAL |
281 | '*server': 'bool', |
282 | '*wait': 'bool', | |
283 | '*nodelay': 'bool', | |
284 | '*telnet': 'bool', | |
285 | '*tn3270': 'bool', | |
286 | '*websocket': 'bool', | |
287 | '*reconnect': 'int' }, | |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
300 | { 'struct': 'ChardevUdp', |
301 | 'data': { 'remote': 'SocketAddressLegacy', | |
302 | '*local': 'SocketAddressLegacy' }, | |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
314 | { 'struct': 'ChardevMux', |
315 | 'data': { 'chardev': 'str' }, | |
dbeee392 MA |
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) | |
6deb20f6 | 324 | # be delivered to qemu. Default: true. |
dbeee392 MA |
325 | # |
326 | # Since: 1.5 | |
327 | ## | |
b0ddeba2 MAL |
328 | { 'struct': 'ChardevStdio', |
329 | 'data': { '*signal': 'bool' }, | |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
342 | { 'struct': 'ChardevSpiceChannel', |
343 | 'data': { 'type': 'str' }, | |
fd9dda3b | 344 | 'base': 'ChardevCommon', |
8a9f1e1d | 345 | 'if': 'CONFIG_SPICE' } |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
356 | { 'struct': 'ChardevSpicePort', |
357 | 'data': { 'fqdn': 'str' }, | |
fd9dda3b | 358 | 'base': 'ChardevCommon', |
8a9f1e1d | 359 | 'if': 'CONFIG_SPICE' } |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
373 | { 'struct': 'ChardevVC', |
374 | 'data': { '*width': 'int', | |
375 | '*height': 'int', | |
376 | '*cols': 'int', | |
377 | '*rows': 'int' }, | |
dbeee392 MA |
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 | ## | |
b0ddeba2 MAL |
389 | { 'struct': 'ChardevRingbuf', |
390 | 'data': { '*size': 'int' }, | |
dbeee392 MA |
391 | 'base': 'ChardevCommon' } |
392 | ||
de74a22c GH |
393 | ## |
394 | # @ChardevQemuVDAgent: | |
395 | # | |
396 | # Configuration info for qemu vdagent implementation. | |
397 | # | |
56081919 | 398 | # @mouse: enable/disable mouse, default is enabled. |
f0349f4d | 399 | # @clipboard: enable/disable clipboard, default is disabled. |
56081919 | 400 | # |
de74a22c GH |
401 | # Since: 6.1 |
402 | # | |
403 | ## | |
404 | { 'struct': 'ChardevQemuVDAgent', | |
f0349f4d GH |
405 | 'data': { '*mouse': 'bool', |
406 | '*clipboard': 'bool' }, | |
de74a22c | 407 | 'base': 'ChardevCommon', |
8a9f1e1d | 408 | 'if': 'CONFIG_SPICE_PROTOCOL' } |
de74a22c | 409 | |
3218c0e9 MA |
410 | ## |
411 | # @ChardevBackendKind: | |
412 | # | |
413 | # @pipe: Since 1.5 | |
414 | # @udp: Since 1.5 | |
415 | # @mux: Since 1.5 | |
416 | # @msmouse: Since 1.5 | |
417 | # @wctablet: Since 2.9 | |
418 | # @braille: Since 1.5 | |
419 | # @testdev: Since 2.2 | |
420 | # @stdio: Since 1.5 | |
421 | # @console: Since 1.5 | |
422 | # @spicevmc: Since 1.5 | |
423 | # @spiceport: Since 1.5 | |
424 | # @qemu-vdagent: Since 6.1 | |
425 | # @vc: v1.5 | |
426 | # @ringbuf: Since 1.6 | |
427 | # @memory: Since 1.5 | |
428 | # | |
429 | # Since: 1.4 | |
430 | ## | |
431 | { 'enum': 'ChardevBackendKind', | |
432 | 'data': [ 'file', | |
433 | 'serial', | |
434 | 'parallel', | |
435 | 'pipe', | |
436 | 'socket', | |
437 | 'udp', | |
438 | 'pty', | |
439 | 'null', | |
440 | 'mux', | |
441 | 'msmouse', | |
442 | 'wctablet', | |
443 | 'braille', | |
444 | 'testdev', | |
445 | 'stdio', | |
446 | 'console', | |
447 | { 'name': 'spicevmc', 'if': 'CONFIG_SPICE' }, | |
448 | { 'name': 'spiceport', 'if': 'CONFIG_SPICE' }, | |
449 | { 'name': 'qemu-vdagent', 'if': 'CONFIG_SPICE_PROTOCOL' }, | |
450 | 'vc', | |
451 | 'ringbuf', | |
452 | # next one is just for compatibility | |
453 | 'memory' ] } | |
454 | ||
455 | ## | |
456 | # @ChardevFileWrapper: | |
457 | # | |
458 | # Since: 1.4 | |
459 | ## | |
460 | { 'struct': 'ChardevFileWrapper', | |
461 | 'data': { 'data': 'ChardevFile' } } | |
462 | ||
463 | ## | |
464 | # @ChardevHostdevWrapper: | |
465 | # | |
466 | # Since: 1.4 | |
467 | ## | |
468 | { 'struct': 'ChardevHostdevWrapper', | |
469 | 'data': { 'data': 'ChardevHostdev' } } | |
470 | ||
471 | ## | |
472 | # @ChardevSocketWrapper: | |
473 | # | |
474 | # Since: 1.4 | |
475 | ## | |
476 | { 'struct': 'ChardevSocketWrapper', | |
477 | 'data': { 'data': 'ChardevSocket' } } | |
478 | ||
479 | ## | |
480 | # @ChardevUdpWrapper: | |
481 | # | |
482 | # Since: 1.5 | |
483 | ## | |
484 | { 'struct': 'ChardevUdpWrapper', | |
485 | 'data': { 'data': 'ChardevUdp' } } | |
486 | ||
487 | ## | |
488 | # @ChardevCommonWrapper: | |
489 | # | |
490 | # Since: 2.6 | |
491 | ## | |
492 | { 'struct': 'ChardevCommonWrapper', | |
493 | 'data': { 'data': 'ChardevCommon' } } | |
494 | ||
495 | ## | |
496 | # @ChardevMuxWrapper: | |
497 | # | |
498 | # Since: 1.5 | |
499 | ## | |
500 | { 'struct': 'ChardevMuxWrapper', | |
501 | 'data': { 'data': 'ChardevMux' } } | |
502 | ||
503 | ## | |
504 | # @ChardevStdioWrapper: | |
505 | # | |
506 | # Since: 1.5 | |
507 | ## | |
508 | { 'struct': 'ChardevStdioWrapper', | |
509 | 'data': { 'data': 'ChardevStdio' } } | |
510 | ||
511 | ## | |
512 | # @ChardevSpiceChannelWrapper: | |
513 | # | |
514 | # Since: 1.5 | |
515 | ## | |
516 | { 'struct': 'ChardevSpiceChannelWrapper', | |
517 | 'data': { 'data': 'ChardevSpiceChannel' }, | |
518 | 'if': 'CONFIG_SPICE' } | |
519 | ||
520 | ## | |
521 | # @ChardevSpicePortWrapper: | |
522 | # | |
523 | # Since: 1.5 | |
524 | ## | |
525 | { 'struct': 'ChardevSpicePortWrapper', | |
526 | 'data': { 'data': 'ChardevSpicePort' }, | |
527 | 'if': 'CONFIG_SPICE' } | |
528 | ||
529 | ## | |
530 | # @ChardevQemuVDAgentWrapper: | |
531 | # | |
532 | # Since: 6.1 | |
533 | ## | |
534 | { 'struct': 'ChardevQemuVDAgentWrapper', | |
535 | 'data': { 'data': 'ChardevQemuVDAgent' }, | |
536 | 'if': 'CONFIG_SPICE_PROTOCOL' } | |
537 | ||
538 | ## | |
539 | # @ChardevVCWrapper: | |
540 | # | |
541 | # Since: 1.5 | |
542 | ## | |
543 | { 'struct': 'ChardevVCWrapper', | |
544 | 'data': { 'data': 'ChardevVC' } } | |
545 | ||
546 | ## | |
547 | # @ChardevRingbufWrapper: | |
548 | # | |
549 | # Since: 1.5 | |
550 | ## | |
551 | { 'struct': 'ChardevRingbufWrapper', | |
552 | 'data': { 'data': 'ChardevRingbuf' } } | |
553 | ||
dbeee392 MA |
554 | ## |
555 | # @ChardevBackend: | |
556 | # | |
557 | # Configuration info for the new chardev backend. | |
558 | # | |
3218c0e9 | 559 | # Since: 1.4 |
dbeee392 | 560 | ## |
b0ddeba2 | 561 | { 'union': 'ChardevBackend', |
3218c0e9 MA |
562 | 'base': { 'type': 'ChardevBackendKind' }, |
563 | 'discriminator': 'type', | |
564 | 'data': { 'file': 'ChardevFileWrapper', | |
565 | 'serial': 'ChardevHostdevWrapper', | |
566 | 'parallel': 'ChardevHostdevWrapper', | |
567 | 'pipe': 'ChardevHostdevWrapper', | |
568 | 'socket': 'ChardevSocketWrapper', | |
569 | 'udp': 'ChardevUdpWrapper', | |
570 | 'pty': 'ChardevCommonWrapper', | |
571 | 'null': 'ChardevCommonWrapper', | |
572 | 'mux': 'ChardevMuxWrapper', | |
573 | 'msmouse': 'ChardevCommonWrapper', | |
574 | 'wctablet': 'ChardevCommonWrapper', | |
575 | 'braille': 'ChardevCommonWrapper', | |
576 | 'testdev': 'ChardevCommonWrapper', | |
577 | 'stdio': 'ChardevStdioWrapper', | |
578 | 'console': 'ChardevCommonWrapper', | |
579 | 'spicevmc': { 'type': 'ChardevSpiceChannelWrapper', | |
8a9f1e1d | 580 | 'if': 'CONFIG_SPICE' }, |
3218c0e9 | 581 | 'spiceport': { 'type': 'ChardevSpicePortWrapper', |
8a9f1e1d | 582 | 'if': 'CONFIG_SPICE' }, |
3218c0e9 | 583 | 'qemu-vdagent': { 'type': 'ChardevQemuVDAgentWrapper', |
8a9f1e1d | 584 | 'if': 'CONFIG_SPICE_PROTOCOL' }, |
3218c0e9 MA |
585 | 'vc': 'ChardevVCWrapper', |
586 | 'ringbuf': 'ChardevRingbufWrapper', | |
b0ddeba2 | 587 | # next one is just for compatibility |
3218c0e9 | 588 | 'memory': 'ChardevRingbufWrapper' } } |
dbeee392 MA |
589 | |
590 | ## | |
591 | # @ChardevReturn: | |
592 | # | |
593 | # Return info about the chardev backend just created. | |
594 | # | |
595 | # @pty: name of the slave pseudoterminal device, present if | |
596 | # and only if a chardev of type 'pty' was created | |
597 | # | |
598 | # Since: 1.4 | |
599 | ## | |
b0ddeba2 MAL |
600 | { 'struct' : 'ChardevReturn', |
601 | 'data': { '*pty': 'str' } } | |
dbeee392 MA |
602 | |
603 | ## | |
604 | # @chardev-add: | |
605 | # | |
606 | # Add a character device backend | |
607 | # | |
608 | # @id: the chardev's ID, must be unique | |
609 | # @backend: backend type and parameters | |
610 | # | |
611 | # Returns: ChardevReturn. | |
612 | # | |
613 | # Since: 1.4 | |
614 | # | |
615 | # Example: | |
616 | # | |
617 | # -> { "execute" : "chardev-add", | |
618 | # "arguments" : { "id" : "foo", | |
619 | # "backend" : { "type" : "null", "data" : {} } } } | |
620 | # <- { "return": {} } | |
621 | # | |
622 | # -> { "execute" : "chardev-add", | |
623 | # "arguments" : { "id" : "bar", | |
624 | # "backend" : { "type" : "file", | |
625 | # "data" : { "out" : "/tmp/bar.log" } } } } | |
626 | # <- { "return": {} } | |
627 | # | |
628 | # -> { "execute" : "chardev-add", | |
629 | # "arguments" : { "id" : "baz", | |
630 | # "backend" : { "type" : "pty", "data" : {} } } } | |
631 | # <- { "return": { "pty" : "/dev/pty/42" } } | |
632 | # | |
633 | ## | |
b0ddeba2 MAL |
634 | { 'command': 'chardev-add', |
635 | 'data': { 'id': 'str', | |
636 | 'backend': 'ChardevBackend' }, | |
dbeee392 MA |
637 | 'returns': 'ChardevReturn' } |
638 | ||
639 | ## | |
640 | # @chardev-change: | |
641 | # | |
642 | # Change a character device backend | |
643 | # | |
644 | # @id: the chardev's ID, must exist | |
645 | # @backend: new backend type and parameters | |
646 | # | |
647 | # Returns: ChardevReturn. | |
648 | # | |
649 | # Since: 2.10 | |
650 | # | |
651 | # Example: | |
652 | # | |
653 | # -> { "execute" : "chardev-change", | |
654 | # "arguments" : { "id" : "baz", | |
655 | # "backend" : { "type" : "pty", "data" : {} } } } | |
656 | # <- { "return": { "pty" : "/dev/pty/42" } } | |
657 | # | |
658 | # -> {"execute" : "chardev-change", | |
659 | # "arguments" : { | |
660 | # "id" : "charchannel2", | |
661 | # "backend" : { | |
662 | # "type" : "socket", | |
663 | # "data" : { | |
664 | # "addr" : { | |
665 | # "type" : "unix" , | |
666 | # "data" : { | |
667 | # "path" : "/tmp/charchannel2.socket" | |
668 | # } | |
669 | # }, | |
670 | # "server" : true, | |
671 | # "wait" : false }}}} | |
672 | # <- {"return": {}} | |
673 | # | |
674 | ## | |
b0ddeba2 MAL |
675 | { 'command': 'chardev-change', |
676 | 'data': { 'id': 'str', | |
677 | 'backend': 'ChardevBackend' }, | |
dbeee392 MA |
678 | 'returns': 'ChardevReturn' } |
679 | ||
680 | ## | |
681 | # @chardev-remove: | |
682 | # | |
683 | # Remove a character device backend | |
684 | # | |
685 | # @id: the chardev's ID, must exist and not be in use | |
686 | # | |
687 | # Returns: Nothing on success | |
688 | # | |
689 | # Since: 1.4 | |
690 | # | |
691 | # Example: | |
692 | # | |
693 | # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } } | |
694 | # <- { "return": {} } | |
695 | # | |
696 | ## | |
b0ddeba2 MAL |
697 | { 'command': 'chardev-remove', |
698 | 'data': { 'id': 'str' } } | |
dbeee392 MA |
699 | |
700 | ## | |
701 | # @chardev-send-break: | |
702 | # | |
703 | # Send a break to a character device | |
704 | # | |
705 | # @id: the chardev's ID, must exist | |
706 | # | |
707 | # Returns: Nothing on success | |
708 | # | |
709 | # Since: 2.10 | |
710 | # | |
711 | # Example: | |
712 | # | |
713 | # -> { "execute": "chardev-send-break", "arguments": { "id" : "foo" } } | |
714 | # <- { "return": {} } | |
715 | # | |
716 | ## | |
b0ddeba2 MAL |
717 | { 'command': 'chardev-send-break', |
718 | 'data': { 'id': 'str' } } | |
dbeee392 MA |
719 | |
720 | ## | |
721 | # @VSERPORT_CHANGE: | |
722 | # | |
723 | # Emitted when the guest opens or closes a virtio-serial port. | |
724 | # | |
725 | # @id: device identifier of the virtio-serial port | |
726 | # | |
727 | # @open: true if the guest has opened the virtio-serial port | |
728 | # | |
382bd1cb MA |
729 | # Note: This event is rate-limited. |
730 | # | |
dbeee392 MA |
731 | # Since: 2.1 |
732 | # | |
733 | # Example: | |
734 | # | |
735 | # <- { "event": "VSERPORT_CHANGE", | |
736 | # "data": { "id": "channel0", "open": true }, | |
737 | # "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } | |
738 | # | |
739 | ## | |
740 | { 'event': 'VSERPORT_CHANGE', | |
b0ddeba2 MAL |
741 | 'data': { 'id': 'str', |
742 | 'open': 'bool' } } |