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
  21 #     backend (e.g. with the chardev=... option) is in open or closed
  22 #     state (since 2.1)
  23 #
  24 # .. note:: @filename is encoded using the QEMU command line character
  25 #    device 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 # .. qmp-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 { 'command': 'query-chardev', 'returns': ['ChardevInfo'],
  67   'allow-preconfig': true }
  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 # .. qmp-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 #        }
 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').
 135 #
 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.
 141 #
 142 # Since: 1.4
 143 #
 144 # .. qmp-example::
 145 #
 146 #     -> { "execute": "ringbuf-write",
 147 #          "arguments": { "device": "foo",
 148 #                         "data": "abcdefgh",
 149 #                         "format": "utf8" } }
 150 #     <- { "return": {} }
 151 ##
 152 { 'command': 'ringbuf-write',
 153   'data': { 'device': 'str',
 154             'data': 'str',
 155            '*format': 'DataFormat'} }
 156
 157 ##
 158 # @ringbuf-read:
 159 #
 160 # Read from a ring buffer character device.
 161 #
 162 # @device: the ring buffer character device name
 163 #
 164 # @size: how many bytes to read at most
 165 #
 166 # @format: data encoding (default 'utf8').
 167 #
 168 #     - base64: the data read is returned in base64 encoding.
 169 #     - utf8: the data read is interpreted as UTF-8.
 170 #       Bug: can screw up when the buffer contains invalid UTF-8
 171 #       sequences, NUL characters, after the ring buffer lost data,
 172 #       and when reading stops because the size limit is reached.
 173 #     - The return value is always Unicode regardless of format, like
 174 #       any other string.
 175 #
 176 # Returns: data read from the device
 177 #
 178 # Since: 1.4
 179 #
 180 # .. qmp-example::
 181 #
 182 #     -> { "execute": "ringbuf-read",
 183 #          "arguments": { "device": "foo",
 184 #                         "size": 1000,
 185 #                         "format": "utf8" } }
 186 #     <- { "return": "abcdefgh" }
 187 ##
 188 { 'command': 'ringbuf-read',
 189   'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
 190   'returns': 'str' }
 191
 192 ##
 193 # @ChardevCommon:
 194 #
 195 # Configuration shared across all chardev backends
 196 #
 197 # @logfile: The name of a logfile to save output
 198 #
 199 # @logappend: true to append instead of truncate (default to false to
 200 #     truncate)
 201 #
 202 # Since: 2.6
 203 ##
 204 { 'struct': 'ChardevCommon',
 205   'data': { '*logfile': 'str',
 206             '*logappend': 'bool' } }
 207
 208 ##
 209 # @ChardevFile:
 210 #
 211 # Configuration info for file chardevs.
 212 #
 213 # @in: The name of the input file
 214 #
 215 # @out: The name of the output file
 216 #
 217 # @append: Open the file in append mode (default false to truncate)
 218 #     (Since 2.6)
 219 #
 220 # Since: 1.4
 221 ##
 222 { 'struct': 'ChardevFile',
 223   'data': { '*in': 'str',
 224             'out': 'str',
 225             '*append': 'bool' },
 226   'base': 'ChardevCommon' }
 227
 228 ##
 229 # @ChardevHostdev:
 230 #
 231 # Configuration info for device and pipe chardevs.
 232 #
 233 # @device: The name of the special file for the device, i.e.
 234 #     /dev/ttyS0 on Unix or COM1: on Windows
 235 #
 236 # Since: 1.4
 237 ##
 238 { 'struct': 'ChardevHostdev',
 239   'data': { 'device': 'str' },
 240   'base': 'ChardevCommon' }
 241
 242 ##
 243 # @ChardevSocket:
 244 #
 245 # Configuration info for (stream) socket chardevs.
 246 #
 247 # @addr: socket address to listen on (server=true) or connect to
 248 #     (server=false)
 249 #
 250 # @tls-creds: the ID of the TLS credentials object (since 2.6)
 251 #
 252 # @tls-authz: the ID of the QAuthZ authorization object against which
 253 #     the client's x509 distinguished name will be validated.  This
 254 #     object is only resolved at time of use, so can be deleted and
 255 #     recreated on the fly while the chardev server is active.  If
 256 #     missing, it will default to denying access (since 4.0)
 257 #
 258 # @server: create server socket (default: true)
 259 #
 260 # @wait: wait for incoming connection on server sockets (default:
 261 #     false).  Silently ignored with server: false.  This use is
 262 #     deprecated.
 263 #
 264 # @nodelay: set TCP_NODELAY socket option (default: false)
 265 #
 266 # @telnet: enable telnet protocol on server sockets (default: false)
 267 #
 268 # @tn3270: enable tn3270 protocol on server sockets (default: false)
 269 #     (Since: 2.10)
 270 #
 271 # @websocket: enable websocket protocol on server sockets
 272 #     (default: false) (Since: 3.1)
 273 #
 274 # @reconnect: For a client socket, if a socket is disconnected, then
 275 #     attempt a reconnect after the given number of seconds.  Setting
 276 #     this to zero disables this function.  The use of this member is
 277 #     deprecated, use @reconnect-ms instead. (default: 0) (Since: 2.2)
 278 #
 279 # @reconnect-ms: For a client socket, if a socket is disconnected,
 280 #     then attempt a reconnect after the given number of milliseconds.
 281 #     Setting this to zero disables this function.  This member is
 282 #     mutually exclusive with @reconnect.
 283 #     (default: 0) (Since: 9.2)
 284 #
 285 # Features:
 286 #
 287 # @deprecated: Member @reconnect is deprecated.  Use @reconnect-ms
 288 #     instead.
 289 #
 290 # Since: 1.4
 291 ##
 292 { 'struct': 'ChardevSocket',
 293   'data': { 'addr': 'SocketAddressLegacy',
 294             '*tls-creds': 'str',
 295             '*tls-authz'  : 'str',
 296             '*server': 'bool',
 297             '*wait': 'bool',
 298             '*nodelay': 'bool',
 299             '*telnet': 'bool',
 300             '*tn3270': 'bool',
 301             '*websocket': 'bool',
 302             '*reconnect': { 'type': 'int', 'features': [ 'deprecated' ] },
 303             '*reconnect-ms': 'int' },
 304   'base': 'ChardevCommon' }
 305
 306 ##
 307 # @ChardevUdp:
 308 #
 309 # Configuration info for datagram socket chardevs.
 310 #
 311 # @remote: remote address
 312 #
 313 # @local: local address
 314 #
 315 # Since: 1.5
 316 ##
 317 { 'struct': 'ChardevUdp',
 318   'data': { 'remote': 'SocketAddressLegacy',
 319             '*local': 'SocketAddressLegacy' },
 320   'base': 'ChardevCommon' }
 321
 322 ##
 323 # @ChardevMux:
 324 #
 325 # Configuration info for mux chardevs.
 326 #
 327 # @chardev: name of the base chardev.
 328 #
 329 # Since: 1.5
 330 ##
 331 { 'struct': 'ChardevMux',
 332   'data': { 'chardev': 'str' },
 333   'base': 'ChardevCommon' }
 334
 335 ##
 336 # @ChardevStdio:
 337 #
 338 # Configuration info for stdio chardevs.
 339 #
 340 # @signal: Allow signals (such as SIGINT triggered by ^C) be delivered
 341 #     to qemu.  Default: true.
 342 #
 343 # Since: 1.5
 344 ##
 345 { 'struct': 'ChardevStdio',
 346   'data': { '*signal': 'bool' },
 347   'base': 'ChardevCommon' }
 348
 349 ##
 350 # @ChardevSpiceChannel:
 351 #
 352 # Configuration info for spice vm channel chardevs.
 353 #
 354 # @type: kind of channel (for example vdagent).
 355 #
 356 # Since: 1.5
 357 ##
 358 { 'struct': 'ChardevSpiceChannel',
 359   'data': { 'type': 'str' },
 360   'base': 'ChardevCommon',
 361   'if': 'CONFIG_SPICE' }
 362
 363 ##
 364 # @ChardevSpicePort:
 365 #
 366 # Configuration info for spice port chardevs.
 367 #
 368 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
 369 #
 370 # Since: 1.5
 371 ##
 372 { 'struct': 'ChardevSpicePort',
 373   'data': { 'fqdn': 'str' },
 374   'base': 'ChardevCommon',
 375   'if': 'CONFIG_SPICE' }
 376
 377 ##
 378 # @ChardevDBus:
 379 #
 380 # Configuration info for DBus chardevs.
 381 #
 382 # @name: name of the channel (following docs/spice-port-fqdn.txt)
 383 #
 384 # Since: 7.0
 385 ##
 386 { 'struct': 'ChardevDBus',
 387   'data': { 'name': 'str' },
 388   'base': 'ChardevCommon',
 389   'if': 'CONFIG_DBUS_DISPLAY' }
 390
 391 ##
 392 # @ChardevVC:
 393 #
 394 # Configuration info for virtual console chardevs.
 395 #
 396 # @width: console width, in pixels
 397 #
 398 # @height: console height, in pixels
 399 #
 400 # @cols: console width, in chars
 401 #
 402 # @rows: console height, in chars
 403 #
 404 # .. note:: The options are only effective when the VNC or SDL
 405 #    graphical display backend is active.  They are ignored with the
 406 #    GTK, Spice, VNC and D-Bus display backends.
 407 #
 408 # Since: 1.5
 409 ##
 410 { 'struct': 'ChardevVC',
 411   'data': { '*width': 'int',
 412             '*height': 'int',
 413             '*cols': 'int',
 414             '*rows': 'int' },
 415   'base': 'ChardevCommon' }
 416
 417 ##
 418 # @ChardevRingbuf:
 419 #
 420 # Configuration info for ring buffer chardevs.
 421 #
 422 # @size: ring buffer size, must be power of two, default is 65536
 423 #
 424 # Since: 1.5
 425 ##
 426 { 'struct': 'ChardevRingbuf',
 427   'data': { '*size': 'int' },
 428   'base': 'ChardevCommon' }
 429
 430 ##
 431 # @ChardevQemuVDAgent:
 432 #
 433 # Configuration info for qemu vdagent implementation.
 434 #
 435 # @mouse: enable/disable mouse, default is enabled.
 436 #
 437 # @clipboard: enable/disable clipboard, default is disabled.
 438 #
 439 # Since: 6.1
 440 ##
 441 { 'struct': 'ChardevQemuVDAgent',
 442   'data': { '*mouse': 'bool',
 443             '*clipboard': 'bool' },
 444   'base': 'ChardevCommon',
 445   'if': 'CONFIG_SPICE_PROTOCOL' }
 446
 447 ##
 448 # @ChardevPty:
 449 #
 450 # Configuration info for pty implementation.
 451 #
 452 # @path: optional path to create a symbolic link that points to the
 453 #     allocated PTY
 454 #
 455 # Since: 9.2
 456 ##
 457 { 'struct': 'ChardevPty',
 458   'data': { '*path': 'str' },
 459   'base': 'ChardevCommon' }
 460
 461 ##
 462 # @ChardevBackendKind:
 463 #
 464 # @file: regular files
 465 #
 466 # @serial: serial host device
 467 #
 468 # @parallel: parallel host device
 469 #
 470 # @pipe: pipes (since 1.5)
 471 #
 472 # @socket: stream socket
 473 #
 474 # @udp: datagram socket (since 1.5)
 475 #
 476 # @pty: pseudo-terminal
 477 #
 478 # @null: provides no input, throws away output
 479 #
 480 # @mux: (since 1.5)
 481 #
 482 # @msmouse: emulated Microsoft serial mouse (since 1.5)
 483 #
 484 # @wctablet: emulated Wacom Penpartner serial tablet (since 2.9)
 485 #
 486 # @braille: Baum Braille device (since 1.5)
 487 #
 488 # @testdev: device for test-suite control (since 2.2)
 489 #
 490 # @stdio: standard I/O (since 1.5)
 491 #
 492 # @console: Windows console (since 1.5)
 493 #
 494 # @spicevmc: spice vm channel (since 1.5)
 495 #
 496 # @spiceport: Spice port channel (since 1.5)
 497 #
 498 # @qemu-vdagent: Spice vdagent (since 6.1)
 499 #
 500 # @dbus: D-Bus channel (since 7.0)
 501 #
 502 # @vc: virtual console (since 1.5)
 503 #
 504 # @ringbuf: memory ring buffer (since 1.6)
 505 #
 506 # @memory: synonym for @ringbuf (since 1.5)
 507 #
 508 # Features:
 509 #
 510 # @deprecated: Member @memory is deprecated.  Use @ringbuf instead.
 511 #
 512 # Since: 1.4
 513 ##
 514 { 'enum': 'ChardevBackendKind',
 515   'data': [ 'file',
 516             { 'name': 'serial', 'if': 'HAVE_CHARDEV_SERIAL' },
 517             { 'name': 'parallel', 'if': 'HAVE_CHARDEV_PARALLEL' },
 518             'pipe',
 519             'socket',
 520             'udp',
 521             'pty',
 522             'null',
 523             'mux',
 524             'msmouse',
 525             'wctablet',
 526             { 'name': 'braille', 'if': 'CONFIG_BRLAPI' },
 527             'testdev',
 528             'stdio',
 529             { 'name': 'console', 'if': 'CONFIG_WIN32' },
 530             { 'name': 'spicevmc', 'if': 'CONFIG_SPICE' },
 531             { 'name': 'spiceport', 'if': 'CONFIG_SPICE' },
 532             { 'name': 'qemu-vdagent', 'if': 'CONFIG_SPICE_PROTOCOL' },
 533             { 'name': 'dbus', 'if': 'CONFIG_DBUS_DISPLAY' },
 534             'vc',
 535             'ringbuf',
 536             { 'name': 'memory', 'features': [ 'deprecated' ] } ] }
 537
 538 ##
 539 # @ChardevFileWrapper:
 540 #
 541 # @data: Configuration info for file chardevs
 542 #
 543 # Since: 1.4
 544 ##
 545 { 'struct': 'ChardevFileWrapper',
 546   'data': { 'data': 'ChardevFile' } }
 547
 548 ##
 549 # @ChardevHostdevWrapper:
 550 #
 551 # @data: Configuration info for device and pipe chardevs
 552 #
 553 # Since: 1.4
 554 ##
 555 { 'struct': 'ChardevHostdevWrapper',
 556   'data': { 'data': 'ChardevHostdev' } }
 557
 558 ##
 559 # @ChardevSocketWrapper:
 560 #
 561 # @data: Configuration info for (stream) socket chardevs
 562 #
 563 # Since: 1.4
 564 ##
 565 { 'struct': 'ChardevSocketWrapper',
 566   'data': { 'data': 'ChardevSocket' } }
 567
 568 ##
 569 # @ChardevUdpWrapper:
 570 #
 571 # @data: Configuration info for datagram socket chardevs
 572 #
 573 # Since: 1.5
 574 ##
 575 { 'struct': 'ChardevUdpWrapper',
 576   'data': { 'data': 'ChardevUdp' } }
 577
 578 ##
 579 # @ChardevCommonWrapper:
 580 #
 581 # @data: Configuration shared across all chardev backends
 582 #
 583 # Since: 2.6
 584 ##
 585 { 'struct': 'ChardevCommonWrapper',
 586   'data': { 'data': 'ChardevCommon' } }
 587
 588 ##
 589 # @ChardevMuxWrapper:
 590 #
 591 # @data: Configuration info for mux chardevs
 592 #
 593 # Since: 1.5
 594 ##
 595 { 'struct': 'ChardevMuxWrapper',
 596   'data': { 'data': 'ChardevMux' } }
 597
 598 ##
 599 # @ChardevStdioWrapper:
 600 #
 601 # @data: Configuration info for stdio chardevs
 602 #
 603 # Since: 1.5
 604 ##
 605 { 'struct': 'ChardevStdioWrapper',
 606   'data': { 'data': 'ChardevStdio' } }
 607
 608 ##
 609 # @ChardevSpiceChannelWrapper:
 610 #
 611 # @data: Configuration info for spice vm channel chardevs
 612 #
 613 # Since: 1.5
 614 ##
 615 { 'struct': 'ChardevSpiceChannelWrapper',
 616   'data': { 'data': 'ChardevSpiceChannel' },
 617   'if': 'CONFIG_SPICE' }
 618
 619 ##
 620 # @ChardevSpicePortWrapper:
 621 #
 622 # @data: Configuration info for spice port chardevs
 623 #
 624 # Since: 1.5
 625 ##
 626 { 'struct': 'ChardevSpicePortWrapper',
 627   'data': { 'data': 'ChardevSpicePort' },
 628   'if': 'CONFIG_SPICE' }
 629
 630 ##
 631 # @ChardevQemuVDAgentWrapper:
 632 #
 633 # @data: Configuration info for qemu vdagent implementation
 634 #
 635 # Since: 6.1
 636 ##
 637 { 'struct': 'ChardevQemuVDAgentWrapper',
 638   'data': { 'data': 'ChardevQemuVDAgent' },
 639   'if': 'CONFIG_SPICE_PROTOCOL' }
 640
 641 ##
 642 # @ChardevDBusWrapper:
 643 #
 644 # @data: Configuration info for DBus chardevs
 645 #
 646 # Since: 7.0
 647 ##
 648 { 'struct': 'ChardevDBusWrapper',
 649   'data': { 'data': 'ChardevDBus' },
 650   'if': 'CONFIG_DBUS_DISPLAY' }
 651
 652 ##
 653 # @ChardevVCWrapper:
 654 #
 655 # @data: Configuration info for virtual console chardevs
 656 #
 657 # Since: 1.5
 658 ##
 659 { 'struct': 'ChardevVCWrapper',
 660   'data': { 'data': 'ChardevVC' } }
 661
 662 ##
 663 # @ChardevRingbufWrapper:
 664 #
 665 # @data: Configuration info for ring buffer chardevs
 666 #
 667 # Since: 1.5
 668 ##
 669 { 'struct': 'ChardevRingbufWrapper',
 670   'data': { 'data': 'ChardevRingbuf' } }
 671
 672
 673 ##
 674 # @ChardevPtyWrapper:
 675 #
 676 # @data: Configuration info for pty chardevs
 677 #
 678 # Since: 9.2
 679 ##
 680 { 'struct': 'ChardevPtyWrapper',
 681   'data': { 'data': 'ChardevPty' } }
 682
 683 ##
 684 # @ChardevBackend:
 685 #
 686 # Configuration info for the new chardev backend.
 687 #
 688 # @type: backend type
 689 #
 690 # Since: 1.4
 691 ##
 692 { 'union': 'ChardevBackend',
 693   'base': { 'type': 'ChardevBackendKind' },
 694   'discriminator': 'type',
 695   'data': { 'file': 'ChardevFileWrapper',
 696             'serial': { 'type': 'ChardevHostdevWrapper',
 697                         'if': 'HAVE_CHARDEV_SERIAL' },
 698             'parallel': { 'type': 'ChardevHostdevWrapper',
 699                           'if': 'HAVE_CHARDEV_PARALLEL' },
 700             'pipe': 'ChardevHostdevWrapper',
 701             'socket': 'ChardevSocketWrapper',
 702             'udp': 'ChardevUdpWrapper',
 703             'pty': 'ChardevPtyWrapper',
 704             'null': 'ChardevCommonWrapper',
 705             'mux': 'ChardevMuxWrapper',
 706             'msmouse': 'ChardevCommonWrapper',
 707             'wctablet': 'ChardevCommonWrapper',
 708             'braille': { 'type': 'ChardevCommonWrapper',
 709                          'if': 'CONFIG_BRLAPI' },
 710             'testdev': 'ChardevCommonWrapper',
 711             'stdio': 'ChardevStdioWrapper',
 712             'console': { 'type': 'ChardevCommonWrapper',
 713                          'if': 'CONFIG_WIN32' },
 714             'spicevmc': { 'type': 'ChardevSpiceChannelWrapper',
 715                           'if': 'CONFIG_SPICE' },
 716             'spiceport': { 'type': 'ChardevSpicePortWrapper',
 717                            'if': 'CONFIG_SPICE' },
 718             'qemu-vdagent': { 'type': 'ChardevQemuVDAgentWrapper',
 719                               'if': 'CONFIG_SPICE_PROTOCOL' },
 720             'dbus': { 'type': 'ChardevDBusWrapper',
 721                       'if': 'CONFIG_DBUS_DISPLAY' },
 722             'vc': 'ChardevVCWrapper',
 723             'ringbuf': 'ChardevRingbufWrapper',
 724             'memory': 'ChardevRingbufWrapper' } }
 725
 726 ##
 727 # @ChardevReturn:
 728 #
 729 # Return info about the chardev backend just created.
 730 #
 731 # @pty: name of the slave pseudoterminal device, present if and only
 732 #     if a chardev of type 'pty' was created
 733 #
 734 # Since: 1.4
 735 ##
 736 { 'struct' : 'ChardevReturn',
 737   'data': { '*pty': 'str' } }
 738
 739 ##
 740 # @chardev-add:
 741 #
 742 # Add a character device backend
 743 #
 744 # @id: the chardev's ID, must be unique
 745 #
 746 # @backend: backend type and parameters
 747 #
 748 # Returns: ChardevReturn.
 749 #
 750 # Since: 1.4
 751 #
 752 # .. qmp-example::
 753 #
 754 #     -> { "execute" : "chardev-add",
 755 #          "arguments" : { "id" : "foo",
 756 #                          "backend" : { "type" : "null", "data" : {} } } }
 757 #     <- { "return": {} }
 758 #
 759 # .. qmp-example::
 760 #
 761 #     -> { "execute" : "chardev-add",
 762 #          "arguments" : { "id" : "bar",
 763 #                          "backend" : { "type" : "file",
 764 #                                        "data" : { "out" : "/tmp/bar.log" } } } }
 765 #     <- { "return": {} }
 766 #
 767 # .. qmp-example::
 768 #
 769 #     -> { "execute" : "chardev-add",
 770 #          "arguments" : { "id" : "baz",
 771 #                          "backend" : { "type" : "pty", "data" : {} } } }
 772 #     <- { "return": { "pty" : "/dev/pty/42" } }
 773 ##
 774 { 'command': 'chardev-add',
 775   'data': { 'id': 'str',
 776             'backend': 'ChardevBackend' },
 777   'returns': 'ChardevReturn' }
 778
 779 ##
 780 # @chardev-change:
 781 #
 782 # Change a character device backend
 783 #
 784 # @id: the chardev's ID, must exist
 785 #
 786 # @backend: new backend type and parameters
 787 #
 788 # Returns: ChardevReturn.
 789 #
 790 # Since: 2.10
 791 #
 792 # .. qmp-example::
 793 #
 794 #     -> { "execute" : "chardev-change",
 795 #          "arguments" : { "id" : "baz",
 796 #                          "backend" : { "type" : "pty", "data" : {} } } }
 797 #     <- { "return": { "pty" : "/dev/pty/42" } }
 798 #
 799 # .. qmp-example::
 800 #
 801 #     -> {"execute" : "chardev-change",
 802 #         "arguments" : {
 803 #             "id" : "charchannel2",
 804 #             "backend" : {
 805 #                 "type" : "socket",
 806 #                 "data" : {
 807 #                     "addr" : {
 808 #                         "type" : "unix" ,
 809 #                         "data" : {
 810 #                             "path" : "/tmp/charchannel2.socket"
 811 #                         }
 812 #                      },
 813 #                      "server" : true,
 814 #                      "wait" : false }}}}
 815 #     <- {"return": {}}
 816 ##
 817 { 'command': 'chardev-change',
 818   'data': { 'id': 'str',
 819             'backend': 'ChardevBackend' },
 820   'returns': 'ChardevReturn' }
 821
 822 ##
 823 # @chardev-remove:
 824 #
 825 # Remove a character device backend
 826 #
 827 # @id: the chardev's ID, must exist and not be in use
 828 #
 829 # Since: 1.4
 830 #
 831 # .. qmp-example::
 832 #
 833 #     -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
 834 #     <- { "return": {} }
 835 ##
 836 { 'command': 'chardev-remove',
 837   'data': { 'id': 'str' } }
 838
 839 ##
 840 # @chardev-send-break:
 841 #
 842 # Send a break to a character device
 843 #
 844 # @id: the chardev's ID, must exist
 845 #
 846 # Since: 2.10
 847 #
 848 # .. qmp-example::
 849 #
 850 #     -> { "execute": "chardev-send-break", "arguments": { "id" : "foo" } }
 851 #     <- { "return": {} }
 852 ##
 853 { 'command': 'chardev-send-break',
 854   'data': { 'id': 'str' } }
 855
 856 ##
 857 # @VSERPORT_CHANGE:
 858 #
 859 # Emitted when the guest opens or closes a virtio-serial port.
 860 #
 861 # @id: device identifier of the virtio-serial port
 862 #
 863 # @open: true if the guest has opened the virtio-serial port
 864 #
 865 # .. note:: This event is rate-limited.
 866 #
 867 # Since: 2.1
 868 #
 869 # .. qmp-example::
 870 #
 871 #     <- { "event": "VSERPORT_CHANGE",
 872 #          "data": { "id": "channel0", "open": true },
 873 #          "timestamp": { "seconds": 1401385907, "microseconds": 422329 } }
 874 ##
 875 { 'event': 'VSERPORT_CHANGE',
 876   'data': { 'id': 'str',
 877             'open': 'bool' } }