qemu/qapi/common.json
<<
>>
Prefs
   1# -*- Mode: Python -*-
   2
   3##
   4# = Common data types
   5##
   6
   7##
   8# @QapiErrorClass:
   9#
  10# QEMU error classes
  11#
  12# @GenericError: this is used for errors that don't require a specific error
  13#                class. This should be the default case for most errors
  14#
  15# @CommandNotFound: the requested command has not been found
  16#
  17# @DeviceNotActive: a device has failed to be become active
  18#
  19# @DeviceNotFound: the requested device has not been found
  20#
  21# @KVMMissingCap: the requested operation can't be fulfilled because a
  22#                 required KVM capability is missing
  23#
  24# Since: 1.2
  25##
  26{ 'enum': 'QapiErrorClass',
  27  # Keep this in sync with ErrorClass in error.h
  28  'data': [ 'GenericError', 'CommandNotFound',
  29            'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }
  30
  31##
  32# @IoOperationType:
  33#
  34# An enumeration of the I/O operation types
  35#
  36# @read: read operation
  37#
  38# @write: write operation
  39#
  40# Since: 2.1
  41##
  42{ 'enum': 'IoOperationType',
  43  'data': [ 'read', 'write' ] }
  44
  45##
  46# @OnOffAuto:
  47#
  48# An enumeration of three options: on, off, and auto
  49#
  50# @auto: QEMU selects the value between on and off
  51#
  52# @on: Enabled
  53#
  54# @off: Disabled
  55#
  56# Since: 2.2
  57##
  58{ 'enum': 'OnOffAuto',
  59  'data': [ 'auto', 'on', 'off' ] }
  60
  61##
  62# @OnOffSplit:
  63#
  64# An enumeration of three values: on, off, and split
  65#
  66# @on: Enabled
  67#
  68# @off: Disabled
  69#
  70# @split: Mixed
  71#
  72# Since: 2.6
  73##
  74{ 'enum': 'OnOffSplit',
  75  'data': [ 'on', 'off', 'split' ] }
  76
  77##
  78# @String:
  79#
  80# A fat type wrapping 'str', to be embedded in lists.
  81#
  82# Since: 1.2
  83##
  84{ 'struct': 'String',
  85  'data': {
  86    'str': 'str' } }
  87
  88##
  89# @StrOrNull:
  90#
  91# This is a string value or the explicit lack of a string (null
  92# pointer in C).  Intended for cases when 'optional absent' already
  93# has a different meaning.
  94#
  95# @s: the string value
  96# @n: no string value
  97#
  98# Since: 2.10
  99##
 100{ 'alternate': 'StrOrNull',
 101  'data': { 's': 'str',
 102            'n': 'null' } }
 103