1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2020-2023 Intel Corporation
6 #include <linux/genalloc.h>
7 #include <linux/highmem.h>
8 #include <linux/kthread.h>
9 #include <linux/pm_runtime.h>
10 #include <linux/wait.h>
15 #include "ivpu_hw_reg_io.h"
17 #include "ivpu_jsm_msg.h"
20 #define IPC_MAX_RX_MSG 128
21 #define IS_KTHREAD() (get_current()->flags & PF_KTHREAD)
23 struct ivpu_ipc_tx_buf {
24 struct ivpu_ipc_hdr ipc;
25 struct vpu_jsm_msg jsm;
28 struct ivpu_ipc_rx_msg {
29 struct list_head link;
30 struct ivpu_ipc_hdr *ipc_hdr;
31 struct vpu_jsm_msg *jsm_msg;
34 static void ivpu_ipc_msg_dump(struct ivpu_device *vdev, char *c,
35 struct ivpu_ipc_hdr *ipc_hdr, u32 vpu_addr)
38 "%s: vpu:0x%x (data_addr:0x%08x, data_size:0x%x, channel:0x%x, src_node:0x%x, dst_node:0x%x, status:0x%x)",
39 c, vpu_addr, ipc_hdr->data_addr, ipc_hdr->data_size, ipc_hdr->channel,
40 ipc_hdr->src_node, ipc_hdr->dst_node, ipc_hdr->status);
43 static void ivpu_jsm_msg_dump(struct ivpu_device *vdev, char *c,
44 struct vpu_jsm_msg *jsm_msg, u32 vpu_addr)
46 u32 *payload = (u32 *)&jsm_msg->payload;
49 "%s: vpu:0x%08x (type:%s, status:0x%x, id: 0x%x, result: 0x%x, payload:0x%x 0x%x 0x%x 0x%x 0x%x)\n",
50 c, vpu_addr, ivpu_jsm_msg_type_to_str(jsm_msg->type),
51 jsm_msg->status, jsm_msg->request_id, jsm_msg->result,
52 payload[0], payload[1], payload[2], payload[3], payload[4]);
56 ivpu_ipc_rx_mark_free(struct ivpu_device *vdev, struct ivpu_ipc_hdr *ipc_hdr,
57 struct vpu_jsm_msg *jsm_msg)
59 ipc_hdr->status = IVPU_IPC_HDR_FREE;
61 jsm_msg->status = VPU_JSM_MSG_FREE;
62 wmb(); /* Flush WC buffers for message statuses */
65 static void ivpu_ipc_mem_fini(struct ivpu_device *vdev)
67 struct ivpu_ipc_info *ipc = vdev->ipc;
69 ivpu_bo_free_internal(ipc->mem_rx);
70 ivpu_bo_free_internal(ipc->mem_tx);
74 ivpu_ipc_tx_prepare(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons,
75 struct vpu_jsm_msg *req)
77 struct ivpu_ipc_info *ipc = vdev->ipc;
78 struct ivpu_ipc_tx_buf *tx_buf;
82 tx_buf_vpu_addr = gen_pool_alloc(ipc->mm_tx, sizeof(*tx_buf));
83 if (!tx_buf_vpu_addr) {
84 ivpu_err_ratelimited(vdev, "Failed to reserve IPC buffer, size %ld\n",
89 tx_buf = ivpu_to_cpu_addr(ipc->mem_tx, tx_buf_vpu_addr);
90 if (drm_WARN_ON(&vdev->drm, !tx_buf)) {
91 gen_pool_free(ipc->mm_tx, tx_buf_vpu_addr, sizeof(*tx_buf));
95 jsm_vpu_addr = tx_buf_vpu_addr + offsetof(struct ivpu_ipc_tx_buf, jsm);
97 if (tx_buf->ipc.status != IVPU_IPC_HDR_FREE)
98 ivpu_warn_ratelimited(vdev, "IPC message vpu:0x%x not released by firmware\n",
101 if (tx_buf->jsm.status != VPU_JSM_MSG_FREE)
102 ivpu_warn_ratelimited(vdev, "JSM message vpu:0x%x not released by firmware\n",
105 memset(tx_buf, 0, sizeof(*tx_buf));
106 tx_buf->ipc.data_addr = jsm_vpu_addr;
107 /* TODO: Set data_size to actual JSM message size, not union of all messages */
108 tx_buf->ipc.data_size = sizeof(*req);
109 tx_buf->ipc.channel = cons->channel;
110 tx_buf->ipc.src_node = 0;
111 tx_buf->ipc.dst_node = 1;
112 tx_buf->ipc.status = IVPU_IPC_HDR_ALLOCATED;
113 tx_buf->jsm.type = req->type;
114 tx_buf->jsm.status = VPU_JSM_MSG_ALLOCATED;
115 tx_buf->jsm.payload = req->payload;
117 req->request_id = atomic_inc_return(&ipc->request_id);
118 tx_buf->jsm.request_id = req->request_id;
119 cons->request_id = req->request_id;
120 wmb(); /* Flush WC buffers for IPC, JSM msgs */
122 cons->tx_vpu_addr = tx_buf_vpu_addr;
124 ivpu_jsm_msg_dump(vdev, "TX", &tx_buf->jsm, jsm_vpu_addr);
125 ivpu_ipc_msg_dump(vdev, "TX", &tx_buf->ipc, tx_buf_vpu_addr);
130 static void ivpu_ipc_tx_release(struct ivpu_device *vdev, u32 vpu_addr)
132 struct ivpu_ipc_info *ipc = vdev->ipc;
135 gen_pool_free(ipc->mm_tx, vpu_addr, sizeof(struct ivpu_ipc_tx_buf));
138 static void ivpu_ipc_tx(struct ivpu_device *vdev, u32 vpu_addr)
140 ivpu_hw_reg_ipc_tx_set(vdev, vpu_addr);
144 ivpu_ipc_consumer_add(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons, u32 channel)
146 struct ivpu_ipc_info *ipc = vdev->ipc;
148 INIT_LIST_HEAD(&cons->link);
149 cons->channel = channel;
150 cons->tx_vpu_addr = 0;
151 cons->request_id = 0;
152 cons->aborted = false;
153 spin_lock_init(&cons->rx_lock);
154 INIT_LIST_HEAD(&cons->rx_msg_list);
155 init_waitqueue_head(&cons->rx_msg_wq);
157 spin_lock_irq(&ipc->cons_list_lock);
158 list_add_tail(&cons->link, &ipc->cons_list);
159 spin_unlock_irq(&ipc->cons_list_lock);
162 void ivpu_ipc_consumer_del(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons)
164 struct ivpu_ipc_info *ipc = vdev->ipc;
165 struct ivpu_ipc_rx_msg *rx_msg, *r;
167 spin_lock_irq(&ipc->cons_list_lock);
168 list_del(&cons->link);
169 spin_unlock_irq(&ipc->cons_list_lock);
171 spin_lock_irq(&cons->rx_lock);
172 list_for_each_entry_safe(rx_msg, r, &cons->rx_msg_list, link) {
173 list_del(&rx_msg->link);
175 ivpu_ipc_rx_mark_free(vdev, rx_msg->ipc_hdr, rx_msg->jsm_msg);
176 atomic_dec(&ipc->rx_msg_count);
179 spin_unlock_irq(&cons->rx_lock);
181 ivpu_ipc_tx_release(vdev, cons->tx_vpu_addr);
185 ivpu_ipc_send(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons, struct vpu_jsm_msg *req)
187 struct ivpu_ipc_info *ipc = vdev->ipc;
190 mutex_lock(&ipc->lock);
197 ret = ivpu_ipc_tx_prepare(vdev, cons, req);
201 ivpu_ipc_tx(vdev, cons->tx_vpu_addr);
204 mutex_unlock(&ipc->lock);
208 static int ivpu_ipc_rx_need_wakeup(struct ivpu_ipc_consumer *cons)
213 ret |= (kthread_should_stop() || kthread_should_park());
215 spin_lock_irq(&cons->rx_lock);
216 ret |= !list_empty(&cons->rx_msg_list) || cons->aborted;
217 spin_unlock_irq(&cons->rx_lock);
222 int ivpu_ipc_receive(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons,
223 struct ivpu_ipc_hdr *ipc_buf,
224 struct vpu_jsm_msg *ipc_payload, unsigned long timeout_ms)
226 struct ivpu_ipc_info *ipc = vdev->ipc;
227 struct ivpu_ipc_rx_msg *rx_msg;
228 int wait_ret, ret = 0;
230 wait_ret = wait_event_timeout(cons->rx_msg_wq,
231 ivpu_ipc_rx_need_wakeup(cons),
232 msecs_to_jiffies(timeout_ms));
234 if (IS_KTHREAD() && kthread_should_stop())
240 spin_lock_irq(&cons->rx_lock);
242 spin_unlock_irq(&cons->rx_lock);
245 rx_msg = list_first_entry_or_null(&cons->rx_msg_list, struct ivpu_ipc_rx_msg, link);
247 spin_unlock_irq(&cons->rx_lock);
250 list_del(&rx_msg->link);
251 spin_unlock_irq(&cons->rx_lock);
254 memcpy(ipc_buf, rx_msg->ipc_hdr, sizeof(*ipc_buf));
255 if (rx_msg->jsm_msg) {
256 u32 size = min_t(int, rx_msg->ipc_hdr->data_size, sizeof(*ipc_payload));
258 if (rx_msg->jsm_msg->result != VPU_JSM_STATUS_SUCCESS) {
259 ivpu_dbg(vdev, IPC, "IPC resp result error: %d\n", rx_msg->jsm_msg->result);
264 memcpy(ipc_payload, rx_msg->jsm_msg, size);
267 ivpu_ipc_rx_mark_free(vdev, rx_msg->ipc_hdr, rx_msg->jsm_msg);
268 atomic_dec(&ipc->rx_msg_count);
275 ivpu_ipc_send_receive_internal(struct ivpu_device *vdev, struct vpu_jsm_msg *req,
276 enum vpu_ipc_msg_type expected_resp_type,
277 struct vpu_jsm_msg *resp, u32 channel,
278 unsigned long timeout_ms)
280 struct ivpu_ipc_consumer cons;
283 ivpu_ipc_consumer_add(vdev, &cons, channel);
285 ret = ivpu_ipc_send(vdev, &cons, req);
287 ivpu_warn_ratelimited(vdev, "IPC send failed: %d\n", ret);
291 ret = ivpu_ipc_receive(vdev, &cons, NULL, resp, timeout_ms);
293 ivpu_warn_ratelimited(vdev, "IPC receive failed: type %s, ret %d\n",
294 ivpu_jsm_msg_type_to_str(req->type), ret);
298 if (resp->type != expected_resp_type) {
299 ivpu_warn_ratelimited(vdev, "Invalid JSM response type: 0x%x\n", resp->type);
304 ivpu_ipc_consumer_del(vdev, &cons);
308 int ivpu_ipc_send_receive_active(struct ivpu_device *vdev, struct vpu_jsm_msg *req,
309 enum vpu_ipc_msg_type expected_resp, struct vpu_jsm_msg *resp,
310 u32 channel, unsigned long timeout_ms)
312 struct vpu_jsm_msg hb_req = { .type = VPU_JSM_MSG_QUERY_ENGINE_HB };
313 struct vpu_jsm_msg hb_resp;
316 drm_WARN_ON(&vdev->drm, pm_runtime_status_suspended(vdev->drm.dev));
318 ret = ivpu_ipc_send_receive_internal(vdev, req, expected_resp, resp, channel, timeout_ms);
319 if (ret != -ETIMEDOUT)
322 hb_ret = ivpu_ipc_send_receive_internal(vdev, &hb_req, VPU_JSM_MSG_QUERY_ENGINE_HB_DONE,
323 &hb_resp, VPU_IPC_CHAN_ASYNC_CMD,
325 if (hb_ret == -ETIMEDOUT) {
326 ivpu_hw_diagnose_failure(vdev);
327 ivpu_pm_schedule_recovery(vdev);
333 int ivpu_ipc_send_receive(struct ivpu_device *vdev, struct vpu_jsm_msg *req,
334 enum vpu_ipc_msg_type expected_resp, struct vpu_jsm_msg *resp,
335 u32 channel, unsigned long timeout_ms)
339 ret = ivpu_rpm_get(vdev);
343 ret = ivpu_ipc_send_receive_active(vdev, req, expected_resp, resp, channel, timeout_ms);
350 ivpu_ipc_match_consumer(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons,
351 struct ivpu_ipc_hdr *ipc_hdr, struct vpu_jsm_msg *jsm_msg)
353 if (cons->channel != ipc_hdr->channel)
356 if (!jsm_msg || jsm_msg->request_id == cons->request_id)
363 ivpu_ipc_dispatch(struct ivpu_device *vdev, struct ivpu_ipc_consumer *cons,
364 struct ivpu_ipc_hdr *ipc_hdr, struct vpu_jsm_msg *jsm_msg)
366 struct ivpu_ipc_info *ipc = vdev->ipc;
367 struct ivpu_ipc_rx_msg *rx_msg;
369 lockdep_assert_held(&ipc->cons_list_lock);
370 lockdep_assert_irqs_disabled();
372 rx_msg = kzalloc(sizeof(*rx_msg), GFP_ATOMIC);
374 ivpu_ipc_rx_mark_free(vdev, ipc_hdr, jsm_msg);
378 atomic_inc(&ipc->rx_msg_count);
380 rx_msg->ipc_hdr = ipc_hdr;
381 rx_msg->jsm_msg = jsm_msg;
383 spin_lock(&cons->rx_lock);
384 list_add_tail(&rx_msg->link, &cons->rx_msg_list);
385 spin_unlock(&cons->rx_lock);
387 wake_up(&cons->rx_msg_wq);
390 int ivpu_ipc_irq_handler(struct ivpu_device *vdev)
392 struct ivpu_ipc_info *ipc = vdev->ipc;
393 struct ivpu_ipc_consumer *cons;
394 struct ivpu_ipc_hdr *ipc_hdr;
395 struct vpu_jsm_msg *jsm_msg;
401 * Driver needs to purge all messages from IPC FIFO to clear IPC interrupt.
402 * Without purge IPC FIFO to 0 next IPC interrupts won't be generated.
404 while (ivpu_hw_reg_ipc_rx_count_get(vdev)) {
405 vpu_addr = ivpu_hw_reg_ipc_rx_addr_get(vdev);
406 if (vpu_addr == REG_IO_ERROR) {
407 ivpu_err_ratelimited(vdev, "Failed to read IPC rx addr register\n");
411 ipc_hdr = ivpu_to_cpu_addr(ipc->mem_rx, vpu_addr);
413 ivpu_warn_ratelimited(vdev, "IPC msg 0x%x out of range\n", vpu_addr);
416 ivpu_ipc_msg_dump(vdev, "RX", ipc_hdr, vpu_addr);
419 if (ipc_hdr->channel != IVPU_IPC_CHAN_BOOT_MSG) {
420 jsm_msg = ivpu_to_cpu_addr(ipc->mem_rx, ipc_hdr->data_addr);
422 ivpu_warn_ratelimited(vdev, "JSM msg 0x%x out of range\n",
424 ivpu_ipc_rx_mark_free(vdev, ipc_hdr, NULL);
427 ivpu_jsm_msg_dump(vdev, "RX", jsm_msg, ipc_hdr->data_addr);
430 if (atomic_read(&ipc->rx_msg_count) > IPC_MAX_RX_MSG) {
431 ivpu_warn_ratelimited(vdev, "IPC RX msg dropped, msg count %d\n",
433 ivpu_ipc_rx_mark_free(vdev, ipc_hdr, jsm_msg);
438 spin_lock_irqsave(&ipc->cons_list_lock, flags);
439 list_for_each_entry(cons, &ipc->cons_list, link) {
440 if (ivpu_ipc_match_consumer(vdev, cons, ipc_hdr, jsm_msg)) {
441 ivpu_ipc_dispatch(vdev, cons, ipc_hdr, jsm_msg);
446 spin_unlock_irqrestore(&ipc->cons_list_lock, flags);
449 ivpu_dbg(vdev, IPC, "IPC RX msg 0x%x dropped (no consumer)\n", vpu_addr);
450 ivpu_ipc_rx_mark_free(vdev, ipc_hdr, jsm_msg);
457 int ivpu_ipc_init(struct ivpu_device *vdev)
459 struct ivpu_ipc_info *ipc = vdev->ipc;
462 ipc->mem_tx = ivpu_bo_alloc_internal(vdev, 0, SZ_16K, DRM_IVPU_BO_WC);
464 ivpu_err(vdev, "Failed to allocate mem_tx\n");
468 ipc->mem_rx = ivpu_bo_alloc_internal(vdev, 0, SZ_16K, DRM_IVPU_BO_WC);
470 ivpu_err(vdev, "Failed to allocate mem_rx\n");
475 ipc->mm_tx = devm_gen_pool_create(vdev->drm.dev, __ffs(IVPU_IPC_ALIGNMENT),
477 if (IS_ERR(ipc->mm_tx)) {
478 ret = PTR_ERR(ipc->mm_tx);
479 ivpu_err(vdev, "Failed to create gen pool, %pe\n", ipc->mm_tx);
483 ret = gen_pool_add(ipc->mm_tx, ipc->mem_tx->vpu_addr, ivpu_bo_size(ipc->mem_tx), -1);
485 ivpu_err(vdev, "gen_pool_add failed, ret %d\n", ret);
489 INIT_LIST_HEAD(&ipc->cons_list);
490 spin_lock_init(&ipc->cons_list_lock);
491 drmm_mutex_init(&vdev->drm, &ipc->lock);
493 ivpu_ipc_reset(vdev);
497 ivpu_bo_free_internal(ipc->mem_rx);
499 ivpu_bo_free_internal(ipc->mem_tx);
503 void ivpu_ipc_fini(struct ivpu_device *vdev)
505 ivpu_ipc_mem_fini(vdev);
508 void ivpu_ipc_enable(struct ivpu_device *vdev)
510 struct ivpu_ipc_info *ipc = vdev->ipc;
512 mutex_lock(&ipc->lock);
514 mutex_unlock(&ipc->lock);
517 void ivpu_ipc_disable(struct ivpu_device *vdev)
519 struct ivpu_ipc_info *ipc = vdev->ipc;
520 struct ivpu_ipc_consumer *cons, *c;
523 mutex_lock(&ipc->lock);
525 mutex_unlock(&ipc->lock);
527 spin_lock_irqsave(&ipc->cons_list_lock, flags);
528 list_for_each_entry_safe(cons, c, &ipc->cons_list, link) {
529 if (cons->channel != VPU_IPC_CHAN_JOB_RET) {
530 spin_lock(&cons->rx_lock);
531 cons->aborted = true;
532 spin_unlock(&cons->rx_lock);
534 wake_up(&cons->rx_msg_wq);
536 spin_unlock_irqrestore(&ipc->cons_list_lock, flags);
539 void ivpu_ipc_reset(struct ivpu_device *vdev)
541 struct ivpu_ipc_info *ipc = vdev->ipc;
543 mutex_lock(&ipc->lock);
544 drm_WARN_ON(&vdev->drm, ipc->on);
546 memset(ivpu_bo_vaddr(ipc->mem_tx), 0, ivpu_bo_size(ipc->mem_tx));
547 memset(ivpu_bo_vaddr(ipc->mem_rx), 0, ivpu_bo_size(ipc->mem_rx));
548 wmb(); /* Flush WC buffers for TX and RX rings */
550 mutex_unlock(&ipc->lock);