Merge remote-tracking branch 'remotes/pmaydell/tags/pull-target-arm-20171006' into...
[qemu/ar7.git] / qapi / common.json
blob6eb01821ef59ee0531945214be4ae2b71d13f697
1 # -*- Mode: Python -*-
3 ##
4 # = Common data types
5 ##
7 ##
8 # @QapiErrorClass:
10 # QEMU error classes
12 # @GenericError: this is used for errors that don't require a specific error
13 #                class. This should be the default case for most errors
15 # @CommandNotFound: the requested command has not been found
17 # @DeviceNotActive: a device has failed to be become active
19 # @DeviceNotFound: the requested device has not been found
21 # @KVMMissingCap: the requested operation can't be fulfilled because a
22 #                 required KVM capability is missing
24 # Since: 1.2
26 { 'enum': 'QapiErrorClass',
27   # Keep this in sync with ErrorClass in error.h
28   'data': [ 'GenericError', 'CommandNotFound',
29             'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }
32 # @IoOperationType:
34 # An enumeration of the I/O operation types
36 # @read: read operation
38 # @write: write operation
40 # Since: 2.1
42 { 'enum': 'IoOperationType',
43   'data': [ 'read', 'write' ] }
46 # @OnOffAuto:
48 # An enumeration of three options: on, off, and auto
50 # @auto: QEMU selects the value between on and off
52 # @on: Enabled
54 # @off: Disabled
56 # Since: 2.2
58 { 'enum': 'OnOffAuto',
59   'data': [ 'auto', 'on', 'off' ] }
62 # @OnOffSplit:
64 # An enumeration of three values: on, off, and split
66 # @on: Enabled
68 # @off: Disabled
70 # @split: Mixed
72 # Since: 2.6
74 { 'enum': 'OnOffSplit',
75   'data': [ 'on', 'off', 'split' ] }
78 # @String:
80 # A fat type wrapping 'str', to be embedded in lists.
82 # Since: 1.2
84 { 'struct': 'String',
85   'data': {
86     'str': 'str' } }
89 # @StrOrNull:
91 # This is a string value or the explicit lack of a string (null
92 # pointer in C).  Intended for cases when 'optional absent' already
93 # has a different meaning.
95 # @s: the string value
96 # @n: no string value
98 # Since: 2.10
100 { 'alternate': 'StrOrNull',
101   'data': { 's': 'str',
102             'n': 'null' } }