xref: /openbmc/linux/drivers/gpu/drm/qxl/qxl_drv.h (revision 6774def6)
1 /*
2  * Copyright 2013 Red Hat Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: Dave Airlie
23  *          Alon Levy
24  */
25 
26 
27 #ifndef QXL_DRV_H
28 #define QXL_DRV_H
29 
30 /*
31  * Definitions taken from spice-protocol, plus kernel driver specific bits.
32  */
33 
34 #include <linux/fence.h>
35 #include <linux/workqueue.h>
36 #include <linux/firmware.h>
37 #include <linux/platform_device.h>
38 
39 #include "drmP.h"
40 #include "drm_crtc.h"
41 #include <ttm/ttm_bo_api.h>
42 #include <ttm/ttm_bo_driver.h>
43 #include <ttm/ttm_placement.h>
44 #include <ttm/ttm_module.h>
45 
46 #include <drm/drm_gem.h>
47 
48 /* just for ttm_validate_buffer */
49 #include <ttm/ttm_execbuf_util.h>
50 
51 #include <drm/qxl_drm.h>
52 #include "qxl_dev.h"
53 
54 #define DRIVER_AUTHOR		"Dave Airlie"
55 
56 #define DRIVER_NAME		"qxl"
57 #define DRIVER_DESC		"RH QXL"
58 #define DRIVER_DATE		"20120117"
59 
60 #define DRIVER_MAJOR 0
61 #define DRIVER_MINOR 1
62 #define DRIVER_PATCHLEVEL 0
63 
64 #define QXL_DEBUGFS_MAX_COMPONENTS		32
65 
66 extern int qxl_log_level;
67 extern int qxl_num_crtc;
68 
69 enum {
70 	QXL_INFO_LEVEL = 1,
71 	QXL_DEBUG_LEVEL = 2,
72 };
73 
74 #define QXL_INFO(qdev, fmt, ...) do { \
75 		if (qxl_log_level >= QXL_INFO_LEVEL) {	\
76 			qxl_io_log(qdev, fmt, __VA_ARGS__); \
77 		}	\
78 	} while (0)
79 #define QXL_DEBUG(qdev, fmt, ...) do { \
80 		if (qxl_log_level >= QXL_DEBUG_LEVEL) {	\
81 			qxl_io_log(qdev, fmt, __VA_ARGS__); \
82 		}	\
83 	} while (0)
84 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \
85 		static int done;		\
86 		if (!done) {			\
87 			done = 1;			\
88 			QXL_INFO(qdev, fmt, __VA_ARGS__);	\
89 		}						\
90 	} while (0)
91 
92 #define DRM_FILE_OFFSET 0x100000000ULL
93 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
94 
95 #define QXL_INTERRUPT_MASK (\
96 	QXL_INTERRUPT_DISPLAY |\
97 	QXL_INTERRUPT_CURSOR |\
98 	QXL_INTERRUPT_IO_CMD |\
99 	QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
100 
101 struct qxl_bo {
102 	/* Protected by gem.mutex */
103 	struct list_head		list;
104 	/* Protected by tbo.reserved */
105 	struct ttm_place		placements[3];
106 	struct ttm_placement		placement;
107 	struct ttm_buffer_object	tbo;
108 	struct ttm_bo_kmap_obj		kmap;
109 	unsigned			pin_count;
110 	void				*kptr;
111 	int                             type;
112 
113 	/* Constant after initialization */
114 	struct drm_gem_object		gem_base;
115 	bool is_primary; /* is this now a primary surface */
116 	bool hw_surf_alloc;
117 	struct qxl_surface surf;
118 	uint32_t surface_id;
119 	struct qxl_release *surf_create;
120 };
121 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
122 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
123 
124 struct qxl_gem {
125 	struct mutex		mutex;
126 	struct list_head	objects;
127 };
128 
129 struct qxl_bo_list {
130 	struct ttm_validate_buffer tv;
131 };
132 
133 struct qxl_crtc {
134 	struct drm_crtc base;
135 	int index;
136 	int cur_x;
137 	int cur_y;
138 };
139 
140 struct qxl_output {
141 	int index;
142 	struct drm_connector base;
143 	struct drm_encoder enc;
144 };
145 
146 struct qxl_framebuffer {
147 	struct drm_framebuffer base;
148 	struct drm_gem_object *obj;
149 };
150 
151 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
152 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
153 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
154 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
155 
156 struct qxl_mman {
157 	struct ttm_bo_global_ref        bo_global_ref;
158 	struct drm_global_reference	mem_global_ref;
159 	bool				mem_global_referenced;
160 	struct ttm_bo_device		bdev;
161 };
162 
163 struct qxl_mode_info {
164 	int num_modes;
165 	struct qxl_mode *modes;
166 	bool mode_config_initialized;
167 
168 	/* pointer to fbdev info structure */
169 	struct qxl_fbdev *qfbdev;
170 };
171 
172 
173 struct qxl_memslot {
174 	uint8_t		generation;
175 	uint64_t	start_phys_addr;
176 	uint64_t	end_phys_addr;
177 	uint64_t	high_bits;
178 };
179 
180 enum {
181 	QXL_RELEASE_DRAWABLE,
182 	QXL_RELEASE_SURFACE_CMD,
183 	QXL_RELEASE_CURSOR_CMD,
184 };
185 
186 /* drm_ prefix to differentiate from qxl_release_info in
187  * spice-protocol/qxl_dev.h */
188 #define QXL_MAX_RES 96
189 struct qxl_release {
190 	struct fence base;
191 
192 	int id;
193 	int type;
194 	uint32_t release_offset;
195 	uint32_t surface_release_id;
196 	struct ww_acquire_ctx ticket;
197 	struct list_head bos;
198 };
199 
200 struct qxl_drm_chunk {
201 	struct list_head head;
202 	struct qxl_bo *bo;
203 };
204 
205 struct qxl_drm_image {
206 	struct qxl_bo *bo;
207 	struct list_head chunk_list;
208 };
209 
210 struct qxl_fb_image {
211 	struct qxl_device *qdev;
212 	uint32_t pseudo_palette[16];
213 	struct fb_image fb_image;
214 	uint32_t visual;
215 };
216 
217 struct qxl_draw_fill {
218 	struct qxl_device *qdev;
219 	struct qxl_rect rect;
220 	uint32_t color;
221 	uint16_t rop;
222 };
223 
224 /*
225  * Debugfs
226  */
227 struct qxl_debugfs {
228 	struct drm_info_list	*files;
229 	unsigned		num_files;
230 };
231 
232 int qxl_debugfs_add_files(struct qxl_device *rdev,
233 			     struct drm_info_list *files,
234 			     unsigned nfiles);
235 int qxl_debugfs_fence_init(struct qxl_device *rdev);
236 void qxl_debugfs_remove_files(struct qxl_device *qdev);
237 
238 struct qxl_device;
239 
240 struct qxl_device {
241 	struct device			*dev;
242 	struct drm_device		*ddev;
243 	struct pci_dev			*pdev;
244 	unsigned long flags;
245 
246 	resource_size_t vram_base, vram_size;
247 	resource_size_t surfaceram_base, surfaceram_size;
248 	resource_size_t rom_base, rom_size;
249 	struct qxl_rom *rom;
250 
251 	struct qxl_mode *modes;
252 	struct qxl_bo *monitors_config_bo;
253 	struct qxl_monitors_config *monitors_config;
254 
255 	/* last received client_monitors_config */
256 	struct qxl_monitors_config *client_monitors_config;
257 
258 	int io_base;
259 	void *ram;
260 	struct qxl_mman		mman;
261 	struct qxl_gem		gem;
262 	struct qxl_mode_info mode_info;
263 
264 	struct fb_info			*fbdev_info;
265 	struct qxl_framebuffer	*fbdev_qfb;
266 	void *ram_physical;
267 
268 	struct qxl_ring *release_ring;
269 	struct qxl_ring *command_ring;
270 	struct qxl_ring *cursor_ring;
271 
272 	struct qxl_ram_header *ram_header;
273 
274 	bool primary_created;
275 
276 	struct qxl_memslot	*mem_slots;
277 	uint8_t		n_mem_slots;
278 
279 	uint8_t		main_mem_slot;
280 	uint8_t		surfaces_mem_slot;
281 	uint8_t		slot_id_bits;
282 	uint8_t		slot_gen_bits;
283 	uint64_t	va_slot_mask;
284 
285 	spinlock_t	release_lock;
286 	struct idr	release_idr;
287 	uint32_t	release_seqno;
288 	spinlock_t release_idr_lock;
289 	struct mutex	async_io_mutex;
290 	unsigned int last_sent_io_cmd;
291 
292 	/* interrupt handling */
293 	atomic_t irq_received;
294 	atomic_t irq_received_display;
295 	atomic_t irq_received_cursor;
296 	atomic_t irq_received_io_cmd;
297 	unsigned irq_received_error;
298 	wait_queue_head_t display_event;
299 	wait_queue_head_t cursor_event;
300 	wait_queue_head_t io_cmd_event;
301 	struct work_struct client_monitors_config_work;
302 
303 	/* debugfs */
304 	struct qxl_debugfs	debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
305 	unsigned		debugfs_count;
306 
307 	struct mutex		update_area_mutex;
308 
309 	struct idr	surf_id_idr;
310 	spinlock_t surf_id_idr_lock;
311 	int last_alloced_surf_id;
312 
313 	struct mutex surf_evict_mutex;
314 	struct io_mapping *vram_mapping;
315 	struct io_mapping *surface_mapping;
316 
317 	/* */
318 	struct mutex release_mutex;
319 	struct qxl_bo *current_release_bo[3];
320 	int current_release_bo_offset[3];
321 
322 	struct workqueue_struct *gc_queue;
323 	struct work_struct gc_work;
324 
325 	struct work_struct fb_work;
326 
327 	struct drm_property *hotplug_mode_update_property;
328 };
329 
330 /* forward declaration for QXL_INFO_IO */
331 void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...);
332 
333 extern const struct drm_ioctl_desc qxl_ioctls[];
334 extern int qxl_max_ioctl;
335 
336 int qxl_driver_load(struct drm_device *dev, unsigned long flags);
337 int qxl_driver_unload(struct drm_device *dev);
338 
339 int qxl_modeset_init(struct qxl_device *qdev);
340 void qxl_modeset_fini(struct qxl_device *qdev);
341 
342 int qxl_bo_init(struct qxl_device *qdev);
343 void qxl_bo_fini(struct qxl_device *qdev);
344 
345 void qxl_reinit_memslots(struct qxl_device *qdev);
346 int qxl_surf_evict(struct qxl_device *qdev);
347 int qxl_vram_evict(struct qxl_device *qdev);
348 
349 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
350 				 int element_size,
351 				 int n_elements,
352 				 int prod_notify,
353 				 bool set_prod_notify,
354 				 wait_queue_head_t *push_event);
355 void qxl_ring_free(struct qxl_ring *ring);
356 void qxl_ring_init_hdr(struct qxl_ring *ring);
357 int qxl_check_idle(struct qxl_ring *ring);
358 
359 static inline void *
360 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical)
361 {
362 	QXL_INFO(qdev, "not implemented (%lu)\n", physical);
363 	return 0;
364 }
365 
366 static inline uint64_t
367 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
368 			unsigned long offset)
369 {
370 	int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
371 	struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
372 
373 	/* TODO - need to hold one of the locks to read tbo.offset */
374 	return slot->high_bits | (bo->tbo.offset + offset);
375 }
376 
377 /* qxl_fb.c */
378 #define QXLFB_CONN_LIMIT 1
379 
380 int qxl_fbdev_init(struct qxl_device *qdev);
381 void qxl_fbdev_fini(struct qxl_device *qdev);
382 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
383 				  struct drm_file *file_priv,
384 				  uint32_t *handle);
385 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state);
386 
387 /* qxl_display.c */
388 int
389 qxl_framebuffer_init(struct drm_device *dev,
390 		     struct qxl_framebuffer *rfb,
391 		     struct drm_mode_fb_cmd2 *mode_cmd,
392 		     struct drm_gem_object *obj);
393 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
394 void qxl_send_monitors_config(struct qxl_device *qdev);
395 int qxl_create_monitors_object(struct qxl_device *qdev);
396 int qxl_destroy_monitors_object(struct qxl_device *qdev);
397 
398 /* used by qxl_debugfs only */
399 void qxl_crtc_set_from_monitors_config(struct qxl_device *qdev);
400 void qxl_alloc_client_monitors_config(struct qxl_device *qdev, unsigned count);
401 
402 /* qxl_gem.c */
403 int qxl_gem_init(struct qxl_device *qdev);
404 void qxl_gem_fini(struct qxl_device *qdev);
405 int qxl_gem_object_create(struct qxl_device *qdev, int size,
406 			  int alignment, int initial_domain,
407 			  bool discardable, bool kernel,
408 			  struct qxl_surface *surf,
409 			  struct drm_gem_object **obj);
410 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
411 				      struct drm_file *file_priv,
412 				      u32 domain,
413 				      size_t size,
414 				      struct qxl_surface *surf,
415 				      struct qxl_bo **qobj,
416 				      uint32_t *handle);
417 void qxl_gem_object_free(struct drm_gem_object *gobj);
418 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
419 void qxl_gem_object_close(struct drm_gem_object *obj,
420 			  struct drm_file *file_priv);
421 void qxl_bo_force_delete(struct qxl_device *qdev);
422 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
423 
424 /* qxl_dumb.c */
425 int qxl_mode_dumb_create(struct drm_file *file_priv,
426 			 struct drm_device *dev,
427 			 struct drm_mode_create_dumb *args);
428 int qxl_mode_dumb_mmap(struct drm_file *filp,
429 		       struct drm_device *dev,
430 		       uint32_t handle, uint64_t *offset_p);
431 
432 
433 /* qxl ttm */
434 int qxl_ttm_init(struct qxl_device *qdev);
435 void qxl_ttm_fini(struct qxl_device *qdev);
436 int qxl_mmap(struct file *filp, struct vm_area_struct *vma);
437 
438 /* qxl image */
439 
440 int qxl_image_init(struct qxl_device *qdev,
441 		   struct qxl_release *release,
442 		   struct qxl_drm_image *dimage,
443 		   const uint8_t *data,
444 		   int x, int y, int width, int height,
445 		   int depth, int stride);
446 int
447 qxl_image_alloc_objects(struct qxl_device *qdev,
448 			struct qxl_release *release,
449 			struct qxl_drm_image **image_ptr,
450 			int height, int stride);
451 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
452 
453 void qxl_update_screen(struct qxl_device *qxl);
454 
455 /* qxl io operations (qxl_cmd.c) */
456 
457 void qxl_io_create_primary(struct qxl_device *qdev,
458 			   unsigned offset,
459 			   struct qxl_bo *bo);
460 void qxl_io_destroy_primary(struct qxl_device *qdev);
461 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
462 void qxl_io_notify_oom(struct qxl_device *qdev);
463 
464 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
465 		       const struct qxl_rect *area);
466 
467 void qxl_io_reset(struct qxl_device *qdev);
468 void qxl_io_monitors_config(struct qxl_device *qdev);
469 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
470 void qxl_io_flush_release(struct qxl_device *qdev);
471 void qxl_io_flush_surfaces(struct qxl_device *qdev);
472 
473 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
474 					struct qxl_release *release);
475 void qxl_release_unmap(struct qxl_device *qdev,
476 		       struct qxl_release *release,
477 		       union qxl_release_info *info);
478 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
479 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
480 void qxl_release_backoff_reserve_list(struct qxl_release *release);
481 void qxl_release_fence_buffer_objects(struct qxl_release *release);
482 
483 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
484 				       enum qxl_surface_cmd_type surface_cmd_type,
485 				       struct qxl_release *create_rel,
486 				       struct qxl_release **release);
487 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
488 			       int type, struct qxl_release **release,
489 			       struct qxl_bo **rbo);
490 
491 int
492 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
493 			      uint32_t type, bool interruptible);
494 int
495 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
496 			     uint32_t type, bool interruptible);
497 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
498 			  struct qxl_release *release,
499 			  unsigned long size,
500 			  struct qxl_bo **_bo);
501 /* qxl drawing commands */
502 
503 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
504 			int stride /* filled in if 0 */);
505 
506 void qxl_draw_dirty_fb(struct qxl_device *qdev,
507 		       struct qxl_framebuffer *qxl_fb,
508 		       struct qxl_bo *bo,
509 		       unsigned flags, unsigned color,
510 		       struct drm_clip_rect *clips,
511 		       unsigned num_clips, int inc);
512 
513 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
514 
515 void qxl_draw_copyarea(struct qxl_device *qdev,
516 		       u32 width, u32 height,
517 		       u32 sx, u32 sy,
518 		       u32 dx, u32 dy);
519 
520 void qxl_release_free(struct qxl_device *qdev,
521 		      struct qxl_release *release);
522 
523 /* used by qxl_debugfs_release */
524 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
525 						   uint64_t id);
526 
527 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
528 int qxl_garbage_collect(struct qxl_device *qdev);
529 
530 /* debugfs */
531 
532 int qxl_debugfs_init(struct drm_minor *minor);
533 void qxl_debugfs_takedown(struct drm_minor *minor);
534 
535 /* qxl_prime.c */
536 int qxl_gem_prime_pin(struct drm_gem_object *obj);
537 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
538 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
539 struct drm_gem_object *qxl_gem_prime_import_sg_table(
540 	struct drm_device *dev, struct dma_buf_attachment *attach,
541 	struct sg_table *sgt);
542 void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
543 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
544 int qxl_gem_prime_mmap(struct drm_gem_object *obj,
545 				struct vm_area_struct *vma);
546 
547 /* qxl_irq.c */
548 int qxl_irq_init(struct qxl_device *qdev);
549 irqreturn_t qxl_irq_handler(int irq, void *arg);
550 
551 /* qxl_fb.c */
552 int qxl_fb_init(struct qxl_device *qdev);
553 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);
554 
555 int qxl_debugfs_add_files(struct qxl_device *qdev,
556 			  struct drm_info_list *files,
557 			  unsigned nfiles);
558 
559 int qxl_surface_id_alloc(struct qxl_device *qdev,
560 			 struct qxl_bo *surf);
561 void qxl_surface_id_dealloc(struct qxl_device *qdev,
562 			    uint32_t surface_id);
563 int qxl_hw_surface_alloc(struct qxl_device *qdev,
564 			 struct qxl_bo *surf,
565 			 struct ttm_mem_reg *mem);
566 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
567 			   struct qxl_bo *surf);
568 
569 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
570 
571 struct qxl_drv_surface *
572 qxl_surface_lookup(struct drm_device *dev, int surface_id);
573 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
574 int qxl_update_surface(struct qxl_device *qdev, struct qxl_bo *surf);
575 
576 #endif
577