1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2011-2018, The Linux Foundation. All rights reserved.
3 // Copyright (c) 2018, Linaro Limited
5 #include <linux/completion.h>
6 #include <linux/device.h>
7 #include <linux/dma-buf.h>
8 #include <linux/dma-mapping.h>
10 #include <linux/list.h>
11 #include <linux/miscdevice.h>
12 #include <linux/module.h>
13 #include <linux/of_address.h>
15 #include <linux/sort.h>
16 #include <linux/of_platform.h>
17 #include <linux/rpmsg.h>
18 #include <linux/scatterlist.h>
19 #include <linux/slab.h>
20 #include <uapi/misc/fastrpc.h>
22 #define ADSP_DOMAIN_ID (0)
23 #define MDSP_DOMAIN_ID (1)
24 #define SDSP_DOMAIN_ID (2)
25 #define CDSP_DOMAIN_ID (3)
26 #define FASTRPC_DEV_MAX 4 /* adsp, mdsp, slpi, cdsp*/
27 #define FASTRPC_MAX_SESSIONS 9 /*8 compute, 1 cpz*/
28 #define FASTRPC_ALIGN 128
29 #define FASTRPC_MAX_FDLIST 16
30 #define FASTRPC_MAX_CRCLIST 64
31 #define FASTRPC_PHYS(p) ((p) & 0xffffffff)
32 #define FASTRPC_CTX_MAX (256)
33 #define FASTRPC_INIT_HANDLE 1
34 #define FASTRPC_CTXID_MASK (0xFF0)
35 #define INIT_FILELEN_MAX (2 * 1024 * 1024)
36 #define FASTRPC_DEVICE_NAME "fastrpc"
37 #define ADSP_MMAP_ADD_PAGES 0x1000
39 /* Retrives number of input buffers from the scalars parameter */
40 #define REMOTE_SCALARS_INBUFS(sc) (((sc) >> 16) & 0x0ff)
42 /* Retrives number of output buffers from the scalars parameter */
43 #define REMOTE_SCALARS_OUTBUFS(sc) (((sc) >> 8) & 0x0ff)
45 /* Retrives number of input handles from the scalars parameter */
46 #define REMOTE_SCALARS_INHANDLES(sc) (((sc) >> 4) & 0x0f)
48 /* Retrives number of output handles from the scalars parameter */
49 #define REMOTE_SCALARS_OUTHANDLES(sc) ((sc) & 0x0f)
51 #define REMOTE_SCALARS_LENGTH(sc) (REMOTE_SCALARS_INBUFS(sc) + \
52 REMOTE_SCALARS_OUTBUFS(sc) + \
53 REMOTE_SCALARS_INHANDLES(sc)+ \
54 REMOTE_SCALARS_OUTHANDLES(sc))
55 #define FASTRPC_BUILD_SCALARS(attr, method, in, out, oin, oout) \
56 (((attr & 0x07) << 29) | \
57 ((method & 0x1f) << 24) | \
58 ((in & 0xff) << 16) | \
59 ((out & 0xff) << 8) | \
60 ((oin & 0x0f) << 4) | \
63 #define FASTRPC_SCALARS(method, in, out) \
64 FASTRPC_BUILD_SCALARS(0, method, in, out, 0, 0)
66 #define FASTRPC_CREATE_PROCESS_NARGS 6
67 /* Remote Method id table */
68 #define FASTRPC_RMID_INIT_ATTACH 0
69 #define FASTRPC_RMID_INIT_RELEASE 1
70 #define FASTRPC_RMID_INIT_MMAP 4
71 #define FASTRPC_RMID_INIT_MUNMAP 5
72 #define FASTRPC_RMID_INIT_CREATE 6
73 #define FASTRPC_RMID_INIT_CREATE_ATTR 7
74 #define FASTRPC_RMID_INIT_CREATE_STATIC 8
76 /* Protection Domain(PD) ids */
77 #define AUDIO_PD (0) /* also GUEST_OS PD? */
79 #define SENSORS_PD (2)
81 #define miscdev_to_cctx(d) container_of(d, struct fastrpc_channel_ctx, miscdev)
83 static const char *domains[FASTRPC_DEV_MAX] = { "adsp", "mdsp",
85 struct fastrpc_phy_page {
86 u64 addr; /* physical address */
87 u64 size; /* size of contiguous region */
90 struct fastrpc_invoke_buf {
91 u32 num; /* number of contiguous regions */
92 u32 pgidx; /* index to start of contiguous region */
95 struct fastrpc_remote_arg {
100 struct fastrpc_mmap_rsp_msg {
104 struct fastrpc_mmap_req_msg {
111 struct fastrpc_munmap_req_msg {
118 int pid; /* process group id */
119 int tid; /* thread id */
120 u64 ctx; /* invoke caller context */
121 u32 handle; /* handle to invoke */
122 u32 sc; /* scalars structure describing the data */
123 u64 addr; /* physical address */
124 u64 size; /* size of contiguous region */
127 struct fastrpc_invoke_rsp {
128 u64 ctx; /* invoke caller context */
129 int retval; /* invoke return value */
132 struct fastrpc_buf_overlap {
142 struct fastrpc_user *fl;
143 struct dma_buf *dmabuf;
148 /* Lock for dma buf attachments */
150 struct list_head attachments;
152 struct list_head node; /* list of user requested mmaps */
156 struct fastrpc_dma_buf_attachment {
159 struct list_head node;
163 struct list_head node;
164 struct fastrpc_user *fl;
167 struct sg_table *table;
168 struct dma_buf_attachment *attach;
173 struct kref refcount;
176 struct fastrpc_invoke_ctx {
186 struct kref refcount;
187 struct list_head node; /* list of ctxs */
188 struct completion work;
189 struct work_struct put_work;
190 struct fastrpc_msg msg;
191 struct fastrpc_user *fl;
192 struct fastrpc_remote_arg *rpra;
193 struct fastrpc_map **maps;
194 struct fastrpc_buf *buf;
195 struct fastrpc_invoke_args *args;
196 struct fastrpc_buf_overlap *olaps;
197 struct fastrpc_channel_ctx *cctx;
200 struct fastrpc_session_ctx {
207 struct fastrpc_channel_ctx {
210 struct rpmsg_device *rpdev;
211 struct fastrpc_session_ctx session[FASTRPC_MAX_SESSIONS];
214 struct list_head users;
215 struct miscdevice miscdev;
216 struct kref refcount;
219 struct fastrpc_user {
220 struct list_head user;
221 struct list_head maps;
222 struct list_head pending;
223 struct list_head mmaps;
225 struct fastrpc_channel_ctx *cctx;
226 struct fastrpc_session_ctx *sctx;
227 struct fastrpc_buf *init_mem;
233 /* lock for allocations */
237 static void fastrpc_free_map(struct kref *ref)
239 struct fastrpc_map *map;
241 map = container_of(ref, struct fastrpc_map, refcount);
244 dma_buf_unmap_attachment(map->attach, map->table,
246 dma_buf_detach(map->buf, map->attach);
247 dma_buf_put(map->buf);
253 static void fastrpc_map_put(struct fastrpc_map *map)
256 kref_put(&map->refcount, fastrpc_free_map);
259 static void fastrpc_map_get(struct fastrpc_map *map)
262 kref_get(&map->refcount);
265 static int fastrpc_map_find(struct fastrpc_user *fl, int fd,
266 struct fastrpc_map **ppmap)
268 struct fastrpc_map *map = NULL;
270 mutex_lock(&fl->mutex);
271 list_for_each_entry(map, &fl->maps, node) {
273 fastrpc_map_get(map);
275 mutex_unlock(&fl->mutex);
279 mutex_unlock(&fl->mutex);
284 static void fastrpc_buf_free(struct fastrpc_buf *buf)
286 dma_free_coherent(buf->dev, buf->size, buf->virt,
287 FASTRPC_PHYS(buf->phys));
291 static int fastrpc_buf_alloc(struct fastrpc_user *fl, struct device *dev,
292 u64 size, struct fastrpc_buf **obuf)
294 struct fastrpc_buf *buf;
296 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
300 INIT_LIST_HEAD(&buf->attachments);
301 INIT_LIST_HEAD(&buf->node);
302 mutex_init(&buf->lock);
311 buf->virt = dma_alloc_coherent(dev, buf->size, (dma_addr_t *)&buf->phys,
314 mutex_destroy(&buf->lock);
319 if (fl->sctx && fl->sctx->sid)
320 buf->phys += ((u64)fl->sctx->sid << 32);
327 static void fastrpc_channel_ctx_free(struct kref *ref)
329 struct fastrpc_channel_ctx *cctx;
331 cctx = container_of(ref, struct fastrpc_channel_ctx, refcount);
336 static void fastrpc_channel_ctx_get(struct fastrpc_channel_ctx *cctx)
338 kref_get(&cctx->refcount);
341 static void fastrpc_channel_ctx_put(struct fastrpc_channel_ctx *cctx)
343 kref_put(&cctx->refcount, fastrpc_channel_ctx_free);
346 static void fastrpc_context_free(struct kref *ref)
348 struct fastrpc_invoke_ctx *ctx;
349 struct fastrpc_channel_ctx *cctx;
353 ctx = container_of(ref, struct fastrpc_invoke_ctx, refcount);
356 for (i = 0; i < ctx->nscalars; i++)
357 fastrpc_map_put(ctx->maps[i]);
360 fastrpc_buf_free(ctx->buf);
362 spin_lock_irqsave(&cctx->lock, flags);
363 idr_remove(&cctx->ctx_idr, ctx->ctxid >> 4);
364 spin_unlock_irqrestore(&cctx->lock, flags);
370 fastrpc_channel_ctx_put(cctx);
373 static void fastrpc_context_get(struct fastrpc_invoke_ctx *ctx)
375 kref_get(&ctx->refcount);
378 static void fastrpc_context_put(struct fastrpc_invoke_ctx *ctx)
380 kref_put(&ctx->refcount, fastrpc_context_free);
383 static void fastrpc_context_put_wq(struct work_struct *work)
385 struct fastrpc_invoke_ctx *ctx =
386 container_of(work, struct fastrpc_invoke_ctx, put_work);
388 fastrpc_context_put(ctx);
391 #define CMP(aa, bb) ((aa) == (bb) ? 0 : (aa) < (bb) ? -1 : 1)
392 static int olaps_cmp(const void *a, const void *b)
394 struct fastrpc_buf_overlap *pa = (struct fastrpc_buf_overlap *)a;
395 struct fastrpc_buf_overlap *pb = (struct fastrpc_buf_overlap *)b;
396 /* sort with lowest starting buffer first */
397 int st = CMP(pa->start, pb->start);
398 /* sort with highest ending buffer first */
399 int ed = CMP(pb->end, pa->end);
401 return st == 0 ? ed : st;
404 static void fastrpc_get_buff_overlaps(struct fastrpc_invoke_ctx *ctx)
409 for (i = 0; i < ctx->nbufs; ++i) {
410 ctx->olaps[i].start = ctx->args[i].ptr;
411 ctx->olaps[i].end = ctx->olaps[i].start + ctx->args[i].length;
412 ctx->olaps[i].raix = i;
415 sort(ctx->olaps, ctx->nbufs, sizeof(*ctx->olaps), olaps_cmp, NULL);
417 for (i = 0; i < ctx->nbufs; ++i) {
418 /* Falling inside previous range */
419 if (ctx->olaps[i].start < max_end) {
420 ctx->olaps[i].mstart = max_end;
421 ctx->olaps[i].mend = ctx->olaps[i].end;
422 ctx->olaps[i].offset = max_end - ctx->olaps[i].start;
424 if (ctx->olaps[i].end > max_end) {
425 max_end = ctx->olaps[i].end;
427 ctx->olaps[i].mend = 0;
428 ctx->olaps[i].mstart = 0;
432 ctx->olaps[i].mend = ctx->olaps[i].end;
433 ctx->olaps[i].mstart = ctx->olaps[i].start;
434 ctx->olaps[i].offset = 0;
435 max_end = ctx->olaps[i].end;
440 static struct fastrpc_invoke_ctx *fastrpc_context_alloc(
441 struct fastrpc_user *user, u32 kernel, u32 sc,
442 struct fastrpc_invoke_args *args)
444 struct fastrpc_channel_ctx *cctx = user->cctx;
445 struct fastrpc_invoke_ctx *ctx = NULL;
449 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
451 return ERR_PTR(-ENOMEM);
453 INIT_LIST_HEAD(&ctx->node);
455 ctx->nscalars = REMOTE_SCALARS_LENGTH(sc);
456 ctx->nbufs = REMOTE_SCALARS_INBUFS(sc) +
457 REMOTE_SCALARS_OUTBUFS(sc);
460 ctx->maps = kcalloc(ctx->nscalars,
461 sizeof(*ctx->maps), GFP_KERNEL);
464 return ERR_PTR(-ENOMEM);
466 ctx->olaps = kcalloc(ctx->nscalars,
467 sizeof(*ctx->olaps), GFP_KERNEL);
471 return ERR_PTR(-ENOMEM);
474 fastrpc_get_buff_overlaps(ctx);
477 /* Released in fastrpc_context_put() */
478 fastrpc_channel_ctx_get(cctx);
482 ctx->pid = current->pid;
483 ctx->tgid = user->tgid;
485 init_completion(&ctx->work);
486 INIT_WORK(&ctx->put_work, fastrpc_context_put_wq);
488 spin_lock(&user->lock);
489 list_add_tail(&ctx->node, &user->pending);
490 spin_unlock(&user->lock);
492 spin_lock_irqsave(&cctx->lock, flags);
493 ret = idr_alloc_cyclic(&cctx->ctx_idr, ctx, 1,
494 FASTRPC_CTX_MAX, GFP_ATOMIC);
496 spin_unlock_irqrestore(&cctx->lock, flags);
499 ctx->ctxid = ret << 4;
500 spin_unlock_irqrestore(&cctx->lock, flags);
502 kref_init(&ctx->refcount);
506 spin_lock(&user->lock);
507 list_del(&ctx->node);
508 spin_unlock(&user->lock);
509 fastrpc_channel_ctx_put(cctx);
517 static struct sg_table *
518 fastrpc_map_dma_buf(struct dma_buf_attachment *attachment,
519 enum dma_data_direction dir)
521 struct fastrpc_dma_buf_attachment *a = attachment->priv;
522 struct sg_table *table;
527 ret = dma_map_sgtable(attachment->dev, table, dir, 0);
529 table = ERR_PTR(ret);
533 static void fastrpc_unmap_dma_buf(struct dma_buf_attachment *attach,
534 struct sg_table *table,
535 enum dma_data_direction dir)
537 dma_unmap_sgtable(attach->dev, table, dir, 0);
540 static void fastrpc_release(struct dma_buf *dmabuf)
542 struct fastrpc_buf *buffer = dmabuf->priv;
544 fastrpc_buf_free(buffer);
547 static int fastrpc_dma_buf_attach(struct dma_buf *dmabuf,
548 struct dma_buf_attachment *attachment)
550 struct fastrpc_dma_buf_attachment *a;
551 struct fastrpc_buf *buffer = dmabuf->priv;
554 a = kzalloc(sizeof(*a), GFP_KERNEL);
558 ret = dma_get_sgtable(buffer->dev, &a->sgt, buffer->virt,
559 FASTRPC_PHYS(buffer->phys), buffer->size);
561 dev_err(buffer->dev, "failed to get scatterlist from DMA API\n");
566 a->dev = attachment->dev;
567 INIT_LIST_HEAD(&a->node);
568 attachment->priv = a;
570 mutex_lock(&buffer->lock);
571 list_add(&a->node, &buffer->attachments);
572 mutex_unlock(&buffer->lock);
577 static void fastrpc_dma_buf_detatch(struct dma_buf *dmabuf,
578 struct dma_buf_attachment *attachment)
580 struct fastrpc_dma_buf_attachment *a = attachment->priv;
581 struct fastrpc_buf *buffer = dmabuf->priv;
583 mutex_lock(&buffer->lock);
585 mutex_unlock(&buffer->lock);
586 sg_free_table(&a->sgt);
590 static int fastrpc_vmap(struct dma_buf *dmabuf, struct dma_buf_map *map)
592 struct fastrpc_buf *buf = dmabuf->priv;
594 dma_buf_map_set_vaddr(map, buf->virt);
599 static int fastrpc_mmap(struct dma_buf *dmabuf,
600 struct vm_area_struct *vma)
602 struct fastrpc_buf *buf = dmabuf->priv;
603 size_t size = vma->vm_end - vma->vm_start;
605 return dma_mmap_coherent(buf->dev, vma, buf->virt,
606 FASTRPC_PHYS(buf->phys), size);
609 static const struct dma_buf_ops fastrpc_dma_buf_ops = {
610 .attach = fastrpc_dma_buf_attach,
611 .detach = fastrpc_dma_buf_detatch,
612 .map_dma_buf = fastrpc_map_dma_buf,
613 .unmap_dma_buf = fastrpc_unmap_dma_buf,
614 .mmap = fastrpc_mmap,
615 .vmap = fastrpc_vmap,
616 .release = fastrpc_release,
619 static int fastrpc_map_create(struct fastrpc_user *fl, int fd,
620 u64 len, struct fastrpc_map **ppmap)
622 struct fastrpc_session_ctx *sess = fl->sctx;
623 struct fastrpc_map *map = NULL;
626 if (!fastrpc_map_find(fl, fd, ppmap))
629 map = kzalloc(sizeof(*map), GFP_KERNEL);
633 INIT_LIST_HEAD(&map->node);
636 map->buf = dma_buf_get(fd);
637 if (IS_ERR(map->buf)) {
638 err = PTR_ERR(map->buf);
642 map->attach = dma_buf_attach(map->buf, sess->dev);
643 if (IS_ERR(map->attach)) {
644 dev_err(sess->dev, "Failed to attach dmabuf\n");
645 err = PTR_ERR(map->attach);
649 map->table = dma_buf_map_attachment(map->attach, DMA_BIDIRECTIONAL);
650 if (IS_ERR(map->table)) {
651 err = PTR_ERR(map->table);
655 map->phys = sg_dma_address(map->table->sgl);
656 map->phys += ((u64)fl->sctx->sid << 32);
658 map->va = sg_virt(map->table->sgl);
660 kref_init(&map->refcount);
662 spin_lock(&fl->lock);
663 list_add_tail(&map->node, &fl->maps);
664 spin_unlock(&fl->lock);
670 dma_buf_detach(map->buf, map->attach);
672 dma_buf_put(map->buf);
680 * Fastrpc payload buffer with metadata looks like:
682 * >>>>>> START of METADATA <<<<<<<<<
683 * +---------------------------------+
685 * | type:(struct fastrpc_remote_arg)|
687 * +---------------------------------+
688 * | Invoke Buffer list |
689 * | type:(struct fastrpc_invoke_buf)|
691 * +---------------------------------+
693 * | type:(struct fastrpc_phy_page) |
695 * +---------------------------------+
697 * |(can be specific to SoC/Firmware)|
698 * +---------------------------------+
699 * >>>>>>>> END of METADATA <<<<<<<<<
700 * +---------------------------------+
703 * +---------------------------------+
706 static int fastrpc_get_meta_size(struct fastrpc_invoke_ctx *ctx)
710 size = (sizeof(struct fastrpc_remote_arg) +
711 sizeof(struct fastrpc_invoke_buf) +
712 sizeof(struct fastrpc_phy_page)) * ctx->nscalars +
713 sizeof(u64) * FASTRPC_MAX_FDLIST +
714 sizeof(u32) * FASTRPC_MAX_CRCLIST;
719 static u64 fastrpc_get_payload_size(struct fastrpc_invoke_ctx *ctx, int metalen)
724 size = ALIGN(metalen, FASTRPC_ALIGN);
725 for (oix = 0; oix < ctx->nbufs; oix++) {
726 int i = ctx->olaps[oix].raix;
728 if (ctx->args[i].fd == 0 || ctx->args[i].fd == -1) {
730 if (ctx->olaps[oix].offset == 0)
731 size = ALIGN(size, FASTRPC_ALIGN);
733 size += (ctx->olaps[oix].mend - ctx->olaps[oix].mstart);
740 static int fastrpc_create_maps(struct fastrpc_invoke_ctx *ctx)
742 struct device *dev = ctx->fl->sctx->dev;
745 for (i = 0; i < ctx->nscalars; ++i) {
746 /* Make sure reserved field is set to 0 */
747 if (ctx->args[i].reserved)
750 if (ctx->args[i].fd == 0 || ctx->args[i].fd == -1 ||
751 ctx->args[i].length == 0)
754 err = fastrpc_map_create(ctx->fl, ctx->args[i].fd,
755 ctx->args[i].length, &ctx->maps[i]);
757 dev_err(dev, "Error Creating map %d\n", err);
765 static int fastrpc_get_args(u32 kernel, struct fastrpc_invoke_ctx *ctx)
767 struct device *dev = ctx->fl->sctx->dev;
768 struct fastrpc_remote_arg *rpra;
769 struct fastrpc_invoke_buf *list;
770 struct fastrpc_phy_page *pages;
771 int inbufs, i, oix, err = 0;
772 u64 len, rlen, pkt_size;
773 u64 pg_start, pg_end;
777 inbufs = REMOTE_SCALARS_INBUFS(ctx->sc);
778 metalen = fastrpc_get_meta_size(ctx);
779 pkt_size = fastrpc_get_payload_size(ctx, metalen);
781 err = fastrpc_create_maps(ctx);
785 ctx->msg_sz = pkt_size;
787 err = fastrpc_buf_alloc(ctx->fl, dev, pkt_size, &ctx->buf);
791 rpra = ctx->buf->virt;
792 list = ctx->buf->virt + ctx->nscalars * sizeof(*rpra);
793 pages = ctx->buf->virt + ctx->nscalars * (sizeof(*list) +
795 args = (uintptr_t)ctx->buf->virt + metalen;
796 rlen = pkt_size - metalen;
799 for (oix = 0; oix < ctx->nbufs; ++oix) {
802 i = ctx->olaps[oix].raix;
803 len = ctx->args[i].length;
807 list[i].num = len ? 1 : 0;
814 struct vm_area_struct *vma = NULL;
816 rpra[i].pv = (u64) ctx->args[i].ptr;
817 pages[i].addr = ctx->maps[i]->phys;
819 mmap_read_lock(current->mm);
820 vma = find_vma(current->mm, ctx->args[i].ptr);
822 pages[i].addr += ctx->args[i].ptr -
824 mmap_read_unlock(current->mm);
826 pg_start = (ctx->args[i].ptr & PAGE_MASK) >> PAGE_SHIFT;
827 pg_end = ((ctx->args[i].ptr + len - 1) & PAGE_MASK) >>
829 pages[i].size = (pg_end - pg_start + 1) * PAGE_SIZE;
833 if (ctx->olaps[oix].offset == 0) {
834 rlen -= ALIGN(args, FASTRPC_ALIGN) - args;
835 args = ALIGN(args, FASTRPC_ALIGN);
838 mlen = ctx->olaps[oix].mend - ctx->olaps[oix].mstart;
843 rpra[i].pv = args - ctx->olaps[oix].offset;
844 pages[i].addr = ctx->buf->phys -
845 ctx->olaps[oix].offset +
847 pages[i].addr = pages[i].addr & PAGE_MASK;
849 pg_start = (args & PAGE_MASK) >> PAGE_SHIFT;
850 pg_end = ((args + len - 1) & PAGE_MASK) >> PAGE_SHIFT;
851 pages[i].size = (pg_end - pg_start + 1) * PAGE_SIZE;
856 if (i < inbufs && !ctx->maps[i]) {
857 void *dst = (void *)(uintptr_t)rpra[i].pv;
858 void *src = (void *)(uintptr_t)ctx->args[i].ptr;
861 if (copy_from_user(dst, (void __user *)src,
867 memcpy(dst, src, len);
872 for (i = ctx->nbufs; i < ctx->nscalars; ++i) {
873 rpra[i].pv = (u64) ctx->args[i].ptr;
874 rpra[i].len = ctx->args[i].length;
875 list[i].num = ctx->args[i].length ? 1 : 0;
877 pages[i].addr = ctx->maps[i]->phys;
878 pages[i].size = ctx->maps[i]->size;
883 dev_err(dev, "Error: get invoke args failed:%d\n", err);
888 static int fastrpc_put_args(struct fastrpc_invoke_ctx *ctx,
891 struct fastrpc_remote_arg *rpra = ctx->rpra;
894 inbufs = REMOTE_SCALARS_INBUFS(ctx->sc);
896 for (i = inbufs; i < ctx->nbufs; ++i) {
897 void *src = (void *)(uintptr_t)rpra[i].pv;
898 void *dst = (void *)(uintptr_t)ctx->args[i].ptr;
899 u64 len = rpra[i].len;
902 if (copy_to_user((void __user *)dst, src, len))
905 memcpy(dst, src, len);
912 static int fastrpc_invoke_send(struct fastrpc_session_ctx *sctx,
913 struct fastrpc_invoke_ctx *ctx,
914 u32 kernel, uint32_t handle)
916 struct fastrpc_channel_ctx *cctx;
917 struct fastrpc_user *fl = ctx->fl;
918 struct fastrpc_msg *msg = &ctx->msg;
923 msg->tid = current->pid;
928 msg->ctx = ctx->ctxid | fl->pd;
929 msg->handle = handle;
931 msg->addr = ctx->buf ? ctx->buf->phys : 0;
932 msg->size = roundup(ctx->msg_sz, PAGE_SIZE);
933 fastrpc_context_get(ctx);
935 ret = rpmsg_send(cctx->rpdev->ept, (void *)msg, sizeof(*msg));
938 fastrpc_context_put(ctx);
944 static int fastrpc_internal_invoke(struct fastrpc_user *fl, u32 kernel,
946 struct fastrpc_invoke_args *args)
948 struct fastrpc_invoke_ctx *ctx = NULL;
954 if (!fl->cctx->rpdev)
957 if (handle == FASTRPC_INIT_HANDLE && !kernel) {
958 dev_warn_ratelimited(fl->sctx->dev, "user app trying to send a kernel RPC message (%d)\n", handle);
962 ctx = fastrpc_context_alloc(fl, kernel, sc, args);
967 err = fastrpc_get_args(kernel, ctx);
972 /* make sure that all CPU memory writes are seen by DSP */
974 /* Send invoke buffer to remote dsp */
975 err = fastrpc_invoke_send(fl->sctx, ctx, kernel, handle);
980 if (!wait_for_completion_timeout(&ctx->work, 10 * HZ))
983 err = wait_for_completion_interruptible(&ctx->work);
989 /* Check the response from remote dsp */
995 /* make sure that all memory writes by DSP are seen by CPU */
997 /* populate all the output buffers with results */
998 err = fastrpc_put_args(ctx, kernel);
1004 if (err != -ERESTARTSYS && err != -ETIMEDOUT) {
1005 /* We are done with this compute context */
1006 spin_lock(&fl->lock);
1007 list_del(&ctx->node);
1008 spin_unlock(&fl->lock);
1009 fastrpc_context_put(ctx);
1012 dev_dbg(fl->sctx->dev, "Error: Invoke Failed %d\n", err);
1017 static int fastrpc_init_create_process(struct fastrpc_user *fl,
1020 struct fastrpc_init_create init;
1021 struct fastrpc_invoke_args *args;
1022 struct fastrpc_phy_page pages[1];
1023 struct fastrpc_map *map = NULL;
1024 struct fastrpc_buf *imem = NULL;
1037 args = kcalloc(FASTRPC_CREATE_PROCESS_NARGS, sizeof(*args), GFP_KERNEL);
1041 if (copy_from_user(&init, argp, sizeof(init))) {
1046 if (init.filelen > INIT_FILELEN_MAX) {
1051 inbuf.pgid = fl->tgid;
1052 inbuf.namelen = strlen(current->comm) + 1;
1053 inbuf.filelen = init.filelen;
1055 inbuf.attrs = init.attrs;
1056 inbuf.siglen = init.siglen;
1059 if (init.filelen && init.filefd) {
1060 err = fastrpc_map_create(fl, init.filefd, init.filelen, &map);
1065 memlen = ALIGN(max(INIT_FILELEN_MAX, (int)init.filelen * 4),
1067 err = fastrpc_buf_alloc(fl, fl->sctx->dev, memlen,
1072 fl->init_mem = imem;
1073 args[0].ptr = (u64)(uintptr_t)&inbuf;
1074 args[0].length = sizeof(inbuf);
1077 args[1].ptr = (u64)(uintptr_t)current->comm;
1078 args[1].length = inbuf.namelen;
1081 args[2].ptr = (u64) init.file;
1082 args[2].length = inbuf.filelen;
1083 args[2].fd = init.filefd;
1085 pages[0].addr = imem->phys;
1086 pages[0].size = imem->size;
1088 args[3].ptr = (u64)(uintptr_t) pages;
1089 args[3].length = 1 * sizeof(*pages);
1092 args[4].ptr = (u64)(uintptr_t)&inbuf.attrs;
1093 args[4].length = sizeof(inbuf.attrs);
1096 args[5].ptr = (u64)(uintptr_t) &inbuf.siglen;
1097 args[5].length = sizeof(inbuf.siglen);
1100 sc = FASTRPC_SCALARS(FASTRPC_RMID_INIT_CREATE, 4, 0);
1102 sc = FASTRPC_SCALARS(FASTRPC_RMID_INIT_CREATE_ATTR, 6, 0);
1104 err = fastrpc_internal_invoke(fl, true, FASTRPC_INIT_HANDLE,
1114 fl->init_mem = NULL;
1115 fastrpc_buf_free(imem);
1118 spin_lock(&fl->lock);
1119 list_del(&map->node);
1120 spin_unlock(&fl->lock);
1121 fastrpc_map_put(map);
1129 static struct fastrpc_session_ctx *fastrpc_session_alloc(
1130 struct fastrpc_channel_ctx *cctx)
1132 struct fastrpc_session_ctx *session = NULL;
1133 unsigned long flags;
1136 spin_lock_irqsave(&cctx->lock, flags);
1137 for (i = 0; i < cctx->sesscount; i++) {
1138 if (!cctx->session[i].used && cctx->session[i].valid) {
1139 cctx->session[i].used = true;
1140 session = &cctx->session[i];
1144 spin_unlock_irqrestore(&cctx->lock, flags);
1149 static void fastrpc_session_free(struct fastrpc_channel_ctx *cctx,
1150 struct fastrpc_session_ctx *session)
1152 unsigned long flags;
1154 spin_lock_irqsave(&cctx->lock, flags);
1155 session->used = false;
1156 spin_unlock_irqrestore(&cctx->lock, flags);
1159 static int fastrpc_release_current_dsp_process(struct fastrpc_user *fl)
1161 struct fastrpc_invoke_args args[1];
1166 args[0].ptr = (u64)(uintptr_t) &tgid;
1167 args[0].length = sizeof(tgid);
1169 args[0].reserved = 0;
1170 sc = FASTRPC_SCALARS(FASTRPC_RMID_INIT_RELEASE, 1, 0);
1172 return fastrpc_internal_invoke(fl, true, FASTRPC_INIT_HANDLE,
1176 static int fastrpc_device_release(struct inode *inode, struct file *file)
1178 struct fastrpc_user *fl = (struct fastrpc_user *)file->private_data;
1179 struct fastrpc_channel_ctx *cctx = fl->cctx;
1180 struct fastrpc_invoke_ctx *ctx, *n;
1181 struct fastrpc_map *map, *m;
1182 struct fastrpc_buf *buf, *b;
1183 unsigned long flags;
1185 fastrpc_release_current_dsp_process(fl);
1187 spin_lock_irqsave(&cctx->lock, flags);
1188 list_del(&fl->user);
1189 spin_unlock_irqrestore(&cctx->lock, flags);
1192 fastrpc_buf_free(fl->init_mem);
1194 list_for_each_entry_safe(ctx, n, &fl->pending, node) {
1195 list_del(&ctx->node);
1196 fastrpc_context_put(ctx);
1199 list_for_each_entry_safe(map, m, &fl->maps, node) {
1200 list_del(&map->node);
1201 fastrpc_map_put(map);
1204 list_for_each_entry_safe(buf, b, &fl->mmaps, node) {
1205 list_del(&buf->node);
1206 fastrpc_buf_free(buf);
1209 fastrpc_session_free(cctx, fl->sctx);
1210 fastrpc_channel_ctx_put(cctx);
1212 mutex_destroy(&fl->mutex);
1214 file->private_data = NULL;
1219 static int fastrpc_device_open(struct inode *inode, struct file *filp)
1221 struct fastrpc_channel_ctx *cctx = miscdev_to_cctx(filp->private_data);
1222 struct fastrpc_user *fl = NULL;
1223 unsigned long flags;
1225 fl = kzalloc(sizeof(*fl), GFP_KERNEL);
1229 /* Released in fastrpc_device_release() */
1230 fastrpc_channel_ctx_get(cctx);
1232 filp->private_data = fl;
1233 spin_lock_init(&fl->lock);
1234 mutex_init(&fl->mutex);
1235 INIT_LIST_HEAD(&fl->pending);
1236 INIT_LIST_HEAD(&fl->maps);
1237 INIT_LIST_HEAD(&fl->mmaps);
1238 INIT_LIST_HEAD(&fl->user);
1239 fl->tgid = current->tgid;
1242 fl->sctx = fastrpc_session_alloc(cctx);
1244 dev_err(&cctx->rpdev->dev, "No session available\n");
1245 mutex_destroy(&fl->mutex);
1251 spin_lock_irqsave(&cctx->lock, flags);
1252 list_add_tail(&fl->user, &cctx->users);
1253 spin_unlock_irqrestore(&cctx->lock, flags);
1258 static int fastrpc_dmabuf_alloc(struct fastrpc_user *fl, char __user *argp)
1260 struct fastrpc_alloc_dma_buf bp;
1261 DEFINE_DMA_BUF_EXPORT_INFO(exp_info);
1262 struct fastrpc_buf *buf = NULL;
1265 if (copy_from_user(&bp, argp, sizeof(bp)))
1268 err = fastrpc_buf_alloc(fl, fl->sctx->dev, bp.size, &buf);
1271 exp_info.ops = &fastrpc_dma_buf_ops;
1272 exp_info.size = bp.size;
1273 exp_info.flags = O_RDWR;
1274 exp_info.priv = buf;
1275 buf->dmabuf = dma_buf_export(&exp_info);
1276 if (IS_ERR(buf->dmabuf)) {
1277 err = PTR_ERR(buf->dmabuf);
1278 fastrpc_buf_free(buf);
1282 bp.fd = dma_buf_fd(buf->dmabuf, O_ACCMODE);
1284 dma_buf_put(buf->dmabuf);
1288 if (copy_to_user(argp, &bp, sizeof(bp))) {
1290 * The usercopy failed, but we can't do much about it, as
1291 * dma_buf_fd() already called fd_install() and made the
1292 * file descriptor accessible for the current process. It
1293 * might already be closed and dmabuf no longer valid when
1294 * we reach this point. Therefore "leak" the fd and rely on
1295 * the process exit path to do any required cleanup.
1303 static int fastrpc_init_attach(struct fastrpc_user *fl, int pd)
1305 struct fastrpc_invoke_args args[1];
1306 int tgid = fl->tgid;
1309 args[0].ptr = (u64)(uintptr_t) &tgid;
1310 args[0].length = sizeof(tgid);
1312 args[0].reserved = 0;
1313 sc = FASTRPC_SCALARS(FASTRPC_RMID_INIT_ATTACH, 1, 0);
1316 return fastrpc_internal_invoke(fl, true, FASTRPC_INIT_HANDLE,
1320 static int fastrpc_invoke(struct fastrpc_user *fl, char __user *argp)
1322 struct fastrpc_invoke_args *args = NULL;
1323 struct fastrpc_invoke inv;
1327 if (copy_from_user(&inv, argp, sizeof(inv)))
1330 /* nscalars is truncated here to max supported value */
1331 nscalars = REMOTE_SCALARS_LENGTH(inv.sc);
1333 args = kcalloc(nscalars, sizeof(*args), GFP_KERNEL);
1337 if (copy_from_user(args, (void __user *)(uintptr_t)inv.args,
1338 nscalars * sizeof(*args))) {
1344 err = fastrpc_internal_invoke(fl, false, inv.handle, inv.sc, args);
1350 static int fastrpc_req_munmap_impl(struct fastrpc_user *fl,
1351 struct fastrpc_req_munmap *req)
1353 struct fastrpc_invoke_args args[1] = { [0] = { 0 } };
1354 struct fastrpc_buf *buf = NULL, *iter, *b;
1355 struct fastrpc_munmap_req_msg req_msg;
1356 struct device *dev = fl->sctx->dev;
1360 spin_lock(&fl->lock);
1361 list_for_each_entry_safe(iter, b, &fl->mmaps, node) {
1362 if ((iter->raddr == req->vaddrout) && (iter->size == req->size)) {
1367 spin_unlock(&fl->lock);
1370 dev_err(dev, "mmap not in list\n");
1374 req_msg.pgid = fl->tgid;
1375 req_msg.size = buf->size;
1376 req_msg.vaddr = buf->raddr;
1378 args[0].ptr = (u64) (uintptr_t) &req_msg;
1379 args[0].length = sizeof(req_msg);
1381 sc = FASTRPC_SCALARS(FASTRPC_RMID_INIT_MUNMAP, 1, 0);
1382 err = fastrpc_internal_invoke(fl, true, FASTRPC_INIT_HANDLE, sc,
1385 dev_dbg(dev, "unmmap\tpt 0x%09lx OK\n", buf->raddr);
1386 spin_lock(&fl->lock);
1387 list_del(&buf->node);
1388 spin_unlock(&fl->lock);
1389 fastrpc_buf_free(buf);
1391 dev_err(dev, "unmmap\tpt 0x%09lx ERROR\n", buf->raddr);
1397 static int fastrpc_req_munmap(struct fastrpc_user *fl, char __user *argp)
1399 struct fastrpc_req_munmap req;
1401 if (copy_from_user(&req, argp, sizeof(req)))
1404 return fastrpc_req_munmap_impl(fl, &req);
1407 static int fastrpc_req_mmap(struct fastrpc_user *fl, char __user *argp)
1409 struct fastrpc_invoke_args args[3] = { [0 ... 2] = { 0 } };
1410 struct fastrpc_buf *buf = NULL;
1411 struct fastrpc_mmap_req_msg req_msg;
1412 struct fastrpc_mmap_rsp_msg rsp_msg;
1413 struct fastrpc_req_munmap req_unmap;
1414 struct fastrpc_phy_page pages;
1415 struct fastrpc_req_mmap req;
1416 struct device *dev = fl->sctx->dev;
1420 if (copy_from_user(&req, argp, sizeof(req)))
1423 if (req.flags != ADSP_MMAP_ADD_PAGES) {
1424 dev_err(dev, "flag not supported 0x%x\n", req.flags);
1429 dev_err(dev, "adding user allocated pages is not supported\n");
1433 err = fastrpc_buf_alloc(fl, fl->sctx->dev, req.size, &buf);
1435 dev_err(dev, "failed to allocate buffer\n");
1439 req_msg.pgid = fl->tgid;
1440 req_msg.flags = req.flags;
1441 req_msg.vaddr = req.vaddrin;
1442 req_msg.num = sizeof(pages);
1444 args[0].ptr = (u64) (uintptr_t) &req_msg;
1445 args[0].length = sizeof(req_msg);
1447 pages.addr = buf->phys;
1448 pages.size = buf->size;
1450 args[1].ptr = (u64) (uintptr_t) &pages;
1451 args[1].length = sizeof(pages);
1453 args[2].ptr = (u64) (uintptr_t) &rsp_msg;
1454 args[2].length = sizeof(rsp_msg);
1456 sc = FASTRPC_SCALARS(FASTRPC_RMID_INIT_MMAP, 2, 1);
1457 err = fastrpc_internal_invoke(fl, true, FASTRPC_INIT_HANDLE, sc,
1460 dev_err(dev, "mmap error (len 0x%08llx)\n", buf->size);
1464 /* update the buffer to be able to deallocate the memory on the DSP */
1465 buf->raddr = (uintptr_t) rsp_msg.vaddr;
1467 /* let the client know the address to use */
1468 req.vaddrout = rsp_msg.vaddr;
1470 spin_lock(&fl->lock);
1471 list_add_tail(&buf->node, &fl->mmaps);
1472 spin_unlock(&fl->lock);
1474 if (copy_to_user((void __user *)argp, &req, sizeof(req))) {
1475 /* unmap the memory and release the buffer */
1476 req_unmap.vaddrout = buf->raddr;
1477 req_unmap.size = buf->size;
1478 fastrpc_req_munmap_impl(fl, &req_unmap);
1482 dev_dbg(dev, "mmap\t\tpt 0x%09lx OK [len 0x%08llx]\n",
1483 buf->raddr, buf->size);
1488 fastrpc_buf_free(buf);
1493 static long fastrpc_device_ioctl(struct file *file, unsigned int cmd,
1496 struct fastrpc_user *fl = (struct fastrpc_user *)file->private_data;
1497 char __user *argp = (char __user *)arg;
1501 case FASTRPC_IOCTL_INVOKE:
1502 err = fastrpc_invoke(fl, argp);
1504 case FASTRPC_IOCTL_INIT_ATTACH:
1505 err = fastrpc_init_attach(fl, AUDIO_PD);
1507 case FASTRPC_IOCTL_INIT_ATTACH_SNS:
1508 err = fastrpc_init_attach(fl, SENSORS_PD);
1510 case FASTRPC_IOCTL_INIT_CREATE:
1511 err = fastrpc_init_create_process(fl, argp);
1513 case FASTRPC_IOCTL_ALLOC_DMA_BUFF:
1514 err = fastrpc_dmabuf_alloc(fl, argp);
1516 case FASTRPC_IOCTL_MMAP:
1517 err = fastrpc_req_mmap(fl, argp);
1519 case FASTRPC_IOCTL_MUNMAP:
1520 err = fastrpc_req_munmap(fl, argp);
1530 static const struct file_operations fastrpc_fops = {
1531 .open = fastrpc_device_open,
1532 .release = fastrpc_device_release,
1533 .unlocked_ioctl = fastrpc_device_ioctl,
1534 .compat_ioctl = fastrpc_device_ioctl,
1537 static int fastrpc_cb_probe(struct platform_device *pdev)
1539 struct fastrpc_channel_ctx *cctx;
1540 struct fastrpc_session_ctx *sess;
1541 struct device *dev = &pdev->dev;
1542 int i, sessions = 0;
1543 unsigned long flags;
1546 cctx = dev_get_drvdata(dev->parent);
1550 of_property_read_u32(dev->of_node, "qcom,nsessions", &sessions);
1552 spin_lock_irqsave(&cctx->lock, flags);
1553 sess = &cctx->session[cctx->sesscount];
1557 dev_set_drvdata(dev, sess);
1559 if (of_property_read_u32(dev->of_node, "reg", &sess->sid))
1560 dev_info(dev, "FastRPC Session ID not specified in DT\n");
1563 struct fastrpc_session_ctx *dup_sess;
1565 for (i = 1; i < sessions; i++) {
1566 if (cctx->sesscount++ >= FASTRPC_MAX_SESSIONS)
1568 dup_sess = &cctx->session[cctx->sesscount];
1569 memcpy(dup_sess, sess, sizeof(*dup_sess));
1573 spin_unlock_irqrestore(&cctx->lock, flags);
1574 rc = dma_set_mask(dev, DMA_BIT_MASK(32));
1576 dev_err(dev, "32-bit DMA enable failed\n");
1583 static int fastrpc_cb_remove(struct platform_device *pdev)
1585 struct fastrpc_channel_ctx *cctx = dev_get_drvdata(pdev->dev.parent);
1586 struct fastrpc_session_ctx *sess = dev_get_drvdata(&pdev->dev);
1587 unsigned long flags;
1590 spin_lock_irqsave(&cctx->lock, flags);
1591 for (i = 1; i < FASTRPC_MAX_SESSIONS; i++) {
1592 if (cctx->session[i].sid == sess->sid) {
1593 cctx->session[i].valid = false;
1597 spin_unlock_irqrestore(&cctx->lock, flags);
1602 static const struct of_device_id fastrpc_match_table[] = {
1603 { .compatible = "qcom,fastrpc-compute-cb", },
1607 static struct platform_driver fastrpc_cb_driver = {
1608 .probe = fastrpc_cb_probe,
1609 .remove = fastrpc_cb_remove,
1611 .name = "qcom,fastrpc-cb",
1612 .of_match_table = fastrpc_match_table,
1613 .suppress_bind_attrs = true,
1617 static int fastrpc_rpmsg_probe(struct rpmsg_device *rpdev)
1619 struct device *rdev = &rpdev->dev;
1620 struct fastrpc_channel_ctx *data;
1621 int i, err, domain_id = -1;
1624 err = of_property_read_string(rdev->of_node, "label", &domain);
1626 dev_info(rdev, "FastRPC Domain not specified in DT\n");
1630 for (i = 0; i <= CDSP_DOMAIN_ID; i++) {
1631 if (!strcmp(domains[i], domain)) {
1637 if (domain_id < 0) {
1638 dev_info(rdev, "FastRPC Invalid Domain ID %d\n", domain_id);
1642 data = kzalloc(sizeof(*data), GFP_KERNEL);
1646 data->miscdev.minor = MISC_DYNAMIC_MINOR;
1647 data->miscdev.name = devm_kasprintf(rdev, GFP_KERNEL, "fastrpc-%s",
1648 domains[domain_id]);
1649 data->miscdev.fops = &fastrpc_fops;
1650 err = misc_register(&data->miscdev);
1656 kref_init(&data->refcount);
1658 dev_set_drvdata(&rpdev->dev, data);
1659 dma_set_mask_and_coherent(rdev, DMA_BIT_MASK(32));
1660 INIT_LIST_HEAD(&data->users);
1661 spin_lock_init(&data->lock);
1662 idr_init(&data->ctx_idr);
1663 data->domain_id = domain_id;
1664 data->rpdev = rpdev;
1666 return of_platform_populate(rdev->of_node, NULL, NULL, rdev);
1669 static void fastrpc_notify_users(struct fastrpc_user *user)
1671 struct fastrpc_invoke_ctx *ctx;
1673 spin_lock(&user->lock);
1674 list_for_each_entry(ctx, &user->pending, node)
1675 complete(&ctx->work);
1676 spin_unlock(&user->lock);
1679 static void fastrpc_rpmsg_remove(struct rpmsg_device *rpdev)
1681 struct fastrpc_channel_ctx *cctx = dev_get_drvdata(&rpdev->dev);
1682 struct fastrpc_user *user;
1683 unsigned long flags;
1685 spin_lock_irqsave(&cctx->lock, flags);
1686 list_for_each_entry(user, &cctx->users, user)
1687 fastrpc_notify_users(user);
1688 spin_unlock_irqrestore(&cctx->lock, flags);
1690 misc_deregister(&cctx->miscdev);
1691 of_platform_depopulate(&rpdev->dev);
1694 fastrpc_channel_ctx_put(cctx);
1697 static int fastrpc_rpmsg_callback(struct rpmsg_device *rpdev, void *data,
1698 int len, void *priv, u32 addr)
1700 struct fastrpc_channel_ctx *cctx = dev_get_drvdata(&rpdev->dev);
1701 struct fastrpc_invoke_rsp *rsp = data;
1702 struct fastrpc_invoke_ctx *ctx;
1703 unsigned long flags;
1704 unsigned long ctxid;
1706 if (len < sizeof(*rsp))
1709 ctxid = ((rsp->ctx & FASTRPC_CTXID_MASK) >> 4);
1711 spin_lock_irqsave(&cctx->lock, flags);
1712 ctx = idr_find(&cctx->ctx_idr, ctxid);
1713 spin_unlock_irqrestore(&cctx->lock, flags);
1716 dev_err(&rpdev->dev, "No context ID matches response\n");
1720 ctx->retval = rsp->retval;
1721 complete(&ctx->work);
1724 * The DMA buffer associated with the context cannot be freed in
1725 * interrupt context so schedule it through a worker thread to
1726 * avoid a kernel BUG.
1728 schedule_work(&ctx->put_work);
1733 static const struct of_device_id fastrpc_rpmsg_of_match[] = {
1734 { .compatible = "qcom,fastrpc" },
1737 MODULE_DEVICE_TABLE(of, fastrpc_rpmsg_of_match);
1739 static struct rpmsg_driver fastrpc_driver = {
1740 .probe = fastrpc_rpmsg_probe,
1741 .remove = fastrpc_rpmsg_remove,
1742 .callback = fastrpc_rpmsg_callback,
1744 .name = "qcom,fastrpc",
1745 .of_match_table = fastrpc_rpmsg_of_match,
1749 static int fastrpc_init(void)
1753 ret = platform_driver_register(&fastrpc_cb_driver);
1755 pr_err("fastrpc: failed to register cb driver\n");
1759 ret = register_rpmsg_driver(&fastrpc_driver);
1761 pr_err("fastrpc: failed to register rpmsg driver\n");
1762 platform_driver_unregister(&fastrpc_cb_driver);
1768 module_init(fastrpc_init);
1770 static void fastrpc_exit(void)
1772 platform_driver_unregister(&fastrpc_cb_driver);
1773 unregister_rpmsg_driver(&fastrpc_driver);
1775 module_exit(fastrpc_exit);
1777 MODULE_LICENSE("GPL v2");