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