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