xref: /openbmc/linux/drivers/gpu/drm/qxl/qxl_drv.h (revision 6aa7de05)
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/dma-fence.h>
35 #include <linux/workqueue.h>
36 #include <linux/firmware.h>
37 #include <linux/platform_device.h>
38 
39 #include <drm/drm_crtc.h>
40 #include <drm/drm_encoder.h>
41 #include <drm/drm_gem.h>
42 #include <drm/drmP.h>
43 #include <drm/ttm/ttm_bo_api.h>
44 #include <drm/ttm/ttm_bo_driver.h>
45 /* just for ttm_validate_buffer */
46 #include <drm/ttm/ttm_execbuf_util.h>
47 #include <drm/ttm/ttm_module.h>
48 #include <drm/ttm/ttm_placement.h>
49 #include <drm/qxl_drm.h>
50 
51 #include "qxl_dev.h"
52 
53 #define DRIVER_AUTHOR		"Dave Airlie"
54 
55 #define DRIVER_NAME		"qxl"
56 #define DRIVER_DESC		"RH QXL"
57 #define DRIVER_DATE		"20120117"
58 
59 #define DRIVER_MAJOR 0
60 #define DRIVER_MINOR 1
61 #define DRIVER_PATCHLEVEL 0
62 
63 #define QXL_DEBUGFS_MAX_COMPONENTS		32
64 
65 extern int qxl_log_level;
66 extern int qxl_num_crtc;
67 extern int qxl_max_ioctls;
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 };
137 
138 struct qxl_output {
139 	int index;
140 	struct drm_connector base;
141 	struct drm_encoder enc;
142 };
143 
144 struct qxl_framebuffer {
145 	struct drm_framebuffer base;
146 	struct drm_gem_object *obj;
147 };
148 
149 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
150 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
151 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
152 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
153 
154 struct qxl_mman {
155 	struct ttm_bo_global_ref        bo_global_ref;
156 	struct drm_global_reference	mem_global_ref;
157 	bool				mem_global_referenced;
158 	struct ttm_bo_device		bdev;
159 };
160 
161 struct qxl_mode_info {
162 	bool mode_config_initialized;
163 
164 	/* pointer to fbdev info structure */
165 	struct qxl_fbdev *qfbdev;
166 };
167 
168 
169 struct qxl_memslot {
170 	uint8_t		generation;
171 	uint64_t	start_phys_addr;
172 	uint64_t	end_phys_addr;
173 	uint64_t	high_bits;
174 };
175 
176 enum {
177 	QXL_RELEASE_DRAWABLE,
178 	QXL_RELEASE_SURFACE_CMD,
179 	QXL_RELEASE_CURSOR_CMD,
180 };
181 
182 /* drm_ prefix to differentiate from qxl_release_info in
183  * spice-protocol/qxl_dev.h */
184 #define QXL_MAX_RES 96
185 struct qxl_release {
186 	struct dma_fence base;
187 
188 	int id;
189 	int type;
190 	uint32_t release_offset;
191 	uint32_t surface_release_id;
192 	struct ww_acquire_ctx ticket;
193 	struct list_head bos;
194 };
195 
196 struct qxl_drm_chunk {
197 	struct list_head head;
198 	struct qxl_bo *bo;
199 };
200 
201 struct qxl_drm_image {
202 	struct qxl_bo *bo;
203 	struct list_head chunk_list;
204 };
205 
206 struct qxl_fb_image {
207 	struct qxl_device *qdev;
208 	uint32_t pseudo_palette[16];
209 	struct fb_image fb_image;
210 	uint32_t visual;
211 };
212 
213 struct qxl_draw_fill {
214 	struct qxl_device *qdev;
215 	struct qxl_rect rect;
216 	uint32_t color;
217 	uint16_t rop;
218 };
219 
220 /*
221  * Debugfs
222  */
223 struct qxl_debugfs {
224 	struct drm_info_list	*files;
225 	unsigned		num_files;
226 };
227 
228 int qxl_debugfs_add_files(struct qxl_device *rdev,
229 			     struct drm_info_list *files,
230 			     unsigned nfiles);
231 int qxl_debugfs_fence_init(struct qxl_device *rdev);
232 
233 struct qxl_device;
234 
235 struct qxl_device {
236 	struct drm_device ddev;
237 
238 	resource_size_t vram_base, vram_size;
239 	resource_size_t surfaceram_base, surfaceram_size;
240 	resource_size_t rom_base, rom_size;
241 	struct qxl_rom *rom;
242 
243 	struct qxl_mode *modes;
244 	struct qxl_bo *monitors_config_bo;
245 	struct qxl_monitors_config *monitors_config;
246 
247 	/* last received client_monitors_config */
248 	struct qxl_monitors_config *client_monitors_config;
249 
250 	int io_base;
251 	void *ram;
252 	struct qxl_mman		mman;
253 	struct qxl_gem		gem;
254 	struct qxl_mode_info mode_info;
255 
256 	struct fb_info			*fbdev_info;
257 	struct qxl_framebuffer	*fbdev_qfb;
258 	void *ram_physical;
259 
260 	struct qxl_ring *release_ring;
261 	struct qxl_ring *command_ring;
262 	struct qxl_ring *cursor_ring;
263 
264 	struct qxl_ram_header *ram_header;
265 
266 	bool primary_created;
267 
268 	struct qxl_memslot	*mem_slots;
269 	uint8_t		n_mem_slots;
270 
271 	uint8_t		main_mem_slot;
272 	uint8_t		surfaces_mem_slot;
273 	uint8_t		slot_id_bits;
274 	uint8_t		slot_gen_bits;
275 	uint64_t	va_slot_mask;
276 
277 	spinlock_t	release_lock;
278 	struct idr	release_idr;
279 	uint32_t	release_seqno;
280 	spinlock_t release_idr_lock;
281 	struct mutex	async_io_mutex;
282 	unsigned int last_sent_io_cmd;
283 
284 	/* interrupt handling */
285 	atomic_t irq_received;
286 	atomic_t irq_received_display;
287 	atomic_t irq_received_cursor;
288 	atomic_t irq_received_io_cmd;
289 	unsigned irq_received_error;
290 	wait_queue_head_t display_event;
291 	wait_queue_head_t cursor_event;
292 	wait_queue_head_t io_cmd_event;
293 	struct work_struct client_monitors_config_work;
294 
295 	/* debugfs */
296 	struct qxl_debugfs	debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
297 	unsigned		debugfs_count;
298 
299 	struct mutex		update_area_mutex;
300 
301 	struct idr	surf_id_idr;
302 	spinlock_t surf_id_idr_lock;
303 	int last_alloced_surf_id;
304 
305 	struct mutex surf_evict_mutex;
306 	struct io_mapping *vram_mapping;
307 	struct io_mapping *surface_mapping;
308 
309 	/* */
310 	struct mutex release_mutex;
311 	struct qxl_bo *current_release_bo[3];
312 	int current_release_bo_offset[3];
313 
314 	struct work_struct gc_work;
315 
316 	struct drm_property *hotplug_mode_update_property;
317 	int monitors_config_width;
318 	int monitors_config_height;
319 };
320 
321 /* forward declaration for QXL_INFO_IO */
322 __printf(2,3) void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...);
323 
324 extern const struct drm_ioctl_desc qxl_ioctls[];
325 extern int qxl_max_ioctl;
326 
327 int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv,
328 		    struct pci_dev *pdev);
329 void qxl_device_fini(struct qxl_device *qdev);
330 
331 int qxl_modeset_init(struct qxl_device *qdev);
332 void qxl_modeset_fini(struct qxl_device *qdev);
333 
334 int qxl_bo_init(struct qxl_device *qdev);
335 void qxl_bo_fini(struct qxl_device *qdev);
336 
337 void qxl_reinit_memslots(struct qxl_device *qdev);
338 int qxl_surf_evict(struct qxl_device *qdev);
339 int qxl_vram_evict(struct qxl_device *qdev);
340 
341 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
342 				 int element_size,
343 				 int n_elements,
344 				 int prod_notify,
345 				 bool set_prod_notify,
346 				 wait_queue_head_t *push_event);
347 void qxl_ring_free(struct qxl_ring *ring);
348 void qxl_ring_init_hdr(struct qxl_ring *ring);
349 int qxl_check_idle(struct qxl_ring *ring);
350 
351 static inline void *
352 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical)
353 {
354 	QXL_INFO(qdev, "not implemented (%lu)\n", physical);
355 	return 0;
356 }
357 
358 static inline uint64_t
359 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
360 			unsigned long offset)
361 {
362 	int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
363 	struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
364 
365 	/* TODO - need to hold one of the locks to read tbo.offset */
366 	return slot->high_bits | (bo->tbo.offset + offset);
367 }
368 
369 /* qxl_fb.c */
370 #define QXLFB_CONN_LIMIT 1
371 
372 int qxl_fbdev_init(struct qxl_device *qdev);
373 void qxl_fbdev_fini(struct qxl_device *qdev);
374 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
375 				  struct drm_file *file_priv,
376 				  uint32_t *handle);
377 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state);
378 
379 /* qxl_display.c */
380 void qxl_user_framebuffer_destroy(struct drm_framebuffer *fb);
381 int
382 qxl_framebuffer_init(struct drm_device *dev,
383 		     struct qxl_framebuffer *rfb,
384 		     const struct drm_mode_fb_cmd2 *mode_cmd,
385 		     struct drm_gem_object *obj,
386 		     const struct drm_framebuffer_funcs *funcs);
387 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
388 int qxl_create_monitors_object(struct qxl_device *qdev);
389 int qxl_destroy_monitors_object(struct qxl_device *qdev);
390 
391 /* qxl_gem.c */
392 void qxl_gem_init(struct qxl_device *qdev);
393 void qxl_gem_fini(struct qxl_device *qdev);
394 int qxl_gem_object_create(struct qxl_device *qdev, int size,
395 			  int alignment, int initial_domain,
396 			  bool discardable, bool kernel,
397 			  struct qxl_surface *surf,
398 			  struct drm_gem_object **obj);
399 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
400 				      struct drm_file *file_priv,
401 				      u32 domain,
402 				      size_t size,
403 				      struct qxl_surface *surf,
404 				      struct qxl_bo **qobj,
405 				      uint32_t *handle);
406 void qxl_gem_object_free(struct drm_gem_object *gobj);
407 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
408 void qxl_gem_object_close(struct drm_gem_object *obj,
409 			  struct drm_file *file_priv);
410 void qxl_bo_force_delete(struct qxl_device *qdev);
411 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
412 
413 /* qxl_dumb.c */
414 int qxl_mode_dumb_create(struct drm_file *file_priv,
415 			 struct drm_device *dev,
416 			 struct drm_mode_create_dumb *args);
417 int qxl_mode_dumb_mmap(struct drm_file *filp,
418 		       struct drm_device *dev,
419 		       uint32_t handle, uint64_t *offset_p);
420 
421 
422 /* qxl ttm */
423 int qxl_ttm_init(struct qxl_device *qdev);
424 void qxl_ttm_fini(struct qxl_device *qdev);
425 int qxl_mmap(struct file *filp, struct vm_area_struct *vma);
426 
427 /* qxl image */
428 
429 int qxl_image_init(struct qxl_device *qdev,
430 		   struct qxl_release *release,
431 		   struct qxl_drm_image *dimage,
432 		   const uint8_t *data,
433 		   int x, int y, int width, int height,
434 		   int depth, int stride);
435 int
436 qxl_image_alloc_objects(struct qxl_device *qdev,
437 			struct qxl_release *release,
438 			struct qxl_drm_image **image_ptr,
439 			int height, int stride);
440 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
441 
442 void qxl_update_screen(struct qxl_device *qxl);
443 
444 /* qxl io operations (qxl_cmd.c) */
445 
446 void qxl_io_create_primary(struct qxl_device *qdev,
447 			   unsigned offset,
448 			   struct qxl_bo *bo);
449 void qxl_io_destroy_primary(struct qxl_device *qdev);
450 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
451 void qxl_io_notify_oom(struct qxl_device *qdev);
452 
453 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
454 		       const struct qxl_rect *area);
455 
456 void qxl_io_reset(struct qxl_device *qdev);
457 void qxl_io_monitors_config(struct qxl_device *qdev);
458 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
459 void qxl_io_flush_release(struct qxl_device *qdev);
460 void qxl_io_flush_surfaces(struct qxl_device *qdev);
461 
462 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
463 					struct qxl_release *release);
464 void qxl_release_unmap(struct qxl_device *qdev,
465 		       struct qxl_release *release,
466 		       union qxl_release_info *info);
467 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
468 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
469 void qxl_release_backoff_reserve_list(struct qxl_release *release);
470 void qxl_release_fence_buffer_objects(struct qxl_release *release);
471 
472 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
473 				       enum qxl_surface_cmd_type surface_cmd_type,
474 				       struct qxl_release *create_rel,
475 				       struct qxl_release **release);
476 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
477 			       int type, struct qxl_release **release,
478 			       struct qxl_bo **rbo);
479 
480 int
481 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
482 			      uint32_t type, bool interruptible);
483 int
484 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
485 			     uint32_t type, bool interruptible);
486 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
487 			  struct qxl_release *release,
488 			  unsigned long size,
489 			  struct qxl_bo **_bo);
490 /* qxl drawing commands */
491 
492 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
493 			int stride /* filled in if 0 */);
494 
495 void qxl_draw_dirty_fb(struct qxl_device *qdev,
496 		       struct qxl_framebuffer *qxl_fb,
497 		       struct qxl_bo *bo,
498 		       unsigned flags, unsigned color,
499 		       struct drm_clip_rect *clips,
500 		       unsigned num_clips, int inc);
501 
502 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
503 
504 void qxl_draw_copyarea(struct qxl_device *qdev,
505 		       u32 width, u32 height,
506 		       u32 sx, u32 sy,
507 		       u32 dx, u32 dy);
508 
509 void qxl_release_free(struct qxl_device *qdev,
510 		      struct qxl_release *release);
511 
512 /* used by qxl_debugfs_release */
513 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
514 						   uint64_t id);
515 
516 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
517 int qxl_garbage_collect(struct qxl_device *qdev);
518 
519 /* debugfs */
520 
521 int qxl_debugfs_init(struct drm_minor *minor);
522 int qxl_ttm_debugfs_init(struct qxl_device *qdev);
523 
524 /* qxl_prime.c */
525 int qxl_gem_prime_pin(struct drm_gem_object *obj);
526 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
527 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
528 struct drm_gem_object *qxl_gem_prime_import_sg_table(
529 	struct drm_device *dev, struct dma_buf_attachment *attach,
530 	struct sg_table *sgt);
531 void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
532 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
533 int qxl_gem_prime_mmap(struct drm_gem_object *obj,
534 				struct vm_area_struct *vma);
535 
536 /* qxl_irq.c */
537 int qxl_irq_init(struct qxl_device *qdev);
538 irqreturn_t qxl_irq_handler(int irq, void *arg);
539 
540 /* qxl_fb.c */
541 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);
542 
543 int qxl_debugfs_add_files(struct qxl_device *qdev,
544 			  struct drm_info_list *files,
545 			  unsigned nfiles);
546 
547 int qxl_surface_id_alloc(struct qxl_device *qdev,
548 			 struct qxl_bo *surf);
549 void qxl_surface_id_dealloc(struct qxl_device *qdev,
550 			    uint32_t surface_id);
551 int qxl_hw_surface_alloc(struct qxl_device *qdev,
552 			 struct qxl_bo *surf,
553 			 struct ttm_mem_reg *mem);
554 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
555 			   struct qxl_bo *surf);
556 
557 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
558 
559 struct qxl_drv_surface *
560 qxl_surface_lookup(struct drm_device *dev, int surface_id);
561 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
562 
563 #endif
564