xref: /qemu/qapi/common.json (revision c08da86d)
1# -*- Mode: Python -*-
2# vim: filetype=python
3
4##
5# = Common data types
6##
7
8##
9# @IoOperationType:
10#
11# An enumeration of the I/O operation types
12#
13# @read: read operation
14#
15# @write: write operation
16#
17# Since: 2.1
18##
19{ 'enum': 'IoOperationType',
20  'data': [ 'read', 'write' ] }
21
22##
23# @OnOffAuto:
24#
25# An enumeration of three options: on, off, and auto
26#
27# @auto: QEMU selects the value between on and off
28#
29# @on: Enabled
30#
31# @off: Disabled
32#
33# Since: 2.2
34##
35{ 'enum': 'OnOffAuto',
36  'data': [ 'auto', 'on', 'off' ] }
37
38##
39# @OnOffSplit:
40#
41# An enumeration of three values: on, off, and split
42#
43# @on: Enabled
44#
45# @off: Disabled
46#
47# @split: Mixed
48#
49# Since: 2.6
50##
51{ 'enum': 'OnOffSplit',
52  'data': [ 'on', 'off', 'split' ] }
53
54##
55# @StrOrNull:
56#
57# This is a string value or the explicit lack of a string (null
58# pointer in C).  Intended for cases when 'optional absent' already
59# has a different meaning.
60#
61# @s: the string value
62#
63# @n: no string value
64#
65# Since: 2.10
66##
67{ 'alternate': 'StrOrNull',
68  'data': { 's': 'str',
69            'n': 'null' } }
70
71##
72# @OffAutoPCIBAR:
73#
74# An enumeration of options for specifying a PCI BAR
75#
76# @off: The specified feature is disabled
77#
78# @auto: The PCI BAR for the feature is automatically selected
79#
80# @bar0: PCI BAR0 is used for the feature
81#
82# @bar1: PCI BAR1 is used for the feature
83#
84# @bar2: PCI BAR2 is used for the feature
85#
86# @bar3: PCI BAR3 is used for the feature
87#
88# @bar4: PCI BAR4 is used for the feature
89#
90# @bar5: PCI BAR5 is used for the feature
91#
92# Since: 2.12
93##
94{ 'enum': 'OffAutoPCIBAR',
95  'data': [ 'off', 'auto', 'bar0', 'bar1', 'bar2', 'bar3', 'bar4', 'bar5' ] }
96
97##
98# @PCIELinkSpeed:
99#
100# An enumeration of PCIe link speeds in units of GT/s
101#
102# @2_5: 2.5GT/s
103#
104# @5: 5.0GT/s
105#
106# @8: 8.0GT/s
107#
108# @16: 16.0GT/s
109#
110# @32: 32.0GT/s
111#
112# @64: 64.0GT/s
113#
114# Since: 4.0
115##
116{ 'enum': 'PCIELinkSpeed',
117  'data': [ '2_5', '5', '8', '16', '32', '64' ] }
118
119##
120# @PCIELinkWidth:
121#
122# An enumeration of PCIe link width
123#
124# @1: x1
125#
126# @2: x2
127#
128# @4: x4
129#
130# @8: x8
131#
132# @12: x12
133#
134# @16: x16
135#
136# @32: x32
137#
138# Since: 4.0
139##
140{ 'enum': 'PCIELinkWidth',
141  'data': [ '1', '2', '4', '8', '12', '16', '32' ] }
142
143##
144# @HostMemPolicy:
145#
146# Host memory policy types
147#
148# @default: restore default policy, remove any nondefault policy
149#
150# @preferred: set the preferred host nodes for allocation
151#
152# @bind: a strict policy that restricts memory allocation to the host
153#     nodes specified
154#
155# @interleave: memory allocations are interleaved across the set of
156#     host nodes specified
157#
158# Since: 2.1
159##
160{ 'enum': 'HostMemPolicy',
161  'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
162
163##
164# @NetFilterDirection:
165#
166# Indicates whether a netfilter is attached to a netdev's transmit
167# queue or receive queue or both.
168#
169# @all: the filter is attached both to the receive and the transmit
170#     queue of the netdev (default).
171#
172# @rx: the filter is attached to the receive queue of the netdev,
173#     where it will receive packets sent to the netdev.
174#
175# @tx: the filter is attached to the transmit queue of the netdev,
176#     where it will receive packets sent by the netdev.
177#
178# Since: 2.5
179##
180{ 'enum': 'NetFilterDirection',
181  'data': [ 'all', 'rx', 'tx' ] }
182
183##
184# @GrabToggleKeys:
185#
186# Keys to toggle input-linux between host and guest.
187#
188# Since: 4.0
189##
190{ 'enum': 'GrabToggleKeys',
191  'data': [ 'ctrl-ctrl', 'alt-alt', 'shift-shift','meta-meta', 'scrolllock',
192            'ctrl-scrolllock' ] }
193
194##
195# @HumanReadableText:
196#
197# @human-readable-text: Formatted output intended for humans.
198#
199# Since: 6.2
200##
201{ 'struct': 'HumanReadableText',
202  'data': { 'human-readable-text': 'str' } }
203