1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 
3 /*
4  *  Xen para-virtual DRM device
5  *
6  * Copyright (C) 2016-2018 EPAM Systems Inc.
7  *
8  * Author: Oleksandr Andrushchenko <oleksandr_andrushchenko@epam.com>
9  */
10 
11 #include <linux/delay.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/module.h>
14 #include <linux/of_device.h>
15 
16 #include <drm/drm_atomic_helper.h>
17 #include <drm/drm_drv.h>
18 #include <drm/drm_ioctl.h>
19 #include <drm/drm_probe_helper.h>
20 #include <drm/drm_file.h>
21 #include <drm/drm_gem.h>
22 
23 #include <xen/platform_pci.h>
24 #include <xen/xen.h>
25 #include <xen/xenbus.h>
26 
27 #include <xen/xen-front-pgdir-shbuf.h>
28 #include <xen/interface/io/displif.h>
29 
30 #include "xen_drm_front.h"
31 #include "xen_drm_front_cfg.h"
32 #include "xen_drm_front_evtchnl.h"
33 #include "xen_drm_front_gem.h"
34 #include "xen_drm_front_kms.h"
35 
36 struct xen_drm_front_dbuf {
37 	struct list_head list;
38 	u64 dbuf_cookie;
39 	u64 fb_cookie;
40 
41 	struct xen_front_pgdir_shbuf shbuf;
42 };
43 
44 static void dbuf_add_to_list(struct xen_drm_front_info *front_info,
45 			     struct xen_drm_front_dbuf *dbuf, u64 dbuf_cookie)
46 {
47 	dbuf->dbuf_cookie = dbuf_cookie;
48 	list_add(&dbuf->list, &front_info->dbuf_list);
49 }
50 
51 static struct xen_drm_front_dbuf *dbuf_get(struct list_head *dbuf_list,
52 					   u64 dbuf_cookie)
53 {
54 	struct xen_drm_front_dbuf *buf, *q;
55 
56 	list_for_each_entry_safe(buf, q, dbuf_list, list)
57 		if (buf->dbuf_cookie == dbuf_cookie)
58 			return buf;
59 
60 	return NULL;
61 }
62 
63 static void dbuf_free(struct list_head *dbuf_list, u64 dbuf_cookie)
64 {
65 	struct xen_drm_front_dbuf *buf, *q;
66 
67 	list_for_each_entry_safe(buf, q, dbuf_list, list)
68 		if (buf->dbuf_cookie == dbuf_cookie) {
69 			list_del(&buf->list);
70 			xen_front_pgdir_shbuf_unmap(&buf->shbuf);
71 			xen_front_pgdir_shbuf_free(&buf->shbuf);
72 			kfree(buf);
73 			break;
74 		}
75 }
76 
77 static void dbuf_free_all(struct list_head *dbuf_list)
78 {
79 	struct xen_drm_front_dbuf *buf, *q;
80 
81 	list_for_each_entry_safe(buf, q, dbuf_list, list) {
82 		list_del(&buf->list);
83 		xen_front_pgdir_shbuf_unmap(&buf->shbuf);
84 		xen_front_pgdir_shbuf_free(&buf->shbuf);
85 		kfree(buf);
86 	}
87 }
88 
89 static struct xendispl_req *
90 be_prepare_req(struct xen_drm_front_evtchnl *evtchnl, u8 operation)
91 {
92 	struct xendispl_req *req;
93 
94 	req = RING_GET_REQUEST(&evtchnl->u.req.ring,
95 			       evtchnl->u.req.ring.req_prod_pvt);
96 	req->operation = operation;
97 	req->id = evtchnl->evt_next_id++;
98 	evtchnl->evt_id = req->id;
99 	return req;
100 }
101 
102 static int be_stream_do_io(struct xen_drm_front_evtchnl *evtchnl,
103 			   struct xendispl_req *req)
104 {
105 	reinit_completion(&evtchnl->u.req.completion);
106 	if (unlikely(evtchnl->state != EVTCHNL_STATE_CONNECTED))
107 		return -EIO;
108 
109 	xen_drm_front_evtchnl_flush(evtchnl);
110 	return 0;
111 }
112 
113 static int be_stream_wait_io(struct xen_drm_front_evtchnl *evtchnl)
114 {
115 	if (wait_for_completion_timeout(&evtchnl->u.req.completion,
116 			msecs_to_jiffies(XEN_DRM_FRONT_WAIT_BACK_MS)) <= 0)
117 		return -ETIMEDOUT;
118 
119 	return evtchnl->u.req.resp_status;
120 }
121 
122 int xen_drm_front_mode_set(struct xen_drm_front_drm_pipeline *pipeline,
123 			   u32 x, u32 y, u32 width, u32 height,
124 			   u32 bpp, u64 fb_cookie)
125 {
126 	struct xen_drm_front_evtchnl *evtchnl;
127 	struct xen_drm_front_info *front_info;
128 	struct xendispl_req *req;
129 	unsigned long flags;
130 	int ret;
131 
132 	front_info = pipeline->drm_info->front_info;
133 	evtchnl = &front_info->evt_pairs[pipeline->index].req;
134 	if (unlikely(!evtchnl))
135 		return -EIO;
136 
137 	mutex_lock(&evtchnl->u.req.req_io_lock);
138 
139 	spin_lock_irqsave(&front_info->io_lock, flags);
140 	req = be_prepare_req(evtchnl, XENDISPL_OP_SET_CONFIG);
141 	req->op.set_config.x = x;
142 	req->op.set_config.y = y;
143 	req->op.set_config.width = width;
144 	req->op.set_config.height = height;
145 	req->op.set_config.bpp = bpp;
146 	req->op.set_config.fb_cookie = fb_cookie;
147 
148 	ret = be_stream_do_io(evtchnl, req);
149 	spin_unlock_irqrestore(&front_info->io_lock, flags);
150 
151 	if (ret == 0)
152 		ret = be_stream_wait_io(evtchnl);
153 
154 	mutex_unlock(&evtchnl->u.req.req_io_lock);
155 	return ret;
156 }
157 
158 int xen_drm_front_dbuf_create(struct xen_drm_front_info *front_info,
159 			      u64 dbuf_cookie, u32 width, u32 height,
160 			      u32 bpp, u64 size, struct page **pages)
161 {
162 	struct xen_drm_front_evtchnl *evtchnl;
163 	struct xen_drm_front_dbuf *dbuf;
164 	struct xendispl_req *req;
165 	struct xen_front_pgdir_shbuf_cfg buf_cfg;
166 	unsigned long flags;
167 	int ret;
168 
169 	evtchnl = &front_info->evt_pairs[GENERIC_OP_EVT_CHNL].req;
170 	if (unlikely(!evtchnl))
171 		return -EIO;
172 
173 	dbuf = kzalloc(sizeof(*dbuf), GFP_KERNEL);
174 	if (!dbuf)
175 		return -ENOMEM;
176 
177 	dbuf_add_to_list(front_info, dbuf, dbuf_cookie);
178 
179 	memset(&buf_cfg, 0, sizeof(buf_cfg));
180 	buf_cfg.xb_dev = front_info->xb_dev;
181 	buf_cfg.num_pages = DIV_ROUND_UP(size, PAGE_SIZE);
182 	buf_cfg.pages = pages;
183 	buf_cfg.pgdir = &dbuf->shbuf;
184 	buf_cfg.be_alloc = front_info->cfg.be_alloc;
185 
186 	ret = xen_front_pgdir_shbuf_alloc(&buf_cfg);
187 	if (ret < 0)
188 		goto fail_shbuf_alloc;
189 
190 	mutex_lock(&evtchnl->u.req.req_io_lock);
191 
192 	spin_lock_irqsave(&front_info->io_lock, flags);
193 	req = be_prepare_req(evtchnl, XENDISPL_OP_DBUF_CREATE);
194 	req->op.dbuf_create.gref_directory =
195 			xen_front_pgdir_shbuf_get_dir_start(&dbuf->shbuf);
196 	req->op.dbuf_create.buffer_sz = size;
197 	req->op.dbuf_create.dbuf_cookie = dbuf_cookie;
198 	req->op.dbuf_create.width = width;
199 	req->op.dbuf_create.height = height;
200 	req->op.dbuf_create.bpp = bpp;
201 	if (buf_cfg.be_alloc)
202 		req->op.dbuf_create.flags |= XENDISPL_DBUF_FLG_REQ_ALLOC;
203 
204 	ret = be_stream_do_io(evtchnl, req);
205 	spin_unlock_irqrestore(&front_info->io_lock, flags);
206 
207 	if (ret < 0)
208 		goto fail;
209 
210 	ret = be_stream_wait_io(evtchnl);
211 	if (ret < 0)
212 		goto fail;
213 
214 	ret = xen_front_pgdir_shbuf_map(&dbuf->shbuf);
215 	if (ret < 0)
216 		goto fail;
217 
218 	mutex_unlock(&evtchnl->u.req.req_io_lock);
219 	return 0;
220 
221 fail:
222 	mutex_unlock(&evtchnl->u.req.req_io_lock);
223 fail_shbuf_alloc:
224 	dbuf_free(&front_info->dbuf_list, dbuf_cookie);
225 	return ret;
226 }
227 
228 static int xen_drm_front_dbuf_destroy(struct xen_drm_front_info *front_info,
229 				      u64 dbuf_cookie)
230 {
231 	struct xen_drm_front_evtchnl *evtchnl;
232 	struct xendispl_req *req;
233 	unsigned long flags;
234 	bool be_alloc;
235 	int ret;
236 
237 	evtchnl = &front_info->evt_pairs[GENERIC_OP_EVT_CHNL].req;
238 	if (unlikely(!evtchnl))
239 		return -EIO;
240 
241 	be_alloc = front_info->cfg.be_alloc;
242 
243 	/*
244 	 * For the backend allocated buffer release references now, so backend
245 	 * can free the buffer.
246 	 */
247 	if (be_alloc)
248 		dbuf_free(&front_info->dbuf_list, dbuf_cookie);
249 
250 	mutex_lock(&evtchnl->u.req.req_io_lock);
251 
252 	spin_lock_irqsave(&front_info->io_lock, flags);
253 	req = be_prepare_req(evtchnl, XENDISPL_OP_DBUF_DESTROY);
254 	req->op.dbuf_destroy.dbuf_cookie = dbuf_cookie;
255 
256 	ret = be_stream_do_io(evtchnl, req);
257 	spin_unlock_irqrestore(&front_info->io_lock, flags);
258 
259 	if (ret == 0)
260 		ret = be_stream_wait_io(evtchnl);
261 
262 	/*
263 	 * Do this regardless of communication status with the backend:
264 	 * if we cannot remove remote resources remove what we can locally.
265 	 */
266 	if (!be_alloc)
267 		dbuf_free(&front_info->dbuf_list, dbuf_cookie);
268 
269 	mutex_unlock(&evtchnl->u.req.req_io_lock);
270 	return ret;
271 }
272 
273 int xen_drm_front_fb_attach(struct xen_drm_front_info *front_info,
274 			    u64 dbuf_cookie, u64 fb_cookie, u32 width,
275 			    u32 height, u32 pixel_format)
276 {
277 	struct xen_drm_front_evtchnl *evtchnl;
278 	struct xen_drm_front_dbuf *buf;
279 	struct xendispl_req *req;
280 	unsigned long flags;
281 	int ret;
282 
283 	evtchnl = &front_info->evt_pairs[GENERIC_OP_EVT_CHNL].req;
284 	if (unlikely(!evtchnl))
285 		return -EIO;
286 
287 	buf = dbuf_get(&front_info->dbuf_list, dbuf_cookie);
288 	if (!buf)
289 		return -EINVAL;
290 
291 	buf->fb_cookie = fb_cookie;
292 
293 	mutex_lock(&evtchnl->u.req.req_io_lock);
294 
295 	spin_lock_irqsave(&front_info->io_lock, flags);
296 	req = be_prepare_req(evtchnl, XENDISPL_OP_FB_ATTACH);
297 	req->op.fb_attach.dbuf_cookie = dbuf_cookie;
298 	req->op.fb_attach.fb_cookie = fb_cookie;
299 	req->op.fb_attach.width = width;
300 	req->op.fb_attach.height = height;
301 	req->op.fb_attach.pixel_format = pixel_format;
302 
303 	ret = be_stream_do_io(evtchnl, req);
304 	spin_unlock_irqrestore(&front_info->io_lock, flags);
305 
306 	if (ret == 0)
307 		ret = be_stream_wait_io(evtchnl);
308 
309 	mutex_unlock(&evtchnl->u.req.req_io_lock);
310 	return ret;
311 }
312 
313 int xen_drm_front_fb_detach(struct xen_drm_front_info *front_info,
314 			    u64 fb_cookie)
315 {
316 	struct xen_drm_front_evtchnl *evtchnl;
317 	struct xendispl_req *req;
318 	unsigned long flags;
319 	int ret;
320 
321 	evtchnl = &front_info->evt_pairs[GENERIC_OP_EVT_CHNL].req;
322 	if (unlikely(!evtchnl))
323 		return -EIO;
324 
325 	mutex_lock(&evtchnl->u.req.req_io_lock);
326 
327 	spin_lock_irqsave(&front_info->io_lock, flags);
328 	req = be_prepare_req(evtchnl, XENDISPL_OP_FB_DETACH);
329 	req->op.fb_detach.fb_cookie = fb_cookie;
330 
331 	ret = be_stream_do_io(evtchnl, req);
332 	spin_unlock_irqrestore(&front_info->io_lock, flags);
333 
334 	if (ret == 0)
335 		ret = be_stream_wait_io(evtchnl);
336 
337 	mutex_unlock(&evtchnl->u.req.req_io_lock);
338 	return ret;
339 }
340 
341 int xen_drm_front_page_flip(struct xen_drm_front_info *front_info,
342 			    int conn_idx, u64 fb_cookie)
343 {
344 	struct xen_drm_front_evtchnl *evtchnl;
345 	struct xendispl_req *req;
346 	unsigned long flags;
347 	int ret;
348 
349 	if (unlikely(conn_idx >= front_info->num_evt_pairs))
350 		return -EINVAL;
351 
352 	evtchnl = &front_info->evt_pairs[conn_idx].req;
353 
354 	mutex_lock(&evtchnl->u.req.req_io_lock);
355 
356 	spin_lock_irqsave(&front_info->io_lock, flags);
357 	req = be_prepare_req(evtchnl, XENDISPL_OP_PG_FLIP);
358 	req->op.pg_flip.fb_cookie = fb_cookie;
359 
360 	ret = be_stream_do_io(evtchnl, req);
361 	spin_unlock_irqrestore(&front_info->io_lock, flags);
362 
363 	if (ret == 0)
364 		ret = be_stream_wait_io(evtchnl);
365 
366 	mutex_unlock(&evtchnl->u.req.req_io_lock);
367 	return ret;
368 }
369 
370 void xen_drm_front_on_frame_done(struct xen_drm_front_info *front_info,
371 				 int conn_idx, u64 fb_cookie)
372 {
373 	struct xen_drm_front_drm_info *drm_info = front_info->drm_info;
374 
375 	if (unlikely(conn_idx >= front_info->cfg.num_connectors))
376 		return;
377 
378 	xen_drm_front_kms_on_frame_done(&drm_info->pipeline[conn_idx],
379 					fb_cookie);
380 }
381 
382 static int xen_drm_drv_dumb_create(struct drm_file *filp,
383 				   struct drm_device *dev,
384 				   struct drm_mode_create_dumb *args)
385 {
386 	struct xen_drm_front_drm_info *drm_info = dev->dev_private;
387 	struct drm_gem_object *obj;
388 	int ret;
389 
390 	/*
391 	 * Dumb creation is a two stage process: first we create a fully
392 	 * constructed GEM object which is communicated to the backend, and
393 	 * only after that we can create GEM's handle. This is done so,
394 	 * because of the possible races: once you create a handle it becomes
395 	 * immediately visible to user-space, so the latter can try accessing
396 	 * object without pages etc.
397 	 * For details also see drm_gem_handle_create
398 	 */
399 	args->pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
400 	args->size = args->pitch * args->height;
401 
402 	obj = xen_drm_front_gem_create(dev, args->size);
403 	if (IS_ERR_OR_NULL(obj)) {
404 		ret = PTR_ERR_OR_ZERO(obj);
405 		goto fail;
406 	}
407 
408 	ret = xen_drm_front_dbuf_create(drm_info->front_info,
409 					xen_drm_front_dbuf_to_cookie(obj),
410 					args->width, args->height, args->bpp,
411 					args->size,
412 					xen_drm_front_gem_get_pages(obj));
413 	if (ret)
414 		goto fail_backend;
415 
416 	/* This is the tail of GEM object creation */
417 	ret = drm_gem_handle_create(filp, obj, &args->handle);
418 	if (ret)
419 		goto fail_handle;
420 
421 	/* Drop reference from allocate - handle holds it now */
422 	drm_gem_object_put_unlocked(obj);
423 	return 0;
424 
425 fail_handle:
426 	xen_drm_front_dbuf_destroy(drm_info->front_info,
427 				   xen_drm_front_dbuf_to_cookie(obj));
428 fail_backend:
429 	/* drop reference from allocate */
430 	drm_gem_object_put_unlocked(obj);
431 fail:
432 	DRM_ERROR("Failed to create dumb buffer: %d\n", ret);
433 	return ret;
434 }
435 
436 static void xen_drm_drv_free_object_unlocked(struct drm_gem_object *obj)
437 {
438 	struct xen_drm_front_drm_info *drm_info = obj->dev->dev_private;
439 	int idx;
440 
441 	if (drm_dev_enter(obj->dev, &idx)) {
442 		xen_drm_front_dbuf_destroy(drm_info->front_info,
443 					   xen_drm_front_dbuf_to_cookie(obj));
444 		drm_dev_exit(idx);
445 	} else {
446 		dbuf_free(&drm_info->front_info->dbuf_list,
447 			  xen_drm_front_dbuf_to_cookie(obj));
448 	}
449 
450 	xen_drm_front_gem_free_object_unlocked(obj);
451 }
452 
453 static void xen_drm_drv_release(struct drm_device *dev)
454 {
455 	struct xen_drm_front_drm_info *drm_info = dev->dev_private;
456 	struct xen_drm_front_info *front_info = drm_info->front_info;
457 
458 	xen_drm_front_kms_fini(drm_info);
459 
460 	drm_atomic_helper_shutdown(dev);
461 	drm_mode_config_cleanup(dev);
462 
463 	if (front_info->cfg.be_alloc)
464 		xenbus_switch_state(front_info->xb_dev,
465 				    XenbusStateInitialising);
466 
467 	kfree(drm_info);
468 }
469 
470 static const struct file_operations xen_drm_dev_fops = {
471 	.owner          = THIS_MODULE,
472 	.open           = drm_open,
473 	.release        = drm_release,
474 	.unlocked_ioctl = drm_ioctl,
475 #ifdef CONFIG_COMPAT
476 	.compat_ioctl   = drm_compat_ioctl,
477 #endif
478 	.poll           = drm_poll,
479 	.read           = drm_read,
480 	.llseek         = no_llseek,
481 	.mmap           = xen_drm_front_gem_mmap,
482 };
483 
484 static const struct vm_operations_struct xen_drm_drv_vm_ops = {
485 	.open           = drm_gem_vm_open,
486 	.close          = drm_gem_vm_close,
487 };
488 
489 static struct drm_driver xen_drm_driver = {
490 	.driver_features           = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
491 	.release                   = xen_drm_drv_release,
492 	.gem_vm_ops                = &xen_drm_drv_vm_ops,
493 	.gem_free_object_unlocked  = xen_drm_drv_free_object_unlocked,
494 	.prime_handle_to_fd        = drm_gem_prime_handle_to_fd,
495 	.prime_fd_to_handle        = drm_gem_prime_fd_to_handle,
496 	.gem_prime_import_sg_table = xen_drm_front_gem_import_sg_table,
497 	.gem_prime_get_sg_table    = xen_drm_front_gem_get_sg_table,
498 	.gem_prime_vmap            = xen_drm_front_gem_prime_vmap,
499 	.gem_prime_vunmap          = xen_drm_front_gem_prime_vunmap,
500 	.gem_prime_mmap            = xen_drm_front_gem_prime_mmap,
501 	.dumb_create               = xen_drm_drv_dumb_create,
502 	.fops                      = &xen_drm_dev_fops,
503 	.name                      = "xendrm-du",
504 	.desc                      = "Xen PV DRM Display Unit",
505 	.date                      = "20180221",
506 	.major                     = 1,
507 	.minor                     = 0,
508 
509 };
510 
511 static int xen_drm_drv_init(struct xen_drm_front_info *front_info)
512 {
513 	struct device *dev = &front_info->xb_dev->dev;
514 	struct xen_drm_front_drm_info *drm_info;
515 	struct drm_device *drm_dev;
516 	int ret;
517 
518 	DRM_INFO("Creating %s\n", xen_drm_driver.desc);
519 
520 	drm_info = kzalloc(sizeof(*drm_info), GFP_KERNEL);
521 	if (!drm_info) {
522 		ret = -ENOMEM;
523 		goto fail;
524 	}
525 
526 	drm_info->front_info = front_info;
527 	front_info->drm_info = drm_info;
528 
529 	drm_dev = drm_dev_alloc(&xen_drm_driver, dev);
530 	if (IS_ERR(drm_dev)) {
531 		ret = PTR_ERR(drm_dev);
532 		goto fail;
533 	}
534 
535 	drm_info->drm_dev = drm_dev;
536 
537 	drm_dev->dev_private = drm_info;
538 
539 	ret = xen_drm_front_kms_init(drm_info);
540 	if (ret) {
541 		DRM_ERROR("Failed to initialize DRM/KMS, ret %d\n", ret);
542 		goto fail_modeset;
543 	}
544 
545 	ret = drm_dev_register(drm_dev, 0);
546 	if (ret)
547 		goto fail_register;
548 
549 	DRM_INFO("Initialized %s %d.%d.%d %s on minor %d\n",
550 		 xen_drm_driver.name, xen_drm_driver.major,
551 		 xen_drm_driver.minor, xen_drm_driver.patchlevel,
552 		 xen_drm_driver.date, drm_dev->primary->index);
553 
554 	return 0;
555 
556 fail_register:
557 	drm_dev_unregister(drm_dev);
558 fail_modeset:
559 	drm_kms_helper_poll_fini(drm_dev);
560 	drm_mode_config_cleanup(drm_dev);
561 	drm_dev_put(drm_dev);
562 fail:
563 	kfree(drm_info);
564 	return ret;
565 }
566 
567 static void xen_drm_drv_fini(struct xen_drm_front_info *front_info)
568 {
569 	struct xen_drm_front_drm_info *drm_info = front_info->drm_info;
570 	struct drm_device *dev;
571 
572 	if (!drm_info)
573 		return;
574 
575 	dev = drm_info->drm_dev;
576 	if (!dev)
577 		return;
578 
579 	/* Nothing to do if device is already unplugged */
580 	if (drm_dev_is_unplugged(dev))
581 		return;
582 
583 	drm_kms_helper_poll_fini(dev);
584 	drm_dev_unplug(dev);
585 	drm_dev_put(dev);
586 
587 	front_info->drm_info = NULL;
588 
589 	xen_drm_front_evtchnl_free_all(front_info);
590 	dbuf_free_all(&front_info->dbuf_list);
591 
592 	/*
593 	 * If we are not using backend allocated buffers, then tell the
594 	 * backend we are ready to (re)initialize. Otherwise, wait for
595 	 * drm_driver.release.
596 	 */
597 	if (!front_info->cfg.be_alloc)
598 		xenbus_switch_state(front_info->xb_dev,
599 				    XenbusStateInitialising);
600 }
601 
602 static int displback_initwait(struct xen_drm_front_info *front_info)
603 {
604 	struct xen_drm_front_cfg *cfg = &front_info->cfg;
605 	int ret;
606 
607 	cfg->front_info = front_info;
608 	ret = xen_drm_front_cfg_card(front_info, cfg);
609 	if (ret < 0)
610 		return ret;
611 
612 	DRM_INFO("Have %d connector(s)\n", cfg->num_connectors);
613 	/* Create event channels for all connectors and publish */
614 	ret = xen_drm_front_evtchnl_create_all(front_info);
615 	if (ret < 0)
616 		return ret;
617 
618 	return xen_drm_front_evtchnl_publish_all(front_info);
619 }
620 
621 static int displback_connect(struct xen_drm_front_info *front_info)
622 {
623 	xen_drm_front_evtchnl_set_state(front_info, EVTCHNL_STATE_CONNECTED);
624 	return xen_drm_drv_init(front_info);
625 }
626 
627 static void displback_disconnect(struct xen_drm_front_info *front_info)
628 {
629 	if (!front_info->drm_info)
630 		return;
631 
632 	/* Tell the backend to wait until we release the DRM driver. */
633 	xenbus_switch_state(front_info->xb_dev, XenbusStateReconfiguring);
634 
635 	xen_drm_drv_fini(front_info);
636 }
637 
638 static void displback_changed(struct xenbus_device *xb_dev,
639 			      enum xenbus_state backend_state)
640 {
641 	struct xen_drm_front_info *front_info = dev_get_drvdata(&xb_dev->dev);
642 	int ret;
643 
644 	DRM_DEBUG("Backend state is %s, front is %s\n",
645 		  xenbus_strstate(backend_state),
646 		  xenbus_strstate(xb_dev->state));
647 
648 	switch (backend_state) {
649 	case XenbusStateReconfiguring:
650 		/* fall through */
651 	case XenbusStateReconfigured:
652 		/* fall through */
653 	case XenbusStateInitialised:
654 		break;
655 
656 	case XenbusStateInitialising:
657 		if (xb_dev->state == XenbusStateReconfiguring)
658 			break;
659 
660 		/* recovering after backend unexpected closure */
661 		displback_disconnect(front_info);
662 		break;
663 
664 	case XenbusStateInitWait:
665 		if (xb_dev->state == XenbusStateReconfiguring)
666 			break;
667 
668 		/* recovering after backend unexpected closure */
669 		displback_disconnect(front_info);
670 		if (xb_dev->state != XenbusStateInitialising)
671 			break;
672 
673 		ret = displback_initwait(front_info);
674 		if (ret < 0)
675 			xenbus_dev_fatal(xb_dev, ret, "initializing frontend");
676 		else
677 			xenbus_switch_state(xb_dev, XenbusStateInitialised);
678 		break;
679 
680 	case XenbusStateConnected:
681 		if (xb_dev->state != XenbusStateInitialised)
682 			break;
683 
684 		ret = displback_connect(front_info);
685 		if (ret < 0) {
686 			displback_disconnect(front_info);
687 			xenbus_dev_fatal(xb_dev, ret, "connecting backend");
688 		} else {
689 			xenbus_switch_state(xb_dev, XenbusStateConnected);
690 		}
691 		break;
692 
693 	case XenbusStateClosing:
694 		/*
695 		 * in this state backend starts freeing resources,
696 		 * so let it go into closed state, so we can also
697 		 * remove ours
698 		 */
699 		break;
700 
701 	case XenbusStateUnknown:
702 		/* fall through */
703 	case XenbusStateClosed:
704 		if (xb_dev->state == XenbusStateClosed)
705 			break;
706 
707 		displback_disconnect(front_info);
708 		break;
709 	}
710 }
711 
712 static int xen_drv_probe(struct xenbus_device *xb_dev,
713 			 const struct xenbus_device_id *id)
714 {
715 	struct xen_drm_front_info *front_info;
716 	struct device *dev = &xb_dev->dev;
717 	int ret;
718 
719 	ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
720 	if (ret < 0) {
721 		DRM_ERROR("Cannot setup DMA mask, ret %d", ret);
722 		return ret;
723 	}
724 
725 	front_info = devm_kzalloc(&xb_dev->dev,
726 				  sizeof(*front_info), GFP_KERNEL);
727 	if (!front_info)
728 		return -ENOMEM;
729 
730 	front_info->xb_dev = xb_dev;
731 	spin_lock_init(&front_info->io_lock);
732 	INIT_LIST_HEAD(&front_info->dbuf_list);
733 	dev_set_drvdata(&xb_dev->dev, front_info);
734 
735 	return xenbus_switch_state(xb_dev, XenbusStateInitialising);
736 }
737 
738 static int xen_drv_remove(struct xenbus_device *dev)
739 {
740 	struct xen_drm_front_info *front_info = dev_get_drvdata(&dev->dev);
741 	int to = 100;
742 
743 	xenbus_switch_state(dev, XenbusStateClosing);
744 
745 	/*
746 	 * On driver removal it is disconnected from XenBus,
747 	 * so no backend state change events come via .otherend_changed
748 	 * callback. This prevents us from exiting gracefully, e.g.
749 	 * signaling the backend to free event channels, waiting for its
750 	 * state to change to XenbusStateClosed and cleaning at our end.
751 	 * Normally when front driver removed backend will finally go into
752 	 * XenbusStateInitWait state.
753 	 *
754 	 * Workaround: read backend's state manually and wait with time-out.
755 	 */
756 	while ((xenbus_read_unsigned(front_info->xb_dev->otherend, "state",
757 				     XenbusStateUnknown) != XenbusStateInitWait) &&
758 				     --to)
759 		msleep(10);
760 
761 	if (!to) {
762 		unsigned int state;
763 
764 		state = xenbus_read_unsigned(front_info->xb_dev->otherend,
765 					     "state", XenbusStateUnknown);
766 		DRM_ERROR("Backend state is %s while removing driver\n",
767 			  xenbus_strstate(state));
768 	}
769 
770 	xen_drm_drv_fini(front_info);
771 	xenbus_frontend_closed(dev);
772 	return 0;
773 }
774 
775 static const struct xenbus_device_id xen_driver_ids[] = {
776 	{ XENDISPL_DRIVER_NAME },
777 	{ "" }
778 };
779 
780 static struct xenbus_driver xen_driver = {
781 	.ids = xen_driver_ids,
782 	.probe = xen_drv_probe,
783 	.remove = xen_drv_remove,
784 	.otherend_changed = displback_changed,
785 };
786 
787 static int __init xen_drv_init(void)
788 {
789 	/* At the moment we only support case with XEN_PAGE_SIZE == PAGE_SIZE */
790 	if (XEN_PAGE_SIZE != PAGE_SIZE) {
791 		DRM_ERROR(XENDISPL_DRIVER_NAME ": different kernel and Xen page sizes are not supported: XEN_PAGE_SIZE (%lu) != PAGE_SIZE (%lu)\n",
792 			  XEN_PAGE_SIZE, PAGE_SIZE);
793 		return -ENODEV;
794 	}
795 
796 	if (!xen_domain())
797 		return -ENODEV;
798 
799 	if (!xen_has_pv_devices())
800 		return -ENODEV;
801 
802 	DRM_INFO("Registering XEN PV " XENDISPL_DRIVER_NAME "\n");
803 	return xenbus_register_frontend(&xen_driver);
804 }
805 
806 static void __exit xen_drv_fini(void)
807 {
808 	DRM_INFO("Unregistering XEN PV " XENDISPL_DRIVER_NAME "\n");
809 	xenbus_unregister_driver(&xen_driver);
810 }
811 
812 module_init(xen_drv_init);
813 module_exit(xen_drv_fini);
814 
815 MODULE_DESCRIPTION("Xen para-virtualized display device frontend");
816 MODULE_LICENSE("GPL");
817 MODULE_ALIAS("xen:" XENDISPL_DRIVER_NAME);
818