drivers/mailbox/mtk-cmdq-mailbox.c

File Facts

System

Linux kernel

Corpus path

drivers/mailbox/mtk-cmdq-mailbox.c

Extension

.c

Size

23717 bytes

Lines

888

Domain

Driver Families

Bucket

drivers/mailbox

Inferred role

Driver Families: exported/initcall integration point

Status

integration implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

• Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
• Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
• Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
• Touches IRQ or DMA behavior; this matters for the representative real-device path.
• Allocates kernel memory; connect allocation flags and lifetime to context constraints.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• linux/bitops.h
• linux/clk.h
• linux/clk-provider.h
• linux/dma-mapping.h
• linux/errno.h
• linux/interrupt.h
• linux/io.h
• linux/iopoll.h
• linux/kernel.h
• linux/module.h
• linux/platform_device.h
• linux/pm_runtime.h
• linux/sizes.h
• linux/mailbox_controller.h
• linux/mailbox/mtk-cmdq-mailbox.h
• linux/of.h

Detected Declarations

• struct cmdq_thread
• struct cmdq_task
• struct cmdq
• struct gce_plat
• function cmdq_convert_gce_addr
• function cmdq_revert_gce_addr
• function cmdq_get_mbox_priv
• function cmdq_get_shift_pa
• function cmdq_vm_init
• function cmdq_gctl_value_toggle
• function cmdq_thread_suspend
• function cmdq_thread_resume
• function cmdq_init
• function cmdq_thread_reset
• function cmdq_thread_disable
• function cmdq_thread_invalidate_fetched_data
• function cmdq_task_insert_into_thread
• function cmdq_thread_is_in_wfe
• function cmdq_task_exec_done
• function cmdq_task_handle_error
• function cmdq_thread_irq_handler
• function list_for_each_entry_safe
• function cmdq_irq_handler
• function for_each_clear_bit
• function cmdq_runtime_resume
• function cmdq_runtime_suspend
• function cmdq_suspend
• function cmdq_resume
• function cmdq_remove
• function cmdq_mbox_send_data
• function cmdq_mbox_startup
• function cmdq_mbox_shutdown
• function list_for_each_entry_safe
• function cmdq_mbox_flush
• function list_for_each_entry_safe
• function cmdq_get_clocks
• function cmdq_probe
• function cmdq_drv_init
• function cmdq_drv_exit
• module init cmdq_drv_init
• export cmdq_get_mbox_priv
• export cmdq_get_shift_pa

Annotated Snippet

subsys_initcall(cmdq_drv_init);
module_exit(cmdq_drv_exit);

MODULE_DESCRIPTION("Mediatek Command Queue(CMDQ) Mailbox driver");
MODULE_LICENSE("GPL v2");

Annotation

• Immediate include surface: `linux/bitops.h`, `linux/clk.h`, `linux/clk-provider.h`, `linux/dma-mapping.h`, `linux/errno.h`, `linux/interrupt.h`, `linux/io.h`, `linux/iopoll.h`.
• Detected declarations: `struct cmdq_thread`, `struct cmdq_task`, `struct cmdq`, `struct gce_plat`, `function cmdq_convert_gce_addr`, `function cmdq_revert_gce_addr`, `function cmdq_get_mbox_priv`, `function cmdq_get_shift_pa`, `function cmdq_vm_init`, `function cmdq_gctl_value_toggle`.
• Atlas domain: Driver Families / drivers/mailbox.
• Implementation status: integration implementation candidate.
• Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
• IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.