1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (c) 2017, Linaro Ltd
4  */
5 
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/io.h>
9 #include <linux/slab.h>
10 #include <linux/of.h>
11 #include <linux/of_platform.h>
12 #include <linux/platform_device.h>
13 #include <linux/regmap.h>
14 #include <linux/mailbox_controller.h>
15 
16 #define QCOM_APCS_IPC_BITS	32
17 
18 struct qcom_apcs_ipc {
19 	struct mbox_controller mbox;
20 	struct mbox_chan mbox_chans[QCOM_APCS_IPC_BITS];
21 
22 	struct regmap *regmap;
23 	unsigned long offset;
24 	struct platform_device *clk;
25 };
26 
27 struct qcom_apcs_ipc_data {
28 	int offset;
29 	char *clk_name;
30 };
31 
32 static const struct qcom_apcs_ipc_data ipq6018_apcs_data = {
33 	.offset = 8, .clk_name = "qcom,apss-ipq6018-clk"
34 };
35 
36 static const struct qcom_apcs_ipc_data msm8916_apcs_data = {
37 	.offset = 8, .clk_name = "qcom-apcs-msm8916-clk"
38 };
39 
40 static const struct qcom_apcs_ipc_data msm8994_apcs_data = {
41 	.offset = 8, .clk_name = NULL
42 };
43 
44 static const struct qcom_apcs_ipc_data msm8996_apcs_data = {
45 	.offset = 16, .clk_name = NULL
46 };
47 
48 static const struct qcom_apcs_ipc_data apps_shared_apcs_data = {
49 	.offset = 12, .clk_name = NULL
50 };
51 
52 static const struct qcom_apcs_ipc_data sdx55_apcs_data = {
53 	.offset = 0x1008, .clk_name = "qcom-sdx55-acps-clk"
54 };
55 
56 static const struct regmap_config apcs_regmap_config = {
57 	.reg_bits = 32,
58 	.reg_stride = 4,
59 	.val_bits = 32,
60 	.max_register = 0x1008,
61 	.fast_io = true,
62 };
63 
64 static int qcom_apcs_ipc_send_data(struct mbox_chan *chan, void *data)
65 {
66 	struct qcom_apcs_ipc *apcs = container_of(chan->mbox,
67 						  struct qcom_apcs_ipc, mbox);
68 	unsigned long idx = (unsigned long)chan->con_priv;
69 
70 	return regmap_write(apcs->regmap, apcs->offset, BIT(idx));
71 }
72 
73 static const struct mbox_chan_ops qcom_apcs_ipc_ops = {
74 	.send_data = qcom_apcs_ipc_send_data,
75 };
76 
77 static int qcom_apcs_ipc_probe(struct platform_device *pdev)
78 {
79 	struct qcom_apcs_ipc *apcs;
80 	const struct qcom_apcs_ipc_data *apcs_data;
81 	struct regmap *regmap;
82 	void __iomem *base;
83 	unsigned long i;
84 	int ret;
85 
86 	apcs = devm_kzalloc(&pdev->dev, sizeof(*apcs), GFP_KERNEL);
87 	if (!apcs)
88 		return -ENOMEM;
89 
90 	base = devm_platform_ioremap_resource(pdev, 0);
91 	if (IS_ERR(base))
92 		return PTR_ERR(base);
93 
94 	regmap = devm_regmap_init_mmio(&pdev->dev, base, &apcs_regmap_config);
95 	if (IS_ERR(regmap))
96 		return PTR_ERR(regmap);
97 
98 	apcs_data = of_device_get_match_data(&pdev->dev);
99 
100 	apcs->regmap = regmap;
101 	apcs->offset = apcs_data->offset;
102 
103 	/* Initialize channel identifiers */
104 	for (i = 0; i < ARRAY_SIZE(apcs->mbox_chans); i++)
105 		apcs->mbox_chans[i].con_priv = (void *)i;
106 
107 	apcs->mbox.dev = &pdev->dev;
108 	apcs->mbox.ops = &qcom_apcs_ipc_ops;
109 	apcs->mbox.chans = apcs->mbox_chans;
110 	apcs->mbox.num_chans = ARRAY_SIZE(apcs->mbox_chans);
111 
112 	ret = devm_mbox_controller_register(&pdev->dev, &apcs->mbox);
113 	if (ret) {
114 		dev_err(&pdev->dev, "failed to register APCS IPC controller\n");
115 		return ret;
116 	}
117 
118 	if (apcs_data->clk_name) {
119 		apcs->clk = platform_device_register_data(&pdev->dev,
120 							  apcs_data->clk_name,
121 							  PLATFORM_DEVID_AUTO,
122 							  NULL, 0);
123 		if (IS_ERR(apcs->clk))
124 			dev_err(&pdev->dev, "failed to register APCS clk\n");
125 	}
126 
127 	platform_set_drvdata(pdev, apcs);
128 
129 	return 0;
130 }
131 
132 static int qcom_apcs_ipc_remove(struct platform_device *pdev)
133 {
134 	struct qcom_apcs_ipc *apcs = platform_get_drvdata(pdev);
135 	struct platform_device *clk = apcs->clk;
136 
137 	platform_device_unregister(clk);
138 
139 	return 0;
140 }
141 
142 /* .data is the offset of the ipc register within the global block */
143 static const struct of_device_id qcom_apcs_ipc_of_match[] = {
144 	{ .compatible = "qcom,ipq6018-apcs-apps-global", .data = &ipq6018_apcs_data },
145 	{ .compatible = "qcom,ipq8074-apcs-apps-global", .data = &msm8994_apcs_data },
146 	{ .compatible = "qcom,msm8916-apcs-kpss-global", .data = &msm8916_apcs_data },
147 	{ .compatible = "qcom,msm8939-apcs-kpss-global", .data = &msm8916_apcs_data },
148 	{ .compatible = "qcom,msm8953-apcs-kpss-global", .data = &msm8994_apcs_data },
149 	{ .compatible = "qcom,msm8976-apcs-kpss-global", .data = &msm8994_apcs_data },
150 	{ .compatible = "qcom,msm8994-apcs-kpss-global", .data = &msm8994_apcs_data },
151 	{ .compatible = "qcom,msm8996-apcs-hmss-global", .data = &msm8996_apcs_data },
152 	{ .compatible = "qcom,msm8998-apcs-hmss-global", .data = &msm8994_apcs_data },
153 	{ .compatible = "qcom,qcm2290-apcs-hmss-global", .data = &msm8994_apcs_data },
154 	{ .compatible = "qcom,qcs404-apcs-apps-global", .data = &msm8916_apcs_data },
155 	{ .compatible = "qcom,sc7180-apss-shared", .data = &apps_shared_apcs_data },
156 	{ .compatible = "qcom,sc8180x-apss-shared", .data = &apps_shared_apcs_data },
157 	{ .compatible = "qcom,sdm660-apcs-hmss-global", .data = &msm8994_apcs_data },
158 	{ .compatible = "qcom,sdm845-apss-shared", .data = &apps_shared_apcs_data },
159 	{ .compatible = "qcom,sm6125-apcs-hmss-global", .data = &msm8994_apcs_data },
160 	{ .compatible = "qcom,sm8150-apss-shared", .data = &apps_shared_apcs_data },
161 	{ .compatible = "qcom,sm6115-apcs-hmss-global", .data = &msm8994_apcs_data },
162 	{ .compatible = "qcom,sdx55-apcs-gcc", .data = &sdx55_apcs_data },
163 	{}
164 };
165 MODULE_DEVICE_TABLE(of, qcom_apcs_ipc_of_match);
166 
167 static struct platform_driver qcom_apcs_ipc_driver = {
168 	.probe = qcom_apcs_ipc_probe,
169 	.remove = qcom_apcs_ipc_remove,
170 	.driver = {
171 		.name = "qcom_apcs_ipc",
172 		.of_match_table = qcom_apcs_ipc_of_match,
173 	},
174 };
175 
176 static int __init qcom_apcs_ipc_init(void)
177 {
178 	return platform_driver_register(&qcom_apcs_ipc_driver);
179 }
180 postcore_initcall(qcom_apcs_ipc_init);
181 
182 static void __exit qcom_apcs_ipc_exit(void)
183 {
184 	platform_driver_unregister(&qcom_apcs_ipc_driver);
185 }
186 module_exit(qcom_apcs_ipc_exit);
187 
188 MODULE_LICENSE("GPL v2");
189 MODULE_DESCRIPTION("Qualcomm APCS IPC driver");
190