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 | ## |
| 55 | # @String: |
| 56 | # |
| 57 | # A fat type wrapping 'str', to be embedded in lists. |
| 58 | # |
| 59 | # Since: 1.2 |
| 60 | ## |
| 61 | { 'struct': 'String', |
| 62 | 'data': { |
| 63 | 'str': 'str' } } |
Markus Armbruster | 48685a8 | 2017-08-24 21:14:01 +0200 | [diff] [blame] | 64 | |
| 65 | ## |
| 66 | # @StrOrNull: |
| 67 | # |
| 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. |
| 71 | # |
| 72 | # @s: the string value |
| 73 | # @n: no string value |
| 74 | # |
| 75 | # Since: 2.10 |
| 76 | ## |
| 77 | { 'alternate': 'StrOrNull', |
| 78 | 'data': { 's': 'str', |
| 79 | 'n': 'null' } } |
Alex Williamson | c3bbbdb | 2018-02-06 11:08:26 -0700 | [diff] [blame] | 80 | |
| 81 | ## |
| 82 | # @OffAutoPCIBAR: |
| 83 | # |
| 84 | # An enumeration of options for specifying a PCI BAR |
| 85 | # |
| 86 | # @off: The specified feature is disabled |
| 87 | # |
| 88 | # @auto: The PCI BAR for the feature is automatically selected |
| 89 | # |
| 90 | # @bar0: PCI BAR0 is used for the feature |
| 91 | # |
| 92 | # @bar1: PCI BAR1 is used for the feature |
| 93 | # |
| 94 | # @bar2: PCI BAR2 is used for the feature |
| 95 | # |
| 96 | # @bar3: PCI BAR3 is used for the feature |
| 97 | # |
| 98 | # @bar4: PCI BAR4 is used for the feature |
| 99 | # |
| 100 | # @bar5: PCI BAR5 is used for the feature |
| 101 | # |
| 102 | # Since: 2.12 |
| 103 | ## |
| 104 | { 'enum': 'OffAutoPCIBAR', |
| 105 | 'data': [ 'off', 'auto', 'bar0', 'bar1', 'bar2', 'bar3', 'bar4', 'bar5' ] } |
Laszlo Ersek | 9a801c7 | 2018-04-27 21:28:49 +0200 | [diff] [blame] | 106 | |
| 107 | ## |
Alex Williamson | 4695a2c | 2018-12-12 12:39:08 -0700 | [diff] [blame] | 108 | # @PCIELinkSpeed: |
| 109 | # |
| 110 | # An enumeration of PCIe link speeds in units of GT/s |
| 111 | # |
| 112 | # @2_5: 2.5GT/s |
| 113 | # |
| 114 | # @5: 5.0GT/s |
| 115 | # |
| 116 | # @8: 8.0GT/s |
| 117 | # |
| 118 | # @16: 16.0GT/s |
| 119 | # |
| 120 | # Since: 4.0 |
| 121 | ## |
| 122 | { 'enum': 'PCIELinkSpeed', |
| 123 | 'data': [ '2_5', '5', '8', '16' ] } |
| 124 | |
| 125 | ## |
| 126 | # @PCIELinkWidth: |
| 127 | # |
| 128 | # An enumeration of PCIe link width |
| 129 | # |
| 130 | # @1: x1 |
| 131 | # |
| 132 | # @2: x2 |
| 133 | # |
| 134 | # @4: x4 |
| 135 | # |
| 136 | # @8: x8 |
| 137 | # |
| 138 | # @12: x12 |
| 139 | # |
| 140 | # @16: x16 |
| 141 | # |
| 142 | # @32: x32 |
| 143 | # |
| 144 | # Since: 4.0 |
| 145 | ## |
| 146 | { 'enum': 'PCIELinkWidth', |
| 147 | 'data': [ '1', '2', '4', '8', '12', '16', '32' ] } |