1 /**************************************************************************
3 * Copyright © 2015 VMware, Inc., Palo Alto, CA., USA
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 * USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 #include "vmwgfx_drv.h"
29 #include "ttm/ttm_bo_api.h"
32 * Size of inline command buffers. Try to make sure that a page size is a
33 * multiple of the DMA pool allocation size.
35 #define VMW_CMDBUF_INLINE_ALIGN 64
36 #define VMW_CMDBUF_INLINE_SIZE \
37 (1024 - ALIGN(sizeof(SVGACBHeader), VMW_CMDBUF_INLINE_ALIGN))
40 * struct vmw_cmdbuf_context - Command buffer context queues
42 * @submitted: List of command buffers that have been submitted to the
43 * manager but not yet submitted to hardware.
44 * @hw_submitted: List of command buffers submitted to hardware.
45 * @preempted: List of preempted command buffers.
46 * @num_hw_submitted: Number of buffers currently being processed by hardware
48 struct vmw_cmdbuf_context {
49 struct list_head submitted;
50 struct list_head hw_submitted;
51 struct list_head preempted;
52 unsigned num_hw_submitted;
56 * struct vmw_cmdbuf_man: - Command buffer manager
58 * @cur_mutex: Mutex protecting the command buffer used for incremental small
59 * kernel command submissions, @cur.
60 * @space_mutex: Mutex to protect against starvation when we allocate
61 * main pool buffer space.
62 * @work: A struct work_struct implementeing command buffer error handling.
64 * @dev_priv: Pointer to the device private struct. Immutable.
65 * @ctx: Array of command buffer context queues. The queues and the context
66 * data is protected by @lock.
67 * @error: List of command buffers that have caused device errors.
69 * @mm: Range manager for the command buffer space. Manager allocations and
70 * frees are protected by @lock.
71 * @cmd_space: Buffer object for the command buffer space, unless we were
72 * able to make a contigous coherent DMA memory allocation, @handle. Immutable.
73 * @map_obj: Mapping state for @cmd_space. Immutable.
74 * @map: Pointer to command buffer space. May be a mapped buffer object or
75 * a contigous coherent DMA memory allocation. Immutable.
76 * @cur: Command buffer for small kernel command submissions. Protected by
78 * @cur_pos: Space already used in @cur. Protected by @cur_mutex.
79 * @default_size: Default size for the @cur command buffer. Immutable.
80 * @max_hw_submitted: Max number of in-flight command buffers the device can
82 * @lock: Spinlock protecting command submission queues.
83 * @header: Pool of DMA memory for device command buffer headers.
84 * Internal protection.
85 * @dheaders: Pool of DMA memory for device command buffer headers with trailing
86 * space for inline data. Internal protection.
87 * @tasklet: Tasklet struct for irq processing. Immutable.
88 * @alloc_queue: Wait queue for processes waiting to allocate command buffer
90 * @idle_queue: Wait queue for processes waiting for command buffer idle.
91 * @irq_on: Whether the process function has requested irq to be turned on.
93 * @using_mob: Whether the command buffer space is a MOB or a contigous DMA
94 * allocation. Immutable.
95 * @has_pool: Has a large pool of DMA memory which allows larger allocations.
96 * Typically this is false only during bootstrap.
97 * @handle: DMA address handle for the command buffer space if @using_mob is
99 * @size: The size of the command buffer space. Immutable.
101 struct vmw_cmdbuf_man {
102 struct mutex cur_mutex;
103 struct mutex space_mutex;
104 struct work_struct work;
105 struct vmw_private *dev_priv;
106 struct vmw_cmdbuf_context ctx[SVGA_CB_CONTEXT_MAX];
107 struct list_head error;
109 struct ttm_buffer_object *cmd_space;
110 struct ttm_bo_kmap_obj map_obj;
112 struct vmw_cmdbuf_header *cur;
115 unsigned max_hw_submitted;
117 struct dma_pool *headers;
118 struct dma_pool *dheaders;
119 struct tasklet_struct tasklet;
120 wait_queue_head_t alloc_queue;
121 wait_queue_head_t idle_queue;
130 * struct vmw_cmdbuf_header - Command buffer metadata
132 * @man: The command buffer manager.
133 * @cb_header: Device command buffer header, allocated from a DMA pool.
134 * @cb_context: The device command buffer context.
135 * @list: List head for attaching to the manager lists.
136 * @node: The range manager node.
137 * @handle. The DMA address of @cb_header. Handed to the device on command
139 * @cmd: Pointer to the command buffer space of this buffer.
140 * @size: Size of the command buffer space of this buffer.
141 * @reserved: Reserved space of this buffer.
142 * @inline_space: Whether inline command buffer space is used.
144 struct vmw_cmdbuf_header {
145 struct vmw_cmdbuf_man *man;
146 SVGACBHeader *cb_header;
147 SVGACBContext cb_context;
148 struct list_head list;
149 struct drm_mm_node node;
158 * struct vmw_cmdbuf_dheader - Device command buffer header with inline
159 * command buffer space.
161 * @cb_header: Device command buffer header.
162 * @cmd: Inline command buffer space.
164 struct vmw_cmdbuf_dheader {
165 SVGACBHeader cb_header;
166 u8 cmd[VMW_CMDBUF_INLINE_SIZE] __aligned(VMW_CMDBUF_INLINE_ALIGN);
170 * struct vmw_cmdbuf_alloc_info - Command buffer space allocation metadata
172 * @page_size: Size of requested command buffer space in pages.
173 * @node: Pointer to the range manager node.
174 * @done: True if this allocation has succeeded.
176 struct vmw_cmdbuf_alloc_info {
178 struct drm_mm_node *node;
182 /* Loop over each context in the command buffer manager. */
183 #define for_each_cmdbuf_ctx(_man, _i, _ctx) \
184 for (_i = 0, _ctx = &(_man)->ctx[0]; (_i) < SVGA_CB_CONTEXT_MAX; \
187 static int vmw_cmdbuf_startstop(struct vmw_cmdbuf_man *man, bool enable);
191 * vmw_cmdbuf_cur_lock - Helper to lock the cur_mutex.
193 * @man: The range manager.
194 * @interruptible: Whether to wait interruptible when locking.
196 static int vmw_cmdbuf_cur_lock(struct vmw_cmdbuf_man *man, bool interruptible)
199 if (mutex_lock_interruptible(&man->cur_mutex))
202 mutex_lock(&man->cur_mutex);
209 * vmw_cmdbuf_cur_unlock - Helper to unlock the cur_mutex.
211 * @man: The range manager.
213 static void vmw_cmdbuf_cur_unlock(struct vmw_cmdbuf_man *man)
215 mutex_unlock(&man->cur_mutex);
219 * vmw_cmdbuf_header_inline_free - Free a struct vmw_cmdbuf_header that has
220 * been used for the device context with inline command buffers.
221 * Need not be called locked.
223 * @header: Pointer to the header to free.
225 static void vmw_cmdbuf_header_inline_free(struct vmw_cmdbuf_header *header)
227 struct vmw_cmdbuf_dheader *dheader;
229 if (WARN_ON_ONCE(!header->inline_space))
232 dheader = container_of(header->cb_header, struct vmw_cmdbuf_dheader,
234 dma_pool_free(header->man->dheaders, dheader, header->handle);
239 * __vmw_cmdbuf_header_free - Free a struct vmw_cmdbuf_header and its
240 * associated structures.
242 * header: Pointer to the header to free.
244 * For internal use. Must be called with man::lock held.
246 static void __vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header)
248 struct vmw_cmdbuf_man *man = header->man;
250 BUG_ON(!spin_is_locked(&man->lock));
252 if (header->inline_space) {
253 vmw_cmdbuf_header_inline_free(header);
257 drm_mm_remove_node(&header->node);
258 wake_up_all(&man->alloc_queue);
259 if (header->cb_header)
260 dma_pool_free(man->headers, header->cb_header,
266 * vmw_cmdbuf_header_free - Free a struct vmw_cmdbuf_header and its
267 * associated structures.
269 * @header: Pointer to the header to free.
271 void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header)
273 struct vmw_cmdbuf_man *man = header->man;
275 /* Avoid locking if inline_space */
276 if (header->inline_space) {
277 vmw_cmdbuf_header_inline_free(header);
280 spin_lock_bh(&man->lock);
281 __vmw_cmdbuf_header_free(header);
282 spin_unlock_bh(&man->lock);
287 * vmw_cmbuf_header_submit: Submit a command buffer to hardware.
289 * @header: The header of the buffer to submit.
291 static int vmw_cmdbuf_header_submit(struct vmw_cmdbuf_header *header)
293 struct vmw_cmdbuf_man *man = header->man;
296 if (sizeof(header->handle) > 4)
297 val = (header->handle >> 32);
300 vmw_write(man->dev_priv, SVGA_REG_COMMAND_HIGH, val);
302 val = (header->handle & 0xFFFFFFFFULL);
303 val |= header->cb_context & SVGA_CB_CONTEXT_MASK;
304 vmw_write(man->dev_priv, SVGA_REG_COMMAND_LOW, val);
306 return header->cb_header->status;
310 * vmw_cmdbuf_ctx_init: Initialize a command buffer context.
312 * @ctx: The command buffer context to initialize
314 static void vmw_cmdbuf_ctx_init(struct vmw_cmdbuf_context *ctx)
316 INIT_LIST_HEAD(&ctx->hw_submitted);
317 INIT_LIST_HEAD(&ctx->submitted);
318 INIT_LIST_HEAD(&ctx->preempted);
319 ctx->num_hw_submitted = 0;
323 * vmw_cmdbuf_ctx_submit: Submit command buffers from a command buffer
326 * @man: The command buffer manager.
327 * @ctx: The command buffer context.
329 * Submits command buffers to hardware until there are no more command
330 * buffers to submit or the hardware can't handle more command buffers.
332 static void vmw_cmdbuf_ctx_submit(struct vmw_cmdbuf_man *man,
333 struct vmw_cmdbuf_context *ctx)
335 while (ctx->num_hw_submitted < man->max_hw_submitted &&
336 !list_empty(&ctx->submitted)) {
337 struct vmw_cmdbuf_header *entry;
340 entry = list_first_entry(&ctx->submitted,
341 struct vmw_cmdbuf_header,
344 status = vmw_cmdbuf_header_submit(entry);
346 /* This should never happen */
347 if (WARN_ON_ONCE(status == SVGA_CB_STATUS_QUEUE_FULL)) {
348 entry->cb_header->status = SVGA_CB_STATUS_NONE;
352 list_del(&entry->list);
353 list_add_tail(&entry->list, &ctx->hw_submitted);
354 ctx->num_hw_submitted++;
360 * vmw_cmdbuf_ctx_submit: Process a command buffer context.
362 * @man: The command buffer manager.
363 * @ctx: The command buffer context.
365 * Submit command buffers to hardware if possible, and process finished
366 * buffers. Typically freeing them, but on preemption or error take
367 * appropriate action. Wake up waiters if appropriate.
369 static void vmw_cmdbuf_ctx_process(struct vmw_cmdbuf_man *man,
370 struct vmw_cmdbuf_context *ctx,
373 struct vmw_cmdbuf_header *entry, *next;
375 vmw_cmdbuf_ctx_submit(man, ctx);
377 list_for_each_entry_safe(entry, next, &ctx->hw_submitted, list) {
378 SVGACBStatus status = entry->cb_header->status;
380 if (status == SVGA_CB_STATUS_NONE)
383 list_del(&entry->list);
384 wake_up_all(&man->idle_queue);
385 ctx->num_hw_submitted--;
387 case SVGA_CB_STATUS_COMPLETED:
388 __vmw_cmdbuf_header_free(entry);
390 case SVGA_CB_STATUS_COMMAND_ERROR:
391 case SVGA_CB_STATUS_CB_HEADER_ERROR:
392 list_add_tail(&entry->list, &man->error);
393 schedule_work(&man->work);
395 case SVGA_CB_STATUS_PREEMPTED:
396 list_add(&entry->list, &ctx->preempted);
399 WARN_ONCE(true, "Undefined command buffer status.\n");
400 __vmw_cmdbuf_header_free(entry);
405 vmw_cmdbuf_ctx_submit(man, ctx);
406 if (!list_empty(&ctx->submitted))
411 * vmw_cmdbuf_man_process - Process all command buffer contexts and
412 * switch on and off irqs as appropriate.
414 * @man: The command buffer manager.
416 * Calls vmw_cmdbuf_ctx_process() on all contexts. If any context has
417 * command buffers left that are not submitted to hardware, Make sure
418 * IRQ handling is turned on. Otherwise, make sure it's turned off. This
419 * function may return -EAGAIN to indicate it should be rerun due to
420 * possibly missed IRQs if IRQs has just been turned on.
422 static int vmw_cmdbuf_man_process(struct vmw_cmdbuf_man *man)
425 struct vmw_cmdbuf_context *ctx;
428 for_each_cmdbuf_ctx(man, i, ctx)
429 vmw_cmdbuf_ctx_process(man, ctx, ¬empty);
431 if (man->irq_on && !notempty) {
432 vmw_generic_waiter_remove(man->dev_priv,
433 SVGA_IRQFLAG_COMMAND_BUFFER,
434 &man->dev_priv->cmdbuf_waiters);
436 } else if (!man->irq_on && notempty) {
437 vmw_generic_waiter_add(man->dev_priv,
438 SVGA_IRQFLAG_COMMAND_BUFFER,
439 &man->dev_priv->cmdbuf_waiters);
442 /* Rerun in case we just missed an irq. */
450 * vmw_cmdbuf_ctx_add - Schedule a command buffer for submission on a
451 * command buffer context
453 * @man: The command buffer manager.
454 * @header: The header of the buffer to submit.
455 * @cb_context: The command buffer context to use.
457 * This function adds @header to the "submitted" queue of the command
458 * buffer context identified by @cb_context. It then calls the command buffer
459 * manager processing to potentially submit the buffer to hardware.
460 * @man->lock needs to be held when calling this function.
462 static void vmw_cmdbuf_ctx_add(struct vmw_cmdbuf_man *man,
463 struct vmw_cmdbuf_header *header,
464 SVGACBContext cb_context)
466 if (!(header->cb_header->flags & SVGA_CB_FLAG_DX_CONTEXT))
467 header->cb_header->dxContext = 0;
468 header->cb_context = cb_context;
469 list_add_tail(&header->list, &man->ctx[cb_context].submitted);
471 if (vmw_cmdbuf_man_process(man) == -EAGAIN)
472 vmw_cmdbuf_man_process(man);
476 * vmw_cmdbuf_man_tasklet - The main part of the command buffer interrupt
477 * handler implemented as a tasklet.
479 * @data: Tasklet closure. A pointer to the command buffer manager cast to
482 * The bottom half (tasklet) of the interrupt handler simply calls into the
483 * command buffer processor to free finished buffers and submit any
484 * queued buffers to hardware.
486 static void vmw_cmdbuf_man_tasklet(unsigned long data)
488 struct vmw_cmdbuf_man *man = (struct vmw_cmdbuf_man *) data;
490 spin_lock(&man->lock);
491 if (vmw_cmdbuf_man_process(man) == -EAGAIN)
492 (void) vmw_cmdbuf_man_process(man);
493 spin_unlock(&man->lock);
497 * vmw_cmdbuf_work_func - The deferred work function that handles
498 * command buffer errors.
500 * @work: The work func closure argument.
502 * Restarting the command buffer context after an error requires process
503 * context, so it is deferred to this work function.
505 static void vmw_cmdbuf_work_func(struct work_struct *work)
507 struct vmw_cmdbuf_man *man =
508 container_of(work, struct vmw_cmdbuf_man, work);
509 struct vmw_cmdbuf_header *entry, *next;
510 bool restart = false;
512 spin_lock_bh(&man->lock);
513 list_for_each_entry_safe(entry, next, &man->error, list) {
515 DRM_ERROR("Command buffer error.\n");
517 list_del(&entry->list);
518 __vmw_cmdbuf_header_free(entry);
519 wake_up_all(&man->idle_queue);
521 spin_unlock_bh(&man->lock);
523 if (restart && vmw_cmdbuf_startstop(man, true))
524 DRM_ERROR("Failed restarting command buffer context 0.\n");
529 * vmw_cmdbuf_man idle - Check whether the command buffer manager is idle.
531 * @man: The command buffer manager.
532 * @check_preempted: Check also the preempted queue for pending command buffers.
535 static bool vmw_cmdbuf_man_idle(struct vmw_cmdbuf_man *man,
536 bool check_preempted)
538 struct vmw_cmdbuf_context *ctx;
542 spin_lock_bh(&man->lock);
543 vmw_cmdbuf_man_process(man);
544 for_each_cmdbuf_ctx(man, i, ctx) {
545 if (!list_empty(&ctx->submitted) ||
546 !list_empty(&ctx->hw_submitted) ||
547 (check_preempted && !list_empty(&ctx->preempted)))
551 idle = list_empty(&man->error);
554 spin_unlock_bh(&man->lock);
560 * __vmw_cmdbuf_cur_flush - Flush the current command buffer for small kernel
561 * command submissions
563 * @man: The command buffer manager.
565 * Flushes the current command buffer without allocating a new one. A new one
566 * is automatically allocated when needed. Call with @man->cur_mutex held.
568 static void __vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man)
570 struct vmw_cmdbuf_header *cur = man->cur;
572 WARN_ON(!mutex_is_locked(&man->cur_mutex));
577 spin_lock_bh(&man->lock);
578 if (man->cur_pos == 0) {
579 __vmw_cmdbuf_header_free(cur);
583 man->cur->cb_header->length = man->cur_pos;
584 vmw_cmdbuf_ctx_add(man, man->cur, SVGA_CB_CONTEXT_0);
586 spin_unlock_bh(&man->lock);
592 * vmw_cmdbuf_cur_flush - Flush the current command buffer for small kernel
593 * command submissions
595 * @man: The command buffer manager.
596 * @interruptible: Whether to sleep interruptible when sleeping.
598 * Flushes the current command buffer without allocating a new one. A new one
599 * is automatically allocated when needed.
601 int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
604 int ret = vmw_cmdbuf_cur_lock(man, interruptible);
609 __vmw_cmdbuf_cur_flush(man);
610 vmw_cmdbuf_cur_unlock(man);
616 * vmw_cmdbuf_idle - Wait for command buffer manager idle.
618 * @man: The command buffer manager.
619 * @interruptible: Sleep interruptible while waiting.
620 * @timeout: Time out after this many ticks.
622 * Wait until the command buffer manager has processed all command buffers,
623 * or until a timeout occurs. If a timeout occurs, the function will return
626 int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
627 unsigned long timeout)
631 ret = vmw_cmdbuf_cur_flush(man, interruptible);
632 vmw_generic_waiter_add(man->dev_priv,
633 SVGA_IRQFLAG_COMMAND_BUFFER,
634 &man->dev_priv->cmdbuf_waiters);
637 ret = wait_event_interruptible_timeout
638 (man->idle_queue, vmw_cmdbuf_man_idle(man, true),
641 ret = wait_event_timeout
642 (man->idle_queue, vmw_cmdbuf_man_idle(man, true),
645 vmw_generic_waiter_remove(man->dev_priv,
646 SVGA_IRQFLAG_COMMAND_BUFFER,
647 &man->dev_priv->cmdbuf_waiters);
649 if (!vmw_cmdbuf_man_idle(man, true))
661 * vmw_cmdbuf_try_alloc - Try to allocate buffer space from the main pool.
663 * @man: The command buffer manager.
664 * @info: Allocation info. Will hold the size on entry and allocated mm node
665 * on successful return.
667 * Try to allocate buffer space from the main pool. Returns true if succeeded.
668 * If a fatal error was hit, the error code is returned in @info->ret.
670 static bool vmw_cmdbuf_try_alloc(struct vmw_cmdbuf_man *man,
671 struct vmw_cmdbuf_alloc_info *info)
678 memset(info->node, 0, sizeof(*info->node));
679 spin_lock_bh(&man->lock);
680 ret = drm_mm_insert_node_generic(&man->mm, info->node, info->page_size,
682 DRM_MM_SEARCH_DEFAULT,
683 DRM_MM_CREATE_DEFAULT);
685 (void) vmw_cmdbuf_man_process(man);
686 ret = drm_mm_insert_node_generic(&man->mm, info->node,
687 info->page_size, 0, 0,
688 DRM_MM_SEARCH_DEFAULT,
689 DRM_MM_CREATE_DEFAULT);
692 spin_unlock_bh(&man->lock);
699 * vmw_cmdbuf_alloc_space - Allocate buffer space from the main pool.
701 * @man: The command buffer manager.
702 * @node: Pointer to pre-allocated range-manager node.
703 * @size: The size of the allocation.
704 * @interruptible: Whether to sleep interruptible while waiting for space.
706 * This function allocates buffer space from the main pool, and if there is
707 * no space available ATM, it turns on IRQ handling and sleeps waiting for it to
710 static int vmw_cmdbuf_alloc_space(struct vmw_cmdbuf_man *man,
711 struct drm_mm_node *node,
715 struct vmw_cmdbuf_alloc_info info;
717 info.page_size = PAGE_ALIGN(size) >> PAGE_SHIFT;
722 * To prevent starvation of large requests, only one allocating call
723 * at a time waiting for space.
726 if (mutex_lock_interruptible(&man->space_mutex))
729 mutex_lock(&man->space_mutex);
732 /* Try to allocate space without waiting. */
733 if (vmw_cmdbuf_try_alloc(man, &info))
736 vmw_generic_waiter_add(man->dev_priv,
737 SVGA_IRQFLAG_COMMAND_BUFFER,
738 &man->dev_priv->cmdbuf_waiters);
743 ret = wait_event_interruptible
744 (man->alloc_queue, vmw_cmdbuf_try_alloc(man, &info));
746 vmw_generic_waiter_remove
747 (man->dev_priv, SVGA_IRQFLAG_COMMAND_BUFFER,
748 &man->dev_priv->cmdbuf_waiters);
749 mutex_unlock(&man->space_mutex);
753 wait_event(man->alloc_queue, vmw_cmdbuf_try_alloc(man, &info));
755 vmw_generic_waiter_remove(man->dev_priv,
756 SVGA_IRQFLAG_COMMAND_BUFFER,
757 &man->dev_priv->cmdbuf_waiters);
760 mutex_unlock(&man->space_mutex);
766 * vmw_cmdbuf_space_pool - Set up a command buffer header with command buffer
767 * space from the main pool.
769 * @man: The command buffer manager.
770 * @header: Pointer to the header to set up.
771 * @size: The requested size of the buffer space.
772 * @interruptible: Whether to sleep interruptible while waiting for space.
774 static int vmw_cmdbuf_space_pool(struct vmw_cmdbuf_man *man,
775 struct vmw_cmdbuf_header *header,
779 SVGACBHeader *cb_hdr;
786 ret = vmw_cmdbuf_alloc_space(man, &header->node, size, interruptible);
791 header->cb_header = dma_pool_alloc(man->headers, GFP_KERNEL,
793 if (!header->cb_header) {
795 goto out_no_cb_header;
798 header->size = header->node.size << PAGE_SHIFT;
799 cb_hdr = header->cb_header;
800 offset = header->node.start << PAGE_SHIFT;
801 header->cmd = man->map + offset;
802 memset(cb_hdr, 0, sizeof(*cb_hdr));
803 if (man->using_mob) {
804 cb_hdr->flags = SVGA_CB_FLAG_MOB;
805 cb_hdr->ptr.mob.mobid = man->cmd_space->mem.start;
806 cb_hdr->ptr.mob.mobOffset = offset;
808 cb_hdr->ptr.pa = (u64)man->handle + (u64)offset;
814 spin_lock_bh(&man->lock);
815 drm_mm_remove_node(&header->node);
816 spin_unlock_bh(&man->lock);
822 * vmw_cmdbuf_space_inline - Set up a command buffer header with
823 * inline command buffer space.
825 * @man: The command buffer manager.
826 * @header: Pointer to the header to set up.
827 * @size: The requested size of the buffer space.
829 static int vmw_cmdbuf_space_inline(struct vmw_cmdbuf_man *man,
830 struct vmw_cmdbuf_header *header,
833 struct vmw_cmdbuf_dheader *dheader;
834 SVGACBHeader *cb_hdr;
836 if (WARN_ON_ONCE(size > VMW_CMDBUF_INLINE_SIZE))
839 dheader = dma_pool_alloc(man->dheaders, GFP_KERNEL,
844 header->inline_space = true;
845 header->size = VMW_CMDBUF_INLINE_SIZE;
846 cb_hdr = &dheader->cb_header;
847 header->cb_header = cb_hdr;
848 header->cmd = dheader->cmd;
849 memset(dheader, 0, sizeof(*dheader));
850 cb_hdr->status = SVGA_CB_STATUS_NONE;
851 cb_hdr->flags = SVGA_CB_FLAG_NONE;
852 cb_hdr->ptr.pa = (u64)header->handle +
853 (u64)offsetof(struct vmw_cmdbuf_dheader, cmd);
859 * vmw_cmdbuf_alloc - Allocate a command buffer header complete with
860 * command buffer space.
862 * @man: The command buffer manager.
863 * @size: The requested size of the buffer space.
864 * @interruptible: Whether to sleep interruptible while waiting for space.
865 * @p_header: points to a header pointer to populate on successful return.
867 * Returns a pointer to command buffer space if successful. Otherwise
868 * returns an error pointer. The header pointer returned in @p_header should
869 * be used for upcoming calls to vmw_cmdbuf_reserve() and vmw_cmdbuf_commit().
871 void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
872 size_t size, bool interruptible,
873 struct vmw_cmdbuf_header **p_header)
875 struct vmw_cmdbuf_header *header;
880 header = kzalloc(sizeof(*header), GFP_KERNEL);
882 return ERR_PTR(-ENOMEM);
884 if (size <= VMW_CMDBUF_INLINE_SIZE)
885 ret = vmw_cmdbuf_space_inline(man, header, size);
887 ret = vmw_cmdbuf_space_pool(man, header, size, interruptible);
895 INIT_LIST_HEAD(&header->list);
896 header->cb_header->status = SVGA_CB_STATUS_NONE;
903 * vmw_cmdbuf_reserve_cur - Reserve space for commands in the current
906 * @man: The command buffer manager.
907 * @size: The requested size of the commands.
908 * @ctx_id: The context id if any. Otherwise set to SVGA3D_REG_INVALID.
909 * @interruptible: Whether to sleep interruptible while waiting for space.
911 * Returns a pointer to command buffer space if successful. Otherwise
912 * returns an error pointer.
914 static void *vmw_cmdbuf_reserve_cur(struct vmw_cmdbuf_man *man,
919 struct vmw_cmdbuf_header *cur;
922 if (vmw_cmdbuf_cur_lock(man, interruptible))
923 return ERR_PTR(-ERESTARTSYS);
926 if (cur && (size + man->cur_pos > cur->size ||
927 ((cur->cb_header->flags & SVGA_CB_FLAG_DX_CONTEXT) &&
928 ctx_id != cur->cb_header->dxContext)))
929 __vmw_cmdbuf_cur_flush(man);
932 ret = vmw_cmdbuf_alloc(man,
933 max_t(size_t, size, man->default_size),
934 interruptible, &man->cur);
936 vmw_cmdbuf_cur_unlock(man);
943 if (ctx_id != SVGA3D_INVALID_ID) {
944 cur->cb_header->flags |= SVGA_CB_FLAG_DX_CONTEXT;
945 cur->cb_header->dxContext = ctx_id;
948 cur->reserved = size;
950 return (void *) (man->cur->cmd + man->cur_pos);
954 * vmw_cmdbuf_commit_cur - Commit commands in the current command buffer.
956 * @man: The command buffer manager.
957 * @size: The size of the commands actually written.
958 * @flush: Whether to flush the command buffer immediately.
960 static void vmw_cmdbuf_commit_cur(struct vmw_cmdbuf_man *man,
961 size_t size, bool flush)
963 struct vmw_cmdbuf_header *cur = man->cur;
965 WARN_ON(!mutex_is_locked(&man->cur_mutex));
967 WARN_ON(size > cur->reserved);
968 man->cur_pos += size;
970 cur->cb_header->flags &= ~SVGA_CB_FLAG_DX_CONTEXT;
972 __vmw_cmdbuf_cur_flush(man);
973 vmw_cmdbuf_cur_unlock(man);
977 * vmw_cmdbuf_reserve - Reserve space for commands in a command buffer.
979 * @man: The command buffer manager.
980 * @size: The requested size of the commands.
981 * @ctx_id: The context id if any. Otherwise set to SVGA3D_REG_INVALID.
982 * @interruptible: Whether to sleep interruptible while waiting for space.
983 * @header: Header of the command buffer. NULL if the current command buffer
986 * Returns a pointer to command buffer space if successful. Otherwise
987 * returns an error pointer.
989 void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
990 int ctx_id, bool interruptible,
991 struct vmw_cmdbuf_header *header)
994 return vmw_cmdbuf_reserve_cur(man, size, ctx_id, interruptible);
996 if (size > header->size)
997 return ERR_PTR(-EINVAL);
999 if (ctx_id != SVGA3D_INVALID_ID) {
1000 header->cb_header->flags |= SVGA_CB_FLAG_DX_CONTEXT;
1001 header->cb_header->dxContext = ctx_id;
1004 header->reserved = size;
1009 * vmw_cmdbuf_commit - Commit commands in a command buffer.
1011 * @man: The command buffer manager.
1012 * @size: The size of the commands actually written.
1013 * @header: Header of the command buffer. NULL if the current command buffer
1015 * @flush: Whether to flush the command buffer immediately.
1017 void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1018 struct vmw_cmdbuf_header *header, bool flush)
1021 vmw_cmdbuf_commit_cur(man, size, flush);
1025 (void) vmw_cmdbuf_cur_lock(man, false);
1026 __vmw_cmdbuf_cur_flush(man);
1027 WARN_ON(size > header->reserved);
1029 man->cur_pos = size;
1031 header->cb_header->flags &= ~SVGA_CB_FLAG_DX_CONTEXT;
1033 __vmw_cmdbuf_cur_flush(man);
1034 vmw_cmdbuf_cur_unlock(man);
1038 * vmw_cmdbuf_tasklet_schedule - Schedule the interrupt handler bottom half.
1040 * @man: The command buffer manager.
1042 void vmw_cmdbuf_tasklet_schedule(struct vmw_cmdbuf_man *man)
1047 tasklet_schedule(&man->tasklet);
1051 * vmw_cmdbuf_send_device_command - Send a command through the device context.
1053 * @man: The command buffer manager.
1054 * @command: Pointer to the command to send.
1055 * @size: Size of the command.
1057 * Synchronously sends a device context command.
1059 static int vmw_cmdbuf_send_device_command(struct vmw_cmdbuf_man *man,
1060 const void *command,
1063 struct vmw_cmdbuf_header *header;
1065 void *cmd = vmw_cmdbuf_alloc(man, size, false, &header);
1068 return PTR_ERR(cmd);
1070 memcpy(cmd, command, size);
1071 header->cb_header->length = size;
1072 header->cb_context = SVGA_CB_CONTEXT_DEVICE;
1073 spin_lock_bh(&man->lock);
1074 status = vmw_cmdbuf_header_submit(header);
1075 spin_unlock_bh(&man->lock);
1076 vmw_cmdbuf_header_free(header);
1078 if (status != SVGA_CB_STATUS_COMPLETED) {
1079 DRM_ERROR("Device context command failed with status %d\n",
1088 * vmw_cmdbuf_startstop - Send a start / stop command through the device
1091 * @man: The command buffer manager.
1092 * @enable: Whether to enable or disable the context.
1094 * Synchronously sends a device start / stop context command.
1096 static int vmw_cmdbuf_startstop(struct vmw_cmdbuf_man *man,
1101 SVGADCCmdStartStop body;
1104 cmd.id = SVGA_DC_CMD_START_STOP_CONTEXT;
1105 cmd.body.enable = (enable) ? 1 : 0;
1106 cmd.body.context = SVGA_CB_CONTEXT_0;
1108 return vmw_cmdbuf_send_device_command(man, &cmd, sizeof(cmd));
1112 * vmw_cmdbuf_set_pool_size - Set command buffer manager sizes
1114 * @man: The command buffer manager.
1115 * @size: The size of the main space pool.
1116 * @default_size: The default size of the command buffer for small kernel
1119 * Set the size and allocate the main command buffer space pool,
1120 * as well as the default size of the command buffer for
1121 * small kernel submissions. If successful, this enables large command
1122 * submissions. Note that this function requires that rudimentary command
1123 * submission is already available and that the MOB memory manager is alive.
1124 * Returns 0 on success. Negative error code on failure.
1126 int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1127 size_t size, size_t default_size)
1129 struct vmw_private *dev_priv = man->dev_priv;
1136 /* First, try to allocate a huge chunk of DMA memory */
1137 size = PAGE_ALIGN(size);
1138 man->map = dma_alloc_coherent(&dev_priv->dev->pdev->dev, size,
1139 &man->handle, GFP_KERNEL);
1141 man->using_mob = false;
1144 * DMA memory failed. If we can have command buffers in a
1145 * MOB, try to use that instead. Note that this will
1146 * actually call into the already enabled manager, when
1149 if (!(dev_priv->capabilities & SVGA_CAP_DX))
1152 ret = ttm_bo_create(&dev_priv->bdev, size, ttm_bo_type_device,
1153 &vmw_mob_ne_placement, 0, false, NULL,
1158 man->using_mob = true;
1159 ret = ttm_bo_kmap(man->cmd_space, 0, size >> PAGE_SHIFT,
1164 man->map = ttm_kmap_obj_virtual(&man->map_obj, &dummy);
1168 drm_mm_init(&man->mm, 0, size >> PAGE_SHIFT);
1170 man->has_pool = true;
1171 man->default_size = default_size;
1172 DRM_INFO("Using command buffers with %s pool.\n",
1173 (man->using_mob) ? "MOB" : "DMA");
1179 ttm_bo_unref(&man->cmd_space);
1185 * vmw_cmdbuf_man_create: Create a command buffer manager and enable it for
1186 * inline command buffer submissions only.
1188 * @dev_priv: Pointer to device private structure.
1190 * Returns a pointer to a cummand buffer manager to success or error pointer
1191 * on failure. The command buffer manager will be enabled for submissions of
1192 * size VMW_CMDBUF_INLINE_SIZE only.
1194 struct vmw_cmdbuf_man *vmw_cmdbuf_man_create(struct vmw_private *dev_priv)
1196 struct vmw_cmdbuf_man *man;
1197 struct vmw_cmdbuf_context *ctx;
1201 if (!(dev_priv->capabilities & SVGA_CAP_COMMAND_BUFFERS))
1202 return ERR_PTR(-ENOSYS);
1204 man = kzalloc(sizeof(*man), GFP_KERNEL);
1206 return ERR_PTR(-ENOMEM);
1208 man->headers = dma_pool_create("vmwgfx cmdbuf",
1209 &dev_priv->dev->pdev->dev,
1210 sizeof(SVGACBHeader),
1212 if (!man->headers) {
1217 man->dheaders = dma_pool_create("vmwgfx inline cmdbuf",
1218 &dev_priv->dev->pdev->dev,
1219 sizeof(struct vmw_cmdbuf_dheader),
1221 if (!man->dheaders) {
1226 for_each_cmdbuf_ctx(man, i, ctx)
1227 vmw_cmdbuf_ctx_init(ctx);
1229 INIT_LIST_HEAD(&man->error);
1230 spin_lock_init(&man->lock);
1231 mutex_init(&man->cur_mutex);
1232 mutex_init(&man->space_mutex);
1233 tasklet_init(&man->tasklet, vmw_cmdbuf_man_tasklet,
1234 (unsigned long) man);
1235 man->default_size = VMW_CMDBUF_INLINE_SIZE;
1236 init_waitqueue_head(&man->alloc_queue);
1237 init_waitqueue_head(&man->idle_queue);
1238 man->dev_priv = dev_priv;
1239 man->max_hw_submitted = SVGA_CB_MAX_QUEUED_PER_CONTEXT - 1;
1240 INIT_WORK(&man->work, &vmw_cmdbuf_work_func);
1241 vmw_generic_waiter_add(dev_priv, SVGA_IRQFLAG_ERROR,
1242 &dev_priv->error_waiters);
1243 ret = vmw_cmdbuf_startstop(man, true);
1245 DRM_ERROR("Failed starting command buffer context 0.\n");
1246 vmw_cmdbuf_man_destroy(man);
1247 return ERR_PTR(ret);
1253 dma_pool_destroy(man->headers);
1257 return ERR_PTR(ret);
1261 * vmw_cmdbuf_remove_pool - Take down the main buffer space pool.
1263 * @man: Pointer to a command buffer manager.
1265 * This function removes the main buffer space pool, and should be called
1266 * before MOB memory management is removed. When this function has been called,
1267 * only small command buffer submissions of size VMW_CMDBUF_INLINE_SIZE or
1268 * less are allowed, and the default size of the command buffer for small kernel
1269 * submissions is also set to this size.
1271 void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man)
1276 man->has_pool = false;
1277 man->default_size = VMW_CMDBUF_INLINE_SIZE;
1278 (void) vmw_cmdbuf_idle(man, false, 10*HZ);
1279 if (man->using_mob) {
1280 (void) ttm_bo_kunmap(&man->map_obj);
1281 ttm_bo_unref(&man->cmd_space);
1283 dma_free_coherent(&man->dev_priv->dev->pdev->dev,
1284 man->size, man->map, man->handle);
1289 * vmw_cmdbuf_man_destroy - Take down a command buffer manager.
1291 * @man: Pointer to a command buffer manager.
1293 * This function idles and then destroys a command buffer manager.
1295 void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man)
1297 WARN_ON_ONCE(man->has_pool);
1298 (void) vmw_cmdbuf_idle(man, false, 10*HZ);
1299 if (vmw_cmdbuf_startstop(man, false))
1300 DRM_ERROR("Failed stopping command buffer context 0.\n");
1302 vmw_generic_waiter_remove(man->dev_priv, SVGA_IRQFLAG_ERROR,
1303 &man->dev_priv->error_waiters);
1304 tasklet_kill(&man->tasklet);
1305 (void) cancel_work_sync(&man->work);
1306 dma_pool_destroy(man->dheaders);
1307 dma_pool_destroy(man->headers);
1308 mutex_destroy(&man->cur_mutex);
1309 mutex_destroy(&man->space_mutex);