2 * Copyright 2013 Red Hat Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
22 * Authors: Dave Airlie
26 /* QXL cmd/ring handling */
29 #include "qxl_object.h"
31 static int qxl_reap_surface_id(struct qxl_device *qdev, int max_to_reap);
34 struct qxl_ring_header header;
43 wait_queue_head_t *push_event;
47 void qxl_ring_free(struct qxl_ring *ring)
52 void qxl_ring_init_hdr(struct qxl_ring *ring)
54 ring->ring->header.notify_on_prod = ring->n_elements;
58 qxl_ring_create(struct qxl_ring_header *header,
63 wait_queue_head_t *push_event)
65 struct qxl_ring *ring;
67 ring = kmalloc(sizeof(*ring), GFP_KERNEL);
71 ring->ring = (struct ring *)header;
72 ring->element_size = element_size;
73 ring->n_elements = n_elements;
74 ring->prod_notify = prod_notify;
75 ring->push_event = push_event;
77 qxl_ring_init_hdr(ring);
78 spin_lock_init(&ring->lock);
82 static int qxl_check_header(struct qxl_ring *ring)
85 struct qxl_ring_header *header = &(ring->ring->header);
88 spin_lock_irqsave(&ring->lock, flags);
89 ret = header->prod - header->cons < header->num_items;
91 header->notify_on_cons = header->cons + 1;
92 spin_unlock_irqrestore(&ring->lock, flags);
96 int qxl_check_idle(struct qxl_ring *ring)
99 struct qxl_ring_header *header = &(ring->ring->header);
102 spin_lock_irqsave(&ring->lock, flags);
103 ret = header->prod == header->cons;
104 spin_unlock_irqrestore(&ring->lock, flags);
108 int qxl_ring_push(struct qxl_ring *ring,
109 const void *new_elt, bool interruptible)
111 struct qxl_ring_header *header = &(ring->ring->header);
116 spin_lock_irqsave(&ring->lock, flags);
117 if (header->prod - header->cons == header->num_items) {
118 header->notify_on_cons = header->cons + 1;
120 spin_unlock_irqrestore(&ring->lock, flags);
121 if (!drm_can_sleep()) {
122 while (!qxl_check_header(ring))
126 ret = wait_event_interruptible(*ring->push_event,
127 qxl_check_header(ring));
131 wait_event(*ring->push_event,
132 qxl_check_header(ring));
136 spin_lock_irqsave(&ring->lock, flags);
139 idx = header->prod & (ring->n_elements - 1);
140 elt = ring->ring->elements + idx * ring->element_size;
142 memcpy((void *)elt, new_elt, ring->element_size);
148 if (header->prod == header->notify_on_prod)
149 outb(0, ring->prod_notify);
151 spin_unlock_irqrestore(&ring->lock, flags);
155 static bool qxl_ring_pop(struct qxl_ring *ring,
158 volatile struct qxl_ring_header *header = &(ring->ring->header);
159 volatile uint8_t *ring_elt;
163 spin_lock_irqsave(&ring->lock, flags);
164 if (header->cons == header->prod) {
165 header->notify_on_prod = header->cons + 1;
166 spin_unlock_irqrestore(&ring->lock, flags);
170 idx = header->cons & (ring->n_elements - 1);
171 ring_elt = ring->ring->elements + idx * ring->element_size;
173 memcpy(element, (void *)ring_elt, ring->element_size);
177 spin_unlock_irqrestore(&ring->lock, flags);
182 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
183 uint32_t type, bool interruptible)
185 struct qxl_command cmd;
188 cmd.data = qxl_bo_physical_address(qdev, release->release_bo, release->release_offset);
190 return qxl_ring_push(qdev->command_ring, &cmd, interruptible);
194 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
195 uint32_t type, bool interruptible)
197 struct qxl_command cmd;
200 cmd.data = qxl_bo_physical_address(qdev, release->release_bo, release->release_offset);
202 return qxl_ring_push(qdev->cursor_ring, &cmd, interruptible);
205 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush)
207 if (!qxl_check_idle(qdev->release_ring)) {
208 schedule_work(&qdev->gc_work);
210 flush_work(&qdev->gc_work);
216 int qxl_garbage_collect(struct qxl_device *qdev)
218 struct qxl_release *release;
219 uint64_t id, next_id;
221 union qxl_release_info *info;
223 while (qxl_ring_pop(qdev->release_ring, &id)) {
224 DRM_DEBUG_DRIVER("popped %lld\n", id);
226 release = qxl_release_from_id_locked(qdev, id);
230 info = qxl_release_map(qdev, release);
231 next_id = info->next;
232 qxl_release_unmap(qdev, release, info);
234 DRM_DEBUG_DRIVER("popped %lld, next %lld\n", id,
237 switch (release->type) {
238 case QXL_RELEASE_DRAWABLE:
239 case QXL_RELEASE_SURFACE_CMD:
240 case QXL_RELEASE_CURSOR_CMD:
243 DRM_ERROR("unexpected release type\n");
248 qxl_release_free(qdev, release);
253 DRM_DEBUG_DRIVER("%d\n", i);
258 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
259 struct qxl_release *release,
266 ret = qxl_bo_create(qdev, size, false /* not kernel - device */,
267 false, QXL_GEM_DOMAIN_VRAM, NULL, &bo);
269 DRM_ERROR("failed to allocate VRAM BO\n");
272 ret = qxl_release_list_add(release, bo);
283 static int wait_for_io_cmd_user(struct qxl_device *qdev, uint8_t val, long port, bool intr)
286 long addr = qdev->io_base + port;
289 mutex_lock(&qdev->async_io_mutex);
290 irq_num = atomic_read(&qdev->irq_received_io_cmd);
291 if (qdev->last_sent_io_cmd > irq_num) {
293 ret = wait_event_interruptible_timeout(qdev->io_cmd_event,
294 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
296 ret = wait_event_timeout(qdev->io_cmd_event,
297 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
298 /* 0 is timeout, just bail the "hw" has gone away */
301 irq_num = atomic_read(&qdev->irq_received_io_cmd);
304 qdev->last_sent_io_cmd = irq_num + 1;
306 ret = wait_event_interruptible_timeout(qdev->io_cmd_event,
307 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
309 ret = wait_event_timeout(qdev->io_cmd_event,
310 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
314 mutex_unlock(&qdev->async_io_mutex);
318 static void wait_for_io_cmd(struct qxl_device *qdev, uint8_t val, long port)
323 ret = wait_for_io_cmd_user(qdev, val, port, false);
324 if (ret == -ERESTARTSYS)
328 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
329 const struct qxl_rect *area)
332 uint32_t surface_width, surface_height;
335 if (!surf->hw_surf_alloc)
336 DRM_ERROR("got io update area with no hw surface\n");
338 if (surf->is_primary)
341 surface_id = surf->surface_id;
342 surface_width = surf->surf.width;
343 surface_height = surf->surf.height;
345 if (area->left < 0 || area->top < 0 ||
346 area->right > surface_width || area->bottom > surface_height)
349 mutex_lock(&qdev->update_area_mutex);
350 qdev->ram_header->update_area = *area;
351 qdev->ram_header->update_surface = surface_id;
352 ret = wait_for_io_cmd_user(qdev, 0, QXL_IO_UPDATE_AREA_ASYNC, true);
353 mutex_unlock(&qdev->update_area_mutex);
357 void qxl_io_notify_oom(struct qxl_device *qdev)
359 outb(0, qdev->io_base + QXL_IO_NOTIFY_OOM);
362 void qxl_io_flush_release(struct qxl_device *qdev)
364 outb(0, qdev->io_base + QXL_IO_FLUSH_RELEASE);
367 void qxl_io_flush_surfaces(struct qxl_device *qdev)
369 wait_for_io_cmd(qdev, 0, QXL_IO_FLUSH_SURFACES_ASYNC);
372 void qxl_io_destroy_primary(struct qxl_device *qdev)
374 wait_for_io_cmd(qdev, 0, QXL_IO_DESTROY_PRIMARY_ASYNC);
375 qdev->primary_created = false;
378 void qxl_io_create_primary(struct qxl_device *qdev,
379 unsigned int offset, struct qxl_bo *bo)
381 struct qxl_surface_create *create;
383 DRM_DEBUG_DRIVER("qdev %p, ram_header %p\n", qdev, qdev->ram_header);
384 create = &qdev->ram_header->create_surface;
385 create->format = bo->surf.format;
386 create->width = bo->surf.width;
387 create->height = bo->surf.height;
388 create->stride = bo->surf.stride;
390 create->mem = qxl_bo_physical_address(qdev, bo->shadow, offset);
392 create->mem = qxl_bo_physical_address(qdev, bo, offset);
395 DRM_DEBUG_DRIVER("mem = %llx, from %p\n", create->mem, bo->kptr);
397 create->flags = QXL_SURF_FLAG_KEEP_DATA;
398 create->type = QXL_SURF_TYPE_PRIMARY;
400 wait_for_io_cmd(qdev, 0, QXL_IO_CREATE_PRIMARY_ASYNC);
401 qdev->primary_created = true;
404 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id)
406 DRM_DEBUG_DRIVER("qxl_memslot_add %d\n", id);
407 wait_for_io_cmd(qdev, id, QXL_IO_MEMSLOT_ADD_ASYNC);
410 void qxl_io_reset(struct qxl_device *qdev)
412 outb(0, qdev->io_base + QXL_IO_RESET);
415 void qxl_io_monitors_config(struct qxl_device *qdev)
417 wait_for_io_cmd(qdev, 0, QXL_IO_MONITORS_CONFIG_ASYNC);
420 int qxl_surface_id_alloc(struct qxl_device *qdev,
427 idr_preload(GFP_ATOMIC);
428 spin_lock(&qdev->surf_id_idr_lock);
429 idr_ret = idr_alloc(&qdev->surf_id_idr, NULL, 1, 0, GFP_NOWAIT);
430 spin_unlock(&qdev->surf_id_idr_lock);
436 if (handle >= qdev->rom->n_surfaces) {
438 spin_lock(&qdev->surf_id_idr_lock);
439 idr_remove(&qdev->surf_id_idr, handle);
440 spin_unlock(&qdev->surf_id_idr_lock);
441 qxl_reap_surface_id(qdev, 2);
444 surf->surface_id = handle;
446 spin_lock(&qdev->surf_id_idr_lock);
447 qdev->last_alloced_surf_id = handle;
448 spin_unlock(&qdev->surf_id_idr_lock);
452 void qxl_surface_id_dealloc(struct qxl_device *qdev,
455 spin_lock(&qdev->surf_id_idr_lock);
456 idr_remove(&qdev->surf_id_idr, surface_id);
457 spin_unlock(&qdev->surf_id_idr_lock);
460 int qxl_hw_surface_alloc(struct qxl_device *qdev,
462 struct ttm_mem_reg *new_mem)
464 struct qxl_surface_cmd *cmd;
465 struct qxl_release *release;
468 if (surf->hw_surf_alloc)
471 ret = qxl_alloc_surface_release_reserved(qdev, QXL_SURFACE_CMD_CREATE,
477 ret = qxl_release_reserve_list(release, true);
481 cmd = (struct qxl_surface_cmd *)qxl_release_map(qdev, release);
482 cmd->type = QXL_SURFACE_CMD_CREATE;
483 cmd->flags = QXL_SURF_FLAG_KEEP_DATA;
484 cmd->u.surface_create.format = surf->surf.format;
485 cmd->u.surface_create.width = surf->surf.width;
486 cmd->u.surface_create.height = surf->surf.height;
487 cmd->u.surface_create.stride = surf->surf.stride;
489 int slot_id = surf->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
490 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
492 /* TODO - need to hold one of the locks to read tbo.offset */
493 cmd->u.surface_create.data = slot->high_bits;
495 cmd->u.surface_create.data |= (new_mem->start << PAGE_SHIFT) + surf->tbo.bdev->man[new_mem->mem_type].gpu_offset;
497 cmd->u.surface_create.data = qxl_bo_physical_address(qdev, surf, 0);
498 cmd->surface_id = surf->surface_id;
499 qxl_release_unmap(qdev, release, &cmd->release_info);
501 surf->surf_create = release;
503 /* no need to add a release to the fence for this surface bo,
504 since it is only released when we ask to destroy the surface
505 and it would never signal otherwise */
506 qxl_push_command_ring_release(qdev, release, QXL_CMD_SURFACE, false);
507 qxl_release_fence_buffer_objects(release);
509 surf->hw_surf_alloc = true;
510 spin_lock(&qdev->surf_id_idr_lock);
511 idr_replace(&qdev->surf_id_idr, surf, surf->surface_id);
512 spin_unlock(&qdev->surf_id_idr_lock);
516 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
519 struct qxl_surface_cmd *cmd;
520 struct qxl_release *release;
524 if (!surf->hw_surf_alloc)
527 ret = qxl_alloc_surface_release_reserved(qdev, QXL_SURFACE_CMD_DESTROY,
533 surf->surf_create = NULL;
534 /* remove the surface from the idr, but not the surface id yet */
535 spin_lock(&qdev->surf_id_idr_lock);
536 idr_replace(&qdev->surf_id_idr, NULL, surf->surface_id);
537 spin_unlock(&qdev->surf_id_idr_lock);
538 surf->hw_surf_alloc = false;
540 id = surf->surface_id;
541 surf->surface_id = 0;
543 release->surface_release_id = id;
544 cmd = (struct qxl_surface_cmd *)qxl_release_map(qdev, release);
545 cmd->type = QXL_SURFACE_CMD_DESTROY;
546 cmd->surface_id = id;
547 qxl_release_unmap(qdev, release, &cmd->release_info);
549 qxl_push_command_ring_release(qdev, release, QXL_CMD_SURFACE, false);
551 qxl_release_fence_buffer_objects(release);
556 static int qxl_update_surface(struct qxl_device *qdev, struct qxl_bo *surf)
558 struct qxl_rect rect;
561 /* if we are evicting, we need to make sure the surface is up
564 rect.right = surf->surf.width;
566 rect.bottom = surf->surf.height;
568 ret = qxl_io_update_area(qdev, surf, &rect);
569 if (ret == -ERESTARTSYS)
574 static void qxl_surface_evict_locked(struct qxl_device *qdev, struct qxl_bo *surf, bool do_update_area)
576 /* no need to update area if we are just freeing the surface normally */
578 qxl_update_surface(qdev, surf);
580 /* nuke the surface id at the hw */
581 qxl_hw_surface_dealloc(qdev, surf);
584 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool do_update_area)
586 mutex_lock(&qdev->surf_evict_mutex);
587 qxl_surface_evict_locked(qdev, surf, do_update_area);
588 mutex_unlock(&qdev->surf_evict_mutex);
591 static int qxl_reap_surf(struct qxl_device *qdev, struct qxl_bo *surf, bool stall)
595 ret = qxl_bo_reserve(surf, false);
600 mutex_unlock(&qdev->surf_evict_mutex);
602 ret = ttm_bo_wait(&surf->tbo, true, !stall);
605 mutex_lock(&qdev->surf_evict_mutex);
607 qxl_bo_unreserve(surf);
611 qxl_surface_evict_locked(qdev, surf, true);
612 qxl_bo_unreserve(surf);
616 static int qxl_reap_surface_id(struct qxl_device *qdev, int max_to_reap)
623 mutex_lock(&qdev->surf_evict_mutex);
626 spin_lock(&qdev->surf_id_idr_lock);
627 start = qdev->last_alloced_surf_id + 1;
628 spin_unlock(&qdev->surf_id_idr_lock);
630 for (i = start; i < start + qdev->rom->n_surfaces; i++) {
632 int surfid = i % qdev->rom->n_surfaces;
634 /* this avoids the case where the objects is in the
635 idr but has been evicted half way - its makes
636 the idr lookup atomic with the eviction */
637 spin_lock(&qdev->surf_id_idr_lock);
638 objptr = idr_find(&qdev->surf_id_idr, surfid);
639 spin_unlock(&qdev->surf_id_idr_lock);
644 ret = qxl_reap_surf(qdev, objptr, stall);
647 if (num_reaped >= max_to_reap)
650 if (num_reaped == 0 && stall == false) {
655 mutex_unlock(&qdev->surf_evict_mutex);
657 usleep_range(500, 1000);
658 qxl_queue_garbage_collect(qdev, true);