scripts: kernel-doc: fix troubles with line counts
[qemu/ar7.git] / qapi / common.json
blob716712d4b317e81c926bf4f308e869b651c05330
1 # -*- Mode: Python -*-
2 # vim: filetype=python
4 ##
5 # = Common data types
6 ##
8 ##
9 # @IoOperationType:
11 # An enumeration of the I/O operation types
13 # @read: read operation
15 # @write: write operation
17 # Since: 2.1
19 { 'enum': 'IoOperationType',
20   'data': [ 'read', 'write' ] }
23 # @OnOffAuto:
25 # An enumeration of three options: on, off, and auto
27 # @auto: QEMU selects the value between on and off
29 # @on: Enabled
31 # @off: Disabled
33 # Since: 2.2
35 { 'enum': 'OnOffAuto',
36   'data': [ 'auto', 'on', 'off' ] }
39 # @OnOffSplit:
41 # An enumeration of three values: on, off, and split
43 # @on: Enabled
45 # @off: Disabled
47 # @split: Mixed
49 # Since: 2.6
51 { 'enum': 'OnOffSplit',
52   'data': [ 'on', 'off', 'split' ] }
55 # @String:
57 # A fat type wrapping 'str', to be embedded in lists.
59 # Since: 1.2
61 { 'struct': 'String',
62   'data': {
63     'str': 'str' } }
66 # @StrOrNull:
68 # This is a string value or the explicit lack of a string (null
69 # pointer in C).  Intended for cases when 'optional absent' already
70 # has a different meaning.
72 # @s: the string value
73 # @n: no string value
75 # Since: 2.10
77 { 'alternate': 'StrOrNull',
78   'data': { 's': 'str',
79             'n': 'null' } }
82 # @OffAutoPCIBAR:
84 # An enumeration of options for specifying a PCI BAR
86 # @off: The specified feature is disabled
88 # @auto: The PCI BAR for the feature is automatically selected
90 # @bar0: PCI BAR0 is used for the feature
92 # @bar1: PCI BAR1 is used for the feature
94 # @bar2: PCI BAR2 is used for the feature
96 # @bar3: PCI BAR3 is used for the feature
98 # @bar4: PCI BAR4 is used for the feature
100 # @bar5: PCI BAR5 is used for the feature
102 # Since: 2.12
104 { 'enum': 'OffAutoPCIBAR',
105   'data': [ 'off', 'auto', 'bar0', 'bar1', 'bar2', 'bar3', 'bar4', 'bar5' ] }
108 # @PCIELinkSpeed:
110 # An enumeration of PCIe link speeds in units of GT/s
112 # @2_5: 2.5GT/s
114 # @5: 5.0GT/s
116 # @8: 8.0GT/s
118 # @16: 16.0GT/s
120 # Since: 4.0
122 { 'enum': 'PCIELinkSpeed',
123   'data': [ '2_5', '5', '8', '16' ] }
126 # @PCIELinkWidth:
128 # An enumeration of PCIe link width
130 # @1: x1
132 # @2: x2
134 # @4: x4
136 # @8: x8
138 # @12: x12
140 # @16: x16
142 # @32: x32
144 # Since: 4.0
146 { 'enum': 'PCIELinkWidth',
147   'data': [ '1', '2', '4', '8', '12', '16', '32' ] }