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);
87 spin_lock_irqsave(&ring->lock, flags);
88 ret = header->prod - header->cons < header->num_items;
90 header->notify_on_cons = header->cons + 1;
91 spin_unlock_irqrestore(&ring->lock, flags);
95 int qxl_check_idle(struct qxl_ring *ring)
98 struct qxl_ring_header *header = &(ring->ring->header);
100 spin_lock_irqsave(&ring->lock, flags);
101 ret = header->prod == header->cons;
102 spin_unlock_irqrestore(&ring->lock, flags);
106 int qxl_ring_push(struct qxl_ring *ring,
107 const void *new_elt, bool interruptible)
109 struct qxl_ring_header *header = &(ring->ring->header);
113 spin_lock_irqsave(&ring->lock, flags);
114 if (header->prod - header->cons == header->num_items) {
115 header->notify_on_cons = header->cons + 1;
117 spin_unlock_irqrestore(&ring->lock, flags);
118 if (!drm_can_sleep()) {
119 while (!qxl_check_header(ring))
123 ret = wait_event_interruptible(*ring->push_event,
124 qxl_check_header(ring));
128 wait_event(*ring->push_event,
129 qxl_check_header(ring));
133 spin_lock_irqsave(&ring->lock, flags);
136 idx = header->prod & (ring->n_elements - 1);
137 elt = ring->ring->elements + idx * ring->element_size;
139 memcpy((void *)elt, new_elt, ring->element_size);
145 if (header->prod == header->notify_on_prod)
146 outb(0, ring->prod_notify);
148 spin_unlock_irqrestore(&ring->lock, flags);
152 static bool qxl_ring_pop(struct qxl_ring *ring,
155 volatile struct qxl_ring_header *header = &(ring->ring->header);
156 volatile uint8_t *ring_elt;
159 spin_lock_irqsave(&ring->lock, flags);
160 if (header->cons == header->prod) {
161 header->notify_on_prod = header->cons + 1;
162 spin_unlock_irqrestore(&ring->lock, flags);
166 idx = header->cons & (ring->n_elements - 1);
167 ring_elt = ring->ring->elements + idx * ring->element_size;
169 memcpy(element, (void *)ring_elt, ring->element_size);
173 spin_unlock_irqrestore(&ring->lock, flags);
178 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
179 uint32_t type, bool interruptible)
181 struct qxl_command cmd;
184 cmd.data = qxl_bo_physical_address(qdev, release->release_bo, release->release_offset);
186 return qxl_ring_push(qdev->command_ring, &cmd, interruptible);
190 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
191 uint32_t type, bool interruptible)
193 struct qxl_command cmd;
196 cmd.data = qxl_bo_physical_address(qdev, release->release_bo, release->release_offset);
198 return qxl_ring_push(qdev->cursor_ring, &cmd, interruptible);
201 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush)
203 if (!qxl_check_idle(qdev->release_ring)) {
204 schedule_work(&qdev->gc_work);
206 flush_work(&qdev->gc_work);
212 int qxl_garbage_collect(struct qxl_device *qdev)
214 struct qxl_release *release;
215 uint64_t id, next_id;
217 union qxl_release_info *info;
219 while (qxl_ring_pop(qdev->release_ring, &id)) {
220 DRM_DEBUG_DRIVER("popped %lld\n", id);
222 release = qxl_release_from_id_locked(qdev, id);
226 info = qxl_release_map(qdev, release);
227 next_id = info->next;
228 qxl_release_unmap(qdev, release, info);
230 DRM_DEBUG_DRIVER("popped %lld, next %lld\n", id,
233 switch (release->type) {
234 case QXL_RELEASE_DRAWABLE:
235 case QXL_RELEASE_SURFACE_CMD:
236 case QXL_RELEASE_CURSOR_CMD:
239 DRM_ERROR("unexpected release type\n");
244 qxl_release_free(qdev, release);
249 DRM_DEBUG_DRIVER("%d\n", i);
254 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
255 struct qxl_release *release,
262 ret = qxl_bo_create(qdev, size, false /* not kernel - device */,
263 false, QXL_GEM_DOMAIN_VRAM, NULL, &bo);
265 DRM_ERROR("failed to allocate VRAM BO\n");
268 ret = qxl_release_list_add(release, bo);
279 static int wait_for_io_cmd_user(struct qxl_device *qdev, uint8_t val, long port, bool intr)
282 long addr = qdev->io_base + port;
285 mutex_lock(&qdev->async_io_mutex);
286 irq_num = atomic_read(&qdev->irq_received_io_cmd);
287 if (qdev->last_sent_io_cmd > irq_num) {
289 ret = wait_event_interruptible_timeout(qdev->io_cmd_event,
290 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
292 ret = wait_event_timeout(qdev->io_cmd_event,
293 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
294 /* 0 is timeout, just bail the "hw" has gone away */
297 irq_num = atomic_read(&qdev->irq_received_io_cmd);
300 qdev->last_sent_io_cmd = irq_num + 1;
302 ret = wait_event_interruptible_timeout(qdev->io_cmd_event,
303 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
305 ret = wait_event_timeout(qdev->io_cmd_event,
306 atomic_read(&qdev->irq_received_io_cmd) > irq_num, 5*HZ);
310 mutex_unlock(&qdev->async_io_mutex);
314 static void wait_for_io_cmd(struct qxl_device *qdev, uint8_t val, long port)
319 ret = wait_for_io_cmd_user(qdev, val, port, false);
320 if (ret == -ERESTARTSYS)
324 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
325 const struct qxl_rect *area)
328 uint32_t surface_width, surface_height;
331 if (!surf->hw_surf_alloc)
332 DRM_ERROR("got io update area with no hw surface\n");
334 if (surf->is_primary)
337 surface_id = surf->surface_id;
338 surface_width = surf->surf.width;
339 surface_height = surf->surf.height;
341 if (area->left < 0 || area->top < 0 ||
342 area->right > surface_width || area->bottom > surface_height)
345 mutex_lock(&qdev->update_area_mutex);
346 qdev->ram_header->update_area = *area;
347 qdev->ram_header->update_surface = surface_id;
348 ret = wait_for_io_cmd_user(qdev, 0, QXL_IO_UPDATE_AREA_ASYNC, true);
349 mutex_unlock(&qdev->update_area_mutex);
353 void qxl_io_notify_oom(struct qxl_device *qdev)
355 outb(0, qdev->io_base + QXL_IO_NOTIFY_OOM);
358 void qxl_io_flush_release(struct qxl_device *qdev)
360 outb(0, qdev->io_base + QXL_IO_FLUSH_RELEASE);
363 void qxl_io_flush_surfaces(struct qxl_device *qdev)
365 wait_for_io_cmd(qdev, 0, QXL_IO_FLUSH_SURFACES_ASYNC);
369 void qxl_io_destroy_primary(struct qxl_device *qdev)
371 wait_for_io_cmd(qdev, 0, QXL_IO_DESTROY_PRIMARY_ASYNC);
372 qdev->primary_created = false;
375 void qxl_io_create_primary(struct qxl_device *qdev,
376 unsigned offset, struct qxl_bo *bo)
378 struct qxl_surface_create *create;
380 DRM_DEBUG_DRIVER("qdev %p, ram_header %p\n", qdev, qdev->ram_header);
381 create = &qdev->ram_header->create_surface;
382 create->format = bo->surf.format;
383 create->width = bo->surf.width;
384 create->height = bo->surf.height;
385 create->stride = bo->surf.stride;
387 create->mem = qxl_bo_physical_address(qdev, bo->shadow, offset);
389 create->mem = qxl_bo_physical_address(qdev, bo, offset);
392 DRM_DEBUG_DRIVER("mem = %llx, from %p\n", create->mem, bo->kptr);
394 create->flags = QXL_SURF_FLAG_KEEP_DATA;
395 create->type = QXL_SURF_TYPE_PRIMARY;
397 wait_for_io_cmd(qdev, 0, QXL_IO_CREATE_PRIMARY_ASYNC);
398 qdev->primary_created = true;
401 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id)
403 DRM_DEBUG_DRIVER("qxl_memslot_add %d\n", id);
404 wait_for_io_cmd(qdev, id, QXL_IO_MEMSLOT_ADD_ASYNC);
407 void qxl_io_reset(struct qxl_device *qdev)
409 outb(0, qdev->io_base + QXL_IO_RESET);
412 void qxl_io_monitors_config(struct qxl_device *qdev)
414 wait_for_io_cmd(qdev, 0, QXL_IO_MONITORS_CONFIG_ASYNC);
417 int qxl_surface_id_alloc(struct qxl_device *qdev,
424 idr_preload(GFP_ATOMIC);
425 spin_lock(&qdev->surf_id_idr_lock);
426 idr_ret = idr_alloc(&qdev->surf_id_idr, NULL, 1, 0, GFP_NOWAIT);
427 spin_unlock(&qdev->surf_id_idr_lock);
433 if (handle >= qdev->rom->n_surfaces) {
435 spin_lock(&qdev->surf_id_idr_lock);
436 idr_remove(&qdev->surf_id_idr, handle);
437 spin_unlock(&qdev->surf_id_idr_lock);
438 qxl_reap_surface_id(qdev, 2);
441 surf->surface_id = handle;
443 spin_lock(&qdev->surf_id_idr_lock);
444 qdev->last_alloced_surf_id = handle;
445 spin_unlock(&qdev->surf_id_idr_lock);
449 void qxl_surface_id_dealloc(struct qxl_device *qdev,
452 spin_lock(&qdev->surf_id_idr_lock);
453 idr_remove(&qdev->surf_id_idr, surface_id);
454 spin_unlock(&qdev->surf_id_idr_lock);
457 int qxl_hw_surface_alloc(struct qxl_device *qdev,
459 struct ttm_mem_reg *new_mem)
461 struct qxl_surface_cmd *cmd;
462 struct qxl_release *release;
465 if (surf->hw_surf_alloc)
468 ret = qxl_alloc_surface_release_reserved(qdev, QXL_SURFACE_CMD_CREATE,
474 ret = qxl_release_reserve_list(release, true);
476 qxl_release_free(qdev, release);
479 cmd = (struct qxl_surface_cmd *)qxl_release_map(qdev, release);
480 cmd->type = QXL_SURFACE_CMD_CREATE;
481 cmd->flags = QXL_SURF_FLAG_KEEP_DATA;
482 cmd->u.surface_create.format = surf->surf.format;
483 cmd->u.surface_create.width = surf->surf.width;
484 cmd->u.surface_create.height = surf->surf.height;
485 cmd->u.surface_create.stride = surf->surf.stride;
487 int slot_id = surf->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
488 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
490 /* TODO - need to hold one of the locks to read tbo.offset */
491 cmd->u.surface_create.data = slot->high_bits;
493 cmd->u.surface_create.data |= (new_mem->start << PAGE_SHIFT) + surf->tbo.bdev->man[new_mem->mem_type].gpu_offset;
495 cmd->u.surface_create.data = qxl_bo_physical_address(qdev, surf, 0);
496 cmd->surface_id = surf->surface_id;
497 qxl_release_unmap(qdev, release, &cmd->release_info);
499 surf->surf_create = release;
501 /* no need to add a release to the fence for this surface bo,
502 since it is only released when we ask to destroy the surface
503 and it would never signal otherwise */
504 qxl_release_fence_buffer_objects(release);
505 qxl_push_command_ring_release(qdev, release, QXL_CMD_SURFACE, false);
507 surf->hw_surf_alloc = true;
508 spin_lock(&qdev->surf_id_idr_lock);
509 idr_replace(&qdev->surf_id_idr, surf, surf->surface_id);
510 spin_unlock(&qdev->surf_id_idr_lock);
514 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
517 struct qxl_surface_cmd *cmd;
518 struct qxl_release *release;
522 if (!surf->hw_surf_alloc)
525 ret = qxl_alloc_surface_release_reserved(qdev, QXL_SURFACE_CMD_DESTROY,
531 surf->surf_create = NULL;
532 /* remove the surface from the idr, but not the surface id yet */
533 spin_lock(&qdev->surf_id_idr_lock);
534 idr_replace(&qdev->surf_id_idr, NULL, surf->surface_id);
535 spin_unlock(&qdev->surf_id_idr_lock);
536 surf->hw_surf_alloc = false;
538 id = surf->surface_id;
539 surf->surface_id = 0;
541 release->surface_release_id = id;
542 cmd = (struct qxl_surface_cmd *)qxl_release_map(qdev, release);
543 cmd->type = QXL_SURFACE_CMD_DESTROY;
544 cmd->surface_id = id;
545 qxl_release_unmap(qdev, release, &cmd->release_info);
547 qxl_release_fence_buffer_objects(release);
548 qxl_push_command_ring_release(qdev, release, QXL_CMD_SURFACE, false);
553 static int qxl_update_surface(struct qxl_device *qdev, struct qxl_bo *surf)
555 struct qxl_rect rect;
558 /* if we are evicting, we need to make sure the surface is up
561 rect.right = surf->surf.width;
563 rect.bottom = surf->surf.height;
565 ret = qxl_io_update_area(qdev, surf, &rect);
566 if (ret == -ERESTARTSYS)
571 static void qxl_surface_evict_locked(struct qxl_device *qdev, struct qxl_bo *surf, bool do_update_area)
573 /* no need to update area if we are just freeing the surface normally */
575 qxl_update_surface(qdev, surf);
577 /* nuke the surface id at the hw */
578 qxl_hw_surface_dealloc(qdev, surf);
581 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool do_update_area)
583 mutex_lock(&qdev->surf_evict_mutex);
584 qxl_surface_evict_locked(qdev, surf, do_update_area);
585 mutex_unlock(&qdev->surf_evict_mutex);
588 static int qxl_reap_surf(struct qxl_device *qdev, struct qxl_bo *surf, bool stall)
592 ret = qxl_bo_reserve(surf, false);
597 mutex_unlock(&qdev->surf_evict_mutex);
599 ret = ttm_bo_wait(&surf->tbo, true, !stall);
602 mutex_lock(&qdev->surf_evict_mutex);
604 qxl_bo_unreserve(surf);
608 qxl_surface_evict_locked(qdev, surf, true);
609 qxl_bo_unreserve(surf);
613 static int qxl_reap_surface_id(struct qxl_device *qdev, int max_to_reap)
620 mutex_lock(&qdev->surf_evict_mutex);
623 spin_lock(&qdev->surf_id_idr_lock);
624 start = qdev->last_alloced_surf_id + 1;
625 spin_unlock(&qdev->surf_id_idr_lock);
627 for (i = start; i < start + qdev->rom->n_surfaces; i++) {
629 int surfid = i % qdev->rom->n_surfaces;
631 /* this avoids the case where the objects is in the
632 idr but has been evicted half way - its makes
633 the idr lookup atomic with the eviction */
634 spin_lock(&qdev->surf_id_idr_lock);
635 objptr = idr_find(&qdev->surf_id_idr, surfid);
636 spin_unlock(&qdev->surf_id_idr_lock);
641 ret = qxl_reap_surf(qdev, objptr, stall);
644 if (num_reaped >= max_to_reap)
647 if (num_reaped == 0 && stall == false) {
652 mutex_unlock(&qdev->surf_evict_mutex);
654 usleep_range(500, 1000);
655 qxl_queue_garbage_collect(qdev, true);