qapi/common.json

   1 # -*- Mode: Python -*-
   2
   3 ##
   4 # = Common data types
   5 ##
   6
   7 ##
   8 # @IoOperationType:
   9 #
  10 # An enumeration of the I/O operation types
  11 #
  12 # @read: read operation
  13 #
  14 # @write: write operation
  15 #
  16 # Since: 2.1
  17 ##
  18 { 'enum': 'IoOperationType',
  19   'data': [ 'read', 'write' ] }
  20
  21 ##
  22 # @OnOffAuto:
  23 #
  24 # An enumeration of three options: on, off, and auto
  25 #
  26 # @auto: QEMU selects the value between on and off
  27 #
  28 # @on: Enabled
  29 #
  30 # @off: Disabled
  31 #
  32 # Since: 2.2
  33 ##
  34 { 'enum': 'OnOffAuto',
  35   'data': [ 'auto', 'on', 'off' ] }
  36
  37 ##
  38 # @OnOffSplit:
  39 #
  40 # An enumeration of three values: on, off, and split
  41 #
  42 # @on: Enabled
  43 #
  44 # @off: Disabled
  45 #
  46 # @split: Mixed
  47 #
  48 # Since: 2.6
  49 ##
  50 { 'enum': 'OnOffSplit',
  51   'data': [ 'on', 'off', 'split' ] }
  52
  53 ##
  54 # @String:
  55 #
  56 # A fat type wrapping 'str', to be embedded in lists.
  57 #
  58 # Since: 1.2
  59 ##
  60 { 'struct': 'String',
  61   'data': {
  62     'str': 'str' } }
  63
  64 ##
  65 # @StrOrNull:
  66 #
  67 # This is a string value or the explicit lack of a string (null
  68 # pointer in C).  Intended for cases when 'optional absent' already
  69 # has a different meaning.
  70 #
  71 # @s: the string value
  72 # @n: no string value
  73 #
  74 # Since: 2.10
  75 ##
  76 { 'alternate': 'StrOrNull',
  77   'data': { 's': 'str',
  78             'n': 'null' } }
  79
  80 ##
  81 # @OffAutoPCIBAR:
  82 #
  83 # An enumeration of options for specifying a PCI BAR
  84 #
  85 # @off: The specified feature is disabled
  86 #
  87 # @auto: The PCI BAR for the feature is automatically selected
  88 #
  89 # @bar0: PCI BAR0 is used for the feature
  90 #
  91 # @bar1: PCI BAR1 is used for the feature
  92 #
  93 # @bar2: PCI BAR2 is used for the feature
  94 #
  95 # @bar3: PCI BAR3 is used for the feature
  96 #
  97 # @bar4: PCI BAR4 is used for the feature
  98 #
  99 # @bar5: PCI BAR5 is used for the feature
 100 #
 101 # Since: 2.12
 102 ##
 103 { 'enum': 'OffAutoPCIBAR',
 104   'data': [ 'off', 'auto', 'bar0', 'bar1', 'bar2', 'bar3', 'bar4', 'bar5' ] }
 105
 106 ##
 107 # @PCIELinkSpeed:
 108 #
 109 # An enumeration of PCIe link speeds in units of GT/s
 110 #
 111 # @2_5: 2.5GT/s
 112 #
 113 # @5: 5.0GT/s
 114 #
 115 # @8: 8.0GT/s
 116 #
 117 # @16: 16.0GT/s
 118 #
 119 # Since: 4.0
 120 ##
 121 { 'enum': 'PCIELinkSpeed',
 122   'data': [ '2_5', '5', '8', '16' ] }
 123
 124 ##
 125 # @PCIELinkWidth:
 126 #
 127 # An enumeration of PCIe link width
 128 #
 129 # @1: x1
 130 #
 131 # @2: x2
 132 #
 133 # @4: x4
 134 #
 135 # @8: x8
 136 #
 137 # @12: x12
 138 #
 139 # @16: x16
 140 #
 141 # @32: x32
 142 #
 143 # Since: 4.0
 144 ##
 145 { 'enum': 'PCIELinkWidth',
 146   'data': [ '1', '2', '4', '8', '12', '16', '32' ] }