1 /* SPDX-License-Identifier: MIT */ <<
2 /********************************************* 1 /******************************************************************************
3 * displif.h 2 * displif.h
4 * 3 *
5 * Unified display device I/O interface for Xe 4 * Unified display device I/O interface for Xen guest OSes.
6 * 5 *
>> 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
>> 7 * of this software and associated documentation files (the "Software"), to
>> 8 * deal in the Software without restriction, including without limitation the
>> 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
>> 10 * sell copies of the Software, and to permit persons to whom the Software is
>> 11 * furnished to do so, subject to the following conditions:
>> 12 *
>> 13 * The above copyright notice and this permission notice shall be included in
>> 14 * all copies or substantial portions of the Software.
>> 15 *
>> 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
>> 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
>> 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
>> 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
>> 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
>> 21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
>> 22 * DEALINGS IN THE SOFTWARE.
>> 23 *
7 * Copyright (C) 2016-2017 EPAM Systems Inc. 24 * Copyright (C) 2016-2017 EPAM Systems Inc.
8 * 25 *
9 * Authors: Oleksandr Andrushchenko <oleksandr 26 * Authors: Oleksandr Andrushchenko <oleksandr_andrushchenko@epam.com>
10 * Oleksandr Grytsov <oleksandr_gryts 27 * Oleksandr Grytsov <oleksandr_grytsov@epam.com>
11 */ 28 */
12 29
13 #ifndef __XEN_PUBLIC_IO_DISPLIF_H__ 30 #ifndef __XEN_PUBLIC_IO_DISPLIF_H__
14 #define __XEN_PUBLIC_IO_DISPLIF_H__ 31 #define __XEN_PUBLIC_IO_DISPLIF_H__
15 32
16 #include "ring.h" 33 #include "ring.h"
17 #include "../grant_table.h" 34 #include "../grant_table.h"
18 35
19 /* 36 /*
20 ********************************************* 37 ******************************************************************************
21 * Protocol version 38 * Protocol version
22 ********************************************* 39 ******************************************************************************
23 */ 40 */
24 #define XENDISPL_PROTOCOL_VERSION "2" !! 41 #define XENDISPL_PROTOCOL_VERSION "1"
25 #define XENDISPL_PROTOCOL_VERSION_INT 2 <<
26 42
27 /* 43 /*
28 ********************************************* 44 ******************************************************************************
29 * Main features provided by 45 * Main features provided by the protocol
30 ********************************************* 46 ******************************************************************************
31 * This protocol aims to provide a unified pro 47 * This protocol aims to provide a unified protocol which fits more
32 * sophisticated use-cases than a framebuffer 48 * sophisticated use-cases than a framebuffer device can handle. At the
33 * moment basic functionality is supported wit 49 * moment basic functionality is supported with the intention to be extended:
34 * o multiple dynamically allocated/destroyed 50 * o multiple dynamically allocated/destroyed framebuffers
35 * o buffers of arbitrary sizes 51 * o buffers of arbitrary sizes
36 * o buffer allocation at either back or fron 52 * o buffer allocation at either back or front end
37 * o better configuration options including m 53 * o better configuration options including multiple display support
38 * 54 *
39 * Note: existing fbif can be used together wi 55 * Note: existing fbif can be used together with displif running at the
40 * same time, e.g. on Linux one provides frame 56 * same time, e.g. on Linux one provides framebuffer and another DRM/KMS
41 * 57 *
42 * Note: display resolution (XenStore's "resol 58 * Note: display resolution (XenStore's "resolution" property) defines
43 * visible area of the virtual display. At the 59 * visible area of the virtual display. At the same time resolution of
44 * the display and frame buffers may differ: b 60 * the display and frame buffers may differ: buffers can be smaller, equal
45 * or bigger than the visible area. This is to 61 * or bigger than the visible area. This is to enable use-cases, where backend
46 * may do some post-processing of the display 62 * may do some post-processing of the display and frame buffers supplied,
47 * e.g. those buffers can be just a part of th 63 * e.g. those buffers can be just a part of the final composition.
48 * 64 *
49 ********************************************* 65 ******************************************************************************
50 * Direction of improve 66 * Direction of improvements
51 ********************************************* 67 ******************************************************************************
52 * Future extensions to the existing protocol 68 * Future extensions to the existing protocol may include:
53 * o display/connector cloning 69 * o display/connector cloning
54 * o allocation of objects other than display 70 * o allocation of objects other than display buffers
55 * o plane/overlay support 71 * o plane/overlay support
56 * o scaling support 72 * o scaling support
57 * o rotation support 73 * o rotation support
58 * 74 *
59 ********************************************* 75 ******************************************************************************
60 * Feature and Parameter Nego 76 * Feature and Parameter Negotiation
61 ********************************************* 77 ******************************************************************************
62 * 78 *
63 * Front->back notifications: when enqueuing a 79 * Front->back notifications: when enqueuing a new request, sending a
64 * notification can be made conditional on xen 80 * notification can be made conditional on xendispl_req (i.e., the generic
65 * hold-off mechanism provided by the ring mac 81 * hold-off mechanism provided by the ring macros). Backends must set
66 * xendispl_req appropriately (e.g., using RIN 82 * xendispl_req appropriately (e.g., using RING_FINAL_CHECK_FOR_REQUESTS()).
67 * 83 *
68 * Back->front notifications: when enqueuing a 84 * Back->front notifications: when enqueuing a new response, sending a
69 * notification can be made conditional on xen 85 * notification can be made conditional on xendispl_resp (i.e., the generic
70 * hold-off mechanism provided by the ring mac 86 * hold-off mechanism provided by the ring macros). Frontends must set
71 * xendispl_resp appropriately (e.g., using RI 87 * xendispl_resp appropriately (e.g., using RING_FINAL_CHECK_FOR_RESPONSES()).
72 * 88 *
73 * The two halves of a para-virtual display dr 89 * The two halves of a para-virtual display driver utilize nodes within
74 * XenStore to communicate capabilities and to 90 * XenStore to communicate capabilities and to negotiate operating parameters.
75 * This section enumerates these nodes which r 91 * This section enumerates these nodes which reside in the respective front and
76 * backend portions of XenStore, following the 92 * backend portions of XenStore, following the XenBus convention.
77 * 93 *
78 * All data in XenStore is stored as strings. 94 * All data in XenStore is stored as strings. Nodes specifying numeric
79 * values are encoded in decimal. Integer valu 95 * values are encoded in decimal. Integer value ranges listed below are
80 * expressed as fixed sized integer types capa 96 * expressed as fixed sized integer types capable of storing the conversion
81 * of a properly formated node string, without 97 * of a properly formated node string, without loss of information.
82 * 98 *
83 ********************************************* 99 ******************************************************************************
84 * Example configuratio 100 * Example configuration
85 ********************************************* 101 ******************************************************************************
86 * 102 *
87 * Note: depending on the use-case backend can 103 * Note: depending on the use-case backend can expose more display connectors
88 * than the underlying HW physically has by em 104 * than the underlying HW physically has by employing SW graphics compositors
89 * 105 *
90 * This is an example of backend and frontend 106 * This is an example of backend and frontend configuration:
91 * 107 *
92 *--------------------------------- Backend -- 108 *--------------------------------- Backend -----------------------------------
93 * 109 *
94 * /local/domain/0/backend/vdispl/1/0/frontend 110 * /local/domain/0/backend/vdispl/1/0/frontend-id = "1"
95 * /local/domain/0/backend/vdispl/1/0/frontend 111 * /local/domain/0/backend/vdispl/1/0/frontend = "/local/domain/1/device/vdispl/0"
96 * /local/domain/0/backend/vdispl/1/0/state = 112 * /local/domain/0/backend/vdispl/1/0/state = "4"
97 * /local/domain/0/backend/vdispl/1/0/versions 113 * /local/domain/0/backend/vdispl/1/0/versions = "1,2"
98 * 114 *
99 *--------------------------------- Frontend - 115 *--------------------------------- Frontend ----------------------------------
100 * 116 *
101 * /local/domain/1/device/vdispl/0/backend-id 117 * /local/domain/1/device/vdispl/0/backend-id = ""
102 * /local/domain/1/device/vdispl/0/backend = " 118 * /local/domain/1/device/vdispl/0/backend = "/local/domain/0/backend/vdispl/1/0"
103 * /local/domain/1/device/vdispl/0/state = "4" 119 * /local/domain/1/device/vdispl/0/state = "4"
104 * /local/domain/1/device/vdispl/0/version = " 120 * /local/domain/1/device/vdispl/0/version = "1"
105 * /local/domain/1/device/vdispl/0/be-alloc = 121 * /local/domain/1/device/vdispl/0/be-alloc = "1"
106 * 122 *
107 *-------------------------- Connector 0 confi 123 *-------------------------- Connector 0 configuration ------------------------
108 * 124 *
109 * /local/domain/1/device/vdispl/0/0/resolutio 125 * /local/domain/1/device/vdispl/0/0/resolution = "1920x1080"
110 * /local/domain/1/device/vdispl/0/0/req-ring- 126 * /local/domain/1/device/vdispl/0/0/req-ring-ref = "2832"
111 * /local/domain/1/device/vdispl/0/0/req-event 127 * /local/domain/1/device/vdispl/0/0/req-event-channel = "15"
112 * /local/domain/1/device/vdispl/0/0/evt-ring- 128 * /local/domain/1/device/vdispl/0/0/evt-ring-ref = "387"
113 * /local/domain/1/device/vdispl/0/0/evt-event 129 * /local/domain/1/device/vdispl/0/0/evt-event-channel = "16"
114 * 130 *
115 *-------------------------- Connector 1 confi 131 *-------------------------- Connector 1 configuration ------------------------
116 * 132 *
117 * /local/domain/1/device/vdispl/0/1/resolutio 133 * /local/domain/1/device/vdispl/0/1/resolution = "800x600"
118 * /local/domain/1/device/vdispl/0/1/req-ring- 134 * /local/domain/1/device/vdispl/0/1/req-ring-ref = "2833"
119 * /local/domain/1/device/vdispl/0/1/req-event 135 * /local/domain/1/device/vdispl/0/1/req-event-channel = "17"
120 * /local/domain/1/device/vdispl/0/1/evt-ring- 136 * /local/domain/1/device/vdispl/0/1/evt-ring-ref = "388"
121 * /local/domain/1/device/vdispl/0/1/evt-event 137 * /local/domain/1/device/vdispl/0/1/evt-event-channel = "18"
122 * 138 *
123 ********************************************* 139 ******************************************************************************
124 * Backend XenBus N 140 * Backend XenBus Nodes
125 ********************************************* 141 ******************************************************************************
126 * 142 *
127 *----------------------------- Protocol versi 143 *----------------------------- Protocol version ------------------------------
128 * 144 *
129 * versions 145 * versions
130 * Values: <string> 146 * Values: <string>
131 * 147 *
132 * List of XENDISPL_LIST_SEPARATOR separa 148 * List of XENDISPL_LIST_SEPARATOR separated protocol versions supported
133 * by the backend. For example "1,2,3". 149 * by the backend. For example "1,2,3".
134 * 150 *
135 ********************************************* 151 ******************************************************************************
136 * Frontend XenBus 152 * Frontend XenBus Nodes
137 ********************************************* 153 ******************************************************************************
138 * 154 *
139 *-------------------------------- Addressing 155 *-------------------------------- Addressing ---------------------------------
140 * 156 *
141 * dom-id 157 * dom-id
142 * Values: <uint16_t> 158 * Values: <uint16_t>
143 * 159 *
144 * Domain identifier. 160 * Domain identifier.
145 * 161 *
146 * dev-id 162 * dev-id
147 * Values: <uint16_t> 163 * Values: <uint16_t>
148 * 164 *
149 * Device identifier. 165 * Device identifier.
150 * 166 *
151 * conn-idx 167 * conn-idx
152 * Values: <uint8_t> 168 * Values: <uint8_t>
153 * 169 *
154 * Zero based contigous index of the conn 170 * Zero based contigous index of the connector.
155 * /local/domain/<dom-id>/device/vdispl/< 171 * /local/domain/<dom-id>/device/vdispl/<dev-id>/<conn-idx>/...
156 * 172 *
157 *----------------------------- Protocol versi 173 *----------------------------- Protocol version ------------------------------
158 * 174 *
159 * version 175 * version
160 * Values: <string> 176 * Values: <string>
161 * 177 *
162 * Protocol version, chosen among the one 178 * Protocol version, chosen among the ones supported by the backend.
163 * 179 *
164 *------------------------- Backend buffer all 180 *------------------------- Backend buffer allocation -------------------------
165 * 181 *
166 * be-alloc 182 * be-alloc
167 * Values: "", "1" 183 * Values: "", "1"
168 * 184 *
169 * If value is set to "1", then backend c 185 * If value is set to "1", then backend can be a buffer provider/allocator
170 * for this domain during XENDISPL_OP_DBU 186 * for this domain during XENDISPL_OP_DBUF_CREATE operation (see below
171 * for negotiation). 187 * for negotiation).
172 * If value is not "1" or omitted fronten 188 * If value is not "1" or omitted frontend must allocate buffers itself.
173 * 189 *
174 *----------------------------- Connector sett 190 *----------------------------- Connector settings ----------------------------
175 * 191 *
176 * unique-id <<
177 * Values: <string> <<
178 * <<
179 * After device instance initialization e <<
180 * unique ID, so it can be identified by <<
181 * This can be UUID or such. <<
182 * <<
183 * resolution 192 * resolution
184 * Values: <width, uint32_t>x<hei 193 * Values: <width, uint32_t>x<height, uint32_t>
185 * 194 *
186 * Width and height of the connector in p 195 * Width and height of the connector in pixels separated by
187 * XENDISPL_RESOLUTION_SEPARATOR. This de 196 * XENDISPL_RESOLUTION_SEPARATOR. This defines visible area of the
188 * display. 197 * display.
189 * If backend provides extended display i <<
190 * XENDISPL_OP_GET_EDID request then EDID <<
191 * over the resolutions defined here. <<
192 * 198 *
193 *------------------ Connector Request Transpo 199 *------------------ Connector Request Transport Parameters -------------------
194 * 200 *
195 * This communication path is used to deliver 201 * This communication path is used to deliver requests from frontend to backend
196 * and get the corresponding responses from ba 202 * and get the corresponding responses from backend to frontend,
197 * set up per connector. 203 * set up per connector.
198 * 204 *
199 * req-event-channel 205 * req-event-channel
200 * Values: <uint32_t> 206 * Values: <uint32_t>
201 * 207 *
202 * The identifier of the Xen connector's 208 * The identifier of the Xen connector's control event channel
203 * used to signal activity in the ring bu 209 * used to signal activity in the ring buffer.
204 * 210 *
205 * req-ring-ref 211 * req-ring-ref
206 * Values: <uint32_t> 212 * Values: <uint32_t>
207 * 213 *
208 * The Xen grant reference granting permi 214 * The Xen grant reference granting permission for the backend to map
209 * a sole page of connector's control rin 215 * a sole page of connector's control ring buffer.
210 * 216 *
211 *------------------- Connector Event Transpor 217 *------------------- Connector Event Transport Parameters --------------------
212 * 218 *
213 * This communication path is used to deliver 219 * This communication path is used to deliver asynchronous events from backend
214 * to frontend, set up per connector. 220 * to frontend, set up per connector.
215 * 221 *
216 * evt-event-channel 222 * evt-event-channel
217 * Values: <uint32_t> 223 * Values: <uint32_t>
218 * 224 *
219 * The identifier of the Xen connector's 225 * The identifier of the Xen connector's event channel
220 * used to signal activity in the ring bu 226 * used to signal activity in the ring buffer.
221 * 227 *
222 * evt-ring-ref 228 * evt-ring-ref
223 * Values: <uint32_t> 229 * Values: <uint32_t>
224 * 230 *
225 * The Xen grant reference granting permi 231 * The Xen grant reference granting permission for the backend to map
226 * a sole page of connector's event ring 232 * a sole page of connector's event ring buffer.
227 */ 233 */
228 234
229 /* 235 /*
230 ********************************************* 236 ******************************************************************************
231 * STATE DIAGRAM 237 * STATE DIAGRAMS
232 ********************************************* 238 ******************************************************************************
233 * 239 *
234 * Tool stack creates front and back state nod 240 * Tool stack creates front and back state nodes with initial state
235 * XenbusStateInitialising. 241 * XenbusStateInitialising.
236 * Tool stack creates and sets up frontend dis 242 * Tool stack creates and sets up frontend display configuration
237 * nodes per domain. 243 * nodes per domain.
238 * 244 *
239 *-------------------------------- Normal flow 245 *-------------------------------- Normal flow --------------------------------
240 * 246 *
241 * Front Back 247 * Front Back
242 * ================================= ====== 248 * ================================= =====================================
243 * XenbusStateInitialising Xenbus 249 * XenbusStateInitialising XenbusStateInitialising
244 * o Que 250 * o Query backend device identification
245 * dat 251 * data.
246 * o Ope 252 * o Open and validate backend device.
247 * 253 * |
248 * 254 * |
249 * 255 * V
250 * Xenbus 256 * XenbusStateInitWait
251 * 257 *
252 * o Query frontend configuration 258 * o Query frontend configuration
253 * o Allocate and initialize 259 * o Allocate and initialize
254 * event channels per configured 260 * event channels per configured
255 * connector. 261 * connector.
256 * o Publish transport parameters 262 * o Publish transport parameters
257 * that will be in effect during 263 * that will be in effect during
258 * this connection. 264 * this connection.
259 * | 265 * |
260 * | 266 * |
261 * V 267 * V
262 * XenbusStateInitialised 268 * XenbusStateInitialised
263 * 269 *
264 * o Que 270 * o Query frontend transport parameters.
265 * o Con 271 * o Connect to the event channels.
266 * 272 * |
267 * 273 * |
268 * 274 * V
269 * Xenbus 275 * XenbusStateConnected
270 * 276 *
271 * o Create and initialize OS 277 * o Create and initialize OS
272 * virtual display connectors 278 * virtual display connectors
273 * as per configuration. 279 * as per configuration.
274 * | 280 * |
275 * | 281 * |
276 * V 282 * V
277 * XenbusStateConnected 283 * XenbusStateConnected
278 * 284 *
279 * Xenbus 285 * XenbusStateUnknown
280 * Xenbus 286 * XenbusStateClosed
281 * Xenbus 287 * XenbusStateClosing
282 * o Remove virtual display device 288 * o Remove virtual display device
283 * o Remove event channels 289 * o Remove event channels
284 * | 290 * |
285 * | 291 * |
286 * V 292 * V
287 * XenbusStateClosed 293 * XenbusStateClosed
288 * 294 *
289 *------------------------------- Recovery flo 295 *------------------------------- Recovery flow -------------------------------
290 * 296 *
291 * In case of frontend unrecoverable errors ba 297 * In case of frontend unrecoverable errors backend handles that as
292 * if frontend goes into the XenbusStateClosed 298 * if frontend goes into the XenbusStateClosed state.
293 * 299 *
294 * In case of backend unrecoverable errors fro 300 * In case of backend unrecoverable errors frontend tries removing
295 * the virtualized device. If this is possible 301 * the virtualized device. If this is possible at the moment of error,
296 * then frontend goes into the XenbusStateInit 302 * then frontend goes into the XenbusStateInitialising state and is ready for
297 * new connection with backend. If the virtual 303 * new connection with backend. If the virtualized device is still in use and
298 * cannot be removed, then frontend goes into 304 * cannot be removed, then frontend goes into the XenbusStateReconfiguring state
299 * until either the virtualized device is remo 305 * until either the virtualized device is removed or backend initiates a new
300 * connection. On the virtualized device remov 306 * connection. On the virtualized device removal frontend goes into the
301 * XenbusStateInitialising state. 307 * XenbusStateInitialising state.
302 * 308 *
303 * Note on XenbusStateReconfiguring state of t 309 * Note on XenbusStateReconfiguring state of the frontend: if backend has
304 * unrecoverable errors then frontend cannot s 310 * unrecoverable errors then frontend cannot send requests to the backend
305 * and thus cannot provide functionality of th 311 * and thus cannot provide functionality of the virtualized device anymore.
306 * After backend is back to normal the virtual 312 * After backend is back to normal the virtualized device may still hold some
307 * state: configuration in use, allocated buff 313 * state: configuration in use, allocated buffers, client application state etc.
308 * In most cases, this will require frontend t 314 * In most cases, this will require frontend to implement complex recovery
309 * reconnect logic. Instead, by going into Xen 315 * reconnect logic. Instead, by going into XenbusStateReconfiguring state,
310 * frontend will make sure no new clients of t 316 * frontend will make sure no new clients of the virtualized device are
311 * accepted, allow existing client(s) to exit 317 * accepted, allow existing client(s) to exit gracefully by signaling error
312 * state etc. 318 * state etc.
313 * Once all the clients are gone frontend can 319 * Once all the clients are gone frontend can reinitialize the virtualized
314 * device and get into XenbusStateInitialising 320 * device and get into XenbusStateInitialising state again signaling the
315 * backend that a new connection can be made. 321 * backend that a new connection can be made.
316 * 322 *
317 * There are multiple conditions possible unde 323 * There are multiple conditions possible under which frontend will go from
318 * XenbusStateReconfiguring into XenbusStateIn 324 * XenbusStateReconfiguring into XenbusStateInitialising, some of them are OS
319 * specific. For example: 325 * specific. For example:
320 * 1. The underlying OS framework may provide 326 * 1. The underlying OS framework may provide callbacks to signal that the last
321 * client of the virtualized device has gon 327 * client of the virtualized device has gone and the device can be removed
322 * 2. Frontend can schedule a deferred work (t 328 * 2. Frontend can schedule a deferred work (timer/tasklet/workqueue)
323 * to periodically check if this is the rig 329 * to periodically check if this is the right time to re-try removal of
324 * the virtualized device. 330 * the virtualized device.
325 * 3. By any other means. 331 * 3. By any other means.
326 * 332 *
327 ********************************************* 333 ******************************************************************************
328 * REQUEST CODES 334 * REQUEST CODES
329 ********************************************* 335 ******************************************************************************
330 * Request codes [0; 15] are reserved and must 336 * Request codes [0; 15] are reserved and must not be used
331 */ 337 */
332 338
333 #define XENDISPL_OP_DBUF_CREATE 0x10 339 #define XENDISPL_OP_DBUF_CREATE 0x10
334 #define XENDISPL_OP_DBUF_DESTROY 0x11 340 #define XENDISPL_OP_DBUF_DESTROY 0x11
335 #define XENDISPL_OP_FB_ATTACH 0x12 341 #define XENDISPL_OP_FB_ATTACH 0x12
336 #define XENDISPL_OP_FB_DETACH 0x13 342 #define XENDISPL_OP_FB_DETACH 0x13
337 #define XENDISPL_OP_SET_CONFIG 0x14 343 #define XENDISPL_OP_SET_CONFIG 0x14
338 #define XENDISPL_OP_PG_FLIP 0x15 344 #define XENDISPL_OP_PG_FLIP 0x15
339 /* The below command is available in protocol <<
340 #define XENDISPL_OP_GET_EDID 0x16 <<
341 345
342 /* 346 /*
343 ********************************************* 347 ******************************************************************************
344 * EVENT CODES 348 * EVENT CODES
345 ********************************************* 349 ******************************************************************************
346 */ 350 */
347 #define XENDISPL_EVT_PG_FLIP 0x00 351 #define XENDISPL_EVT_PG_FLIP 0x00
348 352
349 /* 353 /*
350 ********************************************* 354 ******************************************************************************
351 * XENSTORE FIELD AND PATH NAME 355 * XENSTORE FIELD AND PATH NAME STRINGS, HELPERS
352 ********************************************* 356 ******************************************************************************
353 */ 357 */
354 #define XENDISPL_DRIVER_NAME "vdisp 358 #define XENDISPL_DRIVER_NAME "vdispl"
355 359
356 #define XENDISPL_LIST_SEPARATOR "," 360 #define XENDISPL_LIST_SEPARATOR ","
357 #define XENDISPL_RESOLUTION_SEPARATOR "x" 361 #define XENDISPL_RESOLUTION_SEPARATOR "x"
358 362
359 #define XENDISPL_FIELD_BE_VERSIONS "versi 363 #define XENDISPL_FIELD_BE_VERSIONS "versions"
360 #define XENDISPL_FIELD_FE_VERSION "versi 364 #define XENDISPL_FIELD_FE_VERSION "version"
361 #define XENDISPL_FIELD_REQ_RING_REF "req-r 365 #define XENDISPL_FIELD_REQ_RING_REF "req-ring-ref"
362 #define XENDISPL_FIELD_REQ_CHANNEL "req-e 366 #define XENDISPL_FIELD_REQ_CHANNEL "req-event-channel"
363 #define XENDISPL_FIELD_EVT_RING_REF "evt-r 367 #define XENDISPL_FIELD_EVT_RING_REF "evt-ring-ref"
364 #define XENDISPL_FIELD_EVT_CHANNEL "evt-e 368 #define XENDISPL_FIELD_EVT_CHANNEL "evt-event-channel"
365 #define XENDISPL_FIELD_RESOLUTION "resol 369 #define XENDISPL_FIELD_RESOLUTION "resolution"
366 #define XENDISPL_FIELD_BE_ALLOC "be-al 370 #define XENDISPL_FIELD_BE_ALLOC "be-alloc"
367 #define XENDISPL_FIELD_UNIQUE_ID "uniqu <<
368 <<
369 #define XENDISPL_EDID_BLOCK_SIZE 128 <<
370 #define XENDISPL_EDID_BLOCK_COUNT 256 <<
371 #define XENDISPL_EDID_MAX_SIZE (XENDI <<
372 371
373 /* 372 /*
374 ********************************************* 373 ******************************************************************************
375 * STATUS RETURN CODE 374 * STATUS RETURN CODES
376 ********************************************* 375 ******************************************************************************
377 * 376 *
378 * Status return code is zero on success and - 377 * Status return code is zero on success and -XEN_EXX on failure.
379 * 378 *
380 ********************************************* 379 ******************************************************************************
381 * Assumptions 380 * Assumptions
382 ********************************************* 381 ******************************************************************************
383 * o usage of grant reference 0 as invalid gra 382 * o usage of grant reference 0 as invalid grant reference:
384 * grant reference 0 is valid, but never exp 383 * grant reference 0 is valid, but never exposed to a PV driver,
385 * because of the fact it is already in use/ 384 * because of the fact it is already in use/reserved by the PV console.
386 * o all references in this document to page s 385 * o all references in this document to page sizes must be treated
387 * as pages of size XEN_PAGE_SIZE unless oth 386 * as pages of size XEN_PAGE_SIZE unless otherwise noted.
388 * 387 *
389 ********************************************* 388 ******************************************************************************
390 * Description of the protocol between f 389 * Description of the protocol between frontend and backend driver
391 ********************************************* 390 ******************************************************************************
392 * 391 *
393 * The two halves of a Para-virtual display dr 392 * The two halves of a Para-virtual display driver communicate with
394 * each other using shared pages and event cha 393 * each other using shared pages and event channels.
395 * Shared page contains a ring with request/re 394 * Shared page contains a ring with request/response packets.
396 * 395 *
397 * All reserved fields in the structures below 396 * All reserved fields in the structures below must be 0.
398 * Display buffers's cookie of value 0 is trea 397 * Display buffers's cookie of value 0 is treated as invalid.
399 * Framebuffer's cookie of value 0 is treated 398 * Framebuffer's cookie of value 0 is treated as invalid.
400 * 399 *
401 * For all request/response/event packets that 400 * For all request/response/event packets that use cookies:
402 * dbuf_cookie - uint64_t, unique to guest d 401 * dbuf_cookie - uint64_t, unique to guest domain value used by the backend
403 * to map remote display buffer to its loc 402 * to map remote display buffer to its local one
404 * fb_cookie - uint64_t, unique to guest dom 403 * fb_cookie - uint64_t, unique to guest domain value used by the backend
405 * to map remote framebuffer to its local 404 * to map remote framebuffer to its local one
406 * 405 *
407 *---------------------------------- Requests 406 *---------------------------------- Requests ---------------------------------
408 * 407 *
409 * All requests/responses, which are not conne 408 * All requests/responses, which are not connector specific, must be sent over
410 * control ring of the connector which has the 409 * control ring of the connector which has the index value of 0:
411 * /local/domain/<dom-id>/device/vdispl/<dev 410 * /local/domain/<dom-id>/device/vdispl/<dev-id>/0/req-ring-ref
412 * 411 *
413 * All request packets have the same length (6 412 * All request packets have the same length (64 octets)
414 * All request packets have common header: 413 * All request packets have common header:
415 * 0 1 414 * 0 1 2 3 octet
416 * +----------------+----------------+-------- 415 * +----------------+----------------+----------------+----------------+
417 * | id | oper 416 * | id | operation | reserved | 4
418 * +----------------+----------------+-------- 417 * +----------------+----------------+----------------+----------------+
419 * | reserved 418 * | reserved | 8
420 * +----------------+----------------+-------- 419 * +----------------+----------------+----------------+----------------+
421 * id - uint16_t, private guest value, echoe 420 * id - uint16_t, private guest value, echoed in response
422 * operation - uint8_t, operation code, XEND 421 * operation - uint8_t, operation code, XENDISPL_OP_???
423 * 422 *
424 * Request dbuf creation - request creation of 423 * Request dbuf creation - request creation of a display buffer.
425 * 0 1 424 * 0 1 2 3 octet
426 * +----------------+----------------+-------- 425 * +----------------+----------------+----------------+----------------+
427 * | id |_OP_DBUF 426 * | id |_OP_DBUF_CREATE | reserved | 4
428 * +----------------+----------------+-------- 427 * +----------------+----------------+----------------+----------------+
429 * | reserved 428 * | reserved | 8
430 * +----------------+----------------+-------- 429 * +----------------+----------------+----------------+----------------+
431 * | dbuf_cookie low 32- 430 * | dbuf_cookie low 32-bit | 12
432 * +----------------+----------------+-------- 431 * +----------------+----------------+----------------+----------------+
433 * | dbuf_cookie high 32 432 * | dbuf_cookie high 32-bit | 16
434 * +----------------+----------------+-------- 433 * +----------------+----------------+----------------+----------------+
435 * | width 434 * | width | 20
436 * +----------------+----------------+-------- 435 * +----------------+----------------+----------------+----------------+
437 * | height 436 * | height | 24
438 * +----------------+----------------+-------- 437 * +----------------+----------------+----------------+----------------+
439 * | bpp 438 * | bpp | 28
440 * +----------------+----------------+-------- 439 * +----------------+----------------+----------------+----------------+
441 * | buffer_sz 440 * | buffer_sz | 32
442 * +----------------+----------------+-------- 441 * +----------------+----------------+----------------+----------------+
443 * | flags 442 * | flags | 36
444 * +----------------+----------------+-------- 443 * +----------------+----------------+----------------+----------------+
445 * | gref_directory 444 * | gref_directory | 40
446 * +----------------+----------------+-------- 445 * +----------------+----------------+----------------+----------------+
447 * | data_ofs !! 446 * | reserved | 44
448 * +----------------+----------------+-------- <<
449 * | reserved <<
450 * +----------------+----------------+-------- 447 * +----------------+----------------+----------------+----------------+
451 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 448 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
452 * +----------------+----------------+-------- 449 * +----------------+----------------+----------------+----------------+
453 * | reserved 450 * | reserved | 64
454 * +----------------+----------------+-------- 451 * +----------------+----------------+----------------+----------------+
455 * 452 *
456 * Must be sent over control ring of the conne 453 * Must be sent over control ring of the connector which has the index
457 * value of 0: 454 * value of 0:
458 * /local/domain/<dom-id>/device/vdispl/<dev 455 * /local/domain/<dom-id>/device/vdispl/<dev-id>/0/req-ring-ref
459 * All unused bits in flags field must be set 456 * All unused bits in flags field must be set to 0.
460 * 457 *
461 * An attempt to create multiple display buffe 458 * An attempt to create multiple display buffers with the same dbuf_cookie is
462 * an error. dbuf_cookie can be re-used after 459 * an error. dbuf_cookie can be re-used after destroying the corresponding
463 * display buffer. 460 * display buffer.
464 * 461 *
465 * Width and height of the display buffers can 462 * Width and height of the display buffers can be smaller, equal or bigger
466 * than the connector's resolution. Depth/pixe 463 * than the connector's resolution. Depth/pixel format of the individual
467 * buffers can differ as well. 464 * buffers can differ as well.
468 * 465 *
469 * width - uint32_t, width in pixels 466 * width - uint32_t, width in pixels
470 * height - uint32_t, height in pixels 467 * height - uint32_t, height in pixels
471 * bpp - uint32_t, bits per pixel 468 * bpp - uint32_t, bits per pixel
472 * buffer_sz - uint32_t, buffer size to be all 469 * buffer_sz - uint32_t, buffer size to be allocated, octets
473 * flags - uint32_t, flags of the operation 470 * flags - uint32_t, flags of the operation
474 * o XENDISPL_DBUF_FLG_REQ_ALLOC - if set, t 471 * o XENDISPL_DBUF_FLG_REQ_ALLOC - if set, then backend is requested
475 * to allocate the buffer with the paramet 472 * to allocate the buffer with the parameters provided in this request.
476 * Page directory is handled as follows: 473 * Page directory is handled as follows:
477 * Frontend on request: 474 * Frontend on request:
478 * o allocates pages for the directory 475 * o allocates pages for the directory (gref_directory,
479 * gref_dir_next_page(s) 476 * gref_dir_next_page(s)
480 * o grants permissions for the pages 477 * o grants permissions for the pages of the directory to the backend
481 * o sets gref_dir_next_page fields 478 * o sets gref_dir_next_page fields
482 * Backend on response: 479 * Backend on response:
483 * o grants permissions for the pages 480 * o grants permissions for the pages of the buffer allocated to
484 * the frontend 481 * the frontend
485 * o fills in page directory with gran 482 * o fills in page directory with grant references
486 * (gref[] in struct xendispl_page_d 483 * (gref[] in struct xendispl_page_directory)
487 * gref_directory - grant_ref_t, a reference t 484 * gref_directory - grant_ref_t, a reference to the first shared page
488 * describing shared buffer references. At l 485 * describing shared buffer references. At least one page exists. If shared
489 * buffer size (buffer_sz) exceeds what can 486 * buffer size (buffer_sz) exceeds what can be addressed by this single page,
490 * then reference to the next page must be s 487 * then reference to the next page must be supplied (see gref_dir_next_page
491 * below) 488 * below)
492 * data_ofs - uint32_t, offset of the data in <<
493 */ 489 */
494 490
495 #define XENDISPL_DBUF_FLG_REQ_ALLOC (1 << 491 #define XENDISPL_DBUF_FLG_REQ_ALLOC (1 << 0)
496 492
497 struct xendispl_dbuf_create_req { 493 struct xendispl_dbuf_create_req {
498 uint64_t dbuf_cookie; 494 uint64_t dbuf_cookie;
499 uint32_t width; 495 uint32_t width;
500 uint32_t height; 496 uint32_t height;
501 uint32_t bpp; 497 uint32_t bpp;
502 uint32_t buffer_sz; 498 uint32_t buffer_sz;
503 uint32_t flags; 499 uint32_t flags;
504 grant_ref_t gref_directory; 500 grant_ref_t gref_directory;
505 uint32_t data_ofs; <<
506 }; 501 };
507 502
508 /* 503 /*
509 * Shared page for XENDISPL_OP_DBUF_CREATE buf 504 * Shared page for XENDISPL_OP_DBUF_CREATE buffer descriptor (gref_directory in
510 * the request) employs a list of pages, descr 505 * the request) employs a list of pages, describing all pages of the shared
511 * data buffer: 506 * data buffer:
512 * 0 1 507 * 0 1 2 3 octet
513 * +----------------+----------------+-------- 508 * +----------------+----------------+----------------+----------------+
514 * | gref_dir_next_page 509 * | gref_dir_next_page | 4
515 * +----------------+----------------+-------- 510 * +----------------+----------------+----------------+----------------+
516 * | gref[0] 511 * | gref[0] | 8
517 * +----------------+----------------+-------- 512 * +----------------+----------------+----------------+----------------+
518 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 513 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
519 * +----------------+----------------+-------- 514 * +----------------+----------------+----------------+----------------+
520 * | gref[i] 515 * | gref[i] | i*4+8
521 * +----------------+----------------+-------- 516 * +----------------+----------------+----------------+----------------+
522 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 517 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
523 * +----------------+----------------+-------- 518 * +----------------+----------------+----------------+----------------+
524 * | gref[N - 1] 519 * | gref[N - 1] | N*4+8
525 * +----------------+----------------+-------- 520 * +----------------+----------------+----------------+----------------+
526 * 521 *
527 * gref_dir_next_page - grant_ref_t, reference 522 * gref_dir_next_page - grant_ref_t, reference to the next page describing
528 * page directory. Must be 0 if there are no 523 * page directory. Must be 0 if there are no more pages in the list.
529 * gref[i] - grant_ref_t, reference to a share 524 * gref[i] - grant_ref_t, reference to a shared page of the buffer
530 * allocated at XENDISPL_OP_DBUF_CREATE 525 * allocated at XENDISPL_OP_DBUF_CREATE
531 * 526 *
532 * Number of grant_ref_t entries in the whole 527 * Number of grant_ref_t entries in the whole page directory is not
533 * passed, but instead can be calculated as: 528 * passed, but instead can be calculated as:
534 * num_grefs_total = (XENDISPL_OP_DBUF_CREAT 529 * num_grefs_total = (XENDISPL_OP_DBUF_CREATE.buffer_sz + XEN_PAGE_SIZE - 1) /
535 * XEN_PAGE_SIZE 530 * XEN_PAGE_SIZE
536 */ 531 */
537 532
538 struct xendispl_page_directory { 533 struct xendispl_page_directory {
539 grant_ref_t gref_dir_next_page; 534 grant_ref_t gref_dir_next_page;
540 grant_ref_t gref[]; !! 535 grant_ref_t gref[1]; /* Variable length */
541 }; 536 };
542 537
543 /* 538 /*
544 * Request dbuf destruction - destroy a previo 539 * Request dbuf destruction - destroy a previously allocated display buffer:
545 * 0 1 540 * 0 1 2 3 octet
546 * +----------------+----------------+-------- 541 * +----------------+----------------+----------------+----------------+
547 * | id |_OP_DBUF 542 * | id |_OP_DBUF_DESTROY| reserved | 4
548 * +----------------+----------------+-------- 543 * +----------------+----------------+----------------+----------------+
549 * | reserved 544 * | reserved | 8
550 * +----------------+----------------+-------- 545 * +----------------+----------------+----------------+----------------+
551 * | dbuf_cookie low 32- 546 * | dbuf_cookie low 32-bit | 12
552 * +----------------+----------------+-------- 547 * +----------------+----------------+----------------+----------------+
553 * | dbuf_cookie high 32 548 * | dbuf_cookie high 32-bit | 16
554 * +----------------+----------------+-------- 549 * +----------------+----------------+----------------+----------------+
555 * | reserved 550 * | reserved | 20
556 * +----------------+----------------+-------- 551 * +----------------+----------------+----------------+----------------+
557 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 552 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
558 * +----------------+----------------+-------- 553 * +----------------+----------------+----------------+----------------+
559 * | reserved 554 * | reserved | 64
560 * +----------------+----------------+-------- 555 * +----------------+----------------+----------------+----------------+
561 * 556 *
562 * Must be sent over control ring of the conne 557 * Must be sent over control ring of the connector which has the index
563 * value of 0: 558 * value of 0:
564 * /local/domain/<dom-id>/device/vdispl/<dev 559 * /local/domain/<dom-id>/device/vdispl/<dev-id>/0/req-ring-ref
565 */ 560 */
566 561
567 struct xendispl_dbuf_destroy_req { 562 struct xendispl_dbuf_destroy_req {
568 uint64_t dbuf_cookie; 563 uint64_t dbuf_cookie;
569 }; 564 };
570 565
571 /* 566 /*
572 * Request framebuffer attachment - request at 567 * Request framebuffer attachment - request attachment of a framebuffer to
573 * previously created display buffer. 568 * previously created display buffer.
574 * 0 1 569 * 0 1 2 3 octet
575 * +----------------+----------------+-------- 570 * +----------------+----------------+----------------+----------------+
576 * | id | _OP_FB_ 571 * | id | _OP_FB_ATTACH | reserved | 4
577 * +----------------+----------------+-------- 572 * +----------------+----------------+----------------+----------------+
578 * | reserved 573 * | reserved | 8
579 * +----------------+----------------+-------- 574 * +----------------+----------------+----------------+----------------+
580 * | dbuf_cookie low 32- 575 * | dbuf_cookie low 32-bit | 12
581 * +----------------+----------------+-------- 576 * +----------------+----------------+----------------+----------------+
582 * | dbuf_cookie high 32 577 * | dbuf_cookie high 32-bit | 16
583 * +----------------+----------------+-------- 578 * +----------------+----------------+----------------+----------------+
584 * | fb_cookie low 32-b 579 * | fb_cookie low 32-bit | 20
585 * +----------------+----------------+-------- 580 * +----------------+----------------+----------------+----------------+
586 * | fb_cookie high 32- 581 * | fb_cookie high 32-bit | 24
587 * +----------------+----------------+-------- 582 * +----------------+----------------+----------------+----------------+
588 * | width 583 * | width | 28
589 * +----------------+----------------+-------- 584 * +----------------+----------------+----------------+----------------+
590 * | height 585 * | height | 32
591 * +----------------+----------------+-------- 586 * +----------------+----------------+----------------+----------------+
592 * | pixel_format 587 * | pixel_format | 36
593 * +----------------+----------------+-------- 588 * +----------------+----------------+----------------+----------------+
594 * | reserved 589 * | reserved | 40
595 * +----------------+----------------+-------- 590 * +----------------+----------------+----------------+----------------+
596 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 591 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
597 * +----------------+----------------+-------- 592 * +----------------+----------------+----------------+----------------+
598 * | reserved 593 * | reserved | 64
599 * +----------------+----------------+-------- 594 * +----------------+----------------+----------------+----------------+
600 * 595 *
601 * Must be sent over control ring of the conne 596 * Must be sent over control ring of the connector which has the index
602 * value of 0: 597 * value of 0:
603 * /local/domain/<dom-id>/device/vdispl/<dev 598 * /local/domain/<dom-id>/device/vdispl/<dev-id>/0/req-ring-ref
604 * Width and height can be smaller, equal or b 599 * Width and height can be smaller, equal or bigger than the connector's
605 * resolution. 600 * resolution.
606 * 601 *
607 * An attempt to create multiple frame buffers 602 * An attempt to create multiple frame buffers with the same fb_cookie is
608 * an error. fb_cookie can be re-used after de 603 * an error. fb_cookie can be re-used after destroying the corresponding
609 * frame buffer. 604 * frame buffer.
610 * 605 *
611 * width - uint32_t, width in pixels 606 * width - uint32_t, width in pixels
612 * height - uint32_t, height in pixels 607 * height - uint32_t, height in pixels
613 * pixel_format - uint32_t, pixel format of th 608 * pixel_format - uint32_t, pixel format of the framebuffer, FOURCC code
614 */ 609 */
615 610
616 struct xendispl_fb_attach_req { 611 struct xendispl_fb_attach_req {
617 uint64_t dbuf_cookie; 612 uint64_t dbuf_cookie;
618 uint64_t fb_cookie; 613 uint64_t fb_cookie;
619 uint32_t width; 614 uint32_t width;
620 uint32_t height; 615 uint32_t height;
621 uint32_t pixel_format; 616 uint32_t pixel_format;
622 }; 617 };
623 618
624 /* 619 /*
625 * Request framebuffer detach - detach a previ 620 * Request framebuffer detach - detach a previously
626 * attached framebuffer from the display buffe 621 * attached framebuffer from the display buffer in request:
627 * 0 1 622 * 0 1 2 3 octet
628 * +----------------+----------------+-------- 623 * +----------------+----------------+----------------+----------------+
629 * | id | _OP_FB 624 * | id | _OP_FB_DETACH | reserved | 4
630 * +----------------+----------------+-------- 625 * +----------------+----------------+----------------+----------------+
631 * | reserved 626 * | reserved | 8
632 * +----------------+----------------+-------- 627 * +----------------+----------------+----------------+----------------+
633 * | fb_cookie low 32-b 628 * | fb_cookie low 32-bit | 12
634 * +----------------+----------------+-------- 629 * +----------------+----------------+----------------+----------------+
635 * | fb_cookie high 32- 630 * | fb_cookie high 32-bit | 16
636 * +----------------+----------------+-------- 631 * +----------------+----------------+----------------+----------------+
637 * | reserved 632 * | reserved | 20
638 * +----------------+----------------+-------- 633 * +----------------+----------------+----------------+----------------+
639 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 634 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
640 * +----------------+----------------+-------- 635 * +----------------+----------------+----------------+----------------+
641 * | reserved 636 * | reserved | 64
642 * +----------------+----------------+-------- 637 * +----------------+----------------+----------------+----------------+
643 * 638 *
644 * Must be sent over control ring of the conne 639 * Must be sent over control ring of the connector which has the index
645 * value of 0: 640 * value of 0:
646 * /local/domain/<dom-id>/device/vdispl/<dev 641 * /local/domain/<dom-id>/device/vdispl/<dev-id>/0/req-ring-ref
647 */ 642 */
648 643
649 struct xendispl_fb_detach_req { 644 struct xendispl_fb_detach_req {
650 uint64_t fb_cookie; 645 uint64_t fb_cookie;
651 }; 646 };
652 647
653 /* 648 /*
654 * Request configuration set/reset - request t 649 * Request configuration set/reset - request to set or reset
655 * the configuration/mode of the display: 650 * the configuration/mode of the display:
656 * 0 1 651 * 0 1 2 3 octet
657 * +----------------+----------------+-------- 652 * +----------------+----------------+----------------+----------------+
658 * | id | _OP_SET 653 * | id | _OP_SET_CONFIG | reserved | 4
659 * +----------------+----------------+-------- 654 * +----------------+----------------+----------------+----------------+
660 * | reserved 655 * | reserved | 8
661 * +----------------+----------------+-------- 656 * +----------------+----------------+----------------+----------------+
662 * | fb_cookie low 32-b 657 * | fb_cookie low 32-bit | 12
663 * +----------------+----------------+-------- 658 * +----------------+----------------+----------------+----------------+
664 * | fb_cookie high 32- 659 * | fb_cookie high 32-bit | 16
665 * +----------------+----------------+-------- 660 * +----------------+----------------+----------------+----------------+
666 * | x 661 * | x | 20
667 * +----------------+----------------+-------- 662 * +----------------+----------------+----------------+----------------+
668 * | y 663 * | y | 24
669 * +----------------+----------------+-------- 664 * +----------------+----------------+----------------+----------------+
670 * | width 665 * | width | 28
671 * +----------------+----------------+-------- 666 * +----------------+----------------+----------------+----------------+
672 * | height 667 * | height | 32
673 * +----------------+----------------+-------- 668 * +----------------+----------------+----------------+----------------+
674 * | bpp 669 * | bpp | 40
675 * +----------------+----------------+-------- 670 * +----------------+----------------+----------------+----------------+
676 * | reserved 671 * | reserved | 44
677 * +----------------+----------------+-------- 672 * +----------------+----------------+----------------+----------------+
678 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 673 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
679 * +----------------+----------------+-------- 674 * +----------------+----------------+----------------+----------------+
680 * | reserved 675 * | reserved | 64
681 * +----------------+----------------+-------- 676 * +----------------+----------------+----------------+----------------+
682 * 677 *
683 * Pass all zeros to reset, otherwise command 678 * Pass all zeros to reset, otherwise command is treated as
684 * configuration set. 679 * configuration set.
685 * Framebuffer's cookie defines which framebuf 680 * Framebuffer's cookie defines which framebuffer/dbuf must be
686 * displayed while enabling display (applying 681 * displayed while enabling display (applying configuration).
687 * x, y, width and height are bound by the con 682 * x, y, width and height are bound by the connector's resolution and must not
688 * exceed it. 683 * exceed it.
689 * 684 *
690 * x - uint32_t, starting position in pixels b 685 * x - uint32_t, starting position in pixels by X axis
691 * y - uint32_t, starting position in pixels b 686 * y - uint32_t, starting position in pixels by Y axis
692 * width - uint32_t, width in pixels 687 * width - uint32_t, width in pixels
693 * height - uint32_t, height in pixels 688 * height - uint32_t, height in pixels
694 * bpp - uint32_t, bits per pixel 689 * bpp - uint32_t, bits per pixel
695 */ 690 */
696 691
697 struct xendispl_set_config_req { 692 struct xendispl_set_config_req {
698 uint64_t fb_cookie; 693 uint64_t fb_cookie;
699 uint32_t x; 694 uint32_t x;
700 uint32_t y; 695 uint32_t y;
701 uint32_t width; 696 uint32_t width;
702 uint32_t height; 697 uint32_t height;
703 uint32_t bpp; 698 uint32_t bpp;
704 }; 699 };
705 700
706 /* 701 /*
707 * Request page flip - request to flip a page 702 * Request page flip - request to flip a page identified by the framebuffer
708 * cookie: 703 * cookie:
709 * 0 1 704 * 0 1 2 3 octet
710 * +----------------+----------------+-------- 705 * +----------------+----------------+----------------+----------------+
711 * | id | _OP_PG_ 706 * | id | _OP_PG_FLIP | reserved | 4
712 * +----------------+----------------+-------- 707 * +----------------+----------------+----------------+----------------+
713 * | reserved 708 * | reserved | 8
714 * +----------------+----------------+-------- 709 * +----------------+----------------+----------------+----------------+
715 * | fb_cookie low 32-b 710 * | fb_cookie low 32-bit | 12
716 * +----------------+----------------+-------- 711 * +----------------+----------------+----------------+----------------+
717 * | fb_cookie high 32- 712 * | fb_cookie high 32-bit | 16
718 * +----------------+----------------+-------- 713 * +----------------+----------------+----------------+----------------+
719 * | reserved 714 * | reserved | 20
720 * +----------------+----------------+-------- 715 * +----------------+----------------+----------------+----------------+
721 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 716 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
722 * +----------------+----------------+-------- 717 * +----------------+----------------+----------------+----------------+
723 * | reserved 718 * | reserved | 64
724 * +----------------+----------------+-------- 719 * +----------------+----------------+----------------+----------------+
725 */ 720 */
726 721
727 struct xendispl_page_flip_req { 722 struct xendispl_page_flip_req {
728 uint64_t fb_cookie; 723 uint64_t fb_cookie;
729 }; 724 };
730 725
731 /* 726 /*
732 * Request EDID - request EDID describing curr <<
733 * 0 1 <<
734 * +----------------+----------------+-------- <<
735 * | id | _OP_GET <<
736 * +----------------+----------------+-------- <<
737 * | buffer_sz <<
738 * +----------------+----------------+-------- <<
739 * | gref_directory <<
740 * +----------------+----------------+-------- <<
741 * | reserved <<
742 * +----------------+----------------+-------- <<
743 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ <<
744 * +----------------+----------------+-------- <<
745 * | reserved <<
746 * +----------------+----------------+-------- <<
747 * <<
748 * Notes: <<
749 * - This command is not available in protoc <<
750 * ignored. <<
751 * - This request is optional and if not sup <<
752 * is defined by the relevant XenStore's " <<
753 * - Shared buffer, allocated for EDID stora <<
754 * XENDISPL_EDID_MAX_SIZE octets. <<
755 * <<
756 * buffer_sz - uint32_t, buffer size to be all <<
757 * gref_directory - grant_ref_t, a reference t <<
758 * describing EDID buffer references. See XE <<
759 * grant page directory structure (struct xe <<
760 * <<
761 * See response format for this request. <<
762 */ <<
763 <<
764 struct xendispl_get_edid_req { <<
765 uint32_t buffer_sz; <<
766 grant_ref_t gref_directory; <<
767 }; <<
768 <<
769 /* <<
770 *---------------------------------- Responses 727 *---------------------------------- Responses --------------------------------
771 * 728 *
772 * All response packets have the same length ( 729 * All response packets have the same length (64 octets)
773 * 730 *
774 * All response packets have common header: 731 * All response packets have common header:
775 * 0 1 732 * 0 1 2 3 octet
776 * +----------------+----------------+-------- 733 * +----------------+----------------+----------------+----------------+
777 * | id | 734 * | id | reserved | 4
778 * +----------------+----------------+-------- 735 * +----------------+----------------+----------------+----------------+
779 * | status 736 * | status | 8
780 * +----------------+----------------+-------- 737 * +----------------+----------------+----------------+----------------+
781 * | reserved 738 * | reserved | 12
782 * +----------------+----------------+-------- 739 * +----------------+----------------+----------------+----------------+
783 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 740 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
784 * +----------------+----------------+-------- 741 * +----------------+----------------+----------------+----------------+
785 * | reserved 742 * | reserved | 64
786 * +----------------+----------------+-------- 743 * +----------------+----------------+----------------+----------------+
787 * 744 *
788 * id - uint16_t, private guest value, echoed 745 * id - uint16_t, private guest value, echoed from request
789 * status - int32_t, response status, zero on 746 * status - int32_t, response status, zero on success and -XEN_EXX on failure
790 * 747 *
791 * <<
792 * Get EDID response - response for XENDISPL_O <<
793 * 0 1 <<
794 * +----------------+----------------+-------- <<
795 * | id | oper <<
796 * +----------------+----------------+-------- <<
797 * | status <<
798 * +----------------+----------------+-------- <<
799 * | edid_sz <<
800 * +----------------+----------------+-------- <<
801 * | reserved <<
802 * +----------------+----------------+-------- <<
803 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ <<
804 * +----------------+----------------+-------- <<
805 * | reserved <<
806 * +----------------+----------------+-------- <<
807 * <<
808 * Notes: <<
809 * - This response is not available in proto <<
810 * ignored. <<
811 * <<
812 * edid_sz - uint32_t, size of the EDID, octet <<
813 */ <<
814 <<
815 struct xendispl_get_edid_resp { <<
816 uint32_t edid_sz; <<
817 }; <<
818 <<
819 /* <<
820 *----------------------------------- Events - 748 *----------------------------------- Events ----------------------------------
821 * 749 *
822 * Events are sent via a shared page allocated 750 * Events are sent via a shared page allocated by the front and propagated by
823 * evt-event-channel/evt-ring-ref XenStore e 751 * evt-event-channel/evt-ring-ref XenStore entries
824 * All event packets have the same length (64 752 * All event packets have the same length (64 octets)
825 * All event packets have common header: 753 * All event packets have common header:
826 * 0 1 754 * 0 1 2 3 octet
827 * +----------------+----------------+-------- 755 * +----------------+----------------+----------------+----------------+
828 * | id | ty 756 * | id | type | reserved | 4
829 * +----------------+----------------+-------- 757 * +----------------+----------------+----------------+----------------+
830 * | reserved 758 * | reserved | 8
831 * +----------------+----------------+-------- 759 * +----------------+----------------+----------------+----------------+
832 * 760 *
833 * id - uint16_t, event id, may be used by fro 761 * id - uint16_t, event id, may be used by front
834 * type - uint8_t, type of the event 762 * type - uint8_t, type of the event
835 * 763 *
836 * 764 *
837 * Page flip complete event - event from back 765 * Page flip complete event - event from back to front on page flip completed:
838 * 0 1 766 * 0 1 2 3 octet
839 * +----------------+----------------+-------- 767 * +----------------+----------------+----------------+----------------+
840 * | id | _EVT_ 768 * | id | _EVT_PG_FLIP | reserved | 4
841 * +----------------+----------------+-------- 769 * +----------------+----------------+----------------+----------------+
842 * | reserved 770 * | reserved | 8
843 * +----------------+----------------+-------- 771 * +----------------+----------------+----------------+----------------+
844 * | fb_cookie low 32-b 772 * | fb_cookie low 32-bit | 12
845 * +----------------+----------------+-------- 773 * +----------------+----------------+----------------+----------------+
846 * | fb_cookie high 32- 774 * | fb_cookie high 32-bit | 16
847 * +----------------+----------------+-------- 775 * +----------------+----------------+----------------+----------------+
848 * | reserved 776 * | reserved | 20
849 * +----------------+----------------+-------- 777 * +----------------+----------------+----------------+----------------+
850 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\ 778 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
851 * +----------------+----------------+-------- 779 * +----------------+----------------+----------------+----------------+
852 * | reserved 780 * | reserved | 64
853 * +----------------+----------------+-------- 781 * +----------------+----------------+----------------+----------------+
854 */ 782 */
855 783
856 struct xendispl_pg_flip_evt { 784 struct xendispl_pg_flip_evt {
857 uint64_t fb_cookie; 785 uint64_t fb_cookie;
858 }; 786 };
859 787
860 struct xendispl_req { 788 struct xendispl_req {
861 uint16_t id; 789 uint16_t id;
862 uint8_t operation; 790 uint8_t operation;
863 uint8_t reserved[5]; 791 uint8_t reserved[5];
864 union { 792 union {
865 struct xendispl_dbuf_create_re 793 struct xendispl_dbuf_create_req dbuf_create;
866 struct xendispl_dbuf_destroy_r 794 struct xendispl_dbuf_destroy_req dbuf_destroy;
867 struct xendispl_fb_attach_req 795 struct xendispl_fb_attach_req fb_attach;
868 struct xendispl_fb_detach_req 796 struct xendispl_fb_detach_req fb_detach;
869 struct xendispl_set_config_req 797 struct xendispl_set_config_req set_config;
870 struct xendispl_page_flip_req 798 struct xendispl_page_flip_req pg_flip;
871 struct xendispl_get_edid_req g <<
872 uint8_t reserved[56]; 799 uint8_t reserved[56];
873 } op; 800 } op;
874 }; 801 };
875 802
876 struct xendispl_resp { 803 struct xendispl_resp {
877 uint16_t id; 804 uint16_t id;
878 uint8_t operation; 805 uint8_t operation;
879 uint8_t reserved; 806 uint8_t reserved;
880 int32_t status; 807 int32_t status;
881 union { !! 808 uint8_t reserved1[56];
882 struct xendispl_get_edid_resp <<
883 uint8_t reserved1[56]; <<
884 } op; <<
885 }; 809 };
886 810
887 struct xendispl_evt { 811 struct xendispl_evt {
888 uint16_t id; 812 uint16_t id;
889 uint8_t type; 813 uint8_t type;
890 uint8_t reserved[5]; 814 uint8_t reserved[5];
891 union { 815 union {
892 struct xendispl_pg_flip_evt pg 816 struct xendispl_pg_flip_evt pg_flip;
893 uint8_t reserved[56]; 817 uint8_t reserved[56];
894 } op; 818 } op;
895 }; 819 };
896 820
897 DEFINE_RING_TYPES(xen_displif, struct xendispl 821 DEFINE_RING_TYPES(xen_displif, struct xendispl_req, struct xendispl_resp);
898 822
899 /* 823 /*
900 ********************************************* 824 ******************************************************************************
901 * Back to front events 825 * Back to front events delivery
902 ********************************************* 826 ******************************************************************************
903 * In order to deliver asynchronous events fro 827 * In order to deliver asynchronous events from back to front a shared page is
904 * allocated by front and its granted referenc 828 * allocated by front and its granted reference propagated to back via
905 * XenStore entries (evt-ring-ref/evt-event-ch 829 * XenStore entries (evt-ring-ref/evt-event-channel).
906 * This page has a common header used by both 830 * This page has a common header used by both front and back to synchronize
907 * access and control event's ring buffer, whi 831 * access and control event's ring buffer, while back being a producer of the
908 * events and front being a consumer. The rest 832 * events and front being a consumer. The rest of the page after the header
909 * is used for event packets. 833 * is used for event packets.
910 * 834 *
911 * Upon reception of an event(s) front may con 835 * Upon reception of an event(s) front may confirm its reception
912 * for either each event, group of events or n 836 * for either each event, group of events or none.
913 */ 837 */
914 838
915 struct xendispl_event_page { 839 struct xendispl_event_page {
916 uint32_t in_cons; 840 uint32_t in_cons;
917 uint32_t in_prod; 841 uint32_t in_prod;
918 uint8_t reserved[56]; 842 uint8_t reserved[56];
919 }; 843 };
920 844
921 #define XENDISPL_EVENT_PAGE_SIZE XEN_PAGE_SIZE 845 #define XENDISPL_EVENT_PAGE_SIZE XEN_PAGE_SIZE
922 #define XENDISPL_IN_RING_OFFS (sizeof(struct x 846 #define XENDISPL_IN_RING_OFFS (sizeof(struct xendispl_event_page))
923 #define XENDISPL_IN_RING_SIZE (XENDISPL_EVENT_ 847 #define XENDISPL_IN_RING_SIZE (XENDISPL_EVENT_PAGE_SIZE - XENDISPL_IN_RING_OFFS)
924 #define XENDISPL_IN_RING_LEN (XENDISPL_IN_RING 848 #define XENDISPL_IN_RING_LEN (XENDISPL_IN_RING_SIZE / sizeof(struct xendispl_evt))
925 #define XENDISPL_IN_RING(page) \ 849 #define XENDISPL_IN_RING(page) \
926 ((struct xendispl_evt *)((char *)(page 850 ((struct xendispl_evt *)((char *)(page) + XENDISPL_IN_RING_OFFS))
927 #define XENDISPL_IN_RING_REF(page, idx) \ 851 #define XENDISPL_IN_RING_REF(page, idx) \
928 (XENDISPL_IN_RING((page))[(idx) % XEND 852 (XENDISPL_IN_RING((page))[(idx) % XENDISPL_IN_RING_LEN])
929 853
930 #endif /* __XEN_PUBLIC_IO_DISPLIF_H__ */ 854 #endif /* __XEN_PUBLIC_IO_DISPLIF_H__ */
931 855
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.