1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (c) 2020 NVIDIA Corporation */
4 #include <linux/dma-fence-array.h>
5 #include <linux/dma-mapping.h>
6 #include <linux/file.h>
7 #include <linux/host1x.h>
8 #include <linux/iommu.h>
9 #include <linux/kref.h>
10 #include <linux/list.h>
11 #include <linux/nospec.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/scatterlist.h>
14 #include <linux/slab.h>
15 #include <linux/sync_file.h>
17 #include <drm/drm_drv.h>
18 #include <drm/drm_file.h>
19 #include <drm/drm_syncobj.h>
26 #define SUBMIT_ERR(context, fmt, ...) \
27 dev_err_ratelimited(context->client->base.dev, \
28 "%s: job submission failed: " fmt "\n", \
29 current->comm, ##__VA_ARGS__)
32 struct host1x_bo base;
38 dma_addr_t gather_data_dma;
39 size_t gather_data_words;
42 static struct host1x_bo *gather_bo_get(struct host1x_bo *host_bo)
44 struct gather_bo *bo = container_of(host_bo, struct gather_bo, base);
51 static void gather_bo_release(struct kref *ref)
53 struct gather_bo *bo = container_of(ref, struct gather_bo, ref);
55 dma_free_attrs(bo->dev, bo->gather_data_words * 4, bo->gather_data, bo->gather_data_dma,
60 static void gather_bo_put(struct host1x_bo *host_bo)
62 struct gather_bo *bo = container_of(host_bo, struct gather_bo, base);
64 kref_put(&bo->ref, gather_bo_release);
67 static struct host1x_bo_mapping *
68 gather_bo_pin(struct device *dev, struct host1x_bo *bo, enum dma_data_direction direction)
70 struct gather_bo *gather = container_of(bo, struct gather_bo, base);
71 struct host1x_bo_mapping *map;
74 map = kzalloc(sizeof(*map), GFP_KERNEL);
76 return ERR_PTR(-ENOMEM);
79 map->bo = host1x_bo_get(bo);
80 map->direction = direction;
83 map->sgt = kzalloc(sizeof(*map->sgt), GFP_KERNEL);
89 err = dma_get_sgtable(gather->dev, map->sgt, gather->gather_data, gather->gather_data_dma,
90 gather->gather_data_words * 4);
94 err = dma_map_sgtable(dev, map->sgt, direction, 0);
98 map->phys = sg_dma_address(map->sgt->sgl);
99 map->size = gather->gather_data_words * 4;
105 sg_free_table(map->sgt);
112 static void gather_bo_unpin(struct host1x_bo_mapping *map)
117 dma_unmap_sgtable(map->dev, map->sgt, map->direction, 0);
118 sg_free_table(map->sgt);
120 host1x_bo_put(map->bo);
125 static void *gather_bo_mmap(struct host1x_bo *host_bo)
127 struct gather_bo *bo = container_of(host_bo, struct gather_bo, base);
129 return bo->gather_data;
132 static void gather_bo_munmap(struct host1x_bo *host_bo, void *addr)
136 const struct host1x_bo_ops gather_bo_ops = {
137 .get = gather_bo_get,
138 .put = gather_bo_put,
139 .pin = gather_bo_pin,
140 .unpin = gather_bo_unpin,
141 .mmap = gather_bo_mmap,
142 .munmap = gather_bo_munmap,
145 static struct tegra_drm_mapping *
146 tegra_drm_mapping_get(struct tegra_drm_context *context, u32 id)
148 struct tegra_drm_mapping *mapping;
150 xa_lock(&context->mappings);
152 mapping = xa_load(&context->mappings, id);
154 kref_get(&mapping->ref);
156 xa_unlock(&context->mappings);
161 static void *alloc_copy_user_array(void __user *from, size_t count, size_t size)
166 if (check_mul_overflow(count, size, ©_len))
167 return ERR_PTR(-EINVAL);
169 if (copy_len > 0x4000)
170 return ERR_PTR(-E2BIG);
172 data = kvmalloc(copy_len, GFP_KERNEL);
174 return ERR_PTR(-ENOMEM);
176 if (copy_from_user(data, from, copy_len)) {
178 return ERR_PTR(-EFAULT);
184 static int submit_copy_gather_data(struct gather_bo **pbo, struct device *dev,
185 struct tegra_drm_context *context,
186 struct drm_tegra_channel_submit *args)
188 struct gather_bo *bo;
191 if (args->gather_data_words == 0) {
192 SUBMIT_ERR(context, "gather_data_words cannot be zero");
196 if (check_mul_overflow((size_t)args->gather_data_words, (size_t)4, ©_len)) {
197 SUBMIT_ERR(context, "gather_data_words is too large");
201 bo = kzalloc(sizeof(*bo), GFP_KERNEL);
203 SUBMIT_ERR(context, "failed to allocate memory for bo info");
207 host1x_bo_init(&bo->base, &gather_bo_ops);
211 bo->gather_data = dma_alloc_attrs(dev, copy_len, &bo->gather_data_dma,
212 GFP_KERNEL | __GFP_NOWARN, 0);
213 if (!bo->gather_data) {
214 SUBMIT_ERR(context, "failed to allocate memory for gather data");
219 if (copy_from_user(bo->gather_data, u64_to_user_ptr(args->gather_data_ptr), copy_len)) {
220 SUBMIT_ERR(context, "failed to copy gather data from userspace");
221 dma_free_attrs(dev, copy_len, bo->gather_data, bo->gather_data_dma, 0);
226 bo->gather_data_words = args->gather_data_words;
233 static int submit_write_reloc(struct tegra_drm_context *context, struct gather_bo *bo,
234 struct drm_tegra_submit_buf *buf, struct tegra_drm_mapping *mapping)
236 /* TODO check that target_offset is within bounds */
237 dma_addr_t iova = mapping->iova + buf->reloc.target_offset;
240 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
241 if (buf->flags & DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT)
245 written_ptr = iova >> buf->reloc.shift;
247 if (buf->reloc.gather_offset_words >= bo->gather_data_words) {
249 "relocation has too large gather offset (%u vs gather length %zu)",
250 buf->reloc.gather_offset_words, bo->gather_data_words);
254 buf->reloc.gather_offset_words = array_index_nospec(buf->reloc.gather_offset_words,
255 bo->gather_data_words);
257 bo->gather_data[buf->reloc.gather_offset_words] = written_ptr;
262 static int submit_process_bufs(struct tegra_drm_context *context, struct gather_bo *bo,
263 struct drm_tegra_channel_submit *args,
264 struct tegra_drm_submit_data *job_data)
266 struct tegra_drm_used_mapping *mappings;
267 struct drm_tegra_submit_buf *bufs;
271 bufs = alloc_copy_user_array(u64_to_user_ptr(args->bufs_ptr), args->num_bufs,
274 SUBMIT_ERR(context, "failed to copy bufs array from userspace");
275 return PTR_ERR(bufs);
278 mappings = kcalloc(args->num_bufs, sizeof(*mappings), GFP_KERNEL);
280 SUBMIT_ERR(context, "failed to allocate memory for mapping info");
285 for (i = 0; i < args->num_bufs; i++) {
286 struct drm_tegra_submit_buf *buf = &bufs[i];
287 struct tegra_drm_mapping *mapping;
289 if (buf->flags & ~DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT) {
290 SUBMIT_ERR(context, "invalid flag specified for buffer");
295 mapping = tegra_drm_mapping_get(context, buf->mapping);
297 SUBMIT_ERR(context, "invalid mapping ID '%u' for buffer", buf->mapping);
302 err = submit_write_reloc(context, bo, buf, mapping);
304 tegra_drm_mapping_put(mapping);
308 mappings[i].mapping = mapping;
309 mappings[i].flags = buf->flags;
312 job_data->used_mappings = mappings;
313 job_data->num_used_mappings = i;
321 tegra_drm_mapping_put(mappings[i].mapping);
324 job_data->used_mappings = NULL;
332 static int submit_get_syncpt(struct tegra_drm_context *context, struct host1x_job *job,
333 struct xarray *syncpoints, struct drm_tegra_channel_submit *args)
335 struct host1x_syncpt *sp;
337 if (args->syncpt.flags) {
338 SUBMIT_ERR(context, "invalid flag specified for syncpt");
342 /* Syncpt ref will be dropped on job release */
343 sp = xa_load(syncpoints, args->syncpt.id);
345 SUBMIT_ERR(context, "syncpoint specified in syncpt was not allocated");
349 job->syncpt = host1x_syncpt_get(sp);
350 job->syncpt_incrs = args->syncpt.increments;
355 static int submit_job_add_gather(struct host1x_job *job, struct tegra_drm_context *context,
356 struct drm_tegra_submit_cmd_gather_uptr *cmd,
357 struct gather_bo *bo, u32 *offset,
358 struct tegra_drm_submit_data *job_data,
363 if (cmd->reserved[0] || cmd->reserved[1] || cmd->reserved[2]) {
364 SUBMIT_ERR(context, "non-zero reserved field in GATHER_UPTR command");
368 /* Check for maximum gather size */
369 if (cmd->words > 16383) {
370 SUBMIT_ERR(context, "too many words in GATHER_UPTR command");
374 if (check_add_overflow(*offset, cmd->words, &next_offset)) {
375 SUBMIT_ERR(context, "too many total words in job");
379 if (next_offset > bo->gather_data_words) {
380 SUBMIT_ERR(context, "GATHER_UPTR command overflows gather data");
384 if (tegra_drm_fw_validate(context->client, bo->gather_data, *offset,
385 cmd->words, job_data, class)) {
386 SUBMIT_ERR(context, "job was rejected by firewall");
390 host1x_job_add_gather(job, &bo->base, cmd->words, *offset * 4);
392 *offset = next_offset;
397 static struct host1x_job *
398 submit_create_job(struct tegra_drm_context *context, struct gather_bo *bo,
399 struct drm_tegra_channel_submit *args, struct tegra_drm_submit_data *job_data,
400 struct xarray *syncpoints)
402 struct drm_tegra_submit_cmd *cmds;
403 u32 i, gather_offset = 0, class;
404 struct host1x_job *job;
407 /* Set initial class for firewall. */
408 class = context->client->base.class;
410 cmds = alloc_copy_user_array(u64_to_user_ptr(args->cmds_ptr), args->num_cmds,
413 SUBMIT_ERR(context, "failed to copy cmds array from userspace");
414 return ERR_CAST(cmds);
417 job = host1x_job_alloc(context->channel, args->num_cmds, 0, true);
419 SUBMIT_ERR(context, "failed to allocate memory for job");
420 job = ERR_PTR(-ENOMEM);
424 err = submit_get_syncpt(context, job, syncpoints, args);
428 job->client = &context->client->base;
429 job->class = context->client->base.class;
430 job->serialize = true;
432 for (i = 0; i < args->num_cmds; i++) {
433 struct drm_tegra_submit_cmd *cmd = &cmds[i];
436 SUBMIT_ERR(context, "unknown flags given for cmd");
441 if (cmd->type == DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR) {
442 err = submit_job_add_gather(job, context, &cmd->gather_uptr, bo,
443 &gather_offset, job_data, &class);
446 } else if (cmd->type == DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT) {
447 if (cmd->wait_syncpt.reserved[0] || cmd->wait_syncpt.reserved[1]) {
448 SUBMIT_ERR(context, "non-zero reserved value");
453 host1x_job_add_wait(job, cmd->wait_syncpt.id, cmd->wait_syncpt.value,
455 } else if (cmd->type == DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT_RELATIVE) {
456 if (cmd->wait_syncpt.reserved[0] || cmd->wait_syncpt.reserved[1]) {
457 SUBMIT_ERR(context, "non-zero reserved value");
462 if (cmd->wait_syncpt.id != args->syncpt.id) {
463 SUBMIT_ERR(context, "syncpoint ID in CMD_WAIT_SYNCPT_RELATIVE is not used by the job");
468 host1x_job_add_wait(job, cmd->wait_syncpt.id, cmd->wait_syncpt.value,
471 SUBMIT_ERR(context, "unknown cmd type");
477 if (gather_offset == 0) {
478 SUBMIT_ERR(context, "job must have at least one gather");
495 static void release_job(struct host1x_job *job)
497 struct tegra_drm_client *client = container_of(job->client, struct tegra_drm_client, base);
498 struct tegra_drm_submit_data *job_data = job->user_data;
501 if (job->memory_context)
502 host1x_memory_context_put(job->memory_context);
504 for (i = 0; i < job_data->num_used_mappings; i++)
505 tegra_drm_mapping_put(job_data->used_mappings[i].mapping);
507 kfree(job_data->used_mappings);
510 pm_runtime_mark_last_busy(client->base.dev);
511 pm_runtime_put_autosuspend(client->base.dev);
514 int tegra_drm_ioctl_channel_submit(struct drm_device *drm, void *data,
515 struct drm_file *file)
517 struct tegra_drm_file *fpriv = file->driver_priv;
518 struct drm_tegra_channel_submit *args = data;
519 struct tegra_drm_submit_data *job_data;
520 struct drm_syncobj *syncobj = NULL;
521 struct tegra_drm_context *context;
522 struct host1x_job *job;
523 struct gather_bo *bo;
527 mutex_lock(&fpriv->lock);
529 context = xa_load(&fpriv->contexts, args->context);
531 mutex_unlock(&fpriv->lock);
532 pr_err_ratelimited("%s: %s: invalid channel context '%#x'", __func__,
533 current->comm, args->context);
537 if (args->syncobj_in) {
538 struct dma_fence *fence;
540 err = drm_syncobj_find_fence(file, args->syncobj_in, 0, 0, &fence);
542 SUBMIT_ERR(context, "invalid syncobj_in '%#x'", args->syncobj_in);
546 err = dma_fence_wait_timeout(fence, true, msecs_to_jiffies(10000));
547 dma_fence_put(fence);
549 SUBMIT_ERR(context, "wait for syncobj_in timed out");
554 if (args->syncobj_out) {
555 syncobj = drm_syncobj_find(file, args->syncobj_out);
557 SUBMIT_ERR(context, "invalid syncobj_out '%#x'", args->syncobj_out);
563 /* Allocate gather BO and copy gather words in. */
564 err = submit_copy_gather_data(&bo, drm->dev, context, args);
568 job_data = kzalloc(sizeof(*job_data), GFP_KERNEL);
570 SUBMIT_ERR(context, "failed to allocate memory for job data");
575 /* Get data buffer mappings and do relocation patching. */
576 err = submit_process_bufs(context, bo, args, job_data);
580 /* Allocate host1x_job and add gathers and waits to it. */
581 job = submit_create_job(context, bo, args, job_data, &fpriv->syncpoints);
587 /* Map gather data for Host1x. */
588 err = host1x_job_pin(job, context->client->base.dev);
590 SUBMIT_ERR(context, "failed to pin job: %d", err);
594 if (context->client->ops->get_streamid_offset) {
595 err = context->client->ops->get_streamid_offset(
596 context->client, &job->engine_streamid_offset);
598 SUBMIT_ERR(context, "failed to get streamid offset: %d", err);
603 if (context->memory_context && context->client->ops->can_use_memory_ctx) {
606 err = context->client->ops->can_use_memory_ctx(context->client, &supported);
608 SUBMIT_ERR(context, "failed to detect if engine can use memory context: %d", err);
613 job->memory_context = context->memory_context;
614 host1x_memory_context_get(job->memory_context);
616 } else if (context->client->ops->get_streamid_offset) {
617 #ifdef CONFIG_IOMMU_API
618 struct iommu_fwspec *spec;
621 * Job submission will need to temporarily change stream ID,
622 * so need to tell it what to change it back to.
624 spec = dev_iommu_fwspec_get(context->client->base.dev);
625 if (spec && spec->num_ids > 0)
626 job->engine_fallback_streamid = spec->ids[0] & 0xffff;
628 job->engine_fallback_streamid = 0x7f;
630 job->engine_fallback_streamid = 0x7f;
635 err = pm_runtime_resume_and_get(context->client->base.dev);
637 SUBMIT_ERR(context, "could not power up engine: %d", err);
638 goto put_memory_context;
641 job->user_data = job_data;
642 job->release = release_job;
643 job->timeout = 10000;
646 * job_data is now part of job reference counting, so don't release
651 /* Submit job to hardware. */
652 err = host1x_job_submit(job);
654 SUBMIT_ERR(context, "host1x job submission failed: %d", err);
658 /* Return postfences to userspace and add fences to DMA reservations. */
659 args->syncpt.value = job->syncpt_end;
662 struct dma_fence *fence = host1x_fence_create(job->syncpt, job->syncpt_end);
664 err = PTR_ERR(fence);
665 SUBMIT_ERR(context, "failed to create postfence: %d", err);
668 drm_syncobj_replace_fence(syncobj, fence);
674 if (job->memory_context)
675 host1x_memory_context_put(job->memory_context);
677 host1x_job_unpin(job);
681 if (job_data && job_data->used_mappings) {
682 for (i = 0; i < job_data->num_used_mappings; i++)
683 tegra_drm_mapping_put(job_data->used_mappings[i].mapping);
685 kfree(job_data->used_mappings);
691 gather_bo_put(&bo->base);
694 drm_syncobj_put(syncobj);
696 mutex_unlock(&fpriv->lock);