2 * Copyright (c) 2015, Fuzhou Rockchip Electronics Co., Ltd
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/interrupt.h>
17 #include <linux/kernel.h>
18 #include <linux/mailbox_controller.h>
19 #include <linux/module.h>
20 #include <linux/of_device.h>
21 #include <linux/platform_device.h>
22 #include <linux/slab.h>
23 #include <linux/clk.h>
25 #include <linux/rockchip-mailbox.h>
26 #include <linux/scpi_protocol.h>
28 #define MAILBOX_A2B_INTEN 0x00
29 #define MAILBOX_A2B_STATUS 0x04
30 #define MAILBOX_A2B_CMD(x) (0x08 + (x) * 8)
31 #define MAILBOX_A2B_DAT(x) (0x0c + (x) * 8)
33 #define MAILBOX_B2A_INTEN 0x28
34 #define MAILBOX_B2A_STATUS 0x2C
35 #define MAILBOX_B2A_CMD(x) (0x30 + (x) * 8)
36 #define MAILBOX_B2A_DAT(x) (0x34 + (x) * 8)
38 #define MAILBOX_ATOMIC_LOCK(x) (0x100 + (x) * 8)
41 #define A2B_BUF(size, idx) ((idx) * (size))
43 #define B2A_BUF(size, idx) (((idx) + 4) * (size))
45 struct rockchip_mbox_drv_data {
49 struct rockchip_mbox_chan {
51 struct rockchip_mbox_msg *msg;
52 struct rockchip_mbox *mb;
55 struct rockchip_mbox {
56 struct mbox_controller mbox;
58 void __iomem *mbox_base;
59 /* The base address of share memory to transfer data */
60 void __iomem *buf_base;
61 /* The maximum size of buf for each channel */
63 struct rockchip_mbox_chan *chans;
66 static inline int chan_to_idx(struct rockchip_mbox *mb,
67 struct mbox_chan *chan)
69 return (chan - mb->mbox.chans);
72 static int rockchip_mbox_send_data(struct mbox_chan *chan, void *data)
74 struct rockchip_mbox *mb = dev_get_drvdata(chan->mbox->dev);
75 struct rockchip_mbox_msg *msg = data;
76 int idx = chan_to_idx(mb, chan);
81 if ((msg->tx_size > mb->buf_size) ||
82 (msg->rx_size > mb->buf_size)) {
83 dev_err(mb->mbox.dev, "Transmit size over buf size(%d)\n",
88 dev_dbg(mb->mbox.dev, "Chan[%d]: A2B message, cmd 0x%08x\n",
91 mb->chans[idx].msg = msg;
94 memcpy(mb->buf_base + A2B_BUF(mb->buf_size, idx),
95 msg->tx_buf, msg->tx_size);
97 writel_relaxed(msg->cmd, mb->mbox_base + MAILBOX_A2B_CMD(idx));
98 writel_relaxed(msg->rx_size, mb->mbox_base + MAILBOX_A2B_DAT(idx));
103 static int rockchip_mbox_startup(struct mbox_chan *chan)
108 static void rockchip_mbox_shutdown(struct mbox_chan *chan)
110 struct rockchip_mbox *mb = dev_get_drvdata(chan->mbox->dev);
111 int idx = chan_to_idx(mb, chan);
113 mb->chans[idx].msg = NULL;
116 static struct mbox_chan_ops rockchip_mbox_chan_ops = {
117 .send_data = rockchip_mbox_send_data,
118 .startup = rockchip_mbox_startup,
119 .shutdown = rockchip_mbox_shutdown,
122 static irqreturn_t rockchip_mbox_irq(int irq, void *dev_id)
124 struct rockchip_mbox *mb = (struct rockchip_mbox *)dev_id;
125 u32 status = readl_relaxed(mb->mbox_base + MAILBOX_B2A_STATUS);
128 for (idx = 0; idx < mb->mbox.num_chans; idx++) {
129 struct rockchip_mbox_msg *msg = mb->chans[idx].msg;
131 /* Clear mbox interrupt */
132 writel_relaxed(1 << idx, mb->mbox_base + MAILBOX_B2A_STATUS);
134 if (!(status & (1 << idx)))
137 continue; /* spurious */
141 mb->buf_base + B2A_BUF(mb->buf_size, idx),
144 mbox_chan_received_data(&mb->mbox.chans[idx], msg);
145 mb->chans[idx].msg = NULL;
147 dev_dbg(mb->mbox.dev, "Chan[%d]: B2A message, cmd 0x%08x\n",
154 static const struct rockchip_mbox_drv_data rk3368_drv_data = {
158 static struct of_device_id rockchip_mbox_of_match[] = {
159 { .compatible = "rockchip,rk3368-mailbox", .data = &rk3368_drv_data },
162 MODULE_DEVICE_TABLE(of, rockchp_mbox_of_match);
165 static int rockchip_mbox_suspend(struct platform_device *pdev,
168 struct rockchip_mbox *mb = platform_get_drvdata(pdev);
170 if (scpi_sys_set_mcu_state_suspend())
171 dev_err(mb->mbox.dev, "scpi_sys_set_mcu_state_suspend timeout.\n");
175 static int rockchip_mbox_resume(struct platform_device *pdev)
177 struct rockchip_mbox *mb = platform_get_drvdata(pdev);
179 writel_relaxed((1 << mb->mbox.num_chans) - 1,
180 mb->mbox_base + MAILBOX_B2A_INTEN);
182 if (scpi_sys_set_mcu_state_resume())
183 dev_err(mb->mbox.dev, "scpi_sys_set_mcu_state_resume timeout.\n");
186 #endif /* CONFIG_PM */
188 static int rockchip_mbox_probe(struct platform_device *pdev)
190 struct rockchip_mbox *mb;
191 const struct of_device_id *match;
192 const struct rockchip_mbox_drv_data *drv_data;
193 struct resource *res;
196 if (!pdev->dev.of_node)
199 match = of_match_node(rockchip_mbox_of_match, pdev->dev.of_node);
200 drv_data = (const struct rockchip_mbox_drv_data *)match->data;
202 mb = devm_kzalloc(&pdev->dev, sizeof(*mb), GFP_KERNEL);
206 mb->chans = devm_kcalloc(&pdev->dev, drv_data->num_chans,
207 sizeof(*mb->chans), GFP_KERNEL);
211 mb->mbox.chans = devm_kcalloc(&pdev->dev, drv_data->num_chans,
212 sizeof(*mb->mbox.chans), GFP_KERNEL);
216 platform_set_drvdata(pdev, mb);
218 mb->mbox.dev = &pdev->dev;
219 mb->mbox.num_chans = drv_data->num_chans;
220 mb->mbox.ops = &rockchip_mbox_chan_ops;
221 mb->mbox.txdone_irq = true;
223 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
227 mb->mbox_base = devm_request_and_ioremap(&pdev->dev, res);
231 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
235 mb->pclk = devm_clk_get(&pdev->dev, "pclk_mailbox");
236 if (IS_ERR(mb->pclk)) {
237 ret = PTR_ERR(mb->pclk);
238 dev_err(&pdev->dev, "failed to get pclk_mailbox clock: %d\n",
243 ret = clk_prepare_enable(mb->pclk);
245 dev_err(&pdev->dev, "failed to enable pclk: %d\n", ret);
249 /* Each channel has two buffers for A2B and B2A */
250 mb->buf_size = resource_size(res) / (drv_data->num_chans * 2);
251 mb->buf_base = devm_request_and_ioremap(&pdev->dev, res);
255 for (i = 0; i < mb->mbox.num_chans; i++) {
256 irq = platform_get_irq(pdev, i);
260 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
261 rockchip_mbox_irq, IRQF_ONESHOT,
262 dev_name(&pdev->dev), mb);
266 mb->chans[i].idx = i;
267 mb->chans[i].mb = mb;
268 mb->chans[i].msg = NULL;
271 /* Enable all B2A interrupts */
272 writel_relaxed((1 << mb->mbox.num_chans) - 1,
273 mb->mbox_base + MAILBOX_B2A_INTEN);
275 ret = mbox_controller_register(&mb->mbox);
277 dev_err(&pdev->dev, "Failed to register mailbox: %d\n", ret);
282 static int rockchip_mbox_remove(struct platform_device *pdev)
284 struct rockchip_mbox *mb = platform_get_drvdata(pdev);
286 mbox_controller_unregister(&mb->mbox);
291 static struct platform_driver rockchip_mbox_driver = {
292 .probe = rockchip_mbox_probe,
293 .remove = rockchip_mbox_remove,
295 .suspend = rockchip_mbox_suspend,
296 .resume = rockchip_mbox_resume,
297 #endif /* CONFIG_PM */
299 .name = "rockchip-mailbox",
300 .of_match_table = of_match_ptr(rockchip_mbox_of_match),
304 static int __init rockchip_mbox_init(void)
306 return platform_driver_register(&rockchip_mbox_driver);
308 subsys_initcall(rockchip_mbox_init);