Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 1 | # -*- Mode: Python -*- |
Andrea Bolognani | f7160f3 | 2020-07-29 20:50:24 +0200 | [diff] [blame] | 2 | # vim: filetype=python |
Marc-André Lureau | d3a4837 | 2017-01-13 15:41:23 +0100 | [diff] [blame] | 3 | |
| 4 | ## |
Markus Armbruster | f5cf31c | 2017-08-24 21:14:08 +0200 | [diff] [blame] | 5 | # = Common data types |
Marc-André Lureau | d3a4837 | 2017-01-13 15:41:23 +0100 | [diff] [blame] | 6 | ## |
Benoît Canet | d34bda7 | 2014-06-05 13:45:29 +0200 | [diff] [blame] | 7 | |
| 8 | ## |
Markus Armbruster | 2031c13 | 2017-08-24 21:14:06 +0200 | [diff] [blame] | 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 | ## |
Marc-André Lureau | 5072f7b | 2016-11-17 19:54:55 +0400 | [diff] [blame] | 23 | # @OnOffAuto: |
Don Slutz | d1048be | 2014-11-21 11:18:52 -0500 | [diff] [blame] | 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' ] } |
Matt Gingell | 32c18a2 | 2015-11-16 10:03:06 -0800 | [diff] [blame] | 37 | |
| 38 | ## |
Marc-André Lureau | 5072f7b | 2016-11-17 19:54:55 +0400 | [diff] [blame] | 39 | # @OnOffSplit: |
Matt Gingell | 32c18a2 | 2015-11-16 10:03:06 -0800 | [diff] [blame] | 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' ] } |
Markus Armbruster | a2ff5a4 | 2017-08-24 21:13:56 +0200 | [diff] [blame] | 53 | |
| 54 | ## |
Markus Armbruster | 48685a8 | 2017-08-24 21:14:01 +0200 | [diff] [blame] | 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 |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 62 | # |
Markus Armbruster | 48685a8 | 2017-08-24 21:14:01 +0200 | [diff] [blame] | 63 | # @n: no string value |
| 64 | # |
| 65 | # Since: 2.10 |
| 66 | ## |
| 67 | { 'alternate': 'StrOrNull', |
| 68 | 'data': { 's': 'str', |
| 69 | 'n': 'null' } } |
Alex Williamson | c3bbbdb | 2018-02-06 11:08:26 -0700 | [diff] [blame] | 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' ] } |
Laszlo Ersek | 9a801c7 | 2018-04-27 21:28:49 +0200 | [diff] [blame] | 96 | |
| 97 | ## |
Alex Williamson | 4695a2c | 2018-12-12 12:39:08 -0700 | [diff] [blame] | 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 | # |
Michael S. Tsirkin | 1bdef7a | 2024-03-13 02:43:46 -0400 | [diff] [blame] | 110 | # @32: 32.0GT/s (since 9.0) |
Lukas Stockner | c08da86 | 2024-02-15 02:23:26 +0100 | [diff] [blame] | 111 | # |
Michael S. Tsirkin | 1bdef7a | 2024-03-13 02:43:46 -0400 | [diff] [blame] | 112 | # @64: 64.0GT/s (since 9.0) |
Lukas Stockner | c08da86 | 2024-02-15 02:23:26 +0100 | [diff] [blame] | 113 | # |
Alex Williamson | 4695a2c | 2018-12-12 12:39:08 -0700 | [diff] [blame] | 114 | # Since: 4.0 |
| 115 | ## |
| 116 | { 'enum': 'PCIELinkSpeed', |
Lukas Stockner | c08da86 | 2024-02-15 02:23:26 +0100 | [diff] [blame] | 117 | 'data': [ '2_5', '5', '8', '16', '32', '64' ] } |
Alex Williamson | 4695a2c | 2018-12-12 12:39:08 -0700 | [diff] [blame] | 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' ] } |
Kevin Wolf | 913d906 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 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 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 152 | # @bind: a strict policy that restricts memory allocation to the host |
| 153 | # nodes specified |
Kevin Wolf | 913d906 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 154 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 155 | # @interleave: memory allocations are interleaved across the set of |
| 156 | # host nodes specified |
Kevin Wolf | 913d906 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 157 | # |
| 158 | # Since: 2.1 |
| 159 | ## |
| 160 | { 'enum': 'HostMemPolicy', |
| 161 | 'data': [ 'default', 'preferred', 'bind', 'interleave' ] } |
Kevin Wolf | 1156a67 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 162 | |
| 163 | ## |
| 164 | # @NetFilterDirection: |
| 165 | # |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 166 | # Indicates whether a netfilter is attached to a netdev's transmit |
| 167 | # queue or receive queue or both. |
Kevin Wolf | 1156a67 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 168 | # |
| 169 | # @all: the filter is attached both to the receive and the transmit |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 170 | # queue of the netdev (default). |
Kevin Wolf | 1156a67 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 171 | # |
| 172 | # @rx: the filter is attached to the receive queue of the netdev, |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 173 | # where it will receive packets sent to the netdev. |
Kevin Wolf | 1156a67 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 174 | # |
| 175 | # @tx: the filter is attached to the transmit queue of the netdev, |
Markus Armbruster | a937b6a | 2023-04-28 12:54:29 +0200 | [diff] [blame] | 176 | # where it will receive packets sent by the netdev. |
Kevin Wolf | 1156a67 | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 177 | # |
| 178 | # Since: 2.5 |
| 179 | ## |
| 180 | { 'enum': 'NetFilterDirection', |
| 181 | 'data': [ 'all', 'rx', 'tx' ] } |
Kevin Wolf | 30e863e | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 182 | |
| 183 | ## |
| 184 | # @GrabToggleKeys: |
| 185 | # |
Markus Armbruster | ee43800 | 2024-09-11 13:25:39 +0200 | [diff] [blame] | 186 | # Key combinations to toggle input-linux between host and guest. |
| 187 | # |
| 188 | # @ctrl-ctrl: left and right control key |
| 189 | # |
| 190 | # @alt-alt: left and right alt key |
| 191 | # |
| 192 | # @shift-shift: left and right shift key |
| 193 | # |
| 194 | # @meta-meta: left and right meta key |
| 195 | # |
| 196 | # @scrolllock: scroll lock key |
| 197 | # |
| 198 | # @ctrl-scrolllock: either control key and scroll lock key |
Kevin Wolf | 30e863e | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 199 | # |
| 200 | # Since: 4.0 |
Kevin Wolf | 30e863e | 2020-10-20 12:47:58 +0200 | [diff] [blame] | 201 | ## |
| 202 | { 'enum': 'GrabToggleKeys', |
| 203 | 'data': [ 'ctrl-ctrl', 'alt-alt', 'shift-shift','meta-meta', 'scrolllock', |
| 204 | 'ctrl-scrolllock' ] } |
Daniel P. Berrangé | f9429c6 | 2021-10-08 15:09:00 +0100 | [diff] [blame] | 205 | |
| 206 | ## |
| 207 | # @HumanReadableText: |
| 208 | # |
| 209 | # @human-readable-text: Formatted output intended for humans. |
| 210 | # |
| 211 | # Since: 6.2 |
Daniel P. Berrangé | f9429c6 | 2021-10-08 15:09:00 +0100 | [diff] [blame] | 212 | ## |
| 213 | { 'struct': 'HumanReadableText', |
| 214 | 'data': { 'human-readable-text': 'str' } } |