1 // SPDX-License-Identifier: GPL-2.0-only
3 /* Copyright (c) 2019-2021, The Linux Foundation. All rights reserved. */
4 /* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved. */
6 #include <asm/byteorder.h>
7 #include <linux/completion.h>
8 #include <linux/crc32.h>
9 #include <linux/delay.h>
10 #include <linux/dma-mapping.h>
11 #include <linux/kref.h>
12 #include <linux/list.h>
13 #include <linux/mhi.h>
15 #include <linux/moduleparam.h>
16 #include <linux/mutex.h>
17 #include <linux/pci.h>
18 #include <linux/scatterlist.h>
19 #include <linux/types.h>
20 #include <linux/uaccess.h>
21 #include <linux/workqueue.h>
22 #include <linux/wait.h>
23 #include <drm/drm_device.h>
24 #include <drm/drm_file.h>
25 #include <uapi/drm/qaic_accel.h>
29 #define MANAGE_MAGIC_NUMBER ((__force __le32)0x43494151) /* "QAIC" in little endian */
30 #define QAIC_DBC_Q_GAP SZ_256
31 #define QAIC_DBC_Q_BUF_ALIGN SZ_4K
32 #define QAIC_MANAGE_EXT_MSG_LENGTH SZ_64K /* Max DMA message length */
33 #define QAIC_WRAPPER_MAX_SIZE SZ_4K
34 #define QAIC_MHI_RETRY_WAIT_MS 100
35 #define QAIC_MHI_RETRY_MAX 20
37 static unsigned int control_resp_timeout_s = 60; /* 60 sec default */
38 module_param(control_resp_timeout_s, uint, 0600);
39 MODULE_PARM_DESC(control_resp_timeout_s, "Timeout for NNC responses from QSM");
48 * wire encoding structures for the manage protocol.
49 * All fields are little endian on the wire
52 __le32 crc32; /* crc of everything following this field in the message */
54 __le32 sequence_number;
55 __le32 len; /* length of this message */
56 __le32 count; /* number of transactions in this message */
57 __le32 handle; /* unique id to track the resources consumed */
58 __le32 partition_id; /* partition id for the request (signed) */
59 __le32 padding; /* must be 0 */
63 struct wire_msg_hdr hdr;
67 struct wire_trans_hdr {
72 /* Each message sent from driver to device are organized in a list of wrapper_msg */
74 struct list_head list;
75 struct kref ref_count;
76 u32 len; /* length of data to transfer */
77 struct wrapper_list *head;
80 struct wire_trans_hdr trans;
85 struct list_head list;
86 spinlock_t lock; /* Protects the list state during additions and removals */
89 struct wire_trans_passthrough {
90 struct wire_trans_hdr hdr;
94 struct wire_addr_size_pair {
99 struct wire_trans_dma_xfer {
100 struct wire_trans_hdr hdr;
105 struct wire_addr_size_pair data[];
108 /* Initiated by device to continue the DMA xfer of a large piece of data */
109 struct wire_trans_dma_xfer_cont {
110 struct wire_trans_hdr hdr;
116 struct wire_trans_activate_to_dev {
117 struct wire_trans_hdr hdr;
123 __le32 options; /* unused, but BIT(16) has meaning to the device */
126 struct wire_trans_activate_from_dev {
127 struct wire_trans_hdr hdr;
130 __le64 options; /* unused */
133 struct wire_trans_deactivate_from_dev {
134 struct wire_trans_hdr hdr;
139 struct wire_trans_terminate_to_dev {
140 struct wire_trans_hdr hdr;
145 struct wire_trans_terminate_from_dev {
146 struct wire_trans_hdr hdr;
151 struct wire_trans_status_to_dev {
152 struct wire_trans_hdr hdr;
155 struct wire_trans_status_from_dev {
156 struct wire_trans_hdr hdr;
163 struct wire_trans_validate_part_to_dev {
164 struct wire_trans_hdr hdr;
169 struct wire_trans_validate_part_from_dev {
170 struct wire_trans_hdr hdr;
175 struct xfer_queue_elem {
177 * Node in list of ongoing transfer request on control channel.
178 * Maintained by root device struct.
180 struct list_head list;
181 /* Sequence number of this transfer request */
183 /* This is used to wait on until completion of transfer request */
184 struct completion xfer_done;
185 /* Received data from device */
190 /* Node in list of DMA transfers which is used for cleanup */
191 struct list_head list;
192 /* SG table of memory used for DMA */
193 struct sg_table *sgt;
194 /* Array pages used for DMA */
195 struct page **page_list;
196 /* Number of pages used for DMA */
197 unsigned long nr_pages;
200 struct ioctl_resources {
201 /* List of all DMA transfers which is used later for cleanup */
202 struct list_head dma_xfers;
203 /* Base address of request queue which belongs to a DBC */
206 * Base bus address of request queue which belongs to a DBC. Response
207 * queue base bus address can be calculated by adding size of request
208 * queue to base bus address of request queue.
211 /* Total size of request queue and response queue in byte */
213 /* Total number of elements that can be queued in each of request and response queue */
215 /* Base address of response queue which belongs to a DBC */
217 /* Status of the NNC message received */
219 /* DBC id of the DBC received from device */
222 * DMA transfer request messages can be big in size and it may not be
223 * possible to send them in one shot. In such cases the messages are
224 * broken into chunks, this field stores ID of such chunks.
227 /* Total number of bytes transferred for a DMA xfer request */
228 u64 xferred_dma_size;
229 /* Header of transaction message received from user. Used during DMA xfer request. */
234 struct work_struct work;
235 struct qaic_device *qdev;
240 * Since we're working with little endian messages, its useful to be able to
241 * increment without filling a whole line with conversions back and forth just
242 * to add one(1) to a message count.
244 static __le32 incr_le32(__le32 val)
246 return cpu_to_le32(le32_to_cpu(val) + 1);
249 static u32 gen_crc(void *msg)
251 struct wrapper_list *wrappers = msg;
252 struct wrapper_msg *w;
255 list_for_each_entry(w, &wrappers->list, list)
256 crc = crc32(crc, &w->msg, w->len);
261 static u32 gen_crc_stub(void *msg)
266 static bool valid_crc(void *msg)
268 struct wire_msg_hdr *hdr = msg;
273 * The output of this algorithm is always converted to the native
276 crc = le32_to_cpu(hdr->crc32);
278 ret = (crc32(~0, msg, le32_to_cpu(hdr->len)) ^ ~0) == crc;
279 hdr->crc32 = cpu_to_le32(crc);
283 static bool valid_crc_stub(void *msg)
288 static void free_wrapper(struct kref *ref)
290 struct wrapper_msg *wrapper = container_of(ref, struct wrapper_msg, ref_count);
292 list_del(&wrapper->list);
296 static void save_dbc_buf(struct qaic_device *qdev, struct ioctl_resources *resources,
297 struct qaic_user *usr)
299 u32 dbc_id = resources->dbc_id;
301 if (resources->buf) {
302 wait_event_interruptible(qdev->dbc[dbc_id].dbc_release, !qdev->dbc[dbc_id].in_use);
303 qdev->dbc[dbc_id].req_q_base = resources->buf;
304 qdev->dbc[dbc_id].rsp_q_base = resources->rsp_q_base;
305 qdev->dbc[dbc_id].dma_addr = resources->dma_addr;
306 qdev->dbc[dbc_id].total_size = resources->total_size;
307 qdev->dbc[dbc_id].nelem = resources->nelem;
308 enable_dbc(qdev, dbc_id, usr);
309 qdev->dbc[dbc_id].in_use = true;
310 resources->buf = NULL;
314 static void free_dbc_buf(struct qaic_device *qdev, struct ioctl_resources *resources)
317 dma_free_coherent(&qdev->pdev->dev, resources->total_size, resources->buf,
318 resources->dma_addr);
319 resources->buf = NULL;
322 static void free_dma_xfers(struct qaic_device *qdev, struct ioctl_resources *resources)
324 struct dma_xfer *xfer;
328 list_for_each_entry_safe(xfer, x, &resources->dma_xfers, list) {
329 dma_unmap_sgtable(&qdev->pdev->dev, xfer->sgt, DMA_TO_DEVICE, 0);
330 sg_free_table(xfer->sgt);
332 for (i = 0; i < xfer->nr_pages; ++i)
333 put_page(xfer->page_list[i]);
334 kfree(xfer->page_list);
335 list_del(&xfer->list);
340 static struct wrapper_msg *add_wrapper(struct wrapper_list *wrappers, u32 size)
342 struct wrapper_msg *w = kzalloc(size, GFP_KERNEL);
346 list_add_tail(&w->list, &wrappers->list);
347 kref_init(&w->ref_count);
352 static int encode_passthrough(struct qaic_device *qdev, void *trans, struct wrapper_list *wrappers,
355 struct qaic_manage_trans_passthrough *in_trans = trans;
356 struct wire_trans_passthrough *out_trans;
357 struct wrapper_msg *trans_wrapper;
358 struct wrapper_msg *wrapper;
359 struct wire_msg *msg;
362 wrapper = list_first_entry(&wrappers->list, struct wrapper_msg, list);
364 msg_hdr_len = le32_to_cpu(msg->hdr.len);
366 if (in_trans->hdr.len % 8 != 0)
369 if (msg_hdr_len + in_trans->hdr.len > QAIC_MANAGE_EXT_MSG_LENGTH)
372 trans_wrapper = add_wrapper(wrappers,
373 offsetof(struct wrapper_msg, trans) + in_trans->hdr.len);
376 trans_wrapper->len = in_trans->hdr.len;
377 out_trans = (struct wire_trans_passthrough *)&trans_wrapper->trans;
379 memcpy(out_trans->data, in_trans->data, in_trans->hdr.len - sizeof(in_trans->hdr));
380 msg->hdr.len = cpu_to_le32(msg_hdr_len + in_trans->hdr.len);
381 msg->hdr.count = incr_le32(msg->hdr.count);
382 *user_len += in_trans->hdr.len;
383 out_trans->hdr.type = cpu_to_le32(QAIC_TRANS_PASSTHROUGH_TO_DEV);
384 out_trans->hdr.len = cpu_to_le32(in_trans->hdr.len);
389 /* returns error code for failure, 0 if enough pages alloc'd, 1 if dma_cont is needed */
390 static int find_and_map_user_pages(struct qaic_device *qdev,
391 struct qaic_manage_trans_dma_xfer *in_trans,
392 struct ioctl_resources *resources, struct dma_xfer *xfer)
394 unsigned long need_pages;
395 struct page **page_list;
396 unsigned long nr_pages;
397 struct sg_table *sgt;
402 xfer_start_addr = in_trans->addr + resources->xferred_dma_size;
404 need_pages = DIV_ROUND_UP(in_trans->size + offset_in_page(xfer_start_addr) -
405 resources->xferred_dma_size, PAGE_SIZE);
407 nr_pages = need_pages;
410 page_list = kmalloc_array(nr_pages, sizeof(*page_list), GFP_KERNEL | __GFP_NOWARN);
412 nr_pages = nr_pages / 2;
420 ret = get_user_pages_fast(xfer_start_addr, nr_pages, 0, page_list);
421 if (ret < 0 || ret != nr_pages) {
426 sgt = kmalloc(sizeof(*sgt), GFP_KERNEL);
432 ret = sg_alloc_table_from_pages(sgt, page_list, nr_pages,
433 offset_in_page(xfer_start_addr),
434 in_trans->size - resources->xferred_dma_size, GFP_KERNEL);
440 ret = dma_map_sgtable(&qdev->pdev->dev, sgt, DMA_TO_DEVICE, 0);
445 xfer->page_list = page_list;
446 xfer->nr_pages = nr_pages;
448 return need_pages > nr_pages ? 1 : 0;
455 for (i = 0; i < nr_pages; ++i)
456 put_page(page_list[i]);
462 /* returns error code for failure, 0 if everything was encoded, 1 if dma_cont is needed */
463 static int encode_addr_size_pairs(struct dma_xfer *xfer, struct wrapper_list *wrappers,
464 struct ioctl_resources *resources, u32 msg_hdr_len, u32 *size,
465 struct wire_trans_dma_xfer **out_trans)
467 struct wrapper_msg *trans_wrapper;
468 struct sg_table *sgt = xfer->sgt;
469 struct wire_addr_size_pair *asp;
470 struct scatterlist *sg;
471 struct wrapper_msg *w;
472 unsigned int dma_len;
481 *size = QAIC_MANAGE_EXT_MSG_LENGTH - msg_hdr_len - sizeof(**out_trans);
482 for_each_sgtable_sg(sgt, sg, i) {
483 *size -= sizeof(*asp);
484 /* Save 1K for possible follow-up transactions. */
491 trans_wrapper = add_wrapper(wrappers, QAIC_WRAPPER_MAX_SIZE);
494 *out_trans = (struct wire_trans_dma_xfer *)&trans_wrapper->trans;
496 asp = (*out_trans)->data;
497 boundary = (void *)trans_wrapper + QAIC_WRAPPER_MAX_SIZE;
503 for_each_sg(sgt->sgl, sg, nents_dma, i) {
504 asp->size = cpu_to_le64(dma_len);
505 dma_chunk_len += dma_len;
508 if ((void *)asp + sizeof(*asp) > boundary) {
509 w->len = (void *)asp - (void *)&w->msg;
511 w = add_wrapper(wrappers, QAIC_WRAPPER_MAX_SIZE);
514 boundary = (void *)w + QAIC_WRAPPER_MAX_SIZE;
515 asp = (struct wire_addr_size_pair *)&w->msg;
518 asp->addr = cpu_to_le64(sg_dma_address(sg));
519 dma_len = sg_dma_len(sg);
521 /* finalize the last segment */
522 asp->size = cpu_to_le64(dma_len);
523 w->len = (void *)asp + sizeof(*asp) - (void *)&w->msg;
525 dma_chunk_len += dma_len;
526 resources->xferred_dma_size += dma_chunk_len;
528 return nents_dma < nents ? 1 : 0;
531 static void cleanup_xfer(struct qaic_device *qdev, struct dma_xfer *xfer)
535 dma_unmap_sgtable(&qdev->pdev->dev, xfer->sgt, DMA_TO_DEVICE, 0);
536 sg_free_table(xfer->sgt);
538 for (i = 0; i < xfer->nr_pages; ++i)
539 put_page(xfer->page_list[i]);
540 kfree(xfer->page_list);
543 static int encode_dma(struct qaic_device *qdev, void *trans, struct wrapper_list *wrappers,
544 u32 *user_len, struct ioctl_resources *resources, struct qaic_user *usr)
546 struct qaic_manage_trans_dma_xfer *in_trans = trans;
547 struct wire_trans_dma_xfer *out_trans;
548 struct wrapper_msg *wrapper;
549 struct dma_xfer *xfer;
550 struct wire_msg *msg;
556 wrapper = list_first_entry(&wrappers->list, struct wrapper_msg, list);
558 msg_hdr_len = le32_to_cpu(msg->hdr.len);
560 if (msg_hdr_len > (UINT_MAX - QAIC_MANAGE_EXT_MSG_LENGTH))
563 /* There should be enough space to hold at least one ASP entry. */
564 if (msg_hdr_len + sizeof(*out_trans) + sizeof(struct wire_addr_size_pair) >
565 QAIC_MANAGE_EXT_MSG_LENGTH)
568 if (in_trans->addr + in_trans->size < in_trans->addr || !in_trans->size)
571 xfer = kmalloc(sizeof(*xfer), GFP_KERNEL);
575 ret = find_and_map_user_pages(qdev, in_trans, resources, xfer);
579 need_cont_dma = (bool)ret;
581 ret = encode_addr_size_pairs(xfer, wrappers, resources, msg_hdr_len, &size, &out_trans);
585 need_cont_dma = need_cont_dma || (bool)ret;
587 msg->hdr.len = cpu_to_le32(msg_hdr_len + size);
588 msg->hdr.count = incr_le32(msg->hdr.count);
590 out_trans->hdr.type = cpu_to_le32(QAIC_TRANS_DMA_XFER_TO_DEV);
591 out_trans->hdr.len = cpu_to_le32(size);
592 out_trans->tag = cpu_to_le32(in_trans->tag);
593 out_trans->count = cpu_to_le32((size - sizeof(*out_trans)) /
594 sizeof(struct wire_addr_size_pair));
596 *user_len += in_trans->hdr.len;
598 if (resources->dma_chunk_id) {
599 out_trans->dma_chunk_id = cpu_to_le32(resources->dma_chunk_id);
600 } else if (need_cont_dma) {
601 while (resources->dma_chunk_id == 0)
602 resources->dma_chunk_id = atomic_inc_return(&usr->chunk_id);
604 out_trans->dma_chunk_id = cpu_to_le32(resources->dma_chunk_id);
606 resources->trans_hdr = trans;
608 list_add(&xfer->list, &resources->dma_xfers);
612 cleanup_xfer(qdev, xfer);
618 static int encode_activate(struct qaic_device *qdev, void *trans, struct wrapper_list *wrappers,
619 u32 *user_len, struct ioctl_resources *resources)
621 struct qaic_manage_trans_activate_to_dev *in_trans = trans;
622 struct wire_trans_activate_to_dev *out_trans;
623 struct wrapper_msg *trans_wrapper;
624 struct wrapper_msg *wrapper;
625 struct wire_msg *msg;
633 wrapper = list_first_entry(&wrappers->list, struct wrapper_msg, list);
635 msg_hdr_len = le32_to_cpu(msg->hdr.len);
637 if (msg_hdr_len + sizeof(*out_trans) > QAIC_MANAGE_MAX_MSG_LENGTH)
640 if (!in_trans->queue_size)
646 nelem = in_trans->queue_size;
647 size = (get_dbc_req_elem_size() + get_dbc_rsp_elem_size()) * nelem;
648 if (size / nelem != get_dbc_req_elem_size() + get_dbc_rsp_elem_size())
651 if (size + QAIC_DBC_Q_GAP + QAIC_DBC_Q_BUF_ALIGN < size)
654 size = ALIGN((size + QAIC_DBC_Q_GAP), QAIC_DBC_Q_BUF_ALIGN);
656 buf = dma_alloc_coherent(&qdev->pdev->dev, size, &dma_addr, GFP_KERNEL);
660 trans_wrapper = add_wrapper(wrappers,
661 offsetof(struct wrapper_msg, trans) + sizeof(*out_trans));
662 if (!trans_wrapper) {
666 trans_wrapper->len = sizeof(*out_trans);
667 out_trans = (struct wire_trans_activate_to_dev *)&trans_wrapper->trans;
669 out_trans->hdr.type = cpu_to_le32(QAIC_TRANS_ACTIVATE_TO_DEV);
670 out_trans->hdr.len = cpu_to_le32(sizeof(*out_trans));
671 out_trans->buf_len = cpu_to_le32(size);
672 out_trans->req_q_addr = cpu_to_le64(dma_addr);
673 out_trans->req_q_size = cpu_to_le32(nelem);
674 out_trans->rsp_q_addr = cpu_to_le64(dma_addr + size - nelem * get_dbc_rsp_elem_size());
675 out_trans->rsp_q_size = cpu_to_le32(nelem);
676 out_trans->options = cpu_to_le32(in_trans->options);
678 *user_len += in_trans->hdr.len;
679 msg->hdr.len = cpu_to_le32(msg_hdr_len + sizeof(*out_trans));
680 msg->hdr.count = incr_le32(msg->hdr.count);
682 resources->buf = buf;
683 resources->dma_addr = dma_addr;
684 resources->total_size = size;
685 resources->nelem = nelem;
686 resources->rsp_q_base = buf + size - nelem * get_dbc_rsp_elem_size();
690 dma_free_coherent(&qdev->pdev->dev, size, buf, dma_addr);
694 static int encode_deactivate(struct qaic_device *qdev, void *trans,
695 u32 *user_len, struct qaic_user *usr)
697 struct qaic_manage_trans_deactivate *in_trans = trans;
699 if (in_trans->dbc_id >= qdev->num_dbc || in_trans->pad)
702 *user_len += in_trans->hdr.len;
704 return disable_dbc(qdev, in_trans->dbc_id, usr);
707 static int encode_status(struct qaic_device *qdev, void *trans, struct wrapper_list *wrappers,
710 struct qaic_manage_trans_status_to_dev *in_trans = trans;
711 struct wire_trans_status_to_dev *out_trans;
712 struct wrapper_msg *trans_wrapper;
713 struct wrapper_msg *wrapper;
714 struct wire_msg *msg;
717 wrapper = list_first_entry(&wrappers->list, struct wrapper_msg, list);
719 msg_hdr_len = le32_to_cpu(msg->hdr.len);
721 if (msg_hdr_len + in_trans->hdr.len > QAIC_MANAGE_MAX_MSG_LENGTH)
724 trans_wrapper = add_wrapper(wrappers, sizeof(*trans_wrapper));
728 trans_wrapper->len = sizeof(*out_trans);
729 out_trans = (struct wire_trans_status_to_dev *)&trans_wrapper->trans;
731 out_trans->hdr.type = cpu_to_le32(QAIC_TRANS_STATUS_TO_DEV);
732 out_trans->hdr.len = cpu_to_le32(in_trans->hdr.len);
733 msg->hdr.len = cpu_to_le32(msg_hdr_len + in_trans->hdr.len);
734 msg->hdr.count = incr_le32(msg->hdr.count);
735 *user_len += in_trans->hdr.len;
740 static int encode_message(struct qaic_device *qdev, struct manage_msg *user_msg,
741 struct wrapper_list *wrappers, struct ioctl_resources *resources,
742 struct qaic_user *usr)
744 struct qaic_manage_trans_hdr *trans_hdr;
745 struct wrapper_msg *wrapper;
746 struct wire_msg *msg;
751 if (!user_msg->count) {
756 wrapper = list_first_entry(&wrappers->list, struct wrapper_msg, list);
759 msg->hdr.len = cpu_to_le32(sizeof(msg->hdr));
761 if (resources->dma_chunk_id) {
762 ret = encode_dma(qdev, resources->trans_hdr, wrappers, &user_len, resources, usr);
763 msg->hdr.count = cpu_to_le32(1);
767 for (i = 0; i < user_msg->count; ++i) {
768 if (user_len >= user_msg->len) {
772 trans_hdr = (struct qaic_manage_trans_hdr *)(user_msg->data + user_len);
773 if (user_len + trans_hdr->len > user_msg->len) {
778 switch (trans_hdr->type) {
779 case QAIC_TRANS_PASSTHROUGH_FROM_USR:
780 ret = encode_passthrough(qdev, trans_hdr, wrappers, &user_len);
782 case QAIC_TRANS_DMA_XFER_FROM_USR:
783 ret = encode_dma(qdev, trans_hdr, wrappers, &user_len, resources, usr);
785 case QAIC_TRANS_ACTIVATE_FROM_USR:
786 ret = encode_activate(qdev, trans_hdr, wrappers, &user_len, resources);
788 case QAIC_TRANS_DEACTIVATE_FROM_USR:
789 ret = encode_deactivate(qdev, trans_hdr, &user_len, usr);
791 case QAIC_TRANS_STATUS_FROM_USR:
792 ret = encode_status(qdev, trans_hdr, wrappers, &user_len);
803 if (user_len != user_msg->len)
807 free_dma_xfers(qdev, resources);
808 free_dbc_buf(qdev, resources);
815 static int decode_passthrough(struct qaic_device *qdev, void *trans, struct manage_msg *user_msg,
818 struct qaic_manage_trans_passthrough *out_trans;
819 struct wire_trans_passthrough *in_trans = trans;
822 out_trans = (void *)user_msg->data + user_msg->len;
824 len = le32_to_cpu(in_trans->hdr.len);
828 if (user_msg->len + len > QAIC_MANAGE_MAX_MSG_LENGTH)
831 memcpy(out_trans->data, in_trans->data, len - sizeof(in_trans->hdr));
832 user_msg->len += len;
834 out_trans->hdr.type = le32_to_cpu(in_trans->hdr.type);
835 out_trans->hdr.len = len;
840 static int decode_activate(struct qaic_device *qdev, void *trans, struct manage_msg *user_msg,
841 u32 *msg_len, struct ioctl_resources *resources, struct qaic_user *usr)
843 struct qaic_manage_trans_activate_from_dev *out_trans;
844 struct wire_trans_activate_from_dev *in_trans = trans;
847 out_trans = (void *)user_msg->data + user_msg->len;
849 len = le32_to_cpu(in_trans->hdr.len);
850 if (user_msg->len + len > QAIC_MANAGE_MAX_MSG_LENGTH)
853 user_msg->len += len;
855 out_trans->hdr.type = le32_to_cpu(in_trans->hdr.type);
856 out_trans->hdr.len = len;
857 out_trans->status = le32_to_cpu(in_trans->status);
858 out_trans->dbc_id = le32_to_cpu(in_trans->dbc_id);
859 out_trans->options = le64_to_cpu(in_trans->options);
862 /* how did we get an activate response without a request? */
865 if (out_trans->dbc_id >= qdev->num_dbc)
867 * The device assigned an invalid resource, which should never
868 * happen. Return an error so the user can try to recover.
872 if (out_trans->status)
874 * Allocating resources failed on device side. This is not an
875 * expected behaviour, user is expected to handle this situation.
879 resources->status = out_trans->status;
880 resources->dbc_id = out_trans->dbc_id;
881 save_dbc_buf(qdev, resources, usr);
886 static int decode_deactivate(struct qaic_device *qdev, void *trans, u32 *msg_len,
887 struct qaic_user *usr)
889 struct wire_trans_deactivate_from_dev *in_trans = trans;
890 u32 dbc_id = le32_to_cpu(in_trans->dbc_id);
891 u32 status = le32_to_cpu(in_trans->status);
893 if (dbc_id >= qdev->num_dbc)
895 * The device assigned an invalid resource, which should never
896 * happen. Inject an error so the user can try to recover.
902 * Releasing resources failed on the device side, which puts
903 * us in a bind since they may still be in use, so enable the
904 * dbc. User is expected to retry deactivation.
906 enable_dbc(qdev, dbc_id, usr);
910 release_dbc(qdev, dbc_id);
911 *msg_len += sizeof(*in_trans);
916 static int decode_status(struct qaic_device *qdev, void *trans, struct manage_msg *user_msg,
917 u32 *user_len, struct wire_msg *msg)
919 struct qaic_manage_trans_status_from_dev *out_trans;
920 struct wire_trans_status_from_dev *in_trans = trans;
923 out_trans = (void *)user_msg->data + user_msg->len;
925 len = le32_to_cpu(in_trans->hdr.len);
926 if (user_msg->len + len > QAIC_MANAGE_MAX_MSG_LENGTH)
929 out_trans->hdr.type = QAIC_TRANS_STATUS_FROM_DEV;
930 out_trans->hdr.len = len;
931 out_trans->major = le16_to_cpu(in_trans->major);
932 out_trans->minor = le16_to_cpu(in_trans->minor);
933 out_trans->status_flags = le64_to_cpu(in_trans->status_flags);
934 out_trans->status = le32_to_cpu(in_trans->status);
935 *user_len += le32_to_cpu(in_trans->hdr.len);
936 user_msg->len += len;
938 if (out_trans->status)
940 if (out_trans->status_flags & BIT(0) && !valid_crc(msg))
946 static int decode_message(struct qaic_device *qdev, struct manage_msg *user_msg,
947 struct wire_msg *msg, struct ioctl_resources *resources,
948 struct qaic_user *usr)
950 u32 msg_hdr_len = le32_to_cpu(msg->hdr.len);
951 struct wire_trans_hdr *trans_hdr;
956 if (msg_hdr_len > QAIC_MANAGE_MAX_MSG_LENGTH)
960 user_msg->count = le32_to_cpu(msg->hdr.count);
962 for (i = 0; i < user_msg->count; ++i) {
963 trans_hdr = (struct wire_trans_hdr *)(msg->data + msg_len);
964 if (msg_len + le32_to_cpu(trans_hdr->len) > msg_hdr_len)
967 switch (le32_to_cpu(trans_hdr->type)) {
968 case QAIC_TRANS_PASSTHROUGH_FROM_DEV:
969 ret = decode_passthrough(qdev, trans_hdr, user_msg, &msg_len);
971 case QAIC_TRANS_ACTIVATE_FROM_DEV:
972 ret = decode_activate(qdev, trans_hdr, user_msg, &msg_len, resources, usr);
974 case QAIC_TRANS_DEACTIVATE_FROM_DEV:
975 ret = decode_deactivate(qdev, trans_hdr, &msg_len, usr);
977 case QAIC_TRANS_STATUS_FROM_DEV:
978 ret = decode_status(qdev, trans_hdr, user_msg, &msg_len, msg);
988 if (msg_len != (msg_hdr_len - sizeof(msg->hdr)))
994 static void *msg_xfer(struct qaic_device *qdev, struct wrapper_list *wrappers, u32 seq_num,
997 struct xfer_queue_elem elem;
998 struct wire_msg *out_buf;
999 struct wrapper_msg *w;
1004 if (qdev->in_reset) {
1005 mutex_unlock(&qdev->cntl_mutex);
1006 return ERR_PTR(-ENODEV);
1009 /* Attempt to avoid a partial commit of a message */
1010 list_for_each_entry(w, &wrappers->list, list)
1013 for (retry_count = 0; retry_count < QAIC_MHI_RETRY_MAX; retry_count++) {
1014 if (xfer_count <= mhi_get_free_desc_count(qdev->cntl_ch, DMA_TO_DEVICE)) {
1018 msleep_interruptible(QAIC_MHI_RETRY_WAIT_MS);
1019 if (signal_pending(current))
1024 mutex_unlock(&qdev->cntl_mutex);
1025 return ERR_PTR(ret);
1028 elem.seq_num = seq_num;
1030 init_completion(&elem.xfer_done);
1031 if (likely(!qdev->cntl_lost_buf)) {
1033 * The max size of request to device is QAIC_MANAGE_EXT_MSG_LENGTH.
1034 * The max size of response from device is QAIC_MANAGE_MAX_MSG_LENGTH.
1036 out_buf = kmalloc(QAIC_MANAGE_MAX_MSG_LENGTH, GFP_KERNEL);
1038 mutex_unlock(&qdev->cntl_mutex);
1039 return ERR_PTR(-ENOMEM);
1042 ret = mhi_queue_buf(qdev->cntl_ch, DMA_FROM_DEVICE, out_buf,
1043 QAIC_MANAGE_MAX_MSG_LENGTH, MHI_EOT);
1045 mutex_unlock(&qdev->cntl_mutex);
1046 return ERR_PTR(ret);
1050 * we lost a buffer because we queued a recv buf, but then
1051 * queuing the corresponding tx buf failed. To try to avoid
1052 * a memory leak, lets reclaim it and use it for this
1055 qdev->cntl_lost_buf = false;
1058 list_for_each_entry(w, &wrappers->list, list) {
1059 kref_get(&w->ref_count);
1061 ret = mhi_queue_buf(qdev->cntl_ch, DMA_TO_DEVICE, &w->msg, w->len,
1062 list_is_last(&w->list, &wrappers->list) ? MHI_EOT : MHI_CHAIN);
1064 qdev->cntl_lost_buf = true;
1065 kref_put(&w->ref_count, free_wrapper);
1066 mutex_unlock(&qdev->cntl_mutex);
1067 return ERR_PTR(ret);
1071 list_add_tail(&elem.list, &qdev->cntl_xfer_list);
1072 mutex_unlock(&qdev->cntl_mutex);
1075 ret = wait_for_completion_timeout(&elem.xfer_done, control_resp_timeout_s * HZ);
1077 ret = wait_for_completion_interruptible_timeout(&elem.xfer_done,
1078 control_resp_timeout_s * HZ);
1080 * not using _interruptable because we have to cleanup or we'll
1081 * likely cause memory corruption
1083 mutex_lock(&qdev->cntl_mutex);
1084 if (!list_empty(&elem.list))
1085 list_del(&elem.list);
1086 if (!ret && !elem.buf)
1088 else if (ret > 0 && !elem.buf)
1090 mutex_unlock(&qdev->cntl_mutex);
1094 return ERR_PTR(ret);
1095 } else if (!qdev->valid_crc(elem.buf)) {
1097 return ERR_PTR(-EPIPE);
1103 /* Add a transaction to abort the outstanding DMA continuation */
1104 static int abort_dma_cont(struct qaic_device *qdev, struct wrapper_list *wrappers, u32 dma_chunk_id)
1106 struct wire_trans_dma_xfer *out_trans;
1107 u32 size = sizeof(*out_trans);
1108 struct wrapper_msg *wrapper;
1109 struct wrapper_msg *w;
1110 struct wire_msg *msg;
1112 wrapper = list_first_entry(&wrappers->list, struct wrapper_msg, list);
1113 msg = &wrapper->msg;
1115 /* Remove all but the first wrapper which has the msg header */
1116 list_for_each_entry_safe(wrapper, w, &wrappers->list, list)
1117 if (!list_is_first(&wrapper->list, &wrappers->list))
1118 kref_put(&wrapper->ref_count, free_wrapper);
1120 wrapper = add_wrapper(wrappers, offsetof(struct wrapper_msg, trans) + sizeof(*out_trans));
1125 out_trans = (struct wire_trans_dma_xfer *)&wrapper->trans;
1126 out_trans->hdr.type = cpu_to_le32(QAIC_TRANS_DMA_XFER_TO_DEV);
1127 out_trans->hdr.len = cpu_to_le32(size);
1128 out_trans->tag = cpu_to_le32(0);
1129 out_trans->count = cpu_to_le32(0);
1130 out_trans->dma_chunk_id = cpu_to_le32(dma_chunk_id);
1132 msg->hdr.len = cpu_to_le32(size + sizeof(*msg));
1133 msg->hdr.count = cpu_to_le32(1);
1134 wrapper->len = size;
1139 static struct wrapper_list *alloc_wrapper_list(void)
1141 struct wrapper_list *wrappers;
1143 wrappers = kmalloc(sizeof(*wrappers), GFP_KERNEL);
1146 INIT_LIST_HEAD(&wrappers->list);
1147 spin_lock_init(&wrappers->lock);
1152 static int qaic_manage_msg_xfer(struct qaic_device *qdev, struct qaic_user *usr,
1153 struct manage_msg *user_msg, struct ioctl_resources *resources,
1154 struct wire_msg **rsp)
1156 struct wrapper_list *wrappers;
1157 struct wrapper_msg *wrapper;
1158 struct wrapper_msg *w;
1159 bool all_done = false;
1160 struct wire_msg *msg;
1163 wrappers = alloc_wrapper_list();
1167 wrapper = add_wrapper(wrappers, sizeof(*wrapper));
1173 msg = &wrapper->msg;
1174 wrapper->len = sizeof(*msg);
1176 ret = encode_message(qdev, user_msg, wrappers, resources, usr);
1177 if (ret && resources->dma_chunk_id)
1178 ret = abort_dma_cont(qdev, wrappers, resources->dma_chunk_id);
1182 ret = mutex_lock_interruptible(&qdev->cntl_mutex);
1186 msg->hdr.magic_number = MANAGE_MAGIC_NUMBER;
1187 msg->hdr.sequence_number = cpu_to_le32(qdev->next_seq_num++);
1190 msg->hdr.handle = cpu_to_le32(usr->handle);
1191 msg->hdr.partition_id = cpu_to_le32(usr->qddev->partition_id);
1193 msg->hdr.handle = 0;
1194 msg->hdr.partition_id = cpu_to_le32(QAIC_NO_PARTITION);
1197 msg->hdr.padding = cpu_to_le32(0);
1198 msg->hdr.crc32 = cpu_to_le32(qdev->gen_crc(wrappers));
1200 /* msg_xfer releases the mutex */
1201 *rsp = msg_xfer(qdev, wrappers, qdev->next_seq_num - 1, false);
1203 ret = PTR_ERR(*rsp);
1206 free_dma_xfers(qdev, resources);
1208 spin_lock(&wrappers->lock);
1209 list_for_each_entry_safe(wrapper, w, &wrappers->list, list)
1210 kref_put(&wrapper->ref_count, free_wrapper);
1211 all_done = list_empty(&wrappers->list);
1212 spin_unlock(&wrappers->lock);
1219 static int qaic_manage(struct qaic_device *qdev, struct qaic_user *usr, struct manage_msg *user_msg)
1221 struct wire_trans_dma_xfer_cont *dma_cont = NULL;
1222 struct ioctl_resources resources;
1223 struct wire_msg *rsp = NULL;
1226 memset(&resources, 0, sizeof(struct ioctl_resources));
1228 INIT_LIST_HEAD(&resources.dma_xfers);
1230 if (user_msg->len > QAIC_MANAGE_MAX_MSG_LENGTH ||
1231 user_msg->count > QAIC_MANAGE_MAX_MSG_LENGTH / sizeof(struct qaic_manage_trans_hdr))
1235 ret = qaic_manage_msg_xfer(qdev, usr, user_msg, &resources, &rsp);
1238 /* dma_cont should be the only transaction if present */
1239 if (le32_to_cpu(rsp->hdr.count) == 1) {
1240 dma_cont = (struct wire_trans_dma_xfer_cont *)rsp->data;
1241 if (le32_to_cpu(dma_cont->hdr.type) != QAIC_TRANS_DMA_XFER_CONT)
1245 if (le32_to_cpu(dma_cont->dma_chunk_id) == resources.dma_chunk_id &&
1246 le64_to_cpu(dma_cont->xferred_size) == resources.xferred_dma_size) {
1248 goto dma_xfer_continue;
1252 goto dma_cont_failed;
1255 ret = decode_message(qdev, user_msg, rsp, &resources, usr);
1258 free_dbc_buf(qdev, &resources);
1263 int qaic_manage_ioctl(struct drm_device *dev, void *data, struct drm_file *file_priv)
1265 struct qaic_manage_msg *user_msg = data;
1266 struct qaic_device *qdev;
1267 struct manage_msg *msg;
1268 struct qaic_user *usr;
1269 u8 __user *user_data;
1274 if (user_msg->len > QAIC_MANAGE_MAX_MSG_LENGTH)
1277 usr = file_priv->driver_priv;
1279 usr_rcu_id = srcu_read_lock(&usr->qddev_lock);
1281 srcu_read_unlock(&usr->qddev_lock, usr_rcu_id);
1285 qdev = usr->qddev->qdev;
1287 qdev_rcu_id = srcu_read_lock(&qdev->dev_lock);
1288 if (qdev->in_reset) {
1289 srcu_read_unlock(&qdev->dev_lock, qdev_rcu_id);
1290 srcu_read_unlock(&usr->qddev_lock, usr_rcu_id);
1294 msg = kzalloc(QAIC_MANAGE_MAX_MSG_LENGTH + sizeof(*msg), GFP_KERNEL);
1300 msg->len = user_msg->len;
1301 msg->count = user_msg->count;
1303 user_data = u64_to_user_ptr(user_msg->data);
1305 if (copy_from_user(msg->data, user_data, user_msg->len)) {
1310 ret = qaic_manage(qdev, usr, msg);
1313 * If the qaic_manage() is successful then we copy the message onto
1314 * userspace memory but we have an exception for -ECANCELED.
1315 * For -ECANCELED, it means that device has NACKed the message with a
1316 * status error code which userspace would like to know.
1318 if (ret == -ECANCELED || !ret) {
1319 if (copy_to_user(user_data, msg->data, msg->len)) {
1322 user_msg->len = msg->len;
1323 user_msg->count = msg->count;
1330 srcu_read_unlock(&qdev->dev_lock, qdev_rcu_id);
1331 srcu_read_unlock(&usr->qddev_lock, usr_rcu_id);
1335 int get_cntl_version(struct qaic_device *qdev, struct qaic_user *usr, u16 *major, u16 *minor)
1337 struct qaic_manage_trans_status_from_dev *status_result;
1338 struct qaic_manage_trans_status_to_dev *status_query;
1339 struct manage_msg *user_msg;
1342 user_msg = kmalloc(sizeof(*user_msg) + sizeof(*status_result), GFP_KERNEL);
1347 user_msg->len = sizeof(*status_query);
1348 user_msg->count = 1;
1350 status_query = (struct qaic_manage_trans_status_to_dev *)user_msg->data;
1351 status_query->hdr.type = QAIC_TRANS_STATUS_FROM_USR;
1352 status_query->hdr.len = sizeof(status_query->hdr);
1354 ret = qaic_manage(qdev, usr, user_msg);
1356 goto kfree_user_msg;
1357 status_result = (struct qaic_manage_trans_status_from_dev *)user_msg->data;
1358 *major = status_result->major;
1359 *minor = status_result->minor;
1361 if (status_result->status_flags & BIT(0)) { /* device is using CRC */
1362 /* By default qdev->gen_crc is programmed to generate CRC */
1363 qdev->valid_crc = valid_crc;
1365 /* By default qdev->valid_crc is programmed to bypass CRC */
1366 qdev->gen_crc = gen_crc_stub;
1375 static void resp_worker(struct work_struct *work)
1377 struct resp_work *resp = container_of(work, struct resp_work, work);
1378 struct qaic_device *qdev = resp->qdev;
1379 struct wire_msg *msg = resp->buf;
1380 struct xfer_queue_elem *elem;
1381 struct xfer_queue_elem *i;
1384 mutex_lock(&qdev->cntl_mutex);
1385 list_for_each_entry_safe(elem, i, &qdev->cntl_xfer_list, list) {
1386 if (elem->seq_num == le32_to_cpu(msg->hdr.sequence_number)) {
1388 list_del_init(&elem->list);
1390 complete_all(&elem->xfer_done);
1394 mutex_unlock(&qdev->cntl_mutex);
1397 /* request must have timed out, drop packet */
1403 static void free_wrapper_from_list(struct wrapper_list *wrappers, struct wrapper_msg *wrapper)
1405 bool all_done = false;
1407 spin_lock(&wrappers->lock);
1408 kref_put(&wrapper->ref_count, free_wrapper);
1409 all_done = list_empty(&wrappers->list);
1410 spin_unlock(&wrappers->lock);
1416 void qaic_mhi_ul_xfer_cb(struct mhi_device *mhi_dev, struct mhi_result *mhi_result)
1418 struct wire_msg *msg = mhi_result->buf_addr;
1419 struct wrapper_msg *wrapper = container_of(msg, struct wrapper_msg, msg);
1421 free_wrapper_from_list(wrapper->head, wrapper);
1424 void qaic_mhi_dl_xfer_cb(struct mhi_device *mhi_dev, struct mhi_result *mhi_result)
1426 struct qaic_device *qdev = dev_get_drvdata(&mhi_dev->dev);
1427 struct wire_msg *msg = mhi_result->buf_addr;
1428 struct resp_work *resp;
1430 if (mhi_result->transaction_status || msg->hdr.magic_number != MANAGE_MAGIC_NUMBER) {
1435 resp = kmalloc(sizeof(*resp), GFP_ATOMIC);
1441 INIT_WORK(&resp->work, resp_worker);
1444 queue_work(qdev->cntl_wq, &resp->work);
1447 int qaic_control_open(struct qaic_device *qdev)
1452 qdev->cntl_lost_buf = false;
1454 * By default qaic should assume that device has CRC enabled.
1455 * Qaic comes to know if device has CRC enabled or disabled during the
1456 * device status transaction, which is the first transaction performed
1457 * on control channel.
1459 * So CRC validation of first device status transaction response is
1460 * ignored (by calling valid_crc_stub) and is done later during decoding
1461 * if device has CRC enabled.
1462 * Now that qaic knows whether device has CRC enabled or not it acts
1465 qdev->gen_crc = gen_crc;
1466 qdev->valid_crc = valid_crc_stub;
1468 return mhi_prepare_for_transfer(qdev->cntl_ch);
1471 void qaic_control_close(struct qaic_device *qdev)
1473 mhi_unprepare_from_transfer(qdev->cntl_ch);
1476 void qaic_release_usr(struct qaic_device *qdev, struct qaic_user *usr)
1478 struct wire_trans_terminate_to_dev *trans;
1479 struct wrapper_list *wrappers;
1480 struct wrapper_msg *wrapper;
1481 struct wire_msg *msg;
1482 struct wire_msg *rsp;
1484 wrappers = alloc_wrapper_list();
1488 wrapper = add_wrapper(wrappers, sizeof(*wrapper) + sizeof(*msg) + sizeof(*trans));
1492 msg = &wrapper->msg;
1494 trans = (struct wire_trans_terminate_to_dev *)msg->data;
1496 trans->hdr.type = cpu_to_le32(QAIC_TRANS_TERMINATE_TO_DEV);
1497 trans->hdr.len = cpu_to_le32(sizeof(*trans));
1498 trans->handle = cpu_to_le32(usr->handle);
1500 mutex_lock(&qdev->cntl_mutex);
1501 wrapper->len = sizeof(msg->hdr) + sizeof(*trans);
1502 msg->hdr.magic_number = MANAGE_MAGIC_NUMBER;
1503 msg->hdr.sequence_number = cpu_to_le32(qdev->next_seq_num++);
1504 msg->hdr.len = cpu_to_le32(wrapper->len);
1505 msg->hdr.count = cpu_to_le32(1);
1506 msg->hdr.handle = cpu_to_le32(usr->handle);
1507 msg->hdr.padding = cpu_to_le32(0);
1508 msg->hdr.crc32 = cpu_to_le32(qdev->gen_crc(wrappers));
1511 * msg_xfer releases the mutex
1512 * We don't care about the return of msg_xfer since we will not do
1513 * anything different based on what happens.
1514 * We ignore pending signals since one will be set if the user is
1515 * killed, and we need give the device a chance to cleanup, otherwise
1516 * DMA may still be in progress when we return.
1518 rsp = msg_xfer(qdev, wrappers, qdev->next_seq_num - 1, true);
1521 free_wrapper_from_list(wrappers, wrapper);
1524 void wake_all_cntl(struct qaic_device *qdev)
1526 struct xfer_queue_elem *elem;
1527 struct xfer_queue_elem *i;
1529 mutex_lock(&qdev->cntl_mutex);
1530 list_for_each_entry_safe(elem, i, &qdev->cntl_xfer_list, list) {
1531 list_del_init(&elem->list);
1532 complete_all(&elem->xfer_done);
1534 mutex_unlock(&qdev->cntl_mutex);