1 /* $NetBSD: qxl_drv.h,v 1.3 2021/12/18 23:45:42 riastradh Exp $ */
2
3 /*
4 * Copyright 2013 Red Hat Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is 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
19 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * Authors: Dave Airlie
25 * Alon Levy
26 */
27
28 #ifndef QXL_DRV_H
29 #define QXL_DRV_H
30
31 /*
32 * Definitions taken from spice-protocol, plus kernel driver specific bits.
33 */
34
35 #include <linux/dma-fence.h>
36 #include <linux/firmware.h>
37 #include <linux/platform_device.h>
38 #include <linux/workqueue.h>
39
40 #include <drm/drm_crtc.h>
41 #include <drm/drm_encoder.h>
42 #include <drm/drm_fb_helper.h>
43 #include <drm/drm_gem_ttm_helper.h>
44 #include <drm/drm_ioctl.h>
45 #include <drm/drm_gem.h>
46 #include <drm/qxl_drm.h>
47 #include <drm/ttm/ttm_bo_api.h>
48 #include <drm/ttm/ttm_bo_driver.h>
49 #include <drm/ttm/ttm_execbuf_util.h>
50 #include <drm/ttm/ttm_module.h>
51 #include <drm/ttm/ttm_placement.h>
52
53 #include "qxl_dev.h"
54
55 #define DRIVER_AUTHOR "Dave Airlie"
56
57 #define DRIVER_NAME "qxl"
58 #define DRIVER_DESC "RH QXL"
59 #define DRIVER_DATE "20120117"
60
61 #define DRIVER_MAJOR 0
62 #define DRIVER_MINOR 1
63 #define DRIVER_PATCHLEVEL 0
64
65 #define QXL_DEBUGFS_MAX_COMPONENTS 32
66
67 extern int qxl_num_crtc;
68 extern int qxl_max_ioctls;
69
70 #define QXL_INTERRUPT_MASK (\
71 QXL_INTERRUPT_DISPLAY |\
72 QXL_INTERRUPT_CURSOR |\
73 QXL_INTERRUPT_IO_CMD |\
74 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
75
76 struct qxl_bo {
77 struct ttm_buffer_object tbo;
78
79 /* Protected by gem.mutex */
80 struct list_head list;
81 /* Protected by tbo.reserved */
82 struct ttm_place placements[3];
83 struct ttm_placement placement;
84 struct ttm_bo_kmap_obj kmap;
85 unsigned int pin_count;
86 void *kptr;
87 unsigned int map_count;
88 int type;
89
90 /* Constant after initialization */
91 unsigned int is_primary:1; /* is this now a primary surface */
92 unsigned int is_dumb:1;
93 struct qxl_bo *shadow;
94 unsigned int hw_surf_alloc:1;
95 struct qxl_surface surf;
96 uint32_t surface_id;
97 struct qxl_release *surf_create;
98 };
99 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, tbo.base)
100 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
101
102 struct qxl_gem {
103 struct mutex mutex;
104 struct list_head objects;
105 };
106
107 struct qxl_bo_list {
108 struct ttm_validate_buffer tv;
109 };
110
111 struct qxl_crtc {
112 struct drm_crtc base;
113 int index;
114
115 struct qxl_bo *cursor_bo;
116 };
117
118 struct qxl_output {
119 int index;
120 struct drm_connector base;
121 struct drm_encoder enc;
122 };
123
124 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
125 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
126 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
127
128 struct qxl_mman {
129 struct ttm_bo_device bdev;
130 };
131
132 struct qxl_memslot {
133 int index;
134 const char *name;
135 uint8_t generation;
136 uint64_t start_phys_addr;
137 uint64_t size;
138 uint64_t high_bits;
139 uint64_t gpu_offset;
140 };
141
142 enum {
143 QXL_RELEASE_DRAWABLE,
144 QXL_RELEASE_SURFACE_CMD,
145 QXL_RELEASE_CURSOR_CMD,
146 };
147
148 /* drm_ prefix to differentiate from qxl_release_info in
149 * spice-protocol/qxl_dev.h */
150 #define QXL_MAX_RES 96
151 struct qxl_release {
152 struct dma_fence base;
153
154 int id;
155 int type;
156 struct qxl_bo *release_bo;
157 uint32_t release_offset;
158 uint32_t surface_release_id;
159 struct ww_acquire_ctx ticket;
160 struct list_head bos;
161 };
162
163 struct qxl_drm_chunk {
164 struct list_head head;
165 struct qxl_bo *bo;
166 };
167
168 struct qxl_drm_image {
169 struct qxl_bo *bo;
170 struct list_head chunk_list;
171 };
172
173 struct qxl_fb_image {
174 struct qxl_device *qdev;
175 uint32_t pseudo_palette[16];
176 struct fb_image fb_image;
177 uint32_t visual;
178 };
179
180 struct qxl_draw_fill {
181 struct qxl_device *qdev;
182 struct qxl_rect rect;
183 uint32_t color;
184 uint16_t rop;
185 };
186
187 /*
188 * Debugfs
189 */
190 struct qxl_debugfs {
191 struct drm_info_list *files;
192 unsigned int num_files;
193 };
194
195 int qxl_debugfs_add_files(struct qxl_device *rdev,
196 struct drm_info_list *files,
197 unsigned int nfiles);
198 int qxl_debugfs_fence_init(struct qxl_device *rdev);
199
200 struct qxl_device;
201
202 struct qxl_device {
203 struct drm_device ddev;
204
205 resource_size_t vram_base, vram_size;
206 resource_size_t surfaceram_base, surfaceram_size;
207 resource_size_t rom_base, rom_size;
208 struct qxl_rom *rom;
209
210 struct qxl_mode *modes;
211 struct qxl_bo *monitors_config_bo;
212 struct qxl_monitors_config *monitors_config;
213
214 /* last received client_monitors_config */
215 struct qxl_monitors_config *client_monitors_config;
216
217 int io_base;
218 void *ram;
219 struct qxl_mman mman;
220 struct qxl_gem gem;
221
222 void *ram_physical;
223
224 struct qxl_ring *release_ring;
225 struct qxl_ring *command_ring;
226 struct qxl_ring *cursor_ring;
227
228 struct qxl_ram_header *ram_header;
229
230 struct qxl_bo *primary_bo;
231 struct qxl_bo *dumb_shadow_bo;
232 struct qxl_head *dumb_heads;
233
234 struct qxl_memslot main_slot;
235 struct qxl_memslot surfaces_slot;
236
237 spinlock_t release_lock;
238 struct idr release_idr;
239 uint32_t release_seqno;
240 spinlock_t release_idr_lock;
241 struct mutex async_io_mutex;
242 unsigned int last_sent_io_cmd;
243
244 /* interrupt handling */
245 atomic_t irq_received;
246 atomic_t irq_received_display;
247 atomic_t irq_received_cursor;
248 atomic_t irq_received_io_cmd;
249 unsigned int irq_received_error;
250 wait_queue_head_t display_event;
251 wait_queue_head_t cursor_event;
252 wait_queue_head_t io_cmd_event;
253 struct work_struct client_monitors_config_work;
254
255 /* debugfs */
256 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
257 unsigned int debugfs_count;
258
259 struct mutex update_area_mutex;
260
261 struct idr surf_id_idr;
262 spinlock_t surf_id_idr_lock;
263 int last_alloced_surf_id;
264
265 struct mutex surf_evict_mutex;
266 struct io_mapping *vram_mapping;
267 struct io_mapping *surface_mapping;
268
269 /* */
270 struct mutex release_mutex;
271 struct qxl_bo *current_release_bo[3];
272 int current_release_bo_offset[3];
273
274 struct work_struct gc_work;
275
276 struct drm_property *hotplug_mode_update_property;
277 int monitors_config_width;
278 int monitors_config_height;
279 };
280
281 extern const struct drm_ioctl_desc qxl_ioctls[];
282 extern int qxl_max_ioctl;
283
284 int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv,
285 struct pci_dev *pdev);
286 void qxl_device_fini(struct qxl_device *qdev);
287
288 int qxl_modeset_init(struct qxl_device *qdev);
289 void qxl_modeset_fini(struct qxl_device *qdev);
290
291 int qxl_bo_init(struct qxl_device *qdev);
292 void qxl_bo_fini(struct qxl_device *qdev);
293
294 void qxl_reinit_memslots(struct qxl_device *qdev);
295 int qxl_surf_evict(struct qxl_device *qdev);
296 int qxl_vram_evict(struct qxl_device *qdev);
297
298 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
299 int element_size,
300 int n_elements,
301 int prod_notify,
302 bool set_prod_notify,
303 wait_queue_head_t *push_event);
304 void qxl_ring_free(struct qxl_ring *ring);
305 void qxl_ring_init_hdr(struct qxl_ring *ring);
306 int qxl_check_idle(struct qxl_ring *ring);
307
308 static inline uint64_t
qxl_bo_physical_address(struct qxl_device * qdev,struct qxl_bo * bo,unsigned long offset)309 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
310 unsigned long offset)
311 {
312 struct qxl_memslot *slot =
313 (bo->tbo.mem.mem_type == TTM_PL_VRAM)
314 ? &qdev->main_slot : &qdev->surfaces_slot;
315
316 WARN_ON_ONCE((bo->tbo.offset & slot->gpu_offset) != slot->gpu_offset);
317
318 /* TODO - need to hold one of the locks to read tbo.offset */
319 return slot->high_bits | (bo->tbo.offset - slot->gpu_offset + offset);
320 }
321
322 /* qxl_display.c */
323 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
324 int qxl_create_monitors_object(struct qxl_device *qdev);
325 int qxl_destroy_monitors_object(struct qxl_device *qdev);
326
327 /* qxl_gem.c */
328 void qxl_gem_init(struct qxl_device *qdev);
329 void qxl_gem_fini(struct qxl_device *qdev);
330 int qxl_gem_object_create(struct qxl_device *qdev, int size,
331 int alignment, int initial_domain,
332 bool discardable, bool kernel,
333 struct qxl_surface *surf,
334 struct drm_gem_object **obj);
335 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
336 struct drm_file *file_priv,
337 u32 domain,
338 size_t size,
339 struct qxl_surface *surf,
340 struct qxl_bo **qobj,
341 uint32_t *handle);
342 void qxl_gem_object_free(struct drm_gem_object *gobj);
343 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
344 void qxl_gem_object_close(struct drm_gem_object *obj,
345 struct drm_file *file_priv);
346 void qxl_bo_force_delete(struct qxl_device *qdev);
347 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
348
349 /* qxl_dumb.c */
350 int qxl_mode_dumb_create(struct drm_file *file_priv,
351 struct drm_device *dev,
352 struct drm_mode_create_dumb *args);
353 int qxl_mode_dumb_mmap(struct drm_file *filp,
354 struct drm_device *dev,
355 uint32_t handle, uint64_t *offset_p);
356
357 /* qxl ttm */
358 int qxl_ttm_init(struct qxl_device *qdev);
359 void qxl_ttm_fini(struct qxl_device *qdev);
360 int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev,
361 struct ttm_mem_reg *mem);
362
363 /* qxl image */
364
365 int qxl_image_init(struct qxl_device *qdev,
366 struct qxl_release *release,
367 struct qxl_drm_image *dimage,
368 const uint8_t *data,
369 int x, int y, int width, int height,
370 int depth, int stride);
371 int
372 qxl_image_alloc_objects(struct qxl_device *qdev,
373 struct qxl_release *release,
374 struct qxl_drm_image **image_ptr,
375 int height, int stride);
376 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
377
378 void qxl_update_screen(struct qxl_device *qxl);
379
380 /* qxl io operations (qxl_cmd.c) */
381
382 void qxl_io_create_primary(struct qxl_device *qdev,
383 struct qxl_bo *bo);
384 void qxl_io_destroy_primary(struct qxl_device *qdev);
385 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
386 void qxl_io_notify_oom(struct qxl_device *qdev);
387
388 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
389 const struct qxl_rect *area);
390
391 void qxl_io_reset(struct qxl_device *qdev);
392 void qxl_io_monitors_config(struct qxl_device *qdev);
393 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
394 void qxl_io_flush_release(struct qxl_device *qdev);
395 void qxl_io_flush_surfaces(struct qxl_device *qdev);
396
397 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
398 struct qxl_release *release);
399 void qxl_release_unmap(struct qxl_device *qdev,
400 struct qxl_release *release,
401 union qxl_release_info *info);
402 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
403 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
404 void qxl_release_backoff_reserve_list(struct qxl_release *release);
405 void qxl_release_fence_buffer_objects(struct qxl_release *release);
406
407 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
408 enum qxl_surface_cmd_type surface_cmd_type,
409 struct qxl_release *create_rel,
410 struct qxl_release **release);
411 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
412 int type, struct qxl_release **release,
413 struct qxl_bo **rbo);
414
415 int
416 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
417 uint32_t type, bool interruptible);
418 int
419 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
420 uint32_t type, bool interruptible);
421 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
422 struct qxl_release *release,
423 unsigned long size,
424 struct qxl_bo **_bo);
425 /* qxl drawing commands */
426
427 void qxl_draw_dirty_fb(struct qxl_device *qdev,
428 struct drm_framebuffer *fb,
429 struct qxl_bo *bo,
430 unsigned int flags, unsigned int color,
431 struct drm_clip_rect *clips,
432 unsigned int num_clips, int inc,
433 uint32_t dumb_shadow_offset);
434
435 void qxl_release_free(struct qxl_device *qdev,
436 struct qxl_release *release);
437
438 /* used by qxl_debugfs_release */
439 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
440 uint64_t id);
441
442 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
443 int qxl_garbage_collect(struct qxl_device *qdev);
444
445 /* debugfs */
446
447 int qxl_debugfs_init(struct drm_minor *minor);
448 int qxl_ttm_debugfs_init(struct qxl_device *qdev);
449
450 /* qxl_prime.c */
451 int qxl_gem_prime_pin(struct drm_gem_object *obj);
452 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
453 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
454 struct drm_gem_object *qxl_gem_prime_import_sg_table(
455 struct drm_device *dev, struct dma_buf_attachment *attach,
456 struct sg_table *sgt);
457 void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
458 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
459 int qxl_gem_prime_mmap(struct drm_gem_object *obj,
460 struct vm_area_struct *vma);
461
462 /* qxl_irq.c */
463 int qxl_irq_init(struct qxl_device *qdev);
464 irqreturn_t qxl_irq_handler(int irq, void *arg);
465
466 int qxl_debugfs_add_files(struct qxl_device *qdev,
467 struct drm_info_list *files,
468 unsigned int nfiles);
469
470 int qxl_surface_id_alloc(struct qxl_device *qdev,
471 struct qxl_bo *surf);
472 void qxl_surface_id_dealloc(struct qxl_device *qdev,
473 uint32_t surface_id);
474 int qxl_hw_surface_alloc(struct qxl_device *qdev,
475 struct qxl_bo *surf);
476 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
477 struct qxl_bo *surf);
478
479 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
480
481 struct qxl_drv_surface *
482 qxl_surface_lookup(struct drm_device *dev, int surface_id);
483 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);
484
485 #endif
486