]>
Commit | Line | Data |
---|---|---|
61eb9e80 | 1 | # -*- Mode: Python -*- |
f7160f32 | 2 | # vim: filetype=python |
61eb9e80 MA |
3 | # |
4 | ||
183e4281 MAL |
5 | ## |
6 | # @RTC_CHANGE: | |
7 | # | |
8 | # Emitted when the guest changes the RTC time. | |
9 | # | |
10 | # @offset: offset between base RTC clock (as specified by -rtc base), and | |
11 | # new RTC clock value | |
12 | # | |
13 | # Note: This event is rate-limited. | |
14 | # | |
15 | # Since: 0.13.0 | |
16 | # | |
17 | # Example: | |
18 | # | |
19 | # <- { "event": "RTC_CHANGE", | |
20 | # "data": { "offset": 78 }, | |
21 | # "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } | |
22 | # | |
23 | ## | |
24 | { 'event': 'RTC_CHANGE', | |
25 | 'data': { 'offset': 'int' }, | |
26 | 'if': 'defined(TARGET_ALPHA) || defined(TARGET_ARM) || defined(TARGET_HPPA) || defined(TARGET_I386) || defined(TARGET_MIPS) || defined(TARGET_MIPS64) || defined(TARGET_MOXIE) || defined(TARGET_PPC) || defined(TARGET_PPC64) || defined(TARGET_S390X) || defined(TARGET_SH4) || defined(TARGET_SPARC)' } | |
27 | ||
61eb9e80 | 28 | ## |
a6c7040f MAL |
29 | # @rtc-reset-reinjection: |
30 | # | |
31 | # This command will reset the RTC interrupt reinjection backlog. | |
32 | # Can be used if another mechanism to synchronize guest time | |
33 | # is in effect, for example QEMU guest agent's guest-set-time | |
34 | # command. | |
35 | # | |
36 | # Since: 2.1 | |
37 | # | |
38 | # Example: | |
39 | # | |
40 | # -> { "execute": "rtc-reset-reinjection" } | |
41 | # <- { "return": {} } | |
42 | # | |
43 | ## | |
44 | { 'command': 'rtc-reset-reinjection', | |
45 | 'if': 'defined(TARGET_I386)' } | |
46 | ||
47 | ||
48 | ## | |
49 | # @SevState: | |
50 | # | |
51 | # An enumeration of SEV state information used during @query-sev. | |
52 | # | |
53 | # @uninit: The guest is uninitialized. | |
54 | # | |
55 | # @launch-update: The guest is currently being launched; plaintext data and | |
56 | # register state is being imported. | |
57 | # | |
58 | # @launch-secret: The guest is currently being launched; ciphertext data | |
59 | # is being imported. | |
60 | # | |
61 | # @running: The guest is fully launched or migrated in. | |
62 | # | |
63 | # @send-update: The guest is currently being migrated out to another machine. | |
64 | # | |
65 | # @receive-update: The guest is currently being migrated from another machine. | |
66 | # | |
67 | # Since: 2.12 | |
68 | ## | |
69 | { 'enum': 'SevState', | |
70 | 'data': ['uninit', 'launch-update', 'launch-secret', 'running', | |
71 | 'send-update', 'receive-update' ], | |
72 | 'if': 'defined(TARGET_I386)' } | |
73 | ||
74 | ## | |
75 | # @SevInfo: | |
76 | # | |
77 | # Information about Secure Encrypted Virtualization (SEV) support | |
78 | # | |
79 | # @enabled: true if SEV is active | |
80 | # | |
81 | # @api-major: SEV API major version | |
82 | # | |
83 | # @api-minor: SEV API minor version | |
84 | # | |
85 | # @build-id: SEV FW build id | |
86 | # | |
87 | # @policy: SEV policy value | |
88 | # | |
89 | # @state: SEV guest state | |
90 | # | |
91 | # @handle: SEV firmware handle | |
92 | # | |
93 | # Since: 2.12 | |
94 | ## | |
95 | { 'struct': 'SevInfo', | |
96 | 'data': { 'enabled': 'bool', | |
97 | 'api-major': 'uint8', | |
98 | 'api-minor' : 'uint8', | |
99 | 'build-id' : 'uint8', | |
100 | 'policy' : 'uint32', | |
101 | 'state' : 'SevState', | |
102 | 'handle' : 'uint32' | |
103 | }, | |
104 | 'if': 'defined(TARGET_I386)' | |
105 | } | |
106 | ||
107 | ## | |
108 | # @query-sev: | |
109 | # | |
110 | # Returns information about SEV | |
111 | # | |
112 | # Returns: @SevInfo | |
113 | # | |
114 | # Since: 2.12 | |
115 | # | |
116 | # Example: | |
117 | # | |
118 | # -> { "execute": "query-sev" } | |
119 | # <- { "return": { "enabled": true, "api-major" : 0, "api-minor" : 0, | |
120 | # "build-id" : 0, "policy" : 0, "state" : "running", | |
121 | # "handle" : 1 } } | |
122 | # | |
123 | ## | |
124 | { 'command': 'query-sev', 'returns': 'SevInfo', | |
125 | 'if': 'defined(TARGET_I386)' } | |
126 | ||
127 | ||
128 | ## | |
129 | # @SevLaunchMeasureInfo: | |
130 | # | |
131 | # SEV Guest Launch measurement information | |
132 | # | |
133 | # @data: the measurement value encoded in base64 | |
134 | # | |
135 | # Since: 2.12 | |
136 | # | |
137 | ## | |
138 | { 'struct': 'SevLaunchMeasureInfo', 'data': {'data': 'str'}, | |
139 | 'if': 'defined(TARGET_I386)' } | |
140 | ||
141 | ## | |
142 | # @query-sev-launch-measure: | |
143 | # | |
144 | # Query the SEV guest launch information. | |
145 | # | |
146 | # Returns: The @SevLaunchMeasureInfo for the guest | |
147 | # | |
148 | # Since: 2.12 | |
149 | # | |
150 | # Example: | |
151 | # | |
152 | # -> { "execute": "query-sev-launch-measure" } | |
153 | # <- { "return": { "data": "4l8LXeNlSPUDlXPJG5966/8%YZ" } } | |
154 | # | |
155 | ## | |
156 | { 'command': 'query-sev-launch-measure', 'returns': 'SevLaunchMeasureInfo', | |
157 | 'if': 'defined(TARGET_I386)' } | |
158 | ||
159 | ||
160 | ## | |
161 | # @SevCapability: | |
162 | # | |
163 | # The struct describes capability for a Secure Encrypted Virtualization | |
164 | # feature. | |
165 | # | |
166 | # @pdh: Platform Diffie-Hellman key (base64 encoded) | |
167 | # | |
168 | # @cert-chain: PDH certificate chain (base64 encoded) | |
169 | # | |
170 | # @cbitpos: C-bit location in page table entry | |
171 | # | |
172 | # @reduced-phys-bits: Number of physical Address bit reduction when SEV is | |
173 | # enabled | |
174 | # | |
175 | # Since: 2.12 | |
176 | ## | |
177 | { 'struct': 'SevCapability', | |
178 | 'data': { 'pdh': 'str', | |
179 | 'cert-chain': 'str', | |
180 | 'cbitpos': 'int', | |
181 | 'reduced-phys-bits': 'int'}, | |
182 | 'if': 'defined(TARGET_I386)' } | |
183 | ||
184 | ## | |
185 | # @query-sev-capabilities: | |
186 | # | |
187 | # This command is used to get the SEV capabilities, and is supported on AMD | |
188 | # X86 platforms only. | |
189 | # | |
190 | # Returns: SevCapability objects. | |
191 | # | |
192 | # Since: 2.12 | |
193 | # | |
194 | # Example: | |
195 | # | |
196 | # -> { "execute": "query-sev-capabilities" } | |
197 | # <- { "return": { "pdh": "8CCDD8DDD", "cert-chain": "888CCCDDDEE", | |
198 | # "cbitpos": 47, "reduced-phys-bits": 5}} | |
199 | # | |
61eb9e80 | 200 | ## |
a6c7040f MAL |
201 | { 'command': 'query-sev-capabilities', 'returns': 'SevCapability', |
202 | 'if': 'defined(TARGET_I386)' } | |
0e2f4530 MAL |
203 | |
204 | ## | |
205 | # @dump-skeys: | |
206 | # | |
207 | # Dump guest's storage keys | |
208 | # | |
209 | # @filename: the path to the file to dump to | |
210 | # | |
211 | # This command is only supported on s390 architecture. | |
212 | # | |
213 | # Since: 2.5 | |
214 | # | |
215 | # Example: | |
216 | # | |
217 | # -> { "execute": "dump-skeys", | |
218 | # "arguments": { "filename": "/tmp/skeys" } } | |
219 | # <- { "return": {} } | |
220 | # | |
221 | ## | |
222 | { 'command': 'dump-skeys', | |
223 | 'data': { 'filename': 'str' }, | |
224 | 'if': 'defined(TARGET_S390X)' } | |
225 | ||
84c6499e MAL |
226 | ## |
227 | # @GICCapability: | |
228 | # | |
229 | # The struct describes capability for a specific GIC (Generic | |
230 | # Interrupt Controller) version. These bits are not only decided by | |
231 | # QEMU/KVM software version, but also decided by the hardware that | |
232 | # the program is running upon. | |
233 | # | |
26ec4e53 PM |
234 | # @version: version of GIC to be described. Currently, only 2 and 3 |
235 | # are supported. | |
84c6499e MAL |
236 | # |
237 | # @emulated: whether current QEMU/hardware supports emulated GIC | |
238 | # device in user space. | |
239 | # | |
26ec4e53 PM |
240 | # @kernel: whether current QEMU/hardware supports hardware |
241 | # accelerated GIC device in kernel. | |
84c6499e MAL |
242 | # |
243 | # Since: 2.6 | |
244 | ## | |
245 | { 'struct': 'GICCapability', | |
246 | 'data': { 'version': 'int', | |
247 | 'emulated': 'bool', | |
248 | 'kernel': 'bool' }, | |
249 | 'if': 'defined(TARGET_ARM)' } | |
250 | ||
251 | ## | |
252 | # @query-gic-capabilities: | |
253 | # | |
254 | # This command is ARM-only. It will return a list of GICCapability | |
255 | # objects that describe its capability bits. | |
256 | # | |
257 | # Returns: a list of GICCapability objects. | |
258 | # | |
259 | # Since: 2.6 | |
260 | # | |
261 | # Example: | |
262 | # | |
263 | # -> { "execute": "query-gic-capabilities" } | |
264 | # <- { "return": [{ "version": 2, "emulated": true, "kernel": false }, | |
265 | # { "version": 3, "emulated": false, "kernel": true } ] } | |
266 | # | |
267 | ## | |
268 | { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'], | |
269 | 'if': 'defined(TARGET_ARM)' } |