xref: /openbmc/qemu/qapi/common.json (revision ee3b34cd)
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# Since: 4.0
111##
112{ 'enum': 'PCIELinkSpeed',
113  'data': [ '2_5', '5', '8', '16' ] }
114
115##
116# @PCIELinkWidth:
117#
118# An enumeration of PCIe link width
119#
120# @1: x1
121#
122# @2: x2
123#
124# @4: x4
125#
126# @8: x8
127#
128# @12: x12
129#
130# @16: x16
131#
132# @32: x32
133#
134# Since: 4.0
135##
136{ 'enum': 'PCIELinkWidth',
137  'data': [ '1', '2', '4', '8', '12', '16', '32' ] }
138
139##
140# @HostMemPolicy:
141#
142# Host memory policy types
143#
144# @default: restore default policy, remove any nondefault policy
145#
146# @preferred: set the preferred host nodes for allocation
147#
148# @bind: a strict policy that restricts memory allocation to the host
149#     nodes specified
150#
151# @interleave: memory allocations are interleaved across the set of
152#     host nodes specified
153#
154# Since: 2.1
155##
156{ 'enum': 'HostMemPolicy',
157  'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
158
159##
160# @NetFilterDirection:
161#
162# Indicates whether a netfilter is attached to a netdev's transmit
163# queue or receive queue or both.
164#
165# @all: the filter is attached both to the receive and the transmit
166#     queue of the netdev (default).
167#
168# @rx: the filter is attached to the receive queue of the netdev,
169#     where it will receive packets sent to the netdev.
170#
171# @tx: the filter is attached to the transmit queue of the netdev,
172#     where it will receive packets sent by the netdev.
173#
174# Since: 2.5
175##
176{ 'enum': 'NetFilterDirection',
177  'data': [ 'all', 'rx', 'tx' ] }
178
179##
180# @GrabToggleKeys:
181#
182# Keys to toggle input-linux between host and guest.
183#
184# Since: 4.0
185##
186{ 'enum': 'GrabToggleKeys',
187  'data': [ 'ctrl-ctrl', 'alt-alt', 'shift-shift','meta-meta', 'scrolllock',
188            'ctrl-scrolllock' ] }
189
190##
191# @HumanReadableText:
192#
193# @human-readable-text: Formatted output intended for humans.
194#
195# Since: 6.2
196##
197{ 'struct': 'HumanReadableText',
198  'data': { 'human-readable-text': 'str' } }
199