1 // SPDX-License-Identifier: GPL-2.0
3 // Copyright (c) 2018 MediaTek Inc.
5 #include <linux/bitops.h>
7 #include <linux/clk-provider.h>
8 #include <linux/dma-mapping.h>
9 #include <linux/errno.h>
10 #include <linux/interrupt.h>
12 #include <linux/iopoll.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/mailbox_controller.h>
17 #include <linux/mailbox/mtk-cmdq-mailbox.h>
18 #include <linux/of_device.h>
20 #define CMDQ_OP_CODE_MASK (0xff << CMDQ_OP_CODE_SHIFT)
21 #define CMDQ_NUM_CMD(t) (t->cmd_buf_size / CMDQ_INST_SIZE)
23 #define CMDQ_CURR_IRQ_STATUS 0x10
24 #define CMDQ_SYNC_TOKEN_UPDATE 0x68
25 #define CMDQ_THR_SLOT_CYCLES 0x30
26 #define CMDQ_THR_BASE 0x100
27 #define CMDQ_THR_SIZE 0x80
28 #define CMDQ_THR_WARM_RESET 0x00
29 #define CMDQ_THR_ENABLE_TASK 0x04
30 #define CMDQ_THR_SUSPEND_TASK 0x08
31 #define CMDQ_THR_CURR_STATUS 0x0c
32 #define CMDQ_THR_IRQ_STATUS 0x10
33 #define CMDQ_THR_IRQ_ENABLE 0x14
34 #define CMDQ_THR_CURR_ADDR 0x20
35 #define CMDQ_THR_END_ADDR 0x24
36 #define CMDQ_THR_WAIT_TOKEN 0x30
37 #define CMDQ_THR_PRIORITY 0x40
39 #define CMDQ_THR_ACTIVE_SLOT_CYCLES 0x3200
40 #define CMDQ_THR_ENABLED 0x1
41 #define CMDQ_THR_DISABLED 0x0
42 #define CMDQ_THR_SUSPEND 0x1
43 #define CMDQ_THR_RESUME 0x0
44 #define CMDQ_THR_STATUS_SUSPENDED BIT(1)
45 #define CMDQ_THR_DO_WARM_RESET BIT(0)
46 #define CMDQ_THR_IRQ_DONE 0x1
47 #define CMDQ_THR_IRQ_ERROR 0x12
48 #define CMDQ_THR_IRQ_EN (CMDQ_THR_IRQ_ERROR | CMDQ_THR_IRQ_DONE)
49 #define CMDQ_THR_IS_WAITING BIT(31)
51 #define CMDQ_JUMP_BY_OFFSET 0x10000000
52 #define CMDQ_JUMP_BY_PA 0x10000001
55 struct mbox_chan
*chan
;
57 struct list_head task_busy_list
;
63 struct list_head list_entry
;
65 struct cmdq_thread
*thread
;
66 struct cmdq_pkt
*pkt
; /* the packet sent from mailbox client */
70 struct mbox_controller mbox
;
75 struct cmdq_thread
*thread
;
86 u8
cmdq_get_shift_pa(struct mbox_chan
*chan
)
88 struct cmdq
*cmdq
= container_of(chan
->mbox
, struct cmdq
, mbox
);
90 return cmdq
->shift_pa
;
92 EXPORT_SYMBOL(cmdq_get_shift_pa
);
94 static int cmdq_thread_suspend(struct cmdq
*cmdq
, struct cmdq_thread
*thread
)
98 writel(CMDQ_THR_SUSPEND
, thread
->base
+ CMDQ_THR_SUSPEND_TASK
);
100 /* If already disabled, treat as suspended successful. */
101 if (!(readl(thread
->base
+ CMDQ_THR_ENABLE_TASK
) & CMDQ_THR_ENABLED
))
104 if (readl_poll_timeout_atomic(thread
->base
+ CMDQ_THR_CURR_STATUS
,
105 status
, status
& CMDQ_THR_STATUS_SUSPENDED
, 0, 10)) {
106 dev_err(cmdq
->mbox
.dev
, "suspend GCE thread 0x%x failed\n",
107 (u32
)(thread
->base
- cmdq
->base
));
114 static void cmdq_thread_resume(struct cmdq_thread
*thread
)
116 writel(CMDQ_THR_RESUME
, thread
->base
+ CMDQ_THR_SUSPEND_TASK
);
119 static void cmdq_init(struct cmdq
*cmdq
)
123 WARN_ON(clk_enable(cmdq
->clock
) < 0);
124 writel(CMDQ_THR_ACTIVE_SLOT_CYCLES
, cmdq
->base
+ CMDQ_THR_SLOT_CYCLES
);
125 for (i
= 0; i
<= CMDQ_MAX_EVENT
; i
++)
126 writel(i
, cmdq
->base
+ CMDQ_SYNC_TOKEN_UPDATE
);
127 clk_disable(cmdq
->clock
);
130 static int cmdq_thread_reset(struct cmdq
*cmdq
, struct cmdq_thread
*thread
)
134 writel(CMDQ_THR_DO_WARM_RESET
, thread
->base
+ CMDQ_THR_WARM_RESET
);
135 if (readl_poll_timeout_atomic(thread
->base
+ CMDQ_THR_WARM_RESET
,
136 warm_reset
, !(warm_reset
& CMDQ_THR_DO_WARM_RESET
),
138 dev_err(cmdq
->mbox
.dev
, "reset GCE thread 0x%x failed\n",
139 (u32
)(thread
->base
- cmdq
->base
));
146 static void cmdq_thread_disable(struct cmdq
*cmdq
, struct cmdq_thread
*thread
)
148 cmdq_thread_reset(cmdq
, thread
);
149 writel(CMDQ_THR_DISABLED
, thread
->base
+ CMDQ_THR_ENABLE_TASK
);
152 /* notify GCE to re-fetch commands by setting GCE thread PC */
153 static void cmdq_thread_invalidate_fetched_data(struct cmdq_thread
*thread
)
155 writel(readl(thread
->base
+ CMDQ_THR_CURR_ADDR
),
156 thread
->base
+ CMDQ_THR_CURR_ADDR
);
159 static void cmdq_task_insert_into_thread(struct cmdq_task
*task
)
161 struct device
*dev
= task
->cmdq
->mbox
.dev
;
162 struct cmdq_thread
*thread
= task
->thread
;
163 struct cmdq_task
*prev_task
= list_last_entry(
164 &thread
->task_busy_list
, typeof(*task
), list_entry
);
165 u64
*prev_task_base
= prev_task
->pkt
->va_base
;
167 /* let previous task jump to this task */
168 dma_sync_single_for_cpu(dev
, prev_task
->pa_base
,
169 prev_task
->pkt
->cmd_buf_size
, DMA_TO_DEVICE
);
170 prev_task_base
[CMDQ_NUM_CMD(prev_task
->pkt
) - 1] =
171 (u64
)CMDQ_JUMP_BY_PA
<< 32 | task
->pa_base
;
172 dma_sync_single_for_device(dev
, prev_task
->pa_base
,
173 prev_task
->pkt
->cmd_buf_size
, DMA_TO_DEVICE
);
175 cmdq_thread_invalidate_fetched_data(thread
);
178 static bool cmdq_thread_is_in_wfe(struct cmdq_thread
*thread
)
180 return readl(thread
->base
+ CMDQ_THR_WAIT_TOKEN
) & CMDQ_THR_IS_WAITING
;
183 static void cmdq_task_exec_done(struct cmdq_task
*task
, enum cmdq_cb_status sta
)
185 struct cmdq_task_cb
*cb
= &task
->pkt
->async_cb
;
186 struct cmdq_cb_data data
;
188 WARN_ON(cb
->cb
== (cmdq_async_flush_cb
)NULL
);
190 data
.data
= cb
->data
;
193 list_del(&task
->list_entry
);
196 static void cmdq_task_handle_error(struct cmdq_task
*task
)
198 struct cmdq_thread
*thread
= task
->thread
;
199 struct cmdq_task
*next_task
;
200 struct cmdq
*cmdq
= task
->cmdq
;
202 dev_err(cmdq
->mbox
.dev
, "task 0x%p error\n", task
);
203 WARN_ON(cmdq_thread_suspend(cmdq
, thread
) < 0);
204 next_task
= list_first_entry_or_null(&thread
->task_busy_list
,
205 struct cmdq_task
, list_entry
);
207 writel(next_task
->pa_base
>> cmdq
->shift_pa
,
208 thread
->base
+ CMDQ_THR_CURR_ADDR
);
209 cmdq_thread_resume(thread
);
212 static void cmdq_thread_irq_handler(struct cmdq
*cmdq
,
213 struct cmdq_thread
*thread
)
215 struct cmdq_task
*task
, *tmp
, *curr_task
= NULL
;
216 u32 curr_pa
, irq_flag
, task_end_pa
;
219 irq_flag
= readl(thread
->base
+ CMDQ_THR_IRQ_STATUS
);
220 writel(~irq_flag
, thread
->base
+ CMDQ_THR_IRQ_STATUS
);
223 * When ISR call this function, another CPU core could run
224 * "release task" right before we acquire the spin lock, and thus
225 * reset / disable this GCE thread, so we need to check the enable
226 * bit of this GCE thread.
228 if (!(readl(thread
->base
+ CMDQ_THR_ENABLE_TASK
) & CMDQ_THR_ENABLED
))
231 if (irq_flag
& CMDQ_THR_IRQ_ERROR
)
233 else if (irq_flag
& CMDQ_THR_IRQ_DONE
)
238 curr_pa
= readl(thread
->base
+ CMDQ_THR_CURR_ADDR
) << cmdq
->shift_pa
;
240 list_for_each_entry_safe(task
, tmp
, &thread
->task_busy_list
,
242 task_end_pa
= task
->pa_base
+ task
->pkt
->cmd_buf_size
;
243 if (curr_pa
>= task
->pa_base
&& curr_pa
< task_end_pa
)
246 if (!curr_task
|| curr_pa
== task_end_pa
- CMDQ_INST_SIZE
) {
247 cmdq_task_exec_done(task
, CMDQ_CB_NORMAL
);
250 cmdq_task_exec_done(task
, CMDQ_CB_ERROR
);
251 cmdq_task_handle_error(curr_task
);
259 if (list_empty(&thread
->task_busy_list
)) {
260 cmdq_thread_disable(cmdq
, thread
);
261 clk_disable(cmdq
->clock
);
265 static irqreturn_t
cmdq_irq_handler(int irq
, void *dev
)
267 struct cmdq
*cmdq
= dev
;
268 unsigned long irq_status
, flags
= 0L;
271 irq_status
= readl(cmdq
->base
+ CMDQ_CURR_IRQ_STATUS
) & cmdq
->irq_mask
;
272 if (!(irq_status
^ cmdq
->irq_mask
))
275 for_each_clear_bit(bit
, &irq_status
, cmdq
->thread_nr
) {
276 struct cmdq_thread
*thread
= &cmdq
->thread
[bit
];
278 spin_lock_irqsave(&thread
->chan
->lock
, flags
);
279 cmdq_thread_irq_handler(cmdq
, thread
);
280 spin_unlock_irqrestore(&thread
->chan
->lock
, flags
);
286 static int cmdq_suspend(struct device
*dev
)
288 struct cmdq
*cmdq
= dev_get_drvdata(dev
);
289 struct cmdq_thread
*thread
;
291 bool task_running
= false;
293 cmdq
->suspended
= true;
295 for (i
= 0; i
< cmdq
->thread_nr
; i
++) {
296 thread
= &cmdq
->thread
[i
];
297 if (!list_empty(&thread
->task_busy_list
)) {
304 dev_warn(dev
, "exist running task(s) in suspend\n");
306 clk_unprepare(cmdq
->clock
);
311 static int cmdq_resume(struct device
*dev
)
313 struct cmdq
*cmdq
= dev_get_drvdata(dev
);
315 WARN_ON(clk_prepare(cmdq
->clock
) < 0);
316 cmdq
->suspended
= false;
320 static int cmdq_remove(struct platform_device
*pdev
)
322 struct cmdq
*cmdq
= platform_get_drvdata(pdev
);
324 clk_unprepare(cmdq
->clock
);
329 static int cmdq_mbox_send_data(struct mbox_chan
*chan
, void *data
)
331 struct cmdq_pkt
*pkt
= (struct cmdq_pkt
*)data
;
332 struct cmdq_thread
*thread
= (struct cmdq_thread
*)chan
->con_priv
;
333 struct cmdq
*cmdq
= dev_get_drvdata(chan
->mbox
->dev
);
334 struct cmdq_task
*task
;
335 unsigned long curr_pa
, end_pa
;
337 /* Client should not flush new tasks if suspended. */
338 WARN_ON(cmdq
->suspended
);
340 task
= kzalloc(sizeof(*task
), GFP_ATOMIC
);
345 INIT_LIST_HEAD(&task
->list_entry
);
346 task
->pa_base
= pkt
->pa_base
;
347 task
->thread
= thread
;
350 if (list_empty(&thread
->task_busy_list
)) {
351 WARN_ON(clk_enable(cmdq
->clock
) < 0);
353 * The thread reset will clear thread related register to 0,
354 * including pc, end, priority, irq, suspend and enable. Thus
355 * set CMDQ_THR_ENABLED to CMDQ_THR_ENABLE_TASK will enable
356 * thread and make it running.
358 WARN_ON(cmdq_thread_reset(cmdq
, thread
) < 0);
360 writel(task
->pa_base
>> cmdq
->shift_pa
,
361 thread
->base
+ CMDQ_THR_CURR_ADDR
);
362 writel((task
->pa_base
+ pkt
->cmd_buf_size
) >> cmdq
->shift_pa
,
363 thread
->base
+ CMDQ_THR_END_ADDR
);
365 writel(thread
->priority
, thread
->base
+ CMDQ_THR_PRIORITY
);
366 writel(CMDQ_THR_IRQ_EN
, thread
->base
+ CMDQ_THR_IRQ_ENABLE
);
367 writel(CMDQ_THR_ENABLED
, thread
->base
+ CMDQ_THR_ENABLE_TASK
);
369 WARN_ON(cmdq_thread_suspend(cmdq
, thread
) < 0);
370 curr_pa
= readl(thread
->base
+ CMDQ_THR_CURR_ADDR
) <<
372 end_pa
= readl(thread
->base
+ CMDQ_THR_END_ADDR
) <<
375 if (curr_pa
== end_pa
- CMDQ_INST_SIZE
||
377 /* set to this task directly */
378 writel(task
->pa_base
>> cmdq
->shift_pa
,
379 thread
->base
+ CMDQ_THR_CURR_ADDR
);
381 cmdq_task_insert_into_thread(task
);
382 smp_mb(); /* modify jump before enable thread */
384 writel((task
->pa_base
+ pkt
->cmd_buf_size
) >> cmdq
->shift_pa
,
385 thread
->base
+ CMDQ_THR_END_ADDR
);
386 cmdq_thread_resume(thread
);
388 list_move_tail(&task
->list_entry
, &thread
->task_busy_list
);
393 static int cmdq_mbox_startup(struct mbox_chan
*chan
)
398 static void cmdq_mbox_shutdown(struct mbox_chan
*chan
)
400 struct cmdq_thread
*thread
= (struct cmdq_thread
*)chan
->con_priv
;
401 struct cmdq
*cmdq
= dev_get_drvdata(chan
->mbox
->dev
);
402 struct cmdq_task
*task
, *tmp
;
405 spin_lock_irqsave(&thread
->chan
->lock
, flags
);
406 if (list_empty(&thread
->task_busy_list
))
409 WARN_ON(cmdq_thread_suspend(cmdq
, thread
) < 0);
411 /* make sure executed tasks have success callback */
412 cmdq_thread_irq_handler(cmdq
, thread
);
413 if (list_empty(&thread
->task_busy_list
))
416 list_for_each_entry_safe(task
, tmp
, &thread
->task_busy_list
,
418 cmdq_task_exec_done(task
, CMDQ_CB_ERROR
);
422 cmdq_thread_disable(cmdq
, thread
);
423 clk_disable(cmdq
->clock
);
426 * The thread->task_busy_list empty means thread already disable. The
427 * cmdq_mbox_send_data() always reset thread which clear disable and
428 * suspend statue when first pkt send to channel, so there is no need
429 * to do any operation here, only unlock and leave.
431 spin_unlock_irqrestore(&thread
->chan
->lock
, flags
);
434 static int cmdq_mbox_flush(struct mbox_chan
*chan
, unsigned long timeout
)
436 struct cmdq_thread
*thread
= (struct cmdq_thread
*)chan
->con_priv
;
437 struct cmdq_task_cb
*cb
;
438 struct cmdq_cb_data data
;
439 struct cmdq
*cmdq
= dev_get_drvdata(chan
->mbox
->dev
);
440 struct cmdq_task
*task
, *tmp
;
444 spin_lock_irqsave(&thread
->chan
->lock
, flags
);
445 if (list_empty(&thread
->task_busy_list
))
448 WARN_ON(cmdq_thread_suspend(cmdq
, thread
) < 0);
449 if (!cmdq_thread_is_in_wfe(thread
))
452 list_for_each_entry_safe(task
, tmp
, &thread
->task_busy_list
,
454 cb
= &task
->pkt
->async_cb
;
456 data
.sta
= CMDQ_CB_ERROR
;
457 data
.data
= cb
->data
;
460 list_del(&task
->list_entry
);
464 cmdq_thread_resume(thread
);
465 cmdq_thread_disable(cmdq
, thread
);
466 clk_disable(cmdq
->clock
);
469 spin_unlock_irqrestore(&thread
->chan
->lock
, flags
);
473 cmdq_thread_resume(thread
);
474 spin_unlock_irqrestore(&thread
->chan
->lock
, flags
);
475 if (readl_poll_timeout_atomic(thread
->base
+ CMDQ_THR_ENABLE_TASK
,
476 enable
, enable
== 0, 1, timeout
)) {
477 dev_err(cmdq
->mbox
.dev
, "Fail to wait GCE thread 0x%x done\n",
478 (u32
)(thread
->base
- cmdq
->base
));
485 static const struct mbox_chan_ops cmdq_mbox_chan_ops
= {
486 .send_data
= cmdq_mbox_send_data
,
487 .startup
= cmdq_mbox_startup
,
488 .shutdown
= cmdq_mbox_shutdown
,
489 .flush
= cmdq_mbox_flush
,
492 static struct mbox_chan
*cmdq_xlate(struct mbox_controller
*mbox
,
493 const struct of_phandle_args
*sp
)
495 int ind
= sp
->args
[0];
496 struct cmdq_thread
*thread
;
498 if (ind
>= mbox
->num_chans
)
499 return ERR_PTR(-EINVAL
);
501 thread
= (struct cmdq_thread
*)mbox
->chans
[ind
].con_priv
;
502 thread
->priority
= sp
->args
[1];
503 thread
->chan
= &mbox
->chans
[ind
];
505 return &mbox
->chans
[ind
];
508 static int cmdq_probe(struct platform_device
*pdev
)
510 struct device
*dev
= &pdev
->dev
;
511 struct resource
*res
;
514 struct gce_plat
*plat_data
;
516 cmdq
= devm_kzalloc(dev
, sizeof(*cmdq
), GFP_KERNEL
);
520 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
521 cmdq
->base
= devm_ioremap_resource(dev
, res
);
522 if (IS_ERR(cmdq
->base
)) {
523 dev_err(dev
, "failed to ioremap gce\n");
524 return PTR_ERR(cmdq
->base
);
527 cmdq
->irq
= platform_get_irq(pdev
, 0);
531 plat_data
= (struct gce_plat
*)of_device_get_match_data(dev
);
533 dev_err(dev
, "failed to get match data\n");
537 cmdq
->thread_nr
= plat_data
->thread_nr
;
538 cmdq
->shift_pa
= plat_data
->shift
;
539 cmdq
->irq_mask
= GENMASK(cmdq
->thread_nr
- 1, 0);
540 err
= devm_request_irq(dev
, cmdq
->irq
, cmdq_irq_handler
, IRQF_SHARED
,
543 dev_err(dev
, "failed to register ISR (%d)\n", err
);
547 dev_dbg(dev
, "cmdq device: addr:0x%p, va:0x%p, irq:%d\n",
548 dev
, cmdq
->base
, cmdq
->irq
);
550 cmdq
->clock
= devm_clk_get(dev
, "gce");
551 if (IS_ERR(cmdq
->clock
)) {
552 dev_err(dev
, "failed to get gce clk\n");
553 return PTR_ERR(cmdq
->clock
);
556 cmdq
->mbox
.dev
= dev
;
557 cmdq
->mbox
.chans
= devm_kcalloc(dev
, cmdq
->thread_nr
,
558 sizeof(*cmdq
->mbox
.chans
), GFP_KERNEL
);
559 if (!cmdq
->mbox
.chans
)
562 cmdq
->mbox
.num_chans
= cmdq
->thread_nr
;
563 cmdq
->mbox
.ops
= &cmdq_mbox_chan_ops
;
564 cmdq
->mbox
.of_xlate
= cmdq_xlate
;
566 /* make use of TXDONE_BY_ACK */
567 cmdq
->mbox
.txdone_irq
= false;
568 cmdq
->mbox
.txdone_poll
= false;
570 cmdq
->thread
= devm_kcalloc(dev
, cmdq
->thread_nr
,
571 sizeof(*cmdq
->thread
), GFP_KERNEL
);
575 for (i
= 0; i
< cmdq
->thread_nr
; i
++) {
576 cmdq
->thread
[i
].base
= cmdq
->base
+ CMDQ_THR_BASE
+
578 INIT_LIST_HEAD(&cmdq
->thread
[i
].task_busy_list
);
579 cmdq
->mbox
.chans
[i
].con_priv
= (void *)&cmdq
->thread
[i
];
582 err
= devm_mbox_controller_register(dev
, &cmdq
->mbox
);
584 dev_err(dev
, "failed to register mailbox: %d\n", err
);
588 platform_set_drvdata(pdev
, cmdq
);
589 WARN_ON(clk_prepare(cmdq
->clock
) < 0);
596 static const struct dev_pm_ops cmdq_pm_ops
= {
597 .suspend
= cmdq_suspend
,
598 .resume
= cmdq_resume
,
601 static const struct gce_plat gce_plat_v2
= {.thread_nr
= 16};
602 static const struct gce_plat gce_plat_v3
= {.thread_nr
= 24};
603 static const struct gce_plat gce_plat_v4
= {.thread_nr
= 24, .shift
= 3};
605 static const struct of_device_id cmdq_of_ids
[] = {
606 {.compatible
= "mediatek,mt8173-gce", .data
= (void *)&gce_plat_v2
},
607 {.compatible
= "mediatek,mt8183-gce", .data
= (void *)&gce_plat_v3
},
608 {.compatible
= "mediatek,mt6779-gce", .data
= (void *)&gce_plat_v4
},
612 static struct platform_driver cmdq_drv
= {
614 .remove
= cmdq_remove
,
618 .of_match_table
= cmdq_of_ids
,
622 static int __init
cmdq_drv_init(void)
624 return platform_driver_register(&cmdq_drv
);
627 static void __exit
cmdq_drv_exit(void)
629 platform_driver_unregister(&cmdq_drv
);
632 subsys_initcall(cmdq_drv_init
);
633 module_exit(cmdq_drv_exit
);
635 MODULE_LICENSE("GPL v2");