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