drivers/mailbox/mtk-vcp-mailbox.c
Source file repositories/reference/linux-study-clean/drivers/mailbox/mtk-vcp-mailbox.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/mailbox/mtk-vcp-mailbox.c- Extension
.c- Size
- 4180 bytes
- Lines
- 171
- Domain
- Driver Families
- Bucket
- drivers/mailbox
- Inferred role
- Driver Families: implementation source
- Status
- source 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.
- 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/interrupt.hlinux/io.hlinux/kernel.hlinux/mailbox_controller.hlinux/mailbox/mtk-vcp-mailbox.hlinux/module.hlinux/of.hlinux/platform_device.hlinux/slab.h
Detected Declarations
struct mtk_vcp_mboxstruct mtk_vcp_mbox_cfgfunction mtk_vcp_mbox_irq_threadfunction mtk_vcp_mbox_send_datafunction mtk_vcp_mbox_last_tx_donefunction mtk_vcp_mbox_probe
Annotated Snippet
struct mtk_vcp_mbox {
struct mbox_controller mbox;
void __iomem *base;
struct device *dev;
const struct mtk_vcp_mbox_cfg *cfg;
struct mtk_ipi_info ipi_recv;
struct mbox_chan chans;
};
struct mtk_vcp_mbox_cfg {
u16 set_in;
u16 clr_out;
};
static irqreturn_t mtk_vcp_mbox_irq_thread(int irq, void *data)
{
struct mtk_vcp_mbox *priv = data;
/* get irq status */
priv->ipi_recv.irq_status = readl(priv->base + priv->cfg->clr_out);
__ioread32_copy(priv->ipi_recv.msg, priv->base,
MTK_VCP_MBOX_SLOT_MAX_SIZE / 4);
mbox_chan_received_data(&priv->chans, &priv->ipi_recv);
/* clear irq status */
writel(priv->ipi_recv.irq_status, priv->base + priv->cfg->clr_out);
return IRQ_HANDLED;
}
static struct mbox_chan *mtk_vcp_mbox_xlate(struct mbox_controller *mbox,
const struct of_phandle_args *sp)
{
if (sp->args_count)
return ERR_PTR(-EINVAL);
return &mbox->chans[0];
}
static int mtk_vcp_mbox_send_data(struct mbox_chan *chan, void *data)
{
struct mtk_vcp_mbox *priv = chan->con_priv;
struct mtk_ipi_info *ipi_info = data;
u32 status;
if (!ipi_info->msg) {
dev_err(priv->dev, "msg buffer is NULL.\n");
return -EINVAL;
}
status = readl(priv->base + priv->cfg->set_in);
if (status & BIT(ipi_info->index)) {
dev_warn(priv->dev, "mailbox IPI %d is busy.\n", ipi_info->id);
return -EBUSY;
}
if (ipi_info->slot_ofs + ipi_info->len > MTK_VCP_MBOX_SLOT_MAX_SIZE)
return -EINVAL;
__iowrite32_copy(priv->base + ipi_info->slot_ofs, ipi_info->msg,
ipi_info->len);
writel(BIT(ipi_info->index), priv->base + priv->cfg->set_in);
return 0;
}
static bool mtk_vcp_mbox_last_tx_done(struct mbox_chan *chan)
{
struct mtk_ipi_info *ipi_info = chan->active_req;
struct mtk_vcp_mbox *priv = chan->con_priv;
return !(readl(priv->base + priv->cfg->set_in) & BIT(ipi_info->index));
}
static const struct mbox_chan_ops mtk_vcp_mbox_chan_ops = {
.send_data = mtk_vcp_mbox_send_data,
.last_tx_done = mtk_vcp_mbox_last_tx_done,
};
static int mtk_vcp_mbox_probe(struct platform_device *pdev)
{
struct device *dev = &pdev->dev;
struct mtk_vcp_mbox *priv;
struct mbox_controller *mbox;
int ret, irq;
priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
if (!priv)
Annotation
- Immediate include surface: `linux/interrupt.h`, `linux/io.h`, `linux/kernel.h`, `linux/mailbox_controller.h`, `linux/mailbox/mtk-vcp-mailbox.h`, `linux/module.h`, `linux/of.h`, `linux/platform_device.h`.
- Detected declarations: `struct mtk_vcp_mbox`, `struct mtk_vcp_mbox_cfg`, `function mtk_vcp_mbox_irq_thread`, `function mtk_vcp_mbox_send_data`, `function mtk_vcp_mbox_last_tx_done`, `function mtk_vcp_mbox_probe`.
- Atlas domain: Driver Families / drivers/mailbox.
- Implementation status: source implementation candidate.
- 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.